Package com.google.cloud.spanner.connection (6.74.0)

GitHub Repository

This package is not the recommended entry point to using this client library!

For this library, we recommend using com.google.cloud.spanner for new applications.

Classes

Class Description
com.google.cloud.spanner.connection.AbstractStatementParser Internal class for the Spanner Connection API.

Parses ClientSideStatements and normal SQL statements. The parser is able to recognize the type of statement, allowing the connection API to know which method on Spanner should be

com.google.cloud.spanner.connection.AbstractStatementParser.ParametersInfo Parameter information with positional parameters translated to named parameters.
com.google.cloud.spanner.connection.AbstractStatementParser.ParsedStatement A statement that has been parsed
com.google.cloud.spanner.connection.Connection.InternalMetadataQuery This query option is used internally to indicate that a query is executed by the library itself to fetch metadata. These queries are specifically allowed to be executed even when a DDL batch is active.
com.google.cloud.spanner.connection.ConnectionOptions Internal connection API for Google Cloud Spanner. This class may introduce breaking changes without prior notice.

Options for creating a Connection to a Google Cloud Spanner database.

com.google.cloud.spanner.connection.ConnectionOptions.Builder Builder for ConnectionOptions instances.
com.google.cloud.spanner.connection.ConnectionOptions.ConnectionProperty Supported connection properties that can be included in the connection URI.
com.google.cloud.spanner.connection.DirectedReadOptionsUtil
com.google.cloud.spanner.connection.PartitionId Contains a reference to a BatchTransactionId and a Partition. The combination of these two are needed to execute a partition of a partitioned query on a Connection. A PartitionId can safely be given to a different connection and/or host to be executed there.
com.google.cloud.spanner.connection.PostgreSQLStatementParser
com.google.cloud.spanner.connection.ReadOnlyStalenessUtil Util class for parsing and converting ReadOnlyStaleness values to/from strings. This util is used to parse client side statements and values for read only staleness for read-only transactions on Cloud Spanner.
com.google.cloud.spanner.connection.SpannerPool Pool for keeping track of Spanner instances needed for connections.

When a connection is opened for a Google Cloud Spanner database, a Spanner object can be opened in the background. The SpannerPool keeps track of which Spanner objects

com.google.cloud.spanner.connection.SpannerStatementParser

Interfaces

Interface Description
com.google.cloud.spanner.connection.AsyncStatementResult
com.google.cloud.spanner.connection.Connection Internal connection API for Google Cloud Spanner. This interface may introduce breaking changes without prior notice.

A connection to a Cloud Spanner database. Connections are not designed to be thread-safe. The

com.google.cloud.spanner.connection.ConnectionOptions.ExternalChannelProvider ExternalChannelProvider can be used for to specify an external channel provider. This is needed if you require different certificates than those provided by the standard grpc channel provider.
com.google.cloud.spanner.connection.PartitionedQueryResultSet Result set that is returned for partitioned queries.
com.google.cloud.spanner.connection.StatementResult A result of the execution of a statement. Statements that are executed by the Connection#execute(com.google.cloud.spanner.Statement) method could have different types of return values. These are wrapped in a StatementResult.
com.google.cloud.spanner.connection.TransactionRetryListener Cloud Spanner can abort any read/write transaction because of potential deadlocks or other internal reasons. When a transaction is aborted, the entire transaction should be retried. A Connection can automatically retry a transaction internally and check whether the results that are returned during a retry attempt are equal to the results during the original

Enums

Enum Description
com.google.cloud.spanner.connection.AbstractStatementParser.StatementType The type of statement that has been recognized by the parser.
com.google.cloud.spanner.connection.AutocommitDmlMode Enum used to define the behavior of DML statements in autocommit mode
com.google.cloud.spanner.connection.DdlInTransactionMode Enum used for setting the behavior of DDL in read/write transactions.
com.google.cloud.spanner.connection.SavepointSupport Option value used for determining the behavior of savepoints.
com.google.cloud.spanner.connection.StatementResult.ClientSideStatementType The type of client side statement that was executed.
com.google.cloud.spanner.connection.StatementResult.ResultType Enum indicating the type of result that was returned by Connection#execute(com.google.cloud.spanner.Statement)
com.google.cloud.spanner.connection.TransactionMode Enum used to define the transaction type of a Connection
com.google.cloud.spanner.connection.TransactionRetryListener.RetryResult The result of a retry.