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. |
The request for BatchCreateSessions . |
| com. |
The request for BatchCreateSessions . |
| com. |
The response for BatchCreateSessions . |
| com. |
The response for BatchCreateSessions . |
| com. |
The request for BatchWrite . |
| com. |
The request for BatchWrite . |
| com. |
A group of mutations to be committed together. Related mutations should be placed in a group. For example, two mutations inserting rows with the same primary key prefix in both parent and child tables are related. |
| com. |
A group of mutations to be committed together. Related mutations should be placed in a group. For example, two mutations inserting rows with the same primary key prefix in both parent and child tables are related. |
| com. |
The result of applying a batch of mutations. |
| com. |
The result of applying a batch of mutations. |
| com. |
The request for BeginTransaction . |
| com. |
The request for BeginTransaction . |
| com. |
A CacheUpdate
expresses a set of changes the client should incorporate into
its location cache. These changes may or may not be newer than what the
client has in its cache, and should be discarded if necessary. CacheUpdate
s |
| com. |
A CacheUpdate
expresses a set of changes the client should incorporate into
its location cache. These changes may or may not be newer than what the
client has in its cache, and should be discarded if necessary. CacheUpdate
s |
| com. |
|
| com. |
Spanner Change Streams enable customers to capture and stream out changes to their Spanner databases in real-time. A change stream can be created with option partition_mode='IMMUTABLE_KEY_RANGE' or |
| com. |
Spanner Change Streams enable customers to capture and stream out changes to their Spanner databases in real-time. A change stream can be created with option partition_mode='IMMUTABLE_KEY_RANGE' or |
| com. |
A data change record contains a set of changes to a table with the same modification type (insert, update, or delete) committed at the same commit timestamp in one change stream partition for the same transaction. Multiple |
| com. |
A data change record contains a set of changes to a table with the same modification type (insert, update, or delete) committed at the same commit timestamp in one change stream partition for the same transaction. Multiple |
| com. |
Metadata for a column. |
| com. |
Metadata for a column. |
| com. |
A mod describes all data changes in a watched table row. |
| com. |
A mod describes all data changes in a watched table row. |
| com. |
Returns the value and associated metadata for a particular field of the Mod . |
| com. |
Returns the value and associated metadata for a particular field of the Mod . |
| com. |
A heartbeat record is returned as a progress indicator, when there are no data changes or any other partition record types in the change stream partition. |
| com. |
A heartbeat record is returned as a progress indicator, when there are no data changes or any other partition record types in the change stream partition. |
| com. |
A partition end record serves as a notification that the client should stop reading the partition. No further records are expected to be retrieved on it. |
| com. |
A partition end record serves as a notification that the client should stop reading the partition. No further records are expected to be retrieved on it. |
| com. |
A partition event record describes key range changes for a change stream partition. The changes to a row defined by its primary key can be captured in one change stream partition for a specific time range, and then be |
| com. |
A partition event record describes key range changes for a change stream partition. The changes to a row defined by its primary key can be captured in one change stream partition for a specific time range, and then be |
| com. |
Describes move-in of the key ranges into the change stream partition identified by partition_token . |
| com. |
Describes move-in of the key ranges into the change stream partition identified by partition_token . |
| com. |
Describes move-out of the key ranges out of the change stream partition identified by partition_token . |
| com. |
Describes move-out of the key ranges out of the change stream partition identified by partition_token . |
| com. |
A partition start record serves as a notification that the client should schedule the partitions to be queried. PartitionStartRecord returns information about one or more partitions. |
| com. |
A partition start record serves as a notification that the client should schedule the partitions to be queried. PartitionStartRecord returns information about one or more partitions. |
| com. |
The request for Commit . |
| com. |
The request for Commit . |
| com. |
The response for Commit . |
| com. |
The response for Commit . |
| com. |
Additional statistics about a commit. |
| com. |
Additional statistics about a commit. |
| com. |
|
| com. |
The request for CreateSession . |
| com. |
The request for CreateSession . |
| com. |
|
| com. |
Builder for projects/{project}/instances/{instance}/databases/{database}. |
| com. |
The request for DeleteSession . |
| com. |
The request for DeleteSession . |
| com. |
The DirectedReadOptions
can be used to indicate which replicas or regions
should be used for non-transactional reads or queries. |
| com. |
The DirectedReadOptions
can be used to indicate which replicas or regions
should be used for non-transactional reads or queries. |
| com. |
An ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests. |
| com. |
An ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests. |
| com. |
An IncludeReplicas
contains a repeated set of ReplicaSelection
which
indicates the order in which replicas should be considered. |
| com. |
An IncludeReplicas
contains a repeated set of ReplicaSelection
which
indicates the order in which replicas should be considered. |
| com. |
The directed read replica selector. Callers must provide one or more of the following fields for replica selection: |
| com. |
The directed read replica selector. Callers must provide one or more of the following fields for replica selection: |
| com. |
The request for ExecuteBatchDml . |
| com. |
The request for ExecuteBatchDml . |
| com. |
A single DML statement. |
| com. |
A single DML statement. |
| com. |
The response for ExecuteBatchDml . Contains a list of ResultSet messages, one for each DML |
| com. |
The response for ExecuteBatchDml . Contains a list of ResultSet messages, one for each DML |
| com. |
The request for ExecuteSql and ExecuteStreamingSql . |
| com. |
The request for ExecuteSql and ExecuteStreamingSql . |
| com. |
Query optimizer configuration. |
| com. |
Query optimizer configuration. |
| com. |
The request for GetSession . |
| com. |
The request for GetSession . |
| com. |
A Group
represents a paxos group in a database. A group is a set of
tablets that are replicated across multiple servers. Groups may have a leader
tablet. Groups store one (or sometimes more) ranges of keys. |
| com. |
A Group
represents a paxos group in a database. A group is a set of
tablets that are replicated across multiple servers. Groups may have a leader
tablet. Groups store one (or sometimes more) ranges of keys. |
| com. |
KeyRange represents a range of rows in a table or index. A range has a start key and an end key. These keys can be open or |
| com. |
KeyRange represents a range of rows in a table or index. A range has a start key and an end key. These keys can be open or |
| com. |
A KeyRecipe
provides the metadata required to translate reads, mutations,
and queries into a byte array in "sortable string format" (ssformat)that can
be used with Range
s to route requests. Note that the client must
tolerate |
| com. |
A KeyRecipe
provides the metadata required to translate reads, mutations,
and queries into a byte array in "sortable string format" (ssformat)that can
be used with Range
s to route requests. Note that the client must
tolerate |
| com. |
An ssformat key is composed of a sequence of tag numbers and key column
values. Part
represents a single tag or key column value. |
| com. |
An ssformat key is composed of a sequence of tag numbers and key column
values. Part
represents a single tag or key column value. |
| com. |
KeySet
defines a collection of Cloud Spanner keys and/or key ranges. All
the keys are expected to be in the same table or index. The keys need
not be sorted in any particular way. |
| com. |
KeySet
defines a collection of Cloud Spanner keys and/or key ranges. All
the keys are expected to be in the same table or index. The keys need
not be sorted in any particular way. |
| com. |
|
| com. |
The request for ListSessions . |
| com. |
The request for ListSessions . |
| com. |
The response for ListSessions . |
| com. |
The response for ListSessions . |
| com. |
|
| com. |
When a read-write transaction is executed on a multiplexed session, this precommit token is sent back to the client as a part of the Transaction message in the |
| com. |
When a read-write transaction is executed on a multiplexed session, this precommit token is sent back to the client as a part of the Transaction message in the |
| com. |
A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call. |
| com. |
Arguments to ack operations. |
| com. |
Arguments to ack operations. |
| com. |
A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call. |
| com. |
Arguments to delete operations. |
| com. |
Arguments to delete operations. |
| com. |
Arguments to send operations. |
| com. |
Arguments to send operations. |
| com. |
Arguments to insert , update , insert_or_update , and |
| com. |
Arguments to insert , update , insert_or_update , and |
| com. |
|
| com. |
Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume. |
| com. |
Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume. |
| com. |
Information returned for each partition returned in a PartitionResponse. |
| com. |
Information returned for each partition returned in a PartitionResponse. |
| com. |
Options for a PartitionQueryRequest
and PartitionReadRequest
. |
| com. |
Options for a PartitionQueryRequest
and PartitionReadRequest
. |
| com. |
The request for PartitionQuery |
| com. |
The request for PartitionQuery |
| com. |
The request for PartitionRead |
| com. |
The request for PartitionRead |
| com. |
The response for PartitionQuery or PartitionRead |
| com. |
The response for PartitionQuery or PartitionRead |
| com. |
Node information for nodes appearing in a QueryPlan.plan_nodes . |
| com. |
Node information for nodes appearing in a QueryPlan.plan_nodes . |
| com. |
Metadata associated with a parent-child relationship appearing in a PlanNode . |
| com. |
Metadata associated with a parent-child relationship appearing in a PlanNode . |
| com. |
Condensed representation of a node and its subtree. Only present for SCALAR
PlanNode(s)
. |
| com. |
Condensed representation of a node and its subtree. Only present for SCALAR
PlanNode(s)
. |
| com. |
Output of query advisor analysis. |
| com. |
Output of query advisor analysis. |
| com. |
Recommendation to add new indexes to run queries more efficiently. |
| com. |
Recommendation to add new indexes to run queries more efficiently. |
| com. |
Contains an ordered list of nodes appearing in the query plan. |
| com. |
Contains an ordered list of nodes appearing in the query plan. |
| com. |
|
| com. |
A Range
represents a range of keys in a database. The keys themselves
are encoded in "sortable string format", also known as ssformat. Consult
Spanner's open source client libraries for details on the encoding. |
| com. |
A Range
represents a range of keys in a database. The keys themselves
are encoded in "sortable string format", also known as ssformat. Consult
Spanner's open source client libraries for details on the encoding. |
| com. |
The request for Read and StreamingRead . |
| com. |
The request for Read and StreamingRead . |
| com. |
A RecipeList
contains a list of KeyRecipe
s, which share the same
schema generation. |
| com. |
A RecipeList
contains a list of KeyRecipe
s, which share the same
schema generation. |
| com. |
Common request options for various APIs. |
| com. |
Common request options for various APIs. |
| com. |
Container for various pieces of client-owned context attached to a request. |
| com. |
Container for various pieces of client-owned context attached to a request. |
| com. |
Results from Read or ExecuteSql . |
| com. |
Results from Read or ExecuteSql . |
| com. |
Metadata about a ResultSet or PartialResultSet . |
| com. |
Metadata about a ResultSet or PartialResultSet . |
| com. |
|
| com. |
Additional statistics about a ResultSet or PartialResultSet . |
| com. |
Additional statistics about a ResultSet or PartialResultSet . |
| com. |
The request for Rollback . |
| com. |
The request for Rollback . |
| com. |
RoutingHint
can be optionally added to location-aware Spanner
requests. It gives the server hints that can be used to route the request to
an appropriate server, potentially significantly decreasing latency and |
| com. |
RoutingHint
can be optionally added to location-aware Spanner
requests. It gives the server hints that can be used to route the request to
an appropriate server, potentially significantly decreasing latency and |
| com. |
A tablet that was skipped by the client. See Tablet.tablet_uid
and Tablet.incarnation
. |
| com. |
A tablet that was skipped by the client. See Tablet.tablet_uid
and Tablet.incarnation
. |
| com. |
A session in the Cloud Spanner API. |
| com. |
A session in the Cloud Spanner API. |
| com. |
|
| com. |
Builder for projects/{project}/instances/{instance}/databases/{database}/sessions/{session}. |
| com. |
Cloud Spanner API The Cloud Spanner API can be used to manage sessions and execute transactions on data stored in Cloud Spanner databases. |
| com. |
Base class for the server implementation of the service Spanner. Cloud Spanner API |
| com. |
|
| com. |
StructType
defines the fields of a STRUCT
type. |
| com. |
StructType
defines the fields of a STRUCT
type. |
| com. |
Message representing a single field of a struct. |
| com. |
Message representing a single field of a struct. |
| com. |
A Tablet
represents a single replica of a Group
. A tablet is served by a
single server at a time, and can move between servers due to server death or
simply load balancing. |
| com. |
A Tablet
represents a single replica of a Group
. A tablet is served by a
single server at a time, and can move between servers due to server death or
simply load balancing. |
| com. |
A transaction. |
| com. |
A transaction. |
| com. |
Options to use for transactions. |
| com. |
Options to use for transactions. |
| com. |
Message type to initiate a Partitioned DML transaction. |
| com. |
Message type to initiate a Partitioned DML transaction. |
| com. |
Message type to initiate a read-only transaction. |
| com. |
Message type to initiate a read-only transaction. |
| com. |
Message type to initiate a read-write transaction. Currently this transaction type has no options. |
| com. |
Message type to initiate a read-write transaction. Currently this transaction type has no options. |
| com. |
|
| com. |
This message is used to select the transaction in which a Read or ExecuteSql call runs. |
| com. |
This message is used to select the transaction in which a Read or ExecuteSql call runs. |
| com. |
Type
indicates the type of a Cloud Spanner value, as might be stored in a
table cell or returned from an SQL query. |
| com. |
Type
indicates the type of a Cloud Spanner value, as might be stored in a
table cell or returned from an SQL query. |
| com. |
