| ▼NGoogle | |
| ▼NApis | |
| ▼NSpanner | |
| ▼Nv1 | |
| ▼NData | |
| CBackup | A backup of a Cloud Spanner database. |
| CBackupInfo | Information about a backup. |
| CBatchCreateSessionsRequest | The request for BatchCreateSessions. |
| CBatchCreateSessionsResponse | The response for BatchCreateSessions. |
| CBeginTransactionRequest | The request for BeginTransaction. |
| CBinding | Associates members with a role. |
| CChildLink | Metadata associated with a parent-child relationship appearing in a PlanNode. |
| CCommitRequest | The request for Commit. |
| CCommitResponse | The response for Commit. |
| CCreateBackupMetadata | Metadata type for the operation returned by CreateBackup. |
| CCreateDatabaseMetadata | Metadata type for the operation returned by CreateDatabase. |
| CCreateDatabaseRequest | The request for CreateDatabase. |
| CCreateInstanceMetadata | Metadata type for the operation returned by CreateInstance. |
| CCreateInstanceRequest | The request for CreateInstance. |
| CCreateSessionRequest | The request for CreateSession. |
| CDatabase | A Cloud Spanner database. |
| CDelete | Arguments to delete operations. |
| CEmpty | 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: |
| CExecuteBatchDmlRequest | The request for ExecuteBatchDml. |
| CExecuteBatchDmlResponse | 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 |
| CExecuteSqlRequest | The request for ExecuteSql and ExecuteStreamingSql. |
| CExpr | 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 |
| CField | Message representing a single field of a struct. |
| CGetDatabaseDdlResponse | The response for GetDatabaseDdl. |
| CGetIamPolicyRequest | Request message for GetIamPolicy method. |
| CGetPolicyOptions | Encapsulates settings provided to GetIamPolicy. |
| CInstance | An isolated set of Cloud Spanner resources on which databases can be hosted. |
| CInstanceConfig | A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. |
| CKeyRange | KeyRange represents a range of rows in a table or index |
| CKeySet | 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 |
| CListBackupOperationsResponse | The response for ListBackupOperations. |
| CListBackupsResponse | The response for ListBackups. |
| CListDatabaseOperationsResponse | The response for ListDatabaseOperations. |
| CListDatabasesResponse | The response for ListDatabases. |
| CListInstanceConfigsResponse | The response for ListInstanceConfigs. |
| CListInstancesResponse | The response for ListInstances. |
| CListOperationsResponse | The response message for Operations.ListOperations. |
| CListSessionsResponse | The response for ListSessions. |
| CMutation | 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. |
| COperation | This resource represents a long-running operation that is the result of a network API call. |
| COperationProgress | Encapsulates progress related information for a Cloud Spanner long running operation. |
| COptimizeRestoredDatabaseMetadata | 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. |
| CPartialResultSet | 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. |
| CPartition | Information returned for each partition returned in a PartitionResponse. |
| CPartitionedDml | Message type to initiate a Partitioned DML transaction. |
| CPartitionOptions | Options for a PartitionQueryRequest and PartitionReadRequest. |
| CPartitionQueryRequest | The request for PartitionQuery |
| CPartitionReadRequest | The request for PartitionRead |
| CPartitionResponse | The response for PartitionQuery or PartitionRead |
| CPlanNode | Node information for nodes appearing in a QueryPlan.plan_nodes. |
| CPolicy | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources |
| CQueryOptions | Query optimizer configuration. |
| CQueryPlan | Contains an ordered list of nodes appearing in the query plan. |
| CReadOnly | Message type to initiate a read-only transaction. |
| CReadRequest | The request for Read and StreamingRead. |
| CReadWrite | Message type to initiate a read-write transaction. Currently this transaction type has no options. |
| CReplicaInfo | |
| CRestoreDatabaseMetadata | Metadata type for the long-running operation returned by RestoreDatabase. |
| CRestoreDatabaseRequest | The request for RestoreDatabase. |
| CRestoreInfo | Information about the database restore. |
| CResultSet | Results from Read or ExecuteSql. |
| CResultSetMetadata | Metadata about a ResultSet or PartialResultSet. |
| CResultSetStats | Additional statistics about a ResultSet or PartialResultSet. |
| CRollbackRequest | The request for Rollback. |
| CSession | A session in the Cloud Spanner API. |
| CSetIamPolicyRequest | Request message for SetIamPolicy method. |
| CShortRepresentation | Condensed representation of a node and its subtree. Only present for SCALAR PlanNode(s). |
| CStatement | A single DML statement. |
| CStatus | 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 |
| CStructType | StructType defines the fields of a STRUCT type. |
| CTestIamPermissionsRequest | Request message for TestIamPermissions method. |
| CTestIamPermissionsResponse | Response message for TestIamPermissions method. |
| CTransaction | A transaction. |
| CTransactionOptions | # Transactions |
| CTransactionSelector | This message is used to select the transaction in which a Read or ExecuteSql call runs |
| CType | Type indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. |
| CUpdateDatabaseDdlMetadata | Metadata type for the operation returned by UpdateDatabaseDdl. |
| CUpdateDatabaseDdlRequest | 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 |
| CUpdateInstanceMetadata | Metadata type for the operation returned by UpdateInstance. |
| CUpdateInstanceRequest | The request for UpdateInstance. |
| CWrite | Arguments to insert, update, insert_or_update, and replace operations. |
| ▼CProjectsResource | The "projects" collection of methods. |
| ►CInstanceConfigsResource | The "instanceConfigs" collection of methods. |
| CGetRequest | Gets information about a particular instance configuration. |
| CListRequest | Lists the supported instance configurations for a given project. |
| ►CInstancesResource | The "instances" collection of methods. |
| ►CBackupOperationsResource | The "backupOperations" collection of methods. |
| CListRequest | Lists the backup long-running operations in the given instance. A backup operation has a name of the form projects//instances//backups//operations/. The long-running operation metadata field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by operation.metadata.value.progress.start_time in descending order starting from the most recently started operation. |
| ►CBackupsResource | The "backups" collection of methods. |
| CCreateRequest | Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format projects//instances//backups//operations/ and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently. |
| CDeleteRequest | Deletes a pending or completed Backup. |
| CGetIamPolicyRequest | Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set |
| CGetRequest | Gets metadata on a pending or completed Backup. |
| CListRequest | Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time. |
| ►COperationsResource | The "operations" collection of methods. |
| CCancelRequest | Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED. |
| CDeleteRequest | Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. |
| CGetRequest | Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. |
| CListRequest | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED |
| CPatchRequest | Updates a pending or completed Backup. |
| CSetIamPolicyRequest | Sets the access control policy on a database or backup resource. Replaces any existing policy |
| CTestIamPermissionsRequest | Returns permissions that the caller has on the specified database or backup resource |
| CCreateRequest | Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, CreateInstance returns ALREADY_EXISTS |
| ►CDatabaseOperationsResource | The "databaseOperations" collection of methods. |
| CListRequest | Lists database longrunning-operations. A database operation has a name of the form projects//instances//databases//operations/. The long-running operation metadata field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. |
| ►CDatabasesResource | The "databases" collection of methods. |
| CCreateRequest | Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format /operations/ and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. |
| CDropDatabaseRequest | Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their expire_time. |
| CGetDdlRequest | Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations API. |
| CGetIamPolicyRequest | Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set |
| CGetRequest | Gets the state of a Cloud Spanner database. |
| CListRequest | Lists Cloud Spanner databases. |
| ►COperationsResource | The "operations" collection of methods. |
| CCancelRequest | Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED. |
| CDeleteRequest | Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. |
| CGetRequest | Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. |
| CListRequest | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED |
| CRestoreRequest | Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database long-running operation has a name of the format projects//instances//databases//operations/, and can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreDatabaseMetadata. The response type is Database, if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete. |
| ►CSessionsResource | The "sessions" collection of methods. |
| CBatchCreateRequest | Creates multiple new sessions |
| CBeginTransactionRequest | Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect. |
| CCommitRequest | Commits a transaction. The request includes the mutations to be applied to rows in the database |
| CCreateRequest | 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 |
| CDeleteRequest | Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session. |
| CExecuteBatchDmlRequest | Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql |
| CExecuteSqlRequest | Executes an SQL statement, returning all results in a single reply. This method cannot 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 |
| CExecuteStreamingSqlRequest | 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. |
| CGetRequest | Gets a session. Returns NOT_FOUND if the session does not exist. This is mainly useful for determining whether a session is still alive. |
| CListRequest | Lists all sessions in a given database. |
| CPartitionQueryRequest | 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 |
| CPartitionReadRequest | 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 |
| CReadRequest | Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot 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 |
| CRollbackRequest | Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit |
| CStreamingReadRequest | 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. |
| CSetIamPolicyRequest | Sets the access control policy on a database or backup resource. Replaces any existing policy |
| CTestIamPermissionsRequest | Returns permissions that the caller has on the specified database or backup resource |
| CUpdateDdlRequest | Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format /operations/ and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response. |
| CDeleteRequest | Deletes an instance |
| CGetIamPolicyRequest | Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set |
| CGetRequest | Gets information about a particular instance. |
| CListRequest | Lists all instances in the given project. |
| ►COperationsResource | The "operations" collection of methods. |
| CCancelRequest | Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED. |
| CDeleteRequest | Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. |
| CGetRequest | Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. |
| CListRequest | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED |
| CPatchRequest | Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns NOT_FOUND |
| CSetIamPolicyRequest | Sets the access control policy on an instance resource. Replaces any existing policy |
| CTestIamPermissionsRequest | Returns permissions that the caller has on the specified instance resource |
| CSpannerBaseServiceRequest | A base abstract class for Spanner requests. |
| CSpannerService | The Spanner Service. |
