Cloud Spanner API

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

Service: spanner.googleapis.com

All URIs below are relative to https://spanner.googleapis.com

This service provides the following discovery document:

REST Resource: v1.projects.instanceConfigs

Methods
get GET /v1/{name=projects/*/instanceConfigs/*}
Gets information about a particular instance configuration.
list GET /v1/{parent=projects/*}/instanceConfigs
Lists the supported instance configurations for a given project.

REST Resource: v1.projects.instances

Methods
create POST /v1/{parent=projects/*}/instances
Creates an instance and begins preparing it to begin serving.
delete DELETE /v1/{name=projects/*/instances/*}
Deletes an instance.
get GET /v1/{name=projects/*/instances/*}
Gets information about a particular instance.
getIamPolicy POST /v1/{resource=projects/*/instances/*}:getIamPolicy
Gets the access control policy for an instance resource.
list GET /v1/{parent=projects/*}/instances
Lists all instances in the given project.
patch PATCH /v1/{instance.name=projects/*/instances/*}
Updates an instance, and begins allocating or releasing resources as requested.
setIamPolicy POST /v1/{resource=projects/*/instances/*}:setIamPolicy
Sets the access control policy on an instance resource.
testIamPermissions POST /v1/{resource=projects/*/instances/*}:testIamPermissions
Returns permissions that the caller has on the specified instance resource.

REST Resource: v1.projects.instances.databases

Methods
create POST /v1/{parent=projects/*/instances/*}/databases
Creates a new Cloud Spanner database and starts to prepare it for serving.
dropDatabase DELETE /v1/{database=projects/*/instances/*/databases/*}
Drops (aka deletes) a Cloud Spanner database.
get GET /v1/{name=projects/*/instances/*/databases/*}
Gets the state of a Cloud Spanner database.
getDdl GET /v1/{database=projects/*/instances/*/databases/*}/ddl
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.
getIamPolicy POST /v1/{resource=projects/*/instances/*/databases/*}:getIamPolicy
Gets the access control policy for a database resource.
list GET /v1/{parent=projects/*/instances/*}/databases
Lists Cloud Spanner databases.
setIamPolicy POST /v1/{resource=projects/*/instances/*/databases/*}:setIamPolicy
Sets the access control policy on a database resource.
testIamPermissions POST /v1/{resource=projects/*/instances/*/databases/*}:testIamPermissions
Returns permissions that the caller has on the specified database resource.
updateDdl PATCH /v1/{database=projects/*/instances/*/databases/*}/ddl
Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.

REST Resource: v1.projects.instances.databases.operations

Methods
cancel POST /v1/{name=projects/*/instances/*/databases/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=projects/*/instances/*/databases/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/instances/*/databases/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/instances/*/databases/*/operations}
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.instances.databases.sessions

Methods
beginTransaction POST /v1/{session=projects/*/instances/*/databases/*/sessions/*}:beginTransaction
Begins a new transaction.
commit POST /v1/{session=projects/*/instances/*/databases/*/sessions/*}:commit
Commits a transaction.
create POST /v1/{database=projects/*/instances/*/databases/*}/sessions
Creates a new session.
delete DELETE /v1/{name=projects/*/instances/*/databases/*/sessions/*}
Ends a session, releasing server resources associated with it.
executeSql POST /v1/{session=projects/*/instances/*/databases/*/sessions/*}:executeSql
Executes an SQL statement, returning all results in a single reply.
executeStreamingSql POST /v1/{session=projects/*/instances/*/databases/*/sessions/*}:executeStreamingSql
Like ExecuteSql, except returns the result set as a stream.
get GET /v1/{name=projects/*/instances/*/databases/*/sessions/*}
Gets a session.
list GET /v1/{database=projects/*/instances/*/databases/*}/sessions
Lists all sessions in a given database.
partitionQuery POST /v1/{session=projects/*/instances/*/databases/*/sessions/*}:partitionQuery
Creates a set of partition tokens that can be used to execute a query operation in parallel.
partitionRead POST /v1/{session=projects/*/instances/*/databases/*/sessions/*}:partitionRead
Creates a set of partition tokens that can be used to execute a read operation in parallel.
read POST /v1/{session=projects/*/instances/*/databases/*/sessions/*}:read
Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql.
rollback POST /v1/{session=projects/*/instances/*/databases/*/sessions/*}:rollback
Rolls back a transaction, releasing any locks it holds.
streamingRead POST /v1/{session=projects/*/instances/*/databases/*/sessions/*}:streamingRead
Like Read, except returns the result set as a stream.

REST Resource: v1.projects.instances.operations

Methods
cancel POST /v1/{name=projects/*/instances/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=projects/*/instances/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/instances/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/instances/*/operations}
Lists operations that match the specified filter in the request.
Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Spanner Documentation