Class: Google::Apis::SpannerV1::SpannerService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::SpannerV1::SpannerService
- Defined in:
- generated/google/apis/spanner_v1/service.rb
Overview
Cloud Spanner API
Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#batch_create_sessions(database, batch_create_sessions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::BatchCreateSessionsResponse
Creates multiple new sessions.
-
#begin_session_transaction(session, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Transaction
Begins a new transaction.
-
#cancel_project_instance_backup_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
Starts asynchronous cancellation on a long-running operation.
-
#cancel_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
Starts asynchronous cancellation on a long-running operation.
-
#cancel_project_instance_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
Starts asynchronous cancellation on a long-running operation.
-
#commit_session(session, commit_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::CommitResponse
Commits a transaction.
-
#create_database(parent, create_database_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
Creates a new Cloud Spanner database and starts to prepare it for serving.
-
#create_instance(parent, create_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
Creates an instance and begins preparing it to begin serving.
-
#create_project_instance_database_session(database, create_session_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Session
Creates a new session.
-
#delete_project_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
Deletes an instance.
-
#delete_project_instance_backup_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
Deletes a long-running operation.
-
#delete_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
Deletes a long-running operation.
-
#delete_project_instance_database_session(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
Ends a session, releasing server resources associated with it.
-
#delete_project_instance_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
Deletes a long-running operation.
-
#drop_project_instance_database_database(database, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
Drops (aka deletes) a Cloud Spanner database.
-
#execute_project_instance_database_session_streaming_sql(session, execute_sql_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::PartialResultSet
Like ExecuteSql, except returns the result set as a stream.
-
#execute_session_batch_dml(session, execute_batch_dml_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ExecuteBatchDmlResponse
Executes a batch of SQL DML statements.
-
#execute_session_sql(session, execute_sql_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ResultSet
Executes an SQL statement, returning all results in a single reply.
-
#get_backup_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy
Gets the access control policy for a database resource.
-
#get_database_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy
Gets the access control policy for a database resource.
-
#get_instance_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy
Gets the access control policy for an instance resource.
-
#get_project_instance(name, field_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Instance
Gets information about a particular instance.
-
#get_project_instance_backup_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
Gets the latest state of a long-running operation.
-
#get_project_instance_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::InstanceConfig
Gets information about a particular instance configuration.
-
#get_project_instance_database(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Database
Gets the state of a Cloud Spanner database.
-
#get_project_instance_database_ddl(database, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::GetDatabaseDdlResponse
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.
-
#get_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
Gets the latest state of a long-running operation.
-
#get_project_instance_database_session(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Session
Gets a session.
-
#get_project_instance_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
Gets the latest state of a long-running operation.
-
#initialize ⇒ SpannerService
constructor
A new instance of SpannerService.
-
#list_project_instance_backup_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_project_instance_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListInstanceConfigsResponse
Lists the supported instance configurations for a given project.
-
#list_project_instance_database_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_project_instance_database_sessions(database, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListSessionsResponse
Lists all sessions in a given database.
-
#list_project_instance_databases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListDatabasesResponse
Lists Cloud Spanner databases.
-
#list_project_instance_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_project_instances(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListInstancesResponse
Lists all instances in the given project.
-
#partition_session_query(session, partition_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::PartitionResponse
Creates a set of partition tokens that can be used to execute a query operation in parallel.
-
#partition_session_read(session, partition_read_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::PartitionResponse
Creates a set of partition tokens that can be used to execute a read operation in parallel.
-
#patch_project_instance(name, update_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
Updates an instance, and begins allocating or releasing resources as requested.
-
#read_session(session, read_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ResultSet
Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql.
-
#rollback_session(session, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
Rolls back a transaction, releasing any locks it holds.
-
#set_backup_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy
Sets the access control policy on a database resource.
-
#set_database_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy
Sets the access control policy on a database resource.
-
#set_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy
Sets the access control policy on an instance resource.
-
#streaming_project_instance_database_session_read(session, read_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::PartialResultSet
Like Read, except returns the result set as a stream.
-
#test_backup_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::TestIamPermissionsResponse
Returns permissions that the caller has on the specified database resource.
-
#test_database_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::TestIamPermissionsResponse
Returns permissions that the caller has on the specified database resource.
-
#test_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::TestIamPermissionsResponse
Returns permissions that the caller has on the specified instance resource.
-
#update_project_instance_database_ddl(database, update_database_ddl_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ SpannerService
Returns a new instance of SpannerService.
46 47 48 49 |
# File 'generated/google/apis/spanner_v1/service.rb', line 46 def initialize super('https://spanner.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
39 40 41 |
# File 'generated/google/apis/spanner_v1/service.rb', line 39 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
44 45 46 |
# File 'generated/google/apis/spanner_v1/service.rb', line 44 def quota_user @quota_user end |
Instance Method Details
#batch_create_sessions(database, batch_create_sessions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::BatchCreateSessionsResponse
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.
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1275 def batch_create_sessions(database, batch_create_sessions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+database}/sessions:batchCreate', ) command.request_representation = Google::Apis::SpannerV1::BatchCreateSessionsRequest::Representation command.request_object = batch_create_sessions_request_object command.response_representation = Google::Apis::SpannerV1::BatchCreateSessionsResponse::Representation command.response_class = Google::Apis::SpannerV1::BatchCreateSessionsResponse command.params['database'] = database unless database.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#begin_session_transaction(session, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Transaction
Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1311 def begin_session_transaction(session, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+session}:beginTransaction', ) command.request_representation = Google::Apis::SpannerV1::BeginTransactionRequest::Representation command.request_object = begin_transaction_request_object command.response_representation = Google::Apis::SpannerV1::Transaction::Representation command.response_class = Google::Apis::SpannerV1::Transaction command.params['session'] = session unless session.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#cancel_project_instance_backup_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
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
.
647 648 649 650 651 652 653 654 655 |
# File 'generated/google/apis/spanner_v1/service.rb', line 647 def cancel_project_instance_backup_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', ) command.response_representation = Google::Apis::SpannerV1::Empty::Representation command.response_class = Google::Apis::SpannerV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#cancel_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
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
.
1130 1131 1132 1133 1134 1135 1136 1137 1138 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1130 def cancel_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', ) command.response_representation = Google::Apis::SpannerV1::Empty::Representation command.response_class = Google::Apis::SpannerV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#cancel_project_instance_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
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
.
1875 1876 1877 1878 1879 1880 1881 1882 1883 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1875 def cancel_project_instance_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', ) command.response_representation = Google::Apis::SpannerV1::Empty::Representation command.response_class = Google::Apis::SpannerV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#commit_session(session, commit_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::CommitResponse
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.
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1350 def commit_session(session, commit_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+session}:commit', ) command.request_representation = Google::Apis::SpannerV1::CommitRequest::Representation command.request_object = commit_request_object command.response_representation = Google::Apis::SpannerV1::CommitResponse::Representation command.response_class = Google::Apis::SpannerV1::CommitResponse command.params['session'] = session unless session.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_database(parent, create_database_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
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.
798 799 800 801 802 803 804 805 806 807 808 |
# File 'generated/google/apis/spanner_v1/service.rb', line 798 def create_database(parent, create_database_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/databases', ) command.request_representation = Google::Apis::SpannerV1::CreateDatabaseRequest::Representation command.request_object = create_database_request_object command.response_representation = Google::Apis::SpannerV1::Operation::Representation command.response_class = Google::Apis::SpannerV1::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_instance(parent, create_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
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.
171 172 173 174 175 176 177 178 179 180 181 |
# File 'generated/google/apis/spanner_v1/service.rb', line 171 def create_instance(parent, create_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/instances', ) command.request_representation = Google::Apis::SpannerV1::CreateInstanceRequest::Representation command.request_object = create_instance_request_object command.response_representation = Google::Apis::SpannerV1::Operation::Representation command.response_class = Google::Apis::SpannerV1::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_instance_database_session(database, create_session_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Session
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"
.
1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1398 def create_project_instance_database_session(database, create_session_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+database}/sessions', ) command.request_representation = Google::Apis::SpannerV1::CreateSessionRequest::Representation command.request_object = create_session_request_object command.response_representation = Google::Apis::SpannerV1::Session::Representation command.response_class = Google::Apis::SpannerV1::Session command.params['database'] = database unless database.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
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.
210 211 212 213 214 215 216 217 218 |
# File 'generated/google/apis/spanner_v1/service.rb', line 210 def delete_project_instance(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::Empty::Representation command.response_class = Google::Apis::SpannerV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_instance_backup_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
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
.
680 681 682 683 684 685 686 687 688 |
# File 'generated/google/apis/spanner_v1/service.rb', line 680 def delete_project_instance_backup_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::Empty::Representation command.response_class = Google::Apis::SpannerV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
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
.
1163 1164 1165 1166 1167 1168 1169 1170 1171 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1163 def delete_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::Empty::Representation command.response_class = Google::Apis::SpannerV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_instance_database_session(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.
1432 1433 1434 1435 1436 1437 1438 1439 1440 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1432 def delete_project_instance_database_session(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::Empty::Representation command.response_class = Google::Apis::SpannerV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_instance_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
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
.
1908 1909 1910 1911 1912 1913 1914 1915 1916 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1908 def delete_project_instance_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::Empty::Representation command.response_class = Google::Apis::SpannerV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#drop_project_instance_database_database(database, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
Drops (aka deletes) a Cloud Spanner database.
830 831 832 833 834 835 836 837 838 |
# File 'generated/google/apis/spanner_v1/service.rb', line 830 def drop_project_instance_database_database(database, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+database}', ) command.response_representation = Google::Apis::SpannerV1::Empty::Representation command.response_class = Google::Apis::SpannerV1::Empty command.params['database'] = database unless database.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#execute_project_instance_database_session_streaming_sql(session, execute_sql_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::PartialResultSet
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.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1549 def execute_project_instance_database_session_streaming_sql(session, execute_sql_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+session}:executeStreamingSql', ) command.request_representation = Google::Apis::SpannerV1::ExecuteSqlRequest::Representation command.request_object = execute_sql_request_object command.response_representation = Google::Apis::SpannerV1::PartialResultSet::Representation command.response_class = Google::Apis::SpannerV1::PartialResultSet command.params['session'] = session unless session.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#execute_session_batch_dml(session, execute_batch_dml_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ExecuteBatchDmlResponse
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.
1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1471 def execute_session_batch_dml(session, execute_batch_dml_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+session}:executeBatchDml', ) command.request_representation = Google::Apis::SpannerV1::ExecuteBatchDmlRequest::Representation command.request_object = execute_batch_dml_request_object command.response_representation = Google::Apis::SpannerV1::ExecuteBatchDmlResponse::Representation command.response_class = Google::Apis::SpannerV1::ExecuteBatchDmlResponse command.params['session'] = session unless session.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#execute_session_sql(session, execute_sql_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ResultSet
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.
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1512 def execute_session_sql(session, execute_sql_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+session}:executeSql', ) command.request_representation = Google::Apis::SpannerV1::ExecuteSqlRequest::Representation command.request_object = execute_sql_request_object command.response_representation = Google::Apis::SpannerV1::ResultSet::Representation command.response_class = Google::Apis::SpannerV1::ResultSet command.params['session'] = session unless session.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_backup_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy
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.
527 528 529 530 531 532 533 534 535 536 537 |
# File 'generated/google/apis/spanner_v1/service.rb', line 527 def get_backup_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', ) command.request_representation = Google::Apis::SpannerV1::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::SpannerV1::Policy::Representation command.response_class = Google::Apis::SpannerV1::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_database_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy
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.
931 932 933 934 935 936 937 938 939 940 941 |
# File 'generated/google/apis/spanner_v1/service.rb', line 931 def get_database_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', ) command.request_representation = Google::Apis::SpannerV1::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::SpannerV1::Policy::Representation command.response_class = Google::Apis::SpannerV1::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_instance_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy
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.
283 284 285 286 287 288 289 290 291 292 293 |
# File 'generated/google/apis/spanner_v1/service.rb', line 283 def get_instance_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', ) command.request_representation = Google::Apis::SpannerV1::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::SpannerV1::Policy::Representation command.response_class = Google::Apis::SpannerV1::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_instance(name, field_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Instance
Gets information about a particular instance.
245 246 247 248 249 250 251 252 253 254 |
# File 'generated/google/apis/spanner_v1/service.rb', line 245 def get_project_instance(name, field_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::Instance::Representation command.response_class = Google::Apis::SpannerV1::Instance command.params['name'] = name unless name.nil? command.query['fieldMask'] = field_mask unless field_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_instance_backup_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
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.
712 713 714 715 716 717 718 719 720 |
# File 'generated/google/apis/spanner_v1/service.rb', line 712 def get_project_instance_backup_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::Operation::Representation command.response_class = Google::Apis::SpannerV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_instance_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::InstanceConfig
Gets information about a particular instance configuration.
72 73 74 75 76 77 78 79 80 |
# File 'generated/google/apis/spanner_v1/service.rb', line 72 def get_project_instance_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::InstanceConfig::Representation command.response_class = Google::Apis::SpannerV1::InstanceConfig command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_instance_database(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Database
Gets the state of a Cloud Spanner database.
861 862 863 864 865 866 867 868 869 |
# File 'generated/google/apis/spanner_v1/service.rb', line 861 def get_project_instance_database(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::Database::Representation command.response_class = Google::Apis::SpannerV1::Database command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_instance_database_ddl(database, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::GetDatabaseDdlResponse
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.
893 894 895 896 897 898 899 900 901 |
# File 'generated/google/apis/spanner_v1/service.rb', line 893 def get_project_instance_database_ddl(database, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+database}/ddl', ) command.response_representation = Google::Apis::SpannerV1::GetDatabaseDdlResponse::Representation command.response_class = Google::Apis::SpannerV1::GetDatabaseDdlResponse command.params['database'] = database unless database.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
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.
1195 1196 1197 1198 1199 1200 1201 1202 1203 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1195 def get_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::Operation::Representation command.response_class = Google::Apis::SpannerV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_instance_database_session(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Session
Gets a session. Returns NOT_FOUND
if the session does not exist.
This is mainly useful for determining whether a session is still
alive.
1583 1584 1585 1586 1587 1588 1589 1590 1591 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1583 def get_project_instance_database_session(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::Session::Representation command.response_class = Google::Apis::SpannerV1::Session command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_instance_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
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.
1940 1941 1942 1943 1944 1945 1946 1947 1948 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1940 def get_project_instance_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::Operation::Representation command.response_class = Google::Apis::SpannerV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_instance_backup_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListOperationsResponse
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.
756 757 758 759 760 761 762 763 764 765 766 767 |
# File 'generated/google/apis/spanner_v1/service.rb', line 756 def list_project_instance_backup_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::ListOperationsResponse::Representation command.response_class = Google::Apis::SpannerV1::ListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_instance_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListInstanceConfigsResponse
Lists the supported instance configurations for a given project.
111 112 113 114 115 116 117 118 119 120 121 |
# File 'generated/google/apis/spanner_v1/service.rb', line 111 def list_project_instance_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/instanceConfigs', ) command.response_representation = Google::Apis::SpannerV1::ListInstanceConfigsResponse::Representation command.response_class = Google::Apis::SpannerV1::ListInstanceConfigsResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_instance_database_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListOperationsResponse
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.
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1239 def list_project_instance_database_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::ListOperationsResponse::Representation command.response_class = Google::Apis::SpannerV1::ListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_instance_database_sessions(database, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListSessionsResponse
Lists all sessions in a given database.
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1628 def list_project_instance_database_sessions(database, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+database}/sessions', ) command.response_representation = Google::Apis::SpannerV1::ListSessionsResponse::Representation command.response_class = Google::Apis::SpannerV1::ListSessionsResponse command.params['database'] = database unless database.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_instance_databases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListDatabasesResponse
Lists Cloud Spanner databases.
971 972 973 974 975 976 977 978 979 980 981 |
# File 'generated/google/apis/spanner_v1/service.rb', line 971 def list_project_instance_databases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/databases', ) command.response_representation = Google::Apis::SpannerV1::ListDatabasesResponse::Representation command.response_class = Google::Apis::SpannerV1::ListDatabasesResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_instance_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListOperationsResponse
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.
1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1984 def list_project_instance_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::SpannerV1::ListOperationsResponse::Representation command.response_class = Google::Apis::SpannerV1::ListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_instances(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListInstancesResponse
Lists all instances in the given project.
340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'generated/google/apis/spanner_v1/service.rb', line 340 def list_project_instances(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/instances', ) command.response_representation = Google::Apis::SpannerV1::ListInstancesResponse::Representation command.response_class = Google::Apis::SpannerV1::ListInstancesResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#partition_session_query(session, partition_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::PartitionResponse
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.
1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1671 def partition_session_query(session, partition_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+session}:partitionQuery', ) command.request_representation = Google::Apis::SpannerV1::PartitionQueryRequest::Representation command.request_object = partition_query_request_object command.response_representation = Google::Apis::SpannerV1::PartitionResponse::Representation command.response_class = Google::Apis::SpannerV1::PartitionResponse command.params['session'] = session unless session.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#partition_session_read(session, partition_read_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::PartitionResponse
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.
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1715 def partition_session_read(session, partition_read_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+session}:partitionRead', ) command.request_representation = Google::Apis::SpannerV1::PartitionReadRequest::Representation command.request_object = partition_read_request_object command.response_representation = Google::Apis::SpannerV1::PartitionResponse::Representation command.response_class = Google::Apis::SpannerV1::PartitionResponse command.params['session'] = session unless session.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_instance(name, update_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
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 requiresspanner.instances.update
permission on resource name.
408 409 410 411 412 413 414 415 416 417 418 |
# File 'generated/google/apis/spanner_v1/service.rb', line 408 def patch_project_instance(name, update_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::SpannerV1::UpdateInstanceRequest::Representation command.request_object = update_instance_request_object command.response_representation = Google::Apis::SpannerV1::Operation::Representation command.response_class = Google::Apis::SpannerV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#read_session(session, read_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ResultSet
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.
1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1758 def read_session(session, read_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+session}:read', ) command.request_representation = Google::Apis::SpannerV1::ReadRequest::Representation command.request_object = read_request_object command.response_representation = Google::Apis::SpannerV1::ResultSet::Representation command.response_class = Google::Apis::SpannerV1::ResultSet command.params['session'] = session unless session.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#rollback_session(session, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty
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
.
1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1797 def rollback_session(session, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+session}:rollback', ) command.request_representation = Google::Apis::SpannerV1::RollbackRequest::Representation command.request_object = rollback_request_object command.response_representation = Google::Apis::SpannerV1::Empty::Representation command.response_class = Google::Apis::SpannerV1::Empty command.params['session'] = session unless session.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#set_backup_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy
Sets the access control policy on a database resource.
Replaces any existing policy.
Authorization requires spanner.databases.setIamPolicy
permission on resource.
566 567 568 569 570 571 572 573 574 575 576 |
# File 'generated/google/apis/spanner_v1/service.rb', line 566 def set_backup_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::SpannerV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::SpannerV1::Policy::Representation command.response_class = Google::Apis::SpannerV1::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#set_database_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy
Sets the access control policy on a database resource.
Replaces any existing policy.
Authorization requires spanner.databases.setIamPolicy
permission on resource.
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1010 def set_database_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::SpannerV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::SpannerV1::Policy::Representation command.response_class = Google::Apis::SpannerV1::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#set_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy
Sets the access control policy on an instance resource. Replaces any
existing policy.
Authorization requires spanner.instances.setIamPolicy
on
resource.
447 448 449 450 451 452 453 454 455 456 457 |
# File 'generated/google/apis/spanner_v1/service.rb', line 447 def set_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::SpannerV1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::SpannerV1::Policy::Representation command.response_class = Google::Apis::SpannerV1::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#streaming_project_instance_database_session_read(session, read_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::PartialResultSet
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.
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1834 def streaming_project_instance_database_session_read(session, read_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+session}:streamingRead', ) command.request_representation = Google::Apis::SpannerV1::ReadRequest::Representation command.request_object = read_request_object command.response_representation = Google::Apis::SpannerV1::PartialResultSet::Representation command.response_class = Google::Apis::SpannerV1::PartialResultSet command.params['session'] = session unless session.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#test_backup_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::TestIamPermissionsResponse
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.
606 607 608 609 610 611 612 613 614 615 616 |
# File 'generated/google/apis/spanner_v1/service.rb', line 606 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::SpannerV1::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::SpannerV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::SpannerV1::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#test_database_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::TestIamPermissionsResponse
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.
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1050 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::SpannerV1::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::SpannerV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::SpannerV1::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#test_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::TestIamPermissionsResponse
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.
487 488 489 490 491 492 493 494 495 496 497 |
# File 'generated/google/apis/spanner_v1/service.rb', line 487 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::SpannerV1::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::SpannerV1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::SpannerV1::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_project_instance_database_ddl(database, update_database_ddl_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation
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.
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 |
# File 'generated/google/apis/spanner_v1/service.rb', line 1089 def update_project_instance_database_ddl(database, update_database_ddl_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+database}/ddl', ) command.request_representation = Google::Apis::SpannerV1::UpdateDatabaseDdlRequest::Representation command.request_object = update_database_ddl_request_object command.response_representation = Google::Apis::SpannerV1::Operation::Representation command.response_class = Google::Apis::SpannerV1::Operation command.params['database'] = database unless database.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |