Package com.google.cloud.spanner
A client for Cloud Spanner - A no-compromise relational database service.
- See Also:
- Cloud Spanner
-
Interface Summary Interface Description AsyncResultSet Interface for result sets returned by async query methods.AsyncResultSet.ReadyCallback Interface for receiving asynchronous callbacks when new data is ready.AsyncRunner AsyncRunner.AsyncWork<R> Functional interface for executing a read/write transaction asynchronously that returns a result of type R.AsyncTransactionManager An interface for managing the life cycle of a read write transaction including all its retries.AsyncTransactionManager.AsyncTransactionFunction<I,O> Each step in a transaction chain is defined by anAsyncTransactionManager.AsyncTransactionFunction
.AsyncTransactionManager.AsyncTransactionStep<I,O> AsyncTransactionManager.AsyncTransactionStep
is returned byTransactionContextFuture#then(AsyncTransactionFunction)
andAsyncTransactionStep#then(AsyncTransactionFunction)
and allows transaction steps that should be executed serially to be chained together.AsyncTransactionManager.CommitTimestampFuture ApiFuture
that returns the commitTimestamp
of a Cloud Spanner transaction that is executed using anAsyncTransactionManager
.AsyncTransactionManager.TransactionContextFuture ApiFuture
that returns aTransactionContext
and that supports chaining of multipleAsyncTransactionManager.TransactionContextFuture
s to form a transaction.BatchClient Interface for the Batch Client that is used to read data from a Cloud Spanner database.BatchReadOnlyTransaction BatchReadOnlyTransaction
can be configured to read at timestamps in the past and allows for exporting arbitrarily large amounts of data from Cloud Spanner databases.DatabaseAdminClient Client to do admin operations on a Cloud Spanner Database.DatabaseClient Interface for all the APIs that are used to read/write data into a Cloud Spanner database.InstanceAdminClient Client to do admin operations on Cloud Spanner Instance and Instance Configs.Options.ListOption Marker interface to mark options applicable to list operations in admin API.Options.QueryOption Marker interface to mark options applicable to query operation.Options.ReadAndQueryOption Marker interface to mark options applicable to both Read and Query operationsOptions.ReadOption Marker interface to mark options applicable to read operationOptions.ReadQueryUpdateTransactionOption Marker interface to mark options applicable to Read, Query, Update and Write operationsOptions.TransactionOption Marker interface to mark options applicable to write operationsOptions.UpdateOption Marker interface to mark options applicable to update operation.ReadContext A concurrency context in which to run a read or SQL statement.ReadOnlyTransaction A transaction type that provides guaranteed consistency across several reads, but does not allow writes.ResultSet Provides access to the data returned by a Cloud Spanner read or query.Session ASession
can be used to perform transactions that read and/or modify data in a Cloud Spanner database.Spanner An interface for Cloud Spanner.SpannerFactory Factory to create instance ofSpanner
.SpannerOptions.CallContextConfigurator SpannerOptions.CallContextConfigurator
can be used to modify theApiCallContext
for one or more specific RPCs.SpannerOptions.CallCredentialsProvider SpannerOptions.CloseableExecutorProvider ExecutorProvider
that is used forAsyncResultSet
.SpannerOptions.SpannerEnvironment The environment to read configuration values from.StructReader A base interface for reading the fields of aSTRUCT
.TransactionContext Context for a single attempt of a locking read-write transaction.TransactionManager An interface for managing the life cycle of a read write transaction including all its retries.TransactionRunner An interface for executing a body of work in the context of a read-write transaction, with retries for transaction aborts.TransactionRunner.TransactionCallable<T> A unit of work to be performed in the context of a transaction. -
Class Summary Class Description AbstractLazyInitializer<T> GenericAbstractLazyInitializer
for any heavy-weight object that might throw an exception during initialization.AbstractStructReader Base class for assistingStructReader
implementations.Backup Represents a Cloud Spanner database backup.Backup.Builder BackupId Represents an id of a Cloud Spanner backup resource.BackupInfo Represents a Cloud Spanner database backup.BackupInfo.Builder BatchClientImpl Default implementation for Batch Client interface.BatchTransactionId BatchTransactionId
is unique identifier forBatchReadOnlyTransaction
.CommitResponse Represents a response from a commit operation.CommitStats Commit statistics are returned by a read/write transaction if specifically requested by passing inOptions.commitStats()
to the transaction.Database Represents a Cloud Spanner database.Database.Builder DatabaseId Represents an id of a Cloud Spanner database resource.DatabaseInfo Represents a Cloud Spanner database.DatabaseInfo.Builder ForwardingAsyncResultSet Forwarding implementation ofAsyncResultSet
that forwards all calls to a delegate.ForwardingResultSet Forwarding implementation of ResultSet that forwards all calls to a delegate.ForwardingStructReader Forwarding implements of StructReaderInstance Represents a Cloud Spanner Instance.Instance.Builder Builder ofInstance
.InstanceConfig Represents a Cloud Spanner instance config.InstanceConfig
adds a layer of service related functionality overInstanceConfigInfo
.InstanceConfigId Returns id of a Cloud Spanner instance config.InstanceConfigInfo Represents a Cloud Spanner instance config resource.InstanceId Represents the resource name of a Cloud Spanner Instance.InstanceInfo Represents a Cloud Spanner Instance.InstanceInfo.Builder Builder forInstanceInfo
.IsRetryableInternalError IsSslHandshakeException Key Represents a row key in a Cloud Spanner table or index.Key.Builder Builder forKey
instances.KeyRange Represents a range of rows in a table or index.KeyRange.Builder Builder forKeyRange
instances.KeySet Defines a collection of Cloud Spanner keys and/or key ranges.KeySet.Builder Builder forKeySet
instances.LazySpannerInitializer Default implementation ofAbstractLazyInitializer
for aSpanner
instance.Mutation Represents an individual table modification to be applied to Cloud Spanner.Mutation.WriteBuilder Builder forMutation.Op.INSERT
,Mutation.Op.INSERT_OR_UPDATE
,Mutation.Op.UPDATE
, andMutation.Op.REPLACE
mutations.Operation<R,M> Represents a long running operation.Options Specifies options for various spanner operationsPartition Defines the segments of data to be read in a batch read/query context.PartitionedDmlTransaction PartitionOptions Defines the configuration for the number and size of partitions returned fromBatchReadOnlyTransaction.partitionRead(com.google.cloud.spanner.PartitionOptions, java.lang.String, com.google.cloud.spanner.KeySet, java.lang.Iterable<java.lang.String>, com.google.cloud.spanner.Options.ReadOption...)
,BatchReadOnlyTransaction.partitionReadUsingIndex(com.google.cloud.spanner.PartitionOptions, java.lang.String, java.lang.String, com.google.cloud.spanner.KeySet, java.lang.Iterable<java.lang.String>, com.google.cloud.spanner.Options.ReadOption...)
andBatchReadOnlyTransaction.partitionQuery(com.google.cloud.spanner.PartitionOptions, com.google.cloud.spanner.Statement, com.google.cloud.spanner.Options.QueryOption...)
PartitionOptions.Builder Builder forPartitionOptions
instance.ReplicaInfo Represents a Cloud Spanner replica information.ReplicaInfo.BuilderImpl Restore Represents a restore operation of a Cloud Spanner backup.Restore.Builder RestoreInfo Represents the restore information of a Cloud Spanner database.ResultSets Utility methods for working withResultSet
.SessionPoolOptions Options for the session pool used byDatabaseClient
.SessionPoolOptions.Builder Builder for creating SessionPoolOptions.SpannerApiFutures SpannerExceptionFactory A factory for creating instances ofSpannerException
and its subtypes.SpannerOptions Options for the Cloud Spanner service.SpannerOptions.Builder Builder forSpannerOptions
instances.SpannerOptions.FixedCloseableExecutorProvider Implementation ofSpannerOptions.CloseableExecutorProvider
that uses a fixed singleScheduledExecutorService
.SpannerOptions.SpannerCallContextTimeoutConfigurator Helper class to configure timeouts for specific Spanner RPCs.Statement A SQL statement and optional bound parameters that can be executed in aReadContext
.Statement.Builder Builder forStatement
.Struct Represents a non-NULL
value ofType.Code.STRUCT
.Struct.Builder Builder for constructing non-NULL
Struct
instances.TimestampBound Defines how Cloud Spanner will choose a timestamp for a read-only transaction or a single read/query.Type Describes a type in the Cloud Spanner type system.Type.StructField Describes an individual field in aSTRUCT type
.Value Represents a value to be consumed by the Cloud Spanner API.ValueBinder<R> An interface for binding aValue
in some context. -
Enum Summary Enum Description AsyncResultSet.CallbackResponse AsyncResultSet.CursorState Response code fromtryNext()
.BackupInfo.State State of the backup.DatabaseInfo.State State of the database.Dialect ErrorCode Enumerates the major types of error that the Cloud Spanner service can produce.InstanceInfo.InstanceField Represent an updatable field in Cloud Spanner instance.InstanceInfo.State State of the Instance.KeyRange.Endpoint Defines whether a range includes or excludes its endpoint keys.Mutation.Op Enumerates the types of mutation that can be applied.Options.RpcPriority Priority for an RPC invocation.ReadContext.QueryAnalyzeMode Used to specify the mode in which the query should be analyzed byReadContext.analyzeQuery(Statement,QueryAnalyzeMode)
.ReplicaInfo.ReplicaType Indicates the type of the replica.RestoreInfo.RestoreSourceType Source of the restore information.TimestampBound.Mode The type of timestamp bound.TransactionManager.TransactionState State of the transaction manager.Type.Code Enumerates the categories of types. -
Exception Summary Exception Description AbortedDueToConcurrentModificationException Exception thrown by aConnection
when a database operation detects that a transaction has aborted and an internal retry failed because of a concurrent modification.AbortedException Exception thrown by Cloud Spanner when an operation detects that a transaction has aborted.AdminRequestsPerMinuteExceededException Exception thrown by Cloud Spanner the number of administrative requests per minute has been exceeded.DatabaseNotFoundException Exception thrown by Cloud Spanner when an operation detects that the database that is being used no longer exists.InstanceNotFoundException Exception thrown by Cloud Spanner when an operation detects that the instance that is being used no longer exists.SessionNotFoundException Exception thrown by Cloud Spanner when an operation detects that the session that is being used is no longer valid.SpannerBatchUpdateException SpannerException Base exception type for all exceptions produced by the Cloud Spanner service.SpannerException.ResourceNotFoundException Base exception type for NOT_FOUND exceptions for known resource types.