Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://cloud.google.com/spanner/reference/rpc/google.spanner.v1 below:

Package google.spanner.v1 | Spanner | Google Cloud

• Spanner (interface)
• BatchCreateSessionsRequest (message)
• BatchCreateSessionsResponse (message)
• BatchWriteRequest (message)
• BatchWriteRequest.MutationGroup (message)
• BatchWriteResponse (message)
• BeginTransactionRequest (message)
• CommitRequest (message)
• CommitResponse (message)
• CommitResponse.CommitStats (message)
• CreateSessionRequest (message)
• DeleteSessionRequest (message)
• DirectedReadOptions (message)
• DirectedReadOptions.ExcludeReplicas (message)
• DirectedReadOptions.IncludeReplicas (message)
• DirectedReadOptions.ReplicaSelection (message)
• DirectedReadOptions.ReplicaSelection.Type (enum)
• ExecuteBatchDmlRequest (message)
• ExecuteBatchDmlRequest.Statement (message)
• ExecuteBatchDmlResponse (message)
• ExecuteSqlRequest (message)
• ExecuteSqlRequest.QueryMode (enum)
• ExecuteSqlRequest.QueryOptions (message)
• GetSessionRequest (message)
• KeyRange (message)
• KeySet (message)
• ListSessionsRequest (message)
• ListSessionsResponse (message)
• MultiplexedSessionPrecommitToken (message)
• Mutation (message)
• Mutation.Delete (message)
• Mutation.Write (message)
• PartialResultSet (message)
• Partition (message)
• PartitionOptions (message)
• PartitionQueryRequest (message)
• PartitionReadRequest (message)
• PartitionResponse (message)
• PlanNode (message)
• PlanNode.ChildLink (message)
• PlanNode.Kind (enum)
• PlanNode.ShortRepresentation (message)
• QueryAdvisorResult (message)
• QueryAdvisorResult.IndexAdvice (message)
• QueryPlan (message)
• ReadRequest (message)
• RequestOptions (message)
• RequestOptions.Priority (enum)
• ResultSet (message)
• ResultSetMetadata (message)
• ResultSetStats (message)
• RollbackRequest (message)
• Session (message)
• StructType (message)
• StructType.Field (message)
• Transaction (message)
• TransactionOptions (message)
• TransactionOptions.PartitionedDml (message)
• TransactionOptions.ReadOnly (message)
• TransactionOptions.ReadWrite (message)
• TransactionSelector (message)
• Type (message)
• TypeAnnotationCode (enum)
• TypeCode (enum)

Cloud Spanner API

The Cloud Spanner API can be used to manage sessions and execute transactions on data stored in Cloud Spanner databases.

rpc BatchCreateSessions(BatchCreateSessionsRequest) returns (BatchCreateSessionsResponse)

Creates multiple new sessions.

This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc BatchWrite(BatchWriteRequest) returns (BatchWriteResponse)

Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, that is, some groups might have been committed successfully, while some might have failed. The results of individual batches are streamed into the response as the batches are applied.

BatchWrite requests are not replay protected, meaning that each mutation group can be applied more than once. Replays of non-idempotent mutations can have undesirable effects. For example, replays of an insert mutation can produce an already exists error or if you use generated or commit timestamp-based keys, it can result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc BeginTransaction(BeginTransactionRequest) returns (Transaction)

Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc Commit(CommitRequest) returns (CommitResponse)

Commits a transaction. The request includes the mutations to be applied to rows in the database.

Commit might return an ABORTED error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If Commit returns ABORTED, the caller should retry the transaction from the beginning, reusing the same session.

On very rare occasions, Commit might return UNKNOWN. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc CreateSession(CreateSessionRequest) returns (Session)

Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions.

Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit.

Active sessions use additional server resources, so it's a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions when no operations are sent for more than an hour. If a session is deleted, requests to it return NOT_FOUND.

Idle sessions can be kept alive by sending a trivial SQL query periodically, for example, "SELECT 1".

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc DeleteSession(DeleteSessionRequest) returns (Empty)

Ends a session, releasing server resources associated with it. This asynchronously triggers the cancellation of any operations that are running with this session.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc ExecuteBatchDml(ExecuteBatchDmlRequest) returns (ExecuteBatchDmlResponse)

Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql.

Statements are executed in sequential order. A request can succeed even if a statement fails. The ExecuteBatchDmlResponse.status field in the response provides information about the statement that failed. Clients must inspect this field to determine whether an error occurred.

Execution stops after the first failed statement; the remaining statements are not executed.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc ExecuteSql(ExecuteSqlRequest) returns (ResultSet)

Executes an SQL statement, returning all results in a single reply. This method can't be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a FAILED_PRECONDITION error.

Operations inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details.

Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.

The query string can be SQL or Graph Query Language (GQL).

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc ExecuteStreamingSql(ExecuteSqlRequest) returns (PartialResultSet)

Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

The query string can be SQL or Graph Query Language (GQL).

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc GetSession(GetSessionRequest) returns (Session)

Gets a session. Returns NOT_FOUND if the session doesn't exist. This is mainly useful for determining whether a session is still alive.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse)

Lists all sessions in a given database.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc PartitionQuery(PartitionQueryRequest) returns (PartitionResponse)

Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens.

Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it isn't possible to resume the query, and the whole operation must be restarted from the beginning.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc PartitionRead(PartitionReadRequest) returns (PartitionResponse)

Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token.

Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it isn't possible to resume the read, and the whole operation must be restarted from the beginning.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc Read(ReadRequest) returns (ResultSet)

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method can't be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a FAILED_PRECONDITION error.

Reads inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details.

Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc Rollback(RollbackRequest) returns (Empty)

Rolls back a transaction, releasing any locks it holds. It's a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit.

Rollback returns OK if it successfully aborts the transaction, the transaction was already aborted, or the transaction isn't found. Rollback never returns ABORTED.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

rpc StreamingRead(ReadRequest) returns (PartialResultSet)

Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/spanner.data
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

The request for BatchCreateSessions.

string

Required. The database in which the new sessions are created.

Authorization requires the following IAM permission on the specified resource database:

• spanner.sessions.create

Session

Parameters to apply to each created session.

int32

Required. The number of sessions to be created in this batch call. The API can return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting session_count as necessary).

The response for BatchCreateSessions.

Session

The freshly created sessions.

The request for BatchWrite.

string

Required. The session in which the batch request is to be run.

Authorization requires the following IAM permission on the specified resource session:

• spanner.databases.write

RequestOptions

Common options for this request.

MutationGroup

Required. The groups of mutations to be applied.

bool

Optional. If you don't set the exclude_txn_from_change_streams option or if it's set to false, then any change streams monitoring columns modified by transactions will capture the updates made within that transaction.

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.

Mutation

Required. The mutations in this group.

The result of applying a batch of mutations.

int32

The mutation groups applied in this batch. The values index into the mutation_groups field in the corresponding BatchWriteRequest.

Status

An OK status indicates success. Any other status indicates a failure.

Timestamp

The commit timestamp of the transaction that applied this batch. Present if status is OK, absent otherwise.

The request for BeginTransaction.

string

Required. The session in which the transaction runs.

Authorization requires one or more of the following IAM permissions on the specified resource session:

• spanner.databases.beginReadOnlyTransaction
• spanner.databases.beginOrRollbackReadWriteTransaction

TransactionOptions

Required. Options for the new transaction.

RequestOptions

Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct doesn't do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

Mutation

Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

The request for Commit.

string

Required. The session in which the transaction to be committed is running.

Authorization requires the following IAM permission on the specified resource session:

• spanner.databases.write

Mutation

The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

bool

If true, then statistics related to the transaction is included in the CommitResponse. Default value is false.

Duration

Optional. The amount of latency this request is configured to incur in order to improve throughput. If this field isn't set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a commit delay value between 0 and 500 ms.

RequestOptions

Common options for this request.

MultiplexedSessionPrecommitToken

Optional. If the read-write transaction was executed on a multiplexed session, then you must include the precommit token with the highest sequence number received in this transaction attempt. Failing to do so results in a FailedPrecondition error.

bytes

Commit a previously-started transaction.

TransactionOptions

Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it's possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

The response for Commit.

Timestamp

The Cloud Spanner timestamp at which the transaction committed.

CommitStats

The statistics about this Commit. Not returned by default. For more information, see CommitRequest.return_commit_stats.

MultiplexedSessionPrecommitToken

If specified, transaction has not committed yet. You must retry the commit with the new precommit token.

Additional statistics about a commit.

int64

The total number of mutations for the transaction. Knowing the mutation_count value can help you maximize the number of mutations in a transaction and minimize the number of API round trips. You can also monitor this value to prevent transactions from exceeding the system limit. If the number of mutations exceeds the limit, the server returns INVALID_ARGUMENT.

The request for CreateSession.

string

Required. The database in which the new session is created.

Authorization requires the following IAM permission on the specified resource database:

• spanner.sessions.create

Session

Required. The session to create.

The request for DeleteSession.

string

Required. The name of the session to delete.

Authorization requires the following IAM permission on the specified resource name:

• spanner.sessions.delete

The DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries.

DirectedReadOptions can only be specified for a read-only transaction, otherwise the API returns an INVALID_ARGUMENT error.

IncludeReplicas

Include_replicas indicates the order of replicas (as they appear in this list) to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner waits for a replica in the list to become available, requests might fail due to DEADLINE_EXCEEDED errors.

ExcludeReplicas

Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner doesn't route requests to the replicas in this list.

An ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests.

ReplicaSelection

The directed read replica selector.

An IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered.

ReplicaSelection

The directed read replica selector.

bool

If true, Spanner doesn't route requests to a replica outside the <include_replicas list when all of the specified replicas are unavailable or unhealthy. Default value is false.

The directed read replica selector. Callers must provide one or more of the following fields for replica selection:

• location - The location must be one of the regions within the multi-region configuration of your database.
• type - The type of the replica.

Some examples of using replica_selectors are:

• location:us-east1 --> The "us-east1" replica(s) of any available type is used to process the request.
• type:READ_ONLY --> The "READ_ONLY" type replica(s) in the nearest available location are used to process the request.
• location:us-east1 type:READ_ONLY --> The "READ_ONLY" type replica(s) in location "us-east1" is used to process the request.

string

The location or region of the serving requests, for example, "us-east1".

Type

The type of replica.

Indicates the type of replica.

The request for ExecuteBatchDml.

string

Required. The session in which the DML statements should be performed.

Authorization requires the following IAM permission on the specified resource session:

• spanner.databases.write

TransactionSelector

Required. The transaction to use. Must be a read-write transaction.

To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.

Statement

Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement i are visible to statement i+1. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed.

Callers must provide at least one statement.

int64

Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds.

The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction might be aborted. Replays of previously handled requests yield the same response as the first execution.

RequestOptions

Common options for this request.

bool

Optional. If set to true, this request marks the end of the transaction. After these statements execute, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected.

Setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of statements shouldn't be assumed until a subsequent Commit call completes successfully.

A single DML statement.

string

Required. The DML string.

Struct

Parameter names and values that bind to placeholders in the DML string.

A parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName). Parameter names can contain letters, numbers, and underscores.

Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example:

"WHERE id > @msg_id AND id < @msg_id + 100"

It's an error to execute a SQL statement with unbound parameters.

map<string, Type>

It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type BYTES and values of type STRING both appear in params as JSON strings.

In these cases, param_types can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.

The response for ExecuteBatchDml. Contains a list of ResultSet messages, one for each DML statement that has successfully executed, in the same order as the statements in the request. If a statement fails, the status in the response body identifies the cause of the failure.

To check for DML statements that failed, use the following approach:

1. Check the status in the response message. The google.rpc.Code enum value OK indicates that all statements were executed successfully.
2. If the status was not OK, check the number of result sets in the response. If the response contains N ResultSet messages, then statement N+1 in the request failed.

Example 1:

• Request: 5 DML statements, all executed successfully.
• Response: 5 ResultSet messages, with the status OK.

Example 2:

• Request: 5 DML statements. The third statement has a syntax error.
• Response: 2 ResultSet messages, and a syntax error (INVALID_ARGUMENT) status. The number of ResultSet messages indicates that the third statement failed, and the fourth and fifth statements were not executed.

ResultSet

One ResultSet for each statement in the request that ran successfully, in the same order as the statements in the request. Each ResultSet does not contain any rows. The ResultSetStats in each ResultSet contain the number of rows modified by the statement.

Only the first ResultSet in the response contains valid ResultSetMetadata.

Status

If all DML statements are executed successfully, the status is OK. Otherwise, the error status of the first failed statement.

MultiplexedSessionPrecommitToken

Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction.

The request for ExecuteSql and ExecuteStreamingSql.

string

Required. The session in which the SQL query should be performed.

Authorization requires the following IAM permission on the specified resource session:

• spanner.databases.select

TransactionSelector

The transaction to use.

For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency.

Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.

Partitioned DML requires an existing Partitioned DML transaction ID.

string

Required. The SQL string.

Struct

Parameter names and values that bind to placeholders in the SQL string.

A parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers.

Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example:

"WHERE id > @msg_id AND id < @msg_id + 100"

It's an error to execute a SQL statement with unbound parameters.

map<string, Type>

It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type BYTES and values of type STRING both appear in params as JSON strings.

In these cases, you can use param_types to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.

bytes

If this request is resuming a previously interrupted SQL statement execution, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token.

QueryMode

Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL.

bytes

If present, results are restricted to the specified partition previously created using PartitionQuery. There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token.

int64

A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds.

The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction can be aborted. Replays of previously handled requests yield the same response as the first execution.

Required for DML statements. Ignored for queries.

QueryOptions

Query optimizer configuration to use for the given query.

RequestOptions

Common options for this request.

DirectedReadOptions

Directed read options for this request.

bool

If this is for a partitioned query and this field is set to true, the request is executed with Spanner Data Boost independent compute resources.

If the field is set to true but the request doesn't set partition_token, the API returns an INVALID_ARGUMENT error.

bool

Optional. If set to true, this statement marks the end of the transaction. After this statement executes, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected.

For DML statements, setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of a DML statement shouldn't be assumed until a subsequent Commit call completes successfully.

Mode in which the statement must be processed.

Query optimizer configuration.

string

An option to control the selection of optimizer version.

This parameter allows individual queries to pick different query optimizer versions.

Specifying latest as a value instructs Cloud Spanner to use the latest supported query optimizer version. If not specified, Cloud Spanner uses the optimizer version set at the database level options. Any other positive integer (from the list of supported optimizer versions) overrides the default optimizer version for query execution.

The list of supported optimizer versions can be queried from SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS.

Executing a SQL statement with an invalid optimizer version fails with an INVALID_ARGUMENT error.

See https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more information on managing the query optimizer.

The optimizer_version statement hint has precedence over this setting.

string

An option to control the selection of optimizer statistics package.

This parameter allows individual queries to use a different query optimizer statistics package.

Specifying latest as a value instructs Cloud Spanner to use the latest generated statistics package. If not specified, Cloud Spanner uses the statistics package set at the database level options, or the latest package if the database option isn't set.

The statistics package requested by the query has to be exempt from garbage collection. This can be achieved with the following DDL statement:

ALTER STATISTICS <package_name> SET OPTIONS (allow_gc=false)

The list of available statistics packages can be queried from INFORMATION_SCHEMA.SPANNER_STATISTICS.

Executing a SQL statement with an invalid optimizer statistics package or with a statistics package that allows garbage collection fails with an INVALID_ARGUMENT error.

The request for GetSession.

string

Required. The name of the session to retrieve.

Authorization requires the following IAM permission on the specified resource name:

• spanner.sessions.get

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 closed, indicating if the range includes rows with that key.

Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described here.

For example, consider the following table definition:

CREATE TABLE UserEvents (
  UserName STRING(MAX),
  EventDate STRING(10)
) PRIMARY KEY(UserName, EventDate);

The following keys name rows in this table:

["Bob", "2014-09-23"]
["Alfred", "2015-06-12"]

Since the UserEvents table's PRIMARY KEY clause names two columns, each UserEvents key has two elements; the first is the UserName, and the second is the EventDate.

Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user "Bob" that occurred in the year 2015:

"start_closed": ["Bob", "2015-01-01"]
"end_closed": ["Bob", "2015-12-31"]

Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included.

For example, the following range includes all events for "Bob" that occurred during and after the year 2000:

"start_closed": ["Bob", "2000-01-01"]
"end_closed": ["Bob"]

The next example retrieves all events for "Bob":

"start_closed": ["Bob"]
"end_closed": ["Bob"]

To retrieve events before the year 2000:

"start_closed": ["Bob"]
"end_open": ["Bob", "2000-01-01"]

The following range includes all rows in the table:

"start_closed": []
"end_closed": []

This range returns all users whose UserName begins with any character from A to C:

"start_closed": ["A"]
"end_open": ["D"]

This range returns all users whose UserName begins with B:

"start_closed": ["B"]
"end_open": ["C"]

Key ranges honor column sort order. For example, suppose a table is defined as follows:

CREATE TABLE DescendingSortedTable {
  Key INT64,
  ...
) PRIMARY KEY(Key DESC);

The following range retrieves all rows with key values between 1 and 100 inclusive:

"start_closed": ["100"]
"end_closed": ["1"]

Note that 100 is passed as the start, and 1 is passed as the end, because Key is a descending column in the schema.

ListValue

If the start is closed, then the range includes all rows whose first len(start_closed) key columns exactly match start_closed.

ListValue

If the start is open, then the range excludes rows whose first len(start_open) key columns exactly match start_open.

ListValue

If the end is closed, then the range includes all rows whose first len(end_closed) key columns exactly match end_closed.

ListValue

If the end is open, then the range excludes rows whose first len(end_open) key columns exactly match end_open.

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.

If the same key is specified multiple times in the set (for example if two ranges, two keys, or a key and a range overlap), Cloud Spanner behaves as if the key were only specified once.

ListValue

A list of specific keys. Entries in keys should have exactly as many elements as there are columns in the primary or index key with which this KeySet is used. Individual key values are encoded as described here.

KeyRange

A list of key ranges. See KeyRange for more information about key range specifications.

bool

For convenience all can be set to true to indicate that this KeySet matches all keys in the table or index. Note that any keys specified in keys or ranges are only yielded once.

The request for ListSessions.

string

Required. The database in which to list sessions.

Authorization requires the following IAM permission on the specified resource database:

• spanner.sessions.list

int32

Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

string

If non-empty, page_token should contain a next_page_token from a previous ListSessionsResponse.

string

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

• labels.key where key is the name of a label

Some examples of using filters are:

• labels.env:* --> The session has the label "env".
• labels.env:dev --> The session has the label "env" and the value of the label contains the string "dev".

The response for ListSessions.

Session

The list of requested sessions.

string

next_page_token can be sent in a subsequent ListSessions call to fetch more of the matching sessions.

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 BeginTransaction response and also as a part of the ResultSet and PartialResultSet responses.

bytes

Opaque precommit token.

int32

An incrementing seq number is generated on every precommit token that is returned. Clients should remember the precommit token with the highest sequence number from the current transaction attempt.

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.

Write

Insert new rows in a table. If any of the rows already exist, the write or transaction fails with error ALREADY_EXISTS.

Write

Update existing rows in a table. If any of the rows does not already exist, the transaction fails with error NOT_FOUND.

Write

Like insert, except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved.

When using insert_or_update, just as when using insert, all NOT NULL columns in the table must be given a value. This holds true even when the row already exists and will therefore actually be updated.

Write

Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become NULL.

In an interleaved table, if you create the child table with the ON DELETE CASCADE annotation, then replacing a parent row also deletes the child rows. Otherwise, you must delete the child rows before you replace the parent row.

Delete

Delete rows from a table. Succeeds whether or not the named rows were present.

Arguments to delete operations.

string

Required. The table whose rows will be deleted.

KeySet

Required. The primary keys of the rows within table to delete. The primary keys must be specified in the order in which they appear in the PRIMARY KEY() clause of the table's equivalent DDL statement (the DDL statement used to create the table). Delete is idempotent. The transaction will succeed even if some or all rows do not exist.

Arguments to insert, update, insert_or_update, and replace operations.

string

Required. The table whose rows will be written.

string

The names of the columns in table to be written.

The list of columns must contain enough columns to allow Cloud Spanner to derive values for all primary key columns in the row(s) to be modified.

ListValue

The values to be written. values can contain more than one list of values. If it does, then multiple rows are written, one for each entry in values. Each list in values must have exactly as many entries as there are entries in columns above. Sending multiple lists is equivalent to sending multiple Mutations, each containing one values entry and repeating table and columns. Individual values in each list are encoded as described here.

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.

ResultSetMetadata

Metadata about the result set, such as row type information. Only present in the first response.

Value

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It's possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: can't be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.
• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

Some examples of merging:

Strings are concatenated.
"foo", "bar" => "foobar"

Lists of non-strings are concatenated.
[2, 3], [4] => [2, 3, 4]

Lists are concatenated, but the last and first elements are merged
because they are strings.
["a", "b"], ["c", "d"] => ["a", "bc", "d"]

Lists are concatenated, but the last and first elements are merged
because they are lists. Recursively, the last and first elements
of the inner lists are merged because they are strings.
["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

Non-overlapping object fields are combined.
{"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

Overlapping object fields are merged.
{"a": "1"}, {"a": "2"} => {"a": "12"}

Examples of merging objects containing lists of strings.
{"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

{
  "metadata": { ... }
  "values": ["Hello", "W"]
  "chunked_value": true
  "resume_token": "Af65..."
}
{
  "values": ["orl"]
  "chunked_value": true
}
{
  "values": ["d"]
  "resume_token": "Zx1B..."
}

This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

Not all PartialResultSets contain a resume_token. Execution can only be resumed from a previously yielded resume_token. For the above sequence of PartialResultSets, resuming the query with "resume_token": "Af65..." yields results from the PartialResultSet with value "orl".

bool

If true, then the final value in values is chunked, and must be combined with more values from subsequent PartialResultSets to obtain a complete field value.

bytes

Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including resume_token. Note that executing any other transaction in the same session invalidates the token.

ResultSetStats

Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field is also present in the last response for DML statements.

MultiplexedSessionPrecommitToken

Optional. A precommit token is included if the read-write transaction has multiplexed sessions enabled. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction.

bool

Optional. Indicates whether this is the last PartialResultSet in the stream. The server might optionally set this field. Clients shouldn't rely on this field being set in all cases.

Information returned for each partition returned in a PartitionResponse.

bytes

This token can be passed to Read, StreamingRead, ExecuteSql, or ExecuteStreamingSql requests to restrict the results to those identified by this partition token.

Options for a PartitionQueryRequest and PartitionReadRequest.

int64

Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.

The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition can be smaller or larger than this size request.

int64

Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.

The desired maximum number of partitions to return. For example, this might be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned can be smaller or larger than this maximum count request.

The request for PartitionQuery

string

Required. The session used to create the partitions.

Authorization requires the following IAM permission on the specified resource session:

• spanner.databases.partitionQuery

TransactionSelector

Read-only snapshot transactions are supported, read and write and single-use transactions are not.

string

Required. The query request to generate partitions for. The request fails if the query isn't root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see Read data in parallel.

The query request must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.

Struct

Parameter names and values that bind to placeholders in the SQL string.

A parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName). Parameter names can contain letters, numbers, and underscores.

Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example:

"WHERE id > @msg_id AND id < @msg_id + 100"

It's an error to execute a SQL statement with unbound parameters.

map<string, Type>

It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type BYTES and values of type STRING both appear in params as JSON strings.

In these cases, param_types can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types.

PartitionOptions

Additional options that affect how many partitions are created.

The request for PartitionRead

string

Required. The session used to create the partitions.

Authorization requires the following IAM permission on the specified resource session:

• spanner.databases.partitionRead

TransactionSelector

Read only snapshot transactions are supported, read/write and single use transactions are not.

string

Required. The name of the table in the database to be read.

string

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

string

The columns of table to be returned for each row matching this request.

KeySet

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

It isn't an error for the key_set to name rows that don't exist in the database. Read yields nothing for nonexistent rows.

PartitionOptions

Additional options that affect how many partitions are created.

The response for PartitionQuery or PartitionRead

Partition

Partitions created by this request.

Transaction

Transaction created by this request.

Node information for nodes appearing in a QueryPlan.plan_nodes.

int32

The PlanNode's index in node list.

Kind

Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a SCALAR node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.

string

The display name for the node.

ChildLink

List of child node indexes and their relationship to this parent.

ShortRepresentation

Condensed representation for SCALAR nodes.

Struct

Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata:

{
  "parameter_reference": "param1",
  "parameter_type": "array"
}

Struct

The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.

Metadata associated with a parent-child relationship appearing in a PlanNode.

int32

The node to which the link points.

string

The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable, to represent the tag associated with the output variable.

string

Only present if the child node is SCALAR and corresponds to an output variable of the parent node. The field carries the name of the output variable. For example, a TableScan operator that reads rows from a table will have child links to the SCALAR nodes representing the output variables created for each column that is read by the operator. The corresponding variable fields will be set to the variable names assigned to the columns.

The kind of PlanNode. Distinguishes between the two different kinds of nodes that can appear in a query plan.

Condensed representation of a node and its subtree. Only present for SCALAR PlanNode(s).

string

A string representation of the expression subtree rooted at this node.

map<string, int32>

A mapping of (subquery variable name) -> (subquery node id) for cases where the description string of this node references a SCALAR subquery contained in the expression subtree rooted at this node. The referenced SCALAR subquery may not necessarily be a direct child of this node.

Output of query advisor analysis.

IndexAdvice

Optional. Index Recommendation for a query. This is an optional field and the recommendation will only be available when the recommendation guarantees significant improvement in query performance.

Recommendation to add new indexes to run queries more efficiently.

string

Optional. DDL statements to add new indexes that will improve the query.

double

Optional. Estimated latency improvement factor. For example if the query currently takes 500 ms to run and the estimated latency with new indexes is 100 ms this field will be 5.

Contains an ordered list of nodes appearing in the query plan.

PlanNode

The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root. Each PlanNode's id corresponds to its index in plan_nodes.

QueryAdvisorResult

Optional. The advise/recommendations for a query. Currently this field will be serving index recommendations for a query.

The request for Read and StreamingRead.

string

Required. The session in which the read should be performed.

Authorization requires the following IAM permission on the specified resource session:

• spanner.databases.read

TransactionSelector

The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.

string

Required. The name of the table in the database to be read.

string

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

string

Required. The columns of table to be returned for each row matching this request.

KeySet

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field isn't empty, rows are yielded in an unspecified order.

It isn't an error for the key_set to name rows that don't exist in the database. Read yields nothing for nonexistent rows.

int64

If greater than zero, only the first limit rows are yielded. If limit is zero, the default is no limit. A limit can't be specified if partition_token is set.

bytes

If this request is resuming a previously interrupted read, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token.

bytes

If present, results are restricted to the specified partition previously created using PartitionRead. There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.

RequestOptions

Common options for this request.

DirectedReadOptions

Directed read options for this request.

bool

If this is for a partitioned read and this field is set to true, the request is executed with Spanner Data Boost independent compute resources.

If the field is set to true but the request doesn't set partition_token, the API returns an INVALID_ARGUMENT error.

Common request options for various APIs.

Priority

Priority for the request.

string

A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, CommitRequest). Legal characters for request_tag values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.

string

A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, transaction_tag is ignored. Legal characters for transaction_tag values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.

The relative priority for requests. Note that priority isn't applicable for BeginTransaction.

The priority acts as a hint to the Cloud Spanner scheduler and doesn't guarantee priority or order of execution. For example:

• Some parts of a write operation always execute at PRIORITY_HIGH, regardless of the specified priority. This can cause you to see an increase in high priority workload even when executing a low priority request. This can also potentially cause a priority inversion where a lower priority request is fulfilled ahead of a higher priority request.
• If a transaction contains multiple operations with different priorities, Cloud Spanner doesn't guarantee to process the higher priority operations first. There might be other constraints to satisfy, such as the order of operations.

Results from Read or ExecuteSql.

Metadata about a ResultSet or PartialResultSet.

Additional statistics about a ResultSet or PartialResultSet.

QueryPlan

QueryPlan for the query associated with this result.

Struct

Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows:

{
  "rows_returned": "3",
  "elapsed_time": "1.22 secs",
  "cpu_time": "1.19 secs"
}

int64

Standard DML returns an exact count of rows that were modified.

int64

Partitioned DML doesn't offer exactly-once semantics, so it returns a lower bound of the rows modified.

The request for Rollback.

string

Required. The session in which the transaction to roll back is running.

Authorization requires the following IAM permission on the specified resource session:

• spanner.databases.beginOrRollbackReadWriteTransaction

bytes

Required. The transaction to roll back.

A session in the Cloud Spanner API.

string

Output only. The name of the session. This is always system-assigned.

map<string, string>

The labels for the session.

• Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?.
• Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?.
• No more than 64 labels can be associated with a given session.

See https://goo.gl/xmQnxf for more information on and examples of labels.

Timestamp

Output only. The timestamp when the session is created.

Timestamp

Output only. The approximate timestamp when the session is last used. It's typically earlier than the actual last use time.

string

The database role which created this session.

bool

Optional. If true, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent read-only operations. Don't use them for read-write transactions, partitioned reads, or partitioned queries. Use sessions.create to create multiplexed sessions. Don't use BatchCreateSessions to create a multiplexed session. You can't delete or list multiplexed sessions.

StructType defines the fields of a STRUCT type.

Field

The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the SELECT clause of a query.

Message representing a single field of a struct.

string

The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., "Word" in the query "SELECT 'hello' AS Word"), or the column name (e.g., "ColName" in the query "SELECT ColName FROM Table"). Some columns might have an empty name (e.g., "SELECT UPPER(ColName)"). Note that a query result can contain multiple fields with the same name.

Type

The type of the field.

A transaction.

bytes

id may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls.

Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests.

Timestamp

For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see TransactionOptions.ReadOnly.return_read_timestamp.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

MultiplexedSessionPrecommitToken

A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the BeginTransaction. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction.

Options to use for transactions.

bool

When exclude_txn_from_change_streams is set to true, it prevents read or write transactions from being tracked in change streams.

• If the DDL option allow_txn_exclusion is set to true, then the updates made within this transaction aren't recorded in the change stream.

• If you don't set the DDL option allow_txn_exclusion or if it's set to false, then the updates made within this transaction are recorded in the change stream.

When exclude_txn_from_change_streams is set to false or not set, modifications from this transaction are recorded in all change streams that are tracking columns modified by these transactions.

The exclude_txn_from_change_streams option can only be specified for read-write or partitioned DML transactions, otherwise the API returns an INVALID_ARGUMENT error.

ReadWrite

Transaction may write.

Authorization to begin a read-write transaction requires spanner.databases.beginOrRollbackReadWriteTransaction permission on the session resource.

PartitionedDml

Partitioned DML transaction.

Authorization to begin a Partitioned DML transaction requires spanner.databases.beginPartitionedDmlTransaction permission on the session resource.

ReadOnly

Transaction does not write.

Authorization to begin a read-only transaction requires spanner.databases.beginReadOnlyTransaction permission on the session resource.

This type has no fields.

Message type to initiate a Partitioned DML transaction.

Message type to initiate a read-only transaction.

bool

If true, the Cloud Spanner-selected read timestamp is included in the Transaction message that describes the transaction.

bool

Read at a timestamp where all previously committed transactions are visible.

Timestamp

Executes all reads at a timestamp >= min_read_timestamp.

This is useful for requesting fresher data than some previous read, or data that is fresh enough to observe the effects of some previously committed transaction whose timestamp is known.

Note that this option can only be used in single-use transactions.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Duration

Read data at a timestamp >= NOW - max_staleness seconds. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps.

Useful for reading the freshest data available at a nearby replica, while bounding the possible staleness if the local replica has fallen behind.

Note that this option can only be used in single-use transactions.

Timestamp

Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read is blocked until the specified timestamp, modulo the read's deadline.

Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Duration

Executes all reads at a timestamp that is exact_staleness old. The timestamp is chosen soon after the read is started.

Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps.

Useful for reading at nearby replicas without the distributed timestamp negotiation overhead of max_staleness.

Message type to initiate a read-write transaction. Currently this transaction type has no options.

bytes

Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session.

This message is used to select the transaction in which a Read or ExecuteSql call runs.

See TransactionOptions for more information about transactions.

TransactionOptions

Execute the read or SQL query in a temporary transaction. This is the most efficient way to execute a transaction that consists of a single SQL query.

bytes

Execute the read or SQL query in a previously-started transaction.

TransactionOptions

Begin a new transaction and execute this read or SQL query in it. The transaction ID of the new transaction is returned in ResultSetMetadata.transaction, which is a Transaction.

Type indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.

TypeCode

Required. The TypeCode for this type.

Type

If code == ARRAY, then array_element_type is the type of the array elements.

StructType

If code == STRUCT, then struct_type provides type information for the struct's fields.

TypeAnnotationCode

The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.

string

If code == PROTO or code == ENUM, then proto_type_fqn is the fully qualified name of the proto type representing the proto/enum definition.

TypeAnnotationCode is used as a part of Type to disambiguate SQL types that should be used for a given Cloud Spanner value. Disambiguation is needed because the same Cloud Spanner type can be mapped to different SQL types depending on SQL dialect. TypeAnnotationCode doesn't affect the way value is serialized.

TypeCode is used as part of Type to indicate the type of a Cloud Spanner value.

Each legal value of a type can be encoded to or decoded from a JSON value, using the encodings described below. All Cloud Spanner values can be null, regardless of type; nulls are always encoded as a JSON null.

Encoded as string in RFC 3339 timestamp format. The time zone must be present, and must be "Z".

If the schema has the column option allow_commit_timestamp=true, the placeholder string "spanner.commit_timestamp()" can be used to instruct the system to insert the commit timestamp associated with the transaction commit.

Encoded as string, in decimal format or scientific notation format. Decimal format: [+-]Digits[.[Digits]] or [+-][Digits].Digits

Scientific notation: [+-]Digits[.[Digits]][ExponentIndicator[+-]Digits] or [+-][Digits].Digits[ExponentIndicator[+-]Digits] (ExponentIndicator is "e" or "E")

Encoded as a JSON-formatted string as described in RFC 7159. The following rules are applied when parsing JSON input:

• Whitespace characters are not preserved.
• If a JSON object has duplicate keys, only the first key is preserved.
• Members of a JSON object are not guaranteed to have their order preserved.
• JSON array elements will have their order preserved.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4