Cloud Spanner API: projects. Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service. See: https://cloud.google.com/spanner/api/reference/rest/v1/projects
Cloud Spanner API: projects. Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service. See: https://cloud.google.com/spanner/api/reference/rest/v1/projects
(instanceConfigs-get$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instanceConfigs/get
Required parameters: name
Optional parameters: none Gets information about a particular instance configuration.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instanceConfigs/get Required parameters: name Optional parameters: none Gets information about a particular instance configuration.
(instanceConfigs-list$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instanceConfigs/list
Required parameters: parent
Optional parameters: pageToken, pageSize Lists the supported instance configurations for a given project.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instanceConfigs/list Required parameters: parent Optional parameters: pageToken, pageSize Lists the supported instance configurations for a given project.
(instances-backups-getIamPolicy$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/getIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set.
Authorization requires spanner.databases.getIamPolicy
permission on
resource.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource.
(instances-backups-operations-cancel$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/operations/cancel
Required parameters: name
Optional parameters: none
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
.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/operations/cancel Required parameters: name Optional parameters: none 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`.
(instances-backups-operations-delete$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/operations/delete
Required parameters: name
Optional parameters: none
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
.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/operations/delete Required parameters: name Optional parameters: none 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`.
(instances-backups-operations-get$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/operations/get
Required parameters: name
Optional parameters: none 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.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/operations/get Required parameters: name Optional parameters: none 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.
(instances-backups-operations-list$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/operations/list
Required parameters: name
Optional parameters: pageToken, pageSize, filter
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding
to use different resource name schemes, such as users/*/operations
. To
override the binding, API services can add a binding such as
"/v1/{name=users/*}/operations"
to their service configuration.
For backwards compatibility, the default name includes the operations
collection id, however overriding users must ensure the name binding
is the parent resource, without the operations collection id.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/operations/list Required parameters: name Optional parameters: pageToken, pageSize, filter Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
(instances-backups-setIamPolicy$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:policy {:bindings [Binding], :etag string, :version integer}}
Sets the access control policy on a database resource. Replaces any existing policy.
Authorization requires spanner.databases.setIamPolicy
permission on resource.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:bindings [Binding], :etag string, :version integer}} Sets the access control policy on a database resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource.
(instances-backups-testIamPermissions$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/testIamPermissions
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns permissions that the caller has on the specified database resource.
Attempting this RPC on a non-existent Cloud Spanner database will
result in a NOT_FOUND error if the user has
spanner.databases.list
permission on the containing Cloud
Spanner instance. Otherwise returns an empty set of permissions.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/backups/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns permissions that the caller has on the specified database resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions.
(instances-create$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/create
Required parameters: parent
Optional parameters: none
Body:
{:instanceId string, :instance {:displayName string, :endpointUris [string], :nodeCount integer, :labels {}, :config string, :state string, :name string}}
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
.
Immediately upon completion of this request:
CREATING
.Until completion of the returned operation:
Upon completion of the returned operation:
READY
.The returned long-running operation will
have a name of the format <instance_name>/operations/<operation_id>
and
can be used to track creation of the instance. The
metadata field type is
CreateInstanceMetadata.
The response field type is
Instance, if successful.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/create Required parameters: parent Optional parameters: none Body: {:instanceId string, :instance {:displayName string, :endpointUris [string], :nodeCount integer, :labels {}, :config string, :state string, :name string}} 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`. Immediately upon completion of this request: * The instance is readable via the API, with all requested attributes but no allocated resources. Its state is `CREATING`. Until completion of the returned operation: * Cancelling the operation renders the instance immediately unreadable via the API. * The instance can be deleted. * All other attempts to modify the instance are rejected. Upon completion of the returned operation: * Billing for all successfully-allocated resources begins (some types may have lower than the requested levels). * Databases can be created in the instance. * The instance's allocated resource levels are readable via the API. * The instance's state becomes `READY`. The returned long-running operation will have a name of the format `<instance_name>/operations/<operation_id>` and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful.
(instances-databases-create$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/create
Required parameters: parent
Optional parameters: none
Body:
{:createStatement string, :extraStatements [string]}
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 <database_name>/operations/<operation_id>
and
can be used to track preparation of the database. The
metadata field type is
CreateDatabaseMetadata. The
response field type is
Database, if successful.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/create Required parameters: parent Optional parameters: none Body: {:createStatement string, :extraStatements [string]} 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 `<database_name>/operations/<operation_id>` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.
(instances-databases-dropDatabase$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/dropDatabase
Required parameters: database
Optional parameters: none Drops (aka deletes) a Cloud Spanner database.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/dropDatabase Required parameters: database Optional parameters: none Drops (aka deletes) a Cloud Spanner database.
(instances-databases-get$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/get
Required parameters: name
Optional parameters: none Gets the state of a Cloud Spanner database.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/get Required parameters: name Optional parameters: none Gets the state of a Cloud Spanner database.
(instances-databases-getDdl$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/getDdl
Required parameters: database
Optional parameters: none 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.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/getDdl Required parameters: database Optional parameters: none 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.
(instances-databases-getIamPolicy$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/getIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set.
Authorization requires spanner.databases.getIamPolicy
permission on
resource.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource.
(instances-databases-list$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/list
Required parameters: parent
Optional parameters: pageToken, pageSize Lists Cloud Spanner databases.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/list Required parameters: parent Optional parameters: pageToken, pageSize Lists Cloud Spanner databases.
(instances-databases-operations-cancel$ auth args)
Required parameters: name
Optional parameters: none
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
.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/operations/cancel Required parameters: name Optional parameters: none 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`.
(instances-databases-operations-delete$ auth args)
Required parameters: name
Optional parameters: none
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
.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/operations/delete Required parameters: name Optional parameters: none 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`.
(instances-databases-operations-get$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/operations/get
Required parameters: name
Optional parameters: none 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.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/operations/get Required parameters: name Optional parameters: none 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.
(instances-databases-operations-list$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/operations/list
Required parameters: name
Optional parameters: pageToken, pageSize, filter
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding
to use different resource name schemes, such as users/*/operations
. To
override the binding, API services can add a binding such as
"/v1/{name=users/*}/operations"
to their service configuration.
For backwards compatibility, the default name includes the operations
collection id, however overriding users must ensure the name binding
is the parent resource, without the operations collection id.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/operations/list Required parameters: name Optional parameters: pageToken, pageSize, filter Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
(instances-databases-sessions-batchCreate$ auth args body)
Required parameters: database
Optional parameters: none
Body:
{:sessionCount integer, :sessionTemplate {:name string, :approximateLastUseTime string, :labels {}, :createTime string}}
Creates multiple new sessions.
This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/batchCreate Required parameters: database Optional parameters: none Body: {:sessionCount integer, :sessionTemplate {:name string, :approximateLastUseTime string, :labels {}, :createTime string}} Creates multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.
(instances-databases-sessions-beginTransaction$ auth args body)
Required parameters: session
Optional parameters: none
Body:
{:options {:partitionedDml PartitionedDml, :readWrite ReadWrite, :readOnly ReadOnly}}
Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/beginTransaction Required parameters: session Optional parameters: none Body: {:options {:partitionedDml PartitionedDml, :readWrite ReadWrite, :readOnly ReadOnly}} Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.
(instances-databases-sessions-commit$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/commit
Required parameters: session
Optional parameters: none
Body:
{:singleUseTransaction {:partitionedDml PartitionedDml, :readWrite ReadWrite, :readOnly ReadOnly}, :mutations [{:delete Delete, :insert Write, :insertOrUpdate Write, :update Write, :replace Write}], :transactionId string}
Commits a transaction. The request includes the mutations to be applied to rows in the database.
Commit
might return an ABORTED
error. This can occur at any time;
commonly, the cause is conflicts with concurrent
transactions. However, it can also happen for a variety of other
reasons. If Commit
returns ABORTED
, the caller should re-attempt
the transaction from the beginning, re-using the same session.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/commit Required parameters: session Optional parameters: none Body: {:singleUseTransaction {:partitionedDml PartitionedDml, :readWrite ReadWrite, :readOnly ReadOnly}, :mutations [{:delete Delete, :insert Write, :insertOrUpdate Write, :update Write, :replace Write}], :transactionId string} Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session.
(instances-databases-sessions-create$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/create
Required parameters: database
Optional parameters: none
Body:
{:session {:name string, :approximateLastUseTime string, :labels {}, :createTime string}}
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.
Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit.
Active sessions use additional server resources, so it is a good idea to
delete idle and unneeded sessions.
Aside from explicit deletes, Cloud Spanner may delete sessions for which no
operations are sent for more than an hour. If a session is deleted,
requests to it return NOT_FOUND
.
Idle sessions can be kept alive by sending a trivial SQL query
periodically, e.g., "SELECT 1"
.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/create Required parameters: database Optional parameters: none Body: {:session {:name string, :approximateLastUseTime string, :labels {}, :createTime string}} 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. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`.
(instances-databases-sessions-delete$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/delete
Required parameters: name
Optional parameters: none Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/delete Required parameters: name Optional parameters: none Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.
(instances-databases-sessions-executeBatchDml$ auth args body)
Required parameters: session
Optional parameters: none
Body:
{:seqno string, :statements [{:sql string, :params {}, :paramTypes {}}], :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}}
Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql.
Statements are executed in sequential order. A request can succeed even if a statement fails. The ExecuteBatchDmlResponse.status field in the response provides information about the statement that failed. Clients must inspect this field to determine whether an error occurred.
Execution stops after the first failed statement; the remaining statements are not executed.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/executeBatchDml Required parameters: session Optional parameters: none Body: {:seqno string, :statements [{:sql string, :params {}, :paramTypes {}}], :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}} Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql. Statements are executed in sequential order. A request can succeed even if a statement fails. The ExecuteBatchDmlResponse.status field in the response provides information about the statement that failed. Clients must inspect this field to determine whether an error occurred. Execution stops after the first failed statement; the remaining statements are not executed.
(instances-databases-sessions-executeSql$ auth args body)
Required parameters: session
Optional parameters: none
Body:
{:queryMode string, :params {}, :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}, :partitionToken string, :seqno string, :paramTypes {}, :sql string, :resumeToken string, :queryOptions {:optimizerVersion string}}
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.
Operations inside read-write transactions might return ABORTED
. If
this occurs, the application should restart the transaction from
the beginning. See Transaction for more details.
Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/executeSql Required parameters: session Optional parameters: none Body: {:queryMode string, :params {}, :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}, :partitionToken string, :seqno string, :paramTypes {}, :sql string, :resumeToken string, :queryOptions {:optimizerVersion string}} 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. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.
(instances-databases-sessions-executeStreamingSql$ auth args body)
Required parameters: session
Optional parameters: none
Body:
{:queryMode string, :params {}, :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}, :partitionToken string, :seqno string, :paramTypes {}, :sql string, :resumeToken string, :queryOptions {:optimizerVersion string}}
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.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/executeStreamingSql Required parameters: session Optional parameters: none Body: {:queryMode string, :params {}, :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}, :partitionToken string, :seqno string, :paramTypes {}, :sql string, :resumeToken string, :queryOptions {:optimizerVersion string}} 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.
(instances-databases-sessions-get$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/get
Required parameters: name
Optional parameters: none
Gets a session. Returns NOT_FOUND
if the session does not exist.
This is mainly useful for determining whether a session is still
alive.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/get Required parameters: name Optional parameters: none Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive.
(instances-databases-sessions-list$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/list
Required parameters: database
Optional parameters: filter, pageToken, pageSize Lists all sessions in a given database.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/list Required parameters: database Optional parameters: filter, pageToken, pageSize Lists all sessions in a given database.
(instances-databases-sessions-partitionQuery$ auth args body)
Required parameters: session
Optional parameters: none
Body:
{:sql string, :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}, :partitionOptions {:maxPartitions string, :partitionSizeBytes string}, :params {}, :paramTypes {}}
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.
Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/partitionQuery Required parameters: session Optional parameters: none Body: {:sql string, :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}, :partitionOptions {:maxPartitions string, :partitionSizeBytes string}, :params {}, :paramTypes {}} 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. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.
(instances-databases-sessions-partitionRead$ auth args body)
Required parameters: session
Optional parameters: none
Body:
{:keySet {:ranges [KeyRange], :keys [[any]], :all boolean}, :columns [string], :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}, :table string, :partitionOptions {:maxPartitions string, :partitionSizeBytes string}, :index string}
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.
Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/partitionRead Required parameters: session Optional parameters: none Body: {:keySet {:ranges [KeyRange], :keys [[any]], :all boolean}, :columns [string], :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}, :table string, :partitionOptions {:maxPartitions string, :partitionSizeBytes string}, :index string} 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. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.
(instances-databases-sessions-read$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/read
Required parameters: session
Optional parameters: none
Body:
{:limit string, :index string, :keySet {:ranges [KeyRange], :keys [[any]], :all boolean}, :columns [string], :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}, :resumeToken string, :partitionToken string, :table string}
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.
Reads inside read-write transactions might return ABORTED
. If
this occurs, the application should restart the transaction from
the beginning. See Transaction for more details.
Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/read Required parameters: session Optional parameters: none Body: {:limit string, :index string, :keySet {:ranges [KeyRange], :keys [[any]], :all boolean}, :columns [string], :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}, :resumeToken string, :partitionToken string, :table string} 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. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.
(instances-databases-sessions-rollback$ auth args body)
Required parameters: session
Optional parameters: none
Body:
{:transactionId string}
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.
Rollback
returns OK
if it successfully aborts the transaction, the
transaction was already aborted, or the transaction is not
found. Rollback
never returns ABORTED
.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/rollback Required parameters: session Optional parameters: none Body: {:transactionId string} 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. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`.
(instances-databases-sessions-streamingRead$ auth args body)
Required parameters: session
Optional parameters: none
Body:
{:limit string, :index string, :keySet {:ranges [KeyRange], :keys [[any]], :all boolean}, :columns [string], :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}, :resumeToken string, :partitionToken string, :table string}
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.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/sessions/streamingRead Required parameters: session Optional parameters: none Body: {:limit string, :index string, :keySet {:ranges [KeyRange], :keys [[any]], :all boolean}, :columns [string], :transaction {:begin TransactionOptions, :id string, :singleUse TransactionOptions}, :resumeToken string, :partitionToken string, :table string} 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.
(instances-databases-setIamPolicy$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:policy {:bindings [Binding], :etag string, :version integer}}
Sets the access control policy on a database resource. Replaces any existing policy.
Authorization requires spanner.databases.setIamPolicy
permission on resource.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:bindings [Binding], :etag string, :version integer}} Sets the access control policy on a database resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource.
(instances-databases-testIamPermissions$ auth args body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns permissions that the caller has on the specified database resource.
Attempting this RPC on a non-existent Cloud Spanner database will
result in a NOT_FOUND error if the user has
spanner.databases.list
permission on the containing Cloud
Spanner instance. Otherwise returns an empty set of permissions.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns permissions that the caller has on the specified database resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions.
(instances-databases-updateDdl$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/updateDdl
Required parameters: database
Optional parameters: none
Body:
{:statements [string], :operationId string}
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 <database_name>/operations/<operation_id>
and can be used to
track execution of the schema change(s). The
metadata field type is
UpdateDatabaseDdlMetadata. The operation has no response.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/databases/updateDdl Required parameters: database Optional parameters: none Body: {:statements [string], :operationId string} 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 `<database_name>/operations/<operation_id>` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.
(instances-delete$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/delete
Required parameters: name
Optional parameters: none Deletes an instance.
Immediately upon completion of the request:
Soon afterward:
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/delete Required parameters: name Optional parameters: none Deletes an instance. Immediately upon completion of the request: * Billing ceases for all of the instance's reserved resources. Soon afterward: * The instance and *all of its databases* immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.
(instances-get$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/get
Required parameters: name
Optional parameters: fieldMask Gets information about a particular instance.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/get Required parameters: name Optional parameters: fieldMask Gets information about a particular instance.
(instances-getIamPolicy$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/getIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
Authorization requires spanner.instances.getIamPolicy
on
resource.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. Authorization requires `spanner.instances.getIamPolicy` on resource.
(instances-list$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/list
Required parameters: parent
Optional parameters: pageToken, pageSize, filter Lists all instances in the given project.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/list Required parameters: parent Optional parameters: pageToken, pageSize, filter Lists all instances in the given project.
(instances-operations-cancel$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/operations/cancel
Required parameters: name
Optional parameters: none
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
.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/operations/cancel Required parameters: name Optional parameters: none 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`.
(instances-operations-delete$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/operations/delete
Required parameters: name
Optional parameters: none
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
.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/operations/delete Required parameters: name Optional parameters: none 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`.
(instances-operations-get$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/operations/get
Required parameters: name
Optional parameters: none 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.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/operations/get Required parameters: name Optional parameters: none 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.
(instances-operations-list$ auth args)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/operations/list
Required parameters: name
Optional parameters: filter, pageToken, pageSize
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding
to use different resource name schemes, such as users/*/operations
. To
override the binding, API services can add a binding such as
"/v1/{name=users/*}/operations"
to their service configuration.
For backwards compatibility, the default name includes the operations
collection id, however overriding users must ensure the name binding
is the parent resource, without the operations collection id.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/operations/list Required parameters: name Optional parameters: filter, pageToken, pageSize Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
(instances-patch$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/patch
Required parameters: name
Optional parameters: none
Body:
{:instance {:displayName string, :endpointUris [string], :nodeCount integer, :labels {}, :config string, :state string, :name string}, :fieldMask string}
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
.
Immediately upon completion of this request:
Until completion of the returned operation:
CANCELLED
status.Upon completion of the returned operation:
The returned long-running operation will
have a name of the format <instance_name>/operations/<operation_id>
and
can be used to track the instance modification. The
metadata field type is
UpdateInstanceMetadata.
The response field type is
Instance, if successful.
Authorization requires spanner.instances.update
permission on
resource name.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/patch Required parameters: name Optional parameters: none Body: {:instance {:displayName string, :endpointUris [string], :nodeCount integer, :labels {}, :config string, :state string, :name string}, :fieldMask string} 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`. Immediately upon completion of this request: * For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance are rejected. * Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance's tables. * The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format `<instance_name>/operations/<operation_id>` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires `spanner.instances.update` permission on resource name.
(instances-setIamPolicy$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:policy {:bindings [Binding], :etag string, :version integer}}
Sets the access control policy on an instance resource. Replaces any existing policy.
Authorization requires spanner.instances.setIamPolicy
on
resource.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:bindings [Binding], :etag string, :version integer}} Sets the access control policy on an instance resource. Replaces any existing policy. Authorization requires `spanner.instances.setIamPolicy` on resource.
(instances-testIamPermissions$ auth args body)
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/testIamPermissions
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns permissions that the caller has on the specified instance resource.
Attempting this RPC on a non-existent Cloud Spanner instance resource will
result in a NOT_FOUND error if the user has spanner.instances.list
permission on the containing Google Cloud Project. Otherwise returns an
empty set of permissions.
https://cloud.google.com/spanner/api/reference/rest/v1/projects/instances/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns permissions that the caller has on the specified instance resource. Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close