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 an AsyncTransactionManager.AsyncTransactionFunction.
AsyncTransactionManager.AsyncTransactionStep<I,O>	AsyncTransactionManager.AsyncTransactionStep is returned by TransactionContextFuture#then(AsyncTransactionFunction) and AsyncTransactionStep#then(AsyncTransactionFunction) and allows transaction steps that should be executed serially to be chained together.
AsyncTransactionManager.CommitTimestampFuture	ApiFuture that returns the commit Timestamp of a Cloud Spanner transaction that is executed using an AsyncTransactionManager.
AsyncTransactionManager.TransactionContextFuture	ApiFuture that returns a TransactionContext and that supports chaining of multiple AsyncTransactionManager.TransactionContextFutures 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.AdminApiOption	Marker interface to mark options applicable to operations in admin API.
Options.CreateAdminApiOption	Marker interface to mark options applicable to Create operations in admin API.
Options.CreateUpdateDeleteAdminApiOption	Marker interface to mark options applicable to Create, Update and Delete operations in admin API.
Options.DeleteAdminApiOption	Marker interface to mark options applicable to Delete operations in admin API.
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 operations
Options.ReadOption	Marker interface to mark options applicable to read operation
Options.ReadQueryUpdateTransactionOption	Marker interface to mark options applicable to Read, Query, Update and Write operations
Options.TransactionOption	Marker interface to mark options applicable to write operations
Options.UpdateAdminApiOption	Marker interface to mark options applicable to Update operations in admin API.
Options.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	A Session 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 of Spanner.
SpannerOptions.CallContextConfigurator	SpannerOptions.CallContextConfigurator can be used to modify the ApiCallContext for one or more specific RPCs.
SpannerOptions.CallCredentialsProvider	Interface that can be used to provide CallCredentials instead of Credentials to SpannerOptions.
SpannerOptions.CloseableExecutorProvider	ExecutorProvider that is used for AsyncResultSet.
SpannerOptions.SpannerEnvironment	The environment to read configuration values from.
StructReader	A base interface for reading the fields of a STRUCT.
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>	Generic AbstractLazyInitializer for any heavy-weight object that might throw an exception during initialization.
AbstractStructReader	Base class for assisting StructReader 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 for BatchReadOnlyTransaction.
CommitResponse	Represents a response from a commit operation.
CommitStats	Commit statistics are returned by a read/write transaction if specifically requested by passing in Options.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
DatabaseRole	A Cloud Spanner database role.
DatabaseRole.Builder
ForwardingAsyncResultSet	Forwarding implementation of AsyncResultSet that forwards all calls to a delegate.
ForwardingResultSet	Forwarding implementation of ResultSet that forwards all calls to a delegate.
ForwardingStructReader	Forwarding implements of StructReader
Instance	Represents a Cloud Spanner Instance.
Instance.Builder	Builder of Instance.
InstanceConfig	Represents a Cloud Spanner instance config.InstanceConfig adds a layer of service related functionality over InstanceConfigInfo.
InstanceConfig.Builder	Builder of InstanceConfig.
InstanceConfigId	Returns id of a Cloud Spanner instance config.
InstanceConfigInfo	Represents a Cloud Spanner instance config resource.
InstanceConfigInfo.Builder	Builder for InstanceConfigInfo.
InstanceId	Represents the resource name of a Cloud Spanner Instance.
InstanceInfo	Represents a Cloud Spanner Instance.
InstanceInfo.Builder	Builder for InstanceInfo.
IsRetryableInternalError
IsSslHandshakeException
Key	Represents a row key in a Cloud Spanner table or index.
Key.Builder	Builder for Key instances.
KeyRange	Represents a range of rows in a table or index.
KeyRange.Builder	Builder for KeyRange instances.
KeySet	Defines a collection of Cloud Spanner keys and/or key ranges.
KeySet.Builder	Builder for KeySet instances.
LazySpannerInitializer	Default implementation of AbstractLazyInitializer for a Spanner instance.
Mutation	Represents an individual table modification to be applied to Cloud Spanner.
Mutation.WriteBuilder	Builder for Mutation.Op.INSERT, Mutation.Op.INSERT_OR_UPDATE, Mutation.Op.UPDATE, and Mutation.Op.REPLACE mutations.
Operation<R,M>	Represents a long running operation.
Options	Specifies options for various spanner operations
Partition	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 from BatchReadOnlyTransaction.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...) and BatchReadOnlyTransaction.partitionQuery(com.google.cloud.spanner.PartitionOptions, com.google.cloud.spanner.Statement, com.google.cloud.spanner.Options.QueryOption...)
PartitionOptions.Builder	Builder for PartitionOptions 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 with ResultSet.
SessionPoolOptions	Options for the session pool used by DatabaseClient.
SessionPoolOptions.Builder	Builder for creating SessionPoolOptions.
SpannerApiFutures
SpannerExceptionFactory	A factory for creating instances of SpannerException and its subtypes.
SpannerOptions	Options for the Cloud Spanner service.
SpannerOptions.Builder	Builder for SpannerOptions instances.
SpannerOptions.FixedCloseableExecutorProvider	Implementation of SpannerOptions.CloseableExecutorProvider that uses a fixed single ScheduledExecutorService.
SpannerOptions.SpannerCallContextTimeoutConfigurator	Helper class to configure timeouts for specific Spanner RPCs.
Statement	A SQL statement and optional bound parameters that can be executed in a ReadContext.
Statement.Builder	Builder for Statement.
Struct	Represents a non-NULL value of Type.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 a STRUCT type.
Value	Represents a value to be consumed by the Cloud Spanner API.
ValueBinder<R>	An interface for binding a Value in some context.

Enum Summary

Enum	Description
AsyncResultSet.CallbackResponse
AsyncResultSet.CursorState	Response code from tryNext().
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.
InstanceConfigInfo.InstanceConfigField	Represent an updatable field in Cloud Spanner InstanceConfig.
InstanceConfigInfo.State	Type of the Instance config.
InstanceConfigInfo.Type	Type of the Instance config.
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 by ReadContext.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 a Connection 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.