googleapis.spanner.v1 library

Classes

Backup
A backup of a Cloud Spanner database.
BackupInfo
Information about a backup.
BatchCreateSessionsRequest
The request for BatchCreateSessions.
BatchCreateSessionsResponse
The response for BatchCreateSessions.
BeginTransactionRequest
The request for BeginTransaction.
Binding
Associates members with a role.
Metadata associated with a parent-child relationship appearing in a PlanNode.
CommitRequest
The request for Commit.
CommitResponse
The response for Commit.
CreateBackupMetadata
Metadata type for the operation returned by CreateBackup.
CreateDatabaseMetadata
Metadata type for the operation returned by CreateDatabase.
CreateDatabaseRequest
The request for CreateDatabase.
CreateInstanceMetadata
Metadata type for the operation returned by CreateInstance.
CreateInstanceRequest
The request for CreateInstance.
CreateSessionRequest
The request for CreateSession.
Database
A Cloud Spanner database.
Delete
Arguments to delete operations.
Empty
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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
ExecuteBatchDmlRequest
The request for ExecuteBatchDml.
ExecuteBatchDmlResponse
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.
ExecuteSqlRequest
The request for ExecuteSql and ExecuteStreamingSql.
Expr
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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Field
Message representing a single field of a struct.
GetDatabaseDdlResponse
The response for GetDatabaseDdl.
GetIamPolicyRequest
Request message for GetIamPolicy method.
GetPolicyOptions
Encapsulates settings provided to GetIamPolicy.
Instance
An isolated set of Cloud Spanner resources on which databases can be hosted.
InstanceConfig
A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
KeyRange
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" 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.
KeySet
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.
ListBackupOperationsResponse
The response for ListBackupOperations.
ListBackupsResponse
The response for ListBackups.
ListDatabaseOperationsResponse
The response for ListDatabaseOperations.
ListDatabasesResponse
The response for ListDatabases.
ListInstanceConfigsResponse
The response for ListInstanceConfigs.
ListInstancesResponse
The response for ListInstances.
ListOperationsResponse
The response message for Operations.ListOperations.
ListSessionsResponse
The response for ListSessions.
Mutation
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.
Operation
This resource represents a long-running operation that is the result of a network API call.
OperationProgress
Encapsulates progress related information for a Cloud Spanner long running operation.
OptimizeRestoredDatabaseMetadata
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.
PartialResultSet
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.
Partition
Information returned for each partition returned in a PartitionResponse.
PartitionedDml
Message type to initiate a Partitioned DML transaction.
PartitionOptions
Options for a PartitionQueryRequest and PartitionReadRequest.
PartitionQueryRequest
The request for PartitionQuery
PartitionReadRequest
The request for PartitionRead
PartitionResponse
The response for PartitionQuery or PartitionRead
PlanNode
Node information for nodes appearing in a QueryPlan.plan_nodes.
Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" }, { "role": "roles/resourcemanager.organizationViewer", "members": "user:eve@example.com" , "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation.
ProjectsInstanceConfigsResourceApi
ProjectsInstancesBackupOperationsResourceApi
ProjectsInstancesBackupsOperationsResourceApi
ProjectsInstancesBackupsResourceApi
ProjectsInstancesDatabaseOperationsResourceApi
ProjectsInstancesDatabasesOperationsResourceApi
ProjectsInstancesDatabasesResourceApi
ProjectsInstancesDatabasesSessionsResourceApi
ProjectsInstancesOperationsResourceApi
ProjectsInstancesResourceApi
ProjectsResourceApi
QueryOptions
Query optimizer configuration.
QueryPlan
Contains an ordered list of nodes appearing in the query plan.
ReadOnly
Message type to initiate a read-only transaction.
ReadRequest
The request for Read and StreamingRead.
ReadWrite
Message type to initiate a read-write transaction. Currently this transaction type has no options.
ReplicaInfo
RestoreDatabaseMetadata
Metadata type for the long-running operation returned by RestoreDatabase.
RestoreDatabaseRequest
The request for RestoreDatabase.
RestoreInfo
Information about the database restore.
ResultSet
Results from Read or ExecuteSql.
ResultSetMetadata
Metadata about a ResultSet or PartialResultSet.
ResultSetStats
Additional statistics about a ResultSet or PartialResultSet.
RollbackRequest
The request for Rollback.
Session
A session in the Cloud Spanner API.
SetIamPolicyRequest
Request message for SetIamPolicy method.
ShortRepresentation
Condensed representation of a node and its subtree. Only present for SCALAR PlanNode(s).
SpannerApi
Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.
Statement
A single DML statement.
Status
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. You can find out more about this error model and how to work with it in the API Design Guide.
StructType
StructType defines the fields of a STRUCT type.
TestIamPermissionsRequest
Request message for TestIamPermissions method.
TestIamPermissionsResponse
Response message for TestIamPermissions method.
Transaction
A transaction.
TransactionOptions
Transactions Each session can have at most one active transaction at a [...]
TransactionSelector
This message is used to select the transaction in which a Read or ExecuteSql call runs. See TransactionOptions for more information about transactions.
Type
Type indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.
UpdateDatabaseDdlMetadata
Metadata type for the operation returned by UpdateDatabaseDdl.
UpdateDatabaseDdlRequest
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. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details.
UpdateInstanceMetadata
Metadata type for the operation returned by UpdateInstance.
UpdateInstanceRequest
The request for UpdateInstance.
Write
Arguments to insert, update, insert_or_update, and replace operations.

Constants

USER_AGENT → const String
'dart-api-client spanner/v1'

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.