spanner.v1 library Null safety

Cloud Spanner API - v1

Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.

For more information, see cloud.google.com/spanner/

Create an instance of SpannerApi to access these resources:

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.
CommitStats
Additional statistics about a commit.
ContextValue
A message representing context for a KeyRangeInfo, including a label, value, unit, and severity.
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.
DerivedMetric
A message representing a derived metric.
DiagnosticMessage
A message representing the key visualizer diagnostic messages.
EncryptionConfig
Encryption configuration for a Cloud Spanner database.
EncryptionInfo
Encryption information for a Cloud Spanner database or backup.
ExecuteBatchDmlRequest
The request for ExecuteBatchDml.
ExecuteBatchDmlResponse
The response for ExecuteBatchDml. [...]
ExecuteSqlRequest
The request for ExecuteSql and ExecuteStreamingSql.
Field
Message representing a single field of a struct.
GetDatabaseDdlResponse
The response for GetDatabaseDdl.
GetIamPolicyRequest
Request message for GetIamPolicy method.
IndexedHotKey
A message representing a (sparse) collection of hot keys for specific key buckets.
IndexedKeyRangeInfos
A message representing a (sparse) collection of KeyRangeInfos for specific key buckets.
Instance
An isolated set of Cloud Spanner resources on which databases can be hosted.
InstanceConfig
A possible configuration for a Cloud Spanner instance. [...]
KeyRange
KeyRange represents a range of rows in a table or index. [...]
KeyRangeInfo
A message representing information for a key range (possibly one key).
KeyRangeInfos
A message representing a list of specific information for multiple key ranges.
KeySet
KeySet defines a collection of Cloud Spanner keys and/or key ranges. [...]
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.
ListScansResponse
Response method from the ListScans method.
ListSessionsResponse
The response for ListSessions.
LocalizedString
A message representing a user-facing string whose value may need to be translated before being displayed.
Metric
A message representing the actual monitoring data, values for each key bucket over time, of a metric.
MetricMatrix
A message representing a matrix of floats.
MetricMatrixRow
A message representing a row of a matrix of floats.
Mutation
A modification to one or more Cloud Spanner rows. [...]
Operation
This resource represents a long-running operation that is the result of a network API call.
OptimizeRestoredDatabaseMetadata
Metadata type for the long-running operation used to track the progress of optimizations performed on a newly restored database. [...]
PartialResultSet
Partial results from a streaming read or SQL query. [...]
Partition
Information returned for each partition returned in a PartitionResponse.
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. [...]
PrefixNode
A message representing a key prefix node in the key prefix hierarchy. [...]
ProjectsInstanceConfigsResource
ProjectsInstancesBackupOperationsResource
ProjectsInstancesBackupsOperationsResource
ProjectsInstancesBackupsResource
ProjectsInstancesDatabaseOperationsResource
ProjectsInstancesDatabasesOperationsResource
ProjectsInstancesDatabasesResource
ProjectsInstancesDatabasesSessionsResource
ProjectsInstancesOperationsResource
ProjectsInstancesResource
ProjectsResource
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.
ReplicaInfo
RequestOptions
Common request options for various APIs.
RestoreDatabaseEncryptionConfig
Encryption configuration for the restored database.
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.
Scan
Scan is a structure which describes Cloud Key Visualizer scan information.
ScanData
ScanData contains Cloud Key Visualizer scan data used by the caller to construct a visualization.
ScansResource
Session
A session in the Cloud Spanner API.
SetIamPolicyRequest
Request message for SetIamPolicy method.
ShortRepresentation
Condensed representation of a node and its subtree. [...]
SpannerApi
Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.
Statement
A single DML statement.
StructType
StructType defines the fields of a STRUCT type.
TestIamPermissionsRequest
Request message for TestIamPermissions method.
Transaction
A transaction.
TransactionOptions
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). [...]
TransactionSelector
This message is used to select the transaction in which a Read or ExecuteSql call runs. [...]
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. [...]
UpdateInstanceMetadata
Metadata type for the operation returned by UpdateInstance.
UpdateInstanceRequest
The request for UpdateInstance.
VisualizationData
Write
Arguments to insert, update, insert_or_update, and replace operations.

Typedefs

Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. [...]
Expr = $Expr
Represents a textual expression in the Common Expression Language (CEL) syntax. [...]
GetPolicyOptions = $GetPolicyOptions
Encapsulates settings provided to GetIamPolicy.
OperationProgress = $OperationProgress
Encapsulates progress related information for a Cloud Spanner long running operation.
PartitionedDml = $Empty
Message type to initiate a Partitioned DML transaction.
ReadWrite = $Empty
Message type to initiate a read-write transaction. [...]
Status = $Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. [...]
TestIamPermissionsResponse = $PermissionsResponse
Response message for TestIamPermissions method.

Exceptions / Errors

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