google_api_spanner v0.22.0 API Reference

Modules

API client metadata for GoogleApi.Spanner.V1.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.Spanner.V1.

A backup of a Cloud Spanner database.

Information about a backup.

The request for BatchCreateSessions.

The response for BatchCreateSessions.

The request for BeginTransaction.

Associates members with a role.

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

Metadata type for the operation returned by CreateBackup.

Metadata type for the operation returned by CreateDatabase.

The request for CreateDatabase.

Metadata type for the operation returned by CreateInstance.

The request for CreateInstance.

The request for CreateSession.

A Cloud Spanner database.

Arguments to delete operations.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance

The request for ExecuteBatchDml.

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.

The request for ExecuteSql and ExecuteStreamingSql.

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.

Message representing a single field of a struct.

The response for GetDatabaseDdl.

Request message for GetIamPolicy method.

Encapsulates settings provided to GetIamPolicy.

An isolated set of Cloud Spanner resources on which databases can be hosted.

A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.

KeyRange represents a range of rows in a table or index.

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.

The response for ListBackupOperations.

The response for ListBackups.

The response for ListDatabaseOperations.

The response for ListDatabases.

The response for ListInstanceConfigs.

The response for ListInstances.

The response message for Operations.ListOperations.

The response for ListSessions.

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.

This resource represents a long-running operation that is the result of a network API call.

Encapsulates progress related information for a Cloud Spanner long running operation.

Metadata type for the long-running operation used to track the progress of optimizations performed on a newly restored database. This long-running operation is automatically created by the system after the successful completion of a database restore, and cannot be cancelled.

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.

Information returned for each partition returned in a PartitionResponse.

Options for a PartitionQueryRequest and PartitionReadRequest.

The request for PartitionQuery

The request for PartitionRead

The response for PartitionQuery or PartitionRead

Message type to initiate a Partitioned DML transaction.

Node information for nodes appearing in a QueryPlan.plan_nodes.

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Query optimizer configuration.

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

Message type to initiate a read-only transaction.

The request for Read and StreamingRead.

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

Attributes

  • defaultLeaderLocation (type: boolean(), default: nil) - If true, this location is designated as the default leader location where leader replicas are placed. See the region types documentation for more details.
  • location (type: String.t, default: nil) - The location of the serving resources, e.g. "us-central1".
  • type (type: String.t, default: nil) - The type of replica.

Metadata type for the long-running operation returned by RestoreDatabase.

The request for RestoreDatabase.

Information about the database restore.

Results from Read or ExecuteSql.

Metadata about a ResultSet or PartialResultSet.

Additional statistics about a ResultSet or PartialResultSet.

The request for Rollback.

A session in the Cloud Spanner API.

Request message for SetIamPolicy method.

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

A single DML statement.

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

StructType defines the fields of a STRUCT type.

Request message for TestIamPermissions method.

Response message for TestIamPermissions method.

Transactions

Each session can have at most one active transaction at a time (note that standalone reads and queries use a transaction internally and do count towards the one transaction limit). After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction.

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

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

Metadata type for the operation returned by UpdateDatabaseDdl.

Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a NULL value in a column to which NOT NULL would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled.

Metadata type for the operation returned by UpdateInstance.

The request for UpdateInstance.

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