Class: Google::Cloud::Spanner::Client

#batch_write(exclude_txn_from_change_streams: false, request_options: nil, call_options: nil) {|batch_write| ... } ⇒ `Google::Cloud::Spanner::BatchWriteResults`

Batches the supplied mutation groups in a collection of efficient transactions.

All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus they must be independent of each other. Partial failure is possible, i.e., some groups may have been committed successfully, while others may have failed. The results of individual batches are streamed into the response as the batches are applied.

BatchWrite requests are not replay protected, meaning that each mutation group may be applied more than once. Replays of non-idempotent mutations may have undesirable effects. For example, replays of an insert mutation may produce an already exists error or if you use generated or commit timestamp-based keys, it may result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

results = db.batch_write do |b|
  # First mutation group
  b.mutation_group do |mg|
    mg.upsert "Singers", [{ SingerId: 16, FirstName: "Charlie", LastName: "Terry" }]
  end

  # Second mutation group
  b.mutation_group do |mg|
    mg.upsert "Singers", [{ SingerId: 17, FirstName: "Catalina", LastName: "Smith" }]
    mg.update "Albums", [{ SingerId: 17, AlbumId: 1, AlbumTitle: "Go Go Go" }]
  end
end

results.each do |response|
  puts "groups applied: #{response.indexes}" if response.ok?
end

Parameters:

exclude_txn_from_change_streams (Boolean) (defaults to: false) —
If set to true, mutations will not be recorded in change streams with DDL option allow_txn_exclusion=true.
request_options (Hash) (defaults to: nil) —
Common request options.
- :priority (String) The relative priority for requests. The priority acts as a hint to the Cloud Spanner scheduler and does not guarantee priority or order of execution. Valid values are :PRIORITY_LOW, :PRIORITY_MEDIUM, :PRIORITY_HIGH. If priority not set then default is PRIORITY_UNSPECIFIED is equivalent to :PRIORITY_HIGH.
- :tag (String) A per-request tag which can be applied to queries or reads, used for statistics collection. Tag must be a valid identifier of the form: [a-zA-Z][a-zA-Z0-9_\-] between 2 and 64 characters in length.
call_options (Hash) (defaults to: nil) —
A hash of values to specify the custom call options, e.g., timeout, retries, etc. Call options are optional. The following settings can be provided:
- :timeout (Numeric) A numeric value of custom timeout in seconds that overrides the default setting.
- :retry_policy (Hash) A hash of values that overrides the default setting of retry policy with the following keys:
  - :initial_delay (Numeric) - The initial delay in seconds.
  - :max_delay (Numeric) - The max delay in seconds.
  - :multiplier (Numeric) - The incremental backoff multiplier.
  - :retry_codes (Array<String>) - The error codes that should trigger a retry.

Yields:

(batch_write) —
a batch write object

Yield Parameters:

batch_write (Google::Cloud::Spanner::BatchWrite) —
a batch write object used to add mutaion groups through MutationGroup.

Returns:

(Google::Cloud::Spanner::BatchWriteResults) —
The results of the batch write operation. This is a stream of responses, each covering a set of the mutation groups that were either applied or failed together.

Raises:

(ArgumentError)

# File 'lib/google/cloud/spanner/client.rb', line 2083

def batch_write exclude_txn_from_change_streams: false,
                request_options: nil,
                call_options: nil,
                &block
  raise ArgumentError, "Must provide a block" unless block_given?

  @pool.with_session do |session|
    session.batch_write(
      exclude_txn_from_change_streams: exclude_txn_from_change_streams,
      request_options: request_options,
      call_options: call_options,
      &block
    )
  end
end

#close ⇒ `Object`

Closes the client connection and releases resources.



2643
2644
2645

# File 'lib/google/cloud/spanner/client.rb', line 2643

def close
  @pool.close
end

#commit(exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) {|commit| ... } ⇒ `Time`, `CommitResponse`

Creates and commits a transaction for writes that execute atomically at a single logical point in time across columns, rows, and tables in a database.

All changes are accumulated in memory until the block completes. Unlike #transaction, which can also perform reads, this operation accepts only mutations and makes a single API request.

Note: This method does not feature replay protection present in #transaction. This method makes a single RPC, whereas #transaction requires two RPCs (one of which may be performed in advance), and so this method may be appropriate for latency sensitive and/or high throughput blind changes.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

db.commit do |c|
  c.update "users", [{ id: 1, name: "Charlie", active: false }]
  c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
end

Get commit stats

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

commit_options = { return_commit_stats: true }
commit_resp = db.commit commit_options: commit_options do |c|
  c.update "users", [{ id: 1, name: "Charlie", active: false }]
  c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
end

puts commit_resp.timestamp
puts commit_resp.stats.mutation_count

With request options

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

db.commit request_options: { priority: :PRIORITY_MEDIUM } do |c|
  c.update "users", [{ id: 1, name: "Charlie", active: false }]
  c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
end

Commit using tag for transaction statistics collection.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { tag: "BulkManipulate-Users" }
db.commit request_options: request_options do |c|
  c.update "users", [{ id: 1, name: "Charlie", active: false }]
  c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
end

Parameters:

exclude_txn_from_change_streams (Boolean) (defaults to: false) —
If set to true, mutations will not be recorded in change streams with DDL option allow_txn_exclusion=true.
commit_options (Hash) (defaults to: nil) —
A hash of commit options. e.g., return_commit_stats. Commit options are optional. The following options can be provided:
- :return_commit_stats (Boolean) A boolean value. If true, then statistics related to the transaction will be included in Google::Cloud::Spanner::CommitResponse. Default value is false
- :maxCommitDelay (Numeric) The amount of latency in millisecond in this request is willing to incur in order to improve throughput. The commit delay must be at least 0ms and at most 500ms. Default value is nil.
request_options (Hash) (defaults to: nil) —
Common request options.
- :priority (String) The relative priority for requests. The priority acts as a hint to the Cloud Spanner scheduler and does not guarantee priority or order of execution. Valid values are :PRIORITY_LOW, :PRIORITY_MEDIUM, :PRIORITY_HIGH. If priority not set then default is PRIORITY_UNSPECIFIED is equivalent to :PRIORITY_HIGH.
- :tag (String) A tag used for statistics collection about transaction. A tag must be a valid identifier of the format: [a-zA-Z][a-zA-Z0-9_\-]{0,49}.
call_options (Hash) (defaults to: nil) —
A hash of values to specify the custom call options, e.g., timeout, retries, etc. Call options are optional. The following settings can be provided:
- :timeout (Numeric) A numeric value of custom timeout in seconds that overrides the default setting.
- :retry_policy (Hash) A hash of values that overrides the default setting of retry policy with the following keys:
  - :initial_delay (Numeric) - The initial delay in seconds.
  - :max_delay (Numeric) - The max delay in seconds.
  - :multiplier (Numeric) - The incremental backoff multiplier.
  - :retry_codes (Array<String>) - The error codes that should trigger a retry.
read_lock_mode (Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode) (defaults to: nil) —
The read lock mode for the transaction. If not specified, the client-level read lock moce will be used. Can be one of the following:
- :READ_LOCK_MODE_UNSPECIFIED : The default unspecified read lock mode.
- :PESSIMISTIC : The pessimistic lock mode, where read locks are acquired immediately on read.
- :OPTIMISTIC : The optimistic lock mode, where locks for reads are not acquired on read but instead on a commit to validate that the data has not changed since the transaction started.
isolation_level (::Symbol, nil) (defaults to: nil) —
Optional. The isolation level for the transaction. If not specified, the client-level isolation level will be used. Can be one of the following:
- :ISOLATION_LEVEL_UNSPECIFIED : The default unspecified isolation level.
- :SERIALIZABLE : The serializable isolation level.
- :REPEATABLE_READ : The repeatable read isolation level.

Yields:

(commit) —
The block for mutating the data.

Yield Parameters:

commit (Google::Cloud::Spanner::Commit) —
The Commit object.

Returns:

(Time, CommitResponse) —
The timestamp at which the operation committed. If commit options are set it returns Google::Cloud::Spanner::CommitResponse.

Raises:

(ArgumentError)

# File 'lib/google/cloud/spanner/client.rb', line 1980

def commit exclude_txn_from_change_streams: false,
           isolation_level: nil, commit_options: nil, request_options: nil,
           call_options: nil, read_lock_mode: nil, &block
  raise ArgumentError, "Must provide a block" unless block_given?

  request_options = Convert.to_request_options \
    request_options, tag_type: :transaction_tag

  @pool.with_session do |session|
    session.commit(
      exclude_txn_from_change_streams: exclude_txn_from_change_streams,
      isolation_level: isolation_level || @isolation_level,
      commit_options: commit_options,
      request_options: request_options,
      call_options: call_options,
      read_lock_mode: read_lock_mode || @read_lock_mode,
      &block
    )
  end
end

#commit_timestamp ⇒ `ColumnValue`

Creates a column value object representing setting a field's value to the timestamp of the commit. (See Google::Cloud::Spanner::ColumnValue.commit_timestamp)

This placeholder value can only be used for timestamp columns that have set the option "(allow_commit_timestamp=true)" in the schema.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

# create column value object
commit_timestamp = db.commit_timestamp

db.commit do |c|
  c.insert "users", [
    { id: 5, name: "Murphy", updated_at: commit_timestamp }
  ]
end

Returns:

(ColumnValue) —
The commit timestamp column value object.



2636
2637
2638

# File 'lib/google/cloud/spanner/client.rb', line 2636

def commit_timestamp
  ColumnValue.commit_timestamp
end

#database ⇒ `Database`

The Spanner database connected to.

Returns:

(Database)



149
150
151

# File 'lib/google/cloud/spanner/client.rb', line 149

def database
  @project.database instance_id, database_id
end

#database_id ⇒ `String`

The unique identifier for the database.

Returns:

(String)



131
132
133

# File 'lib/google/cloud/spanner/client.rb', line 131

def database_id
  @database_id
end

#database_role ⇒ `String`

The Spanner session creator role.

Returns:

(String)



155
156
157

# File 'lib/google/cloud/spanner/client.rb', line 155

def database_role
  @database_role
end

#delete(table, keys = [], exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ `Time`, `CommitResponse`

Deletes rows from a table. Succeeds whether or not the specified rows were present.

Changes are made immediately upon calling this method using a single-use transaction. To make multiple changes in the same single-use transaction use #commit. To make changes in a transaction that supports reads and automatic retry protection use #transaction.

Note: This method does not feature replay protection present in Transaction#delete (See #transaction). This method makes a single RPC, whereas Transaction#delete requires two RPCs (one of which may be performed in advance), and so this method may be appropriate for latency sensitive and/or high throughput blind deletions.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

db.delete "users", [1, 2, 3]

Get commit stats

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

commit_options = { return_commit_stats: true }
commit_resp = db.delete "users", [1, 2, 3], commit_options: commit_options

puts commit_resp.timestamp
puts commit_resp.stats.mutation_count

With request optinos

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { priority: :PRIORITY_MEDIUM }
db.delete "users", [1, 2, 3], request_options: request_options

Delete using tag for transaction statistics collection.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { tag: "BulkDelete-Users" }
db.delete "users", [1, 2, 3], request_options: request_options

Parameters:

table (String) —
The name of the table in the database to be modified.
keys (Object, Array<Object>) (defaults to: []) —
A single, or list of keys or key ranges to match returned data to. Values should have exactly as many elements as there are columns in the primary key.
exclude_txn_from_change_streams (Boolean) (defaults to: false) —
If set to true, mutations will not be recorded in change streams with DDL option allow_txn_exclusion=true.
commit_options (Hash) (defaults to: nil) —
A hash of commit options. e.g., return_commit_stats. Commit options are optional. The following options can be provided:
- :return_commit_stats (Boolean) A boolean value. If true, then statistics related to the transaction will be included in Google::Cloud::Spanner::CommitResponse. Default value is false
- :maxCommitDelay (Numeric) The amount of latency in millisecond in this request is willing to incur in order to improve throughput. The commit delay must be at least 0ms and at most 500ms. Default value is nil.
request_options (Hash) (defaults to: nil) —
Common request options.
- :priority (String) The relative priority for requests. The priority acts as a hint to the Cloud Spanner scheduler and does not guarantee priority or order of execution. Valid values are :PRIORITY_LOW, :PRIORITY_MEDIUM, :PRIORITY_HIGH. If priority not set then default is PRIORITY_UNSPECIFIED is equivalent to :PRIORITY_HIGH.
- :tag (String) A tag used for statistics collection about transaction. A tag must be a valid identifier of the format: [a-zA-Z][a-zA-Z0-9_\-]{0,49}.
call_options (Hash) (defaults to: nil) —
A hash of values to specify the custom call options, e.g., timeout, retries, etc. Call options are optional. The following settings can be provided:
- :timeout (Numeric) A numeric value of custom timeout in seconds that overrides the default setting.
- :retry_policy (Hash) A hash of values that overrides the default setting of retry policy with the following keys:
  - :initial_delay (Numeric) - The initial delay in seconds.
  - :max_delay (Numeric) - The max delay in seconds.
  - :multiplier (Numeric) - The incremental backoff multiplier.
  - :retry_codes (Array<String>) - The error codes that should trigger a retry.
read_lock_mode (Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode) (defaults to: nil) —
The read lock mode for the transaction. If not specified, the client-level read lock mode will be used. Can be one of the following:
- :READ_LOCK_MODE_UNSPECIFIED : The default unspecified read lock mode.
- :PESSIMISTIC : The pessimistic lock mode, where depending on the isolation level and/or lock requested, locks are acquired on read.
- :OPTIMISTIC : The optimistic lock mode, where locks are not acquired on read. Depending on the isolation level and/or lock requested on a read, data may be validated at commit time to be not changed since the transaction started.
isolation_level (::Symbol, nil) (defaults to: nil) —
Optional. The isolation level for the transaction. If not specified, the client-level isolation level will be used. Can be one of the following:
- :ISOLATION_LEVEL_UNSPECIFIED : The default unspecified isolation level.
- :SERIALIZABLE : The serializable isolation level.
- :REPEATABLE_READ : The repeatable read isolation level.

Returns:

(Time, CommitResponse) —
The timestamp at which the operation committed. If commit options are set it returns Google::Cloud::Spanner::CommitResponse.

# File 'lib/google/cloud/spanner/client.rb', line 1833

def delete table, keys = [],
           exclude_txn_from_change_streams: false,
           isolation_level: nil, commit_options: nil, request_options: nil,
           call_options: nil, read_lock_mode: nil
  request_options = Convert.to_request_options \
    request_options, tag_type: :transaction_tag

  @pool.with_session do |session|
    session.delete table, keys,
                   exclude_txn_from_change_streams: exclude_txn_from_change_streams,
                   isolation_level: isolation_level || @isolation_level,
                   commit_options: commit_options,
                   request_options: request_options,
                   call_options: call_options,
                   read_lock_mode: read_lock_mode || @read_lock_mode
  end
end

#directed_read_options ⇒ `Hash`

A hash of values to specify the custom directed read options for executing SQL query.

Returns:

(Hash)



169
170
171

# File 'lib/google/cloud/spanner/client.rb', line 169

def directed_read_options
  @directed_read_options
end

#execute_partition_update(sql, params: nil, types: nil, exclude_txn_from_change_streams: false, query_options: nil, request_options: nil, call_options: nil) ⇒ `Integer` Also known as: execute_pdml

Executes a Partitioned DML SQL statement.

Partitioned DML is an alternate implementation with looser semantics to enable large-scale changes without running into transaction size limits or (accidentally) locking the entire table in one large transaction. At a high level, it partitions the keyspace and executes the statement on each partition in separate internal transactions.

Partitioned DML does not guarantee database-wide atomicity of the statement - it guarantees row-based atomicity, which includes updates to any indices. Additionally, it does not guarantee that it will execute exactly one time against each row - it guarantees "at least once" semantics.

Where DML statements must be executed using Transaction (see Transaction#execute_update), Partitioned DML statements are executed outside of a read/write transaction.

Not all DML statements can be executed in the Partitioned DML mode and the backend will return an error for the statements which are not supported.

DML statements must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. InvalidArgumentError is raised if the statement does not qualify.

The method will block until the update is complete. Running a DML statement with this method does not offer exactly once semantics, and therefore the DML statement should be idempotent. The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. This is a Partitioned DML transaction in which a single Partitioned DML statement is executed. Partitioned DML partitions the and runs the DML statement over each partition in parallel using separate, internal transactions that commit independently. Partitioned DML transactions do not need to be committed.

Partitioned DML updates are used to execute a single DML statement with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a Transaction#execute_update transaction. Smaller scoped statements, such as an OLTP workload, should prefer using Transaction#execute_update.

That said, Partitioned DML is not a drop-in replacement for standard DML used in Transaction#execute_update.

The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table.
The statement is not applied atomically to all rows of the table. Rather, the statement is applied atomically to partitions of the table, in independent internal transactions. Secondary index rows are updated atomically with the base table rows.
Partitioned DML does not guarantee exactly-once execution semantics against a partition. The statement will be applied at least once to each partition. It is strongly recommended that the DML statement should be idempotent to avoid unexpected results. For instance, it is potentially dangerous to run a statement such as UPDATE table SET column = column + 1 as it could be run multiple times against some rows.
The partitions are committed automatically - there is no support for Commit or Rollback. If the call returns an error, or if the client issuing the DML statement dies, it is possible that some rows had the statement executed on them successfully. It is also possible that statement was never executed against other rows.
If any error is encountered during the execution of the partitioned DML operation (for instance, a UNIQUE INDEX violation, division by zero, or a value that cannot be stored due to schema constraints), then the operation is stopped at that point and an error is returned. It is possible that at this point, some partitions have been committed (or even committed multiple times), and other partitions have not been run at all.

Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new
db = spanner.client "my-instance", "my-database"

row_count = db.execute_partition_update \
 "UPDATE users SET friends = NULL WHERE active = false"

Query using query parameters:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new
db = spanner.client "my-instance", "my-database"

row_count = db.execute_partition_update \
 "UPDATE users SET friends = NULL WHERE active = @active",
 params: { active: false }

Query using query options:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new
db = spanner.client "my-instance", "my-database"

row_count = db.execute_partition_update \
 "UPDATE users SET friends = NULL WHERE active = false",
 query_options: {
   optimizer_version: "1",
   optimizer_statistics_package: "auto_20191128_14_47_22UTC"
 }

Query using custom timeout and retry policy:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new
db = spanner.client "my-instance", "my-database"

timeout = 30.0
retry_policy = {
  initial_delay: 0.25,
  max_delay:     32.0,
  multiplier:    1.3,
  retry_codes:   ["UNAVAILABLE"]
}
call_options = { timeout: timeout, retry_policy: retry_policy }

row_count = db.execute_partition_update \
 "UPDATE users SET friends = NULL WHERE active = false",
 call_options: call_options

Using request options.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new
db = spanner.client "my-instance", "my-database"

request_options = { priority: :PRIORITY_MEDIUM }
row_count = db.execute_partition_update \
 "UPDATE users SET friends = NULL WHERE active = @active",
 params: { active: false }, request_options: request_options

Query using tag for request query statistics collection.


require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new
db = spanner.client "my-instance", "my-database"

request_options = { tag: "Update-Users" }
row_count = db.execute_partition_update \
  "UPDATE users SET friends = NULL WHERE active = false",
  request_options: request_options

Parameters:

sql (String) —
The Partitioned DML statement string. See Query syntax.

The Partitioned DML statement string can contain parameter placeholders. A parameter placeholder consists of "@" followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores.

params (Hash) (defaults to: nil) —

Parameters for the Partitioned DML statement string. The parameter placeholders, minus the "@", are the the hash keys, and the literal values are the hash values. If the query string contains something like "WHERE id > @msg_id", then the params must contain something like :msg_id => 1.

Ruby types are mapped to Spanner types as follows:

Spanner	Ruby	Notes
`BOOL`	`true`/`false`
`INT64`	`Integer`
`FLOAT64`	`Float`
`FLOAT32`	`Float`
`NUMERIC`	`BigDecimal`
`STRING`	`String`
`UUID`	`String`
`DATE`	`Date`
`TIMESTAMP`	`Time`, `DateTime`
`BYTES`	`File`, `IO`, `StringIO`, or similar
`ARRAY`	`Array`	Nested arrays are not supported.
`STRUCT`	`Hash`, Data

See Data types.

See Data Types - Constructing a STRUCT.

types (Hash) (defaults to: nil) —
Types of the SQL parameters in params. It is not always possible for Cloud Spanner to infer the right SQL type from a value in params. In these cases, the types hash can be used to specify the exact SQL type for some or all of the SQL query parameters.

The keys of the hash should be query string parameter placeholders, minus the "@". The values of the hash should be Cloud Spanner type codes from the following list:
- :BOOL
- :BYTES
- :DATE
- :FLOAT64
- :FLOAT32
- :NUMERIC
- :INT64
- :STRING
- :TIMESTAMP
- :UUID
- Array - Lists are specified by providing the type code in an array. For example, an array of integers are specified as [:INT64].
- Fields - Nested Structs are specified by providing a Fields object.
exclude_txn_from_change_streams (Boolean) (defaults to: false) —
If set to true, mutations will not be recorded in change streams with DDL option allow_txn_exclusion=true.
query_options (Hash) (defaults to: nil) —
A hash of values to specify the custom query options for executing SQL query. Query options are optional. The following settings can be provided:
- :optimizer_version (String) The version of optimizer to use. Empty to use database default. "latest" to use the latest available optimizer version.
- :optimizer_statistics_package (String) Statistics package to use. Empty to use the database default.
request_options (Hash) (defaults to: nil) —
Common request options.
- :priority (String) The relative priority for requests. The priority acts as a hint to the Cloud Spanner scheduler and does not guarantee priority or order of execution. Valid values are :PRIORITY_LOW, :PRIORITY_MEDIUM, :PRIORITY_HIGH. If priority not set then default is PRIORITY_UNSPECIFIED is equivalent to :PRIORITY_HIGH.
- :tag (String) A per-request tag which can be applied to queries or reads, used for statistics collection. Tag must be a valid identifier of the form: [a-zA-Z][a-zA-Z0-9_\-] between 2 and 64 characters in length.
call_options (Hash) (defaults to: nil) —
A hash of values to specify the custom call options, e.g., timeout, retries, etc. Call options are optional. The following settings can be provided:
- :timeout (Numeric) A numeric value of custom timeout in seconds that overrides the default setting.
- :retry_policy (Hash) A hash of values that overrides the default setting of retry policy with the following keys:
  - :initial_delay (Numeric) - The initial delay in seconds.
  - :max_delay (Numeric) - The max delay in seconds.
  - :multiplier (Numeric) - The incremental backoff multiplier.
  - :retry_codes (Array<String>) - The error codes that should trigger a retry.

Returns:

(Integer) —
The lower bound number of rows that were modified.

# File 'lib/google/cloud/spanner/client.rb', line 789

def execute_partition_update sql, params: nil, types: nil,
                             exclude_txn_from_change_streams: false,
                             query_options: nil, request_options: nil,
                             call_options: nil
  ensure_service!

  params, types = Convert.to_input_params_and_types params, types
  request_options = Convert.to_request_options request_options,
                                               tag_type: :request_tag
  route_to_leader = LARHeaders.partition_query
  results = nil
  @pool.with_session do |session|
    transaction = pdml_transaction session, exclude_txn_from_change_streams: exclude_txn_from_change_streams
    results = session.execute_query \
      sql, params: params, types: types,
      transaction: transaction,
      query_options: query_options, request_options: request_options,
      call_options: call_options, route_to_leader: route_to_leader
  end
  # Stream all PartialResultSet to get ResultSetStats
  results.rows.to_a
  # Raise an error if there is not a row count returned
  if results.row_count.nil?
    raise Google::Cloud::InvalidArgumentError,
          "Partitioned DML statement is invalid."
  end
  results.row_count
end

#execute_query(sql, params: nil, types: nil, single_use: nil, query_options: nil, request_options: nil, call_options: nil, directed_read_options: nil) ⇒ `Google::Cloud::Spanner::Results` Also known as: execute, query, execute_sql

Executes a SQL query.

The following settings can be provided:

:exclude_replicas (Hash) Exclude_replicas indicates what replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list.
:include_replicas (Hash) Include_replicas indicates the order of replicas to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner will wait for a replica in the list to become available, requests may fail due to DEADLINE_EXCEEDED errors.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

results = db.execute_query "SELECT * FROM users"

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Query using query parameters:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

results = db.execute_query(
  "SELECT * FROM users WHERE active = @active",
  params: { active: true }
)

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Query with a SQL STRUCT query parameter as a Hash:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

user_hash = { id: 1, name: "Charlie", active: false }

results = db.execute_query(
  "SELECT * FROM users WHERE " \
  "ID = @user_struct.id " \
  "AND name = @user_struct.name " \
  "AND active = @user_struct.active",
  params: { user_struct: user_hash }
)

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Specify the SQL STRUCT type using Fields object:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

user_type = db.fields id: :INT64, name: :STRING, active: :BOOL
user_hash = { id: 1, name: nil, active: false }

results = db.execute_query(
  "SELECT * FROM users WHERE " \
  "ID = @user_struct.id " \
  "AND name = @user_struct.name " \
  "AND active = @user_struct.active",
  params: { user_struct: user_hash },
  types: { user_struct: user_type }
)

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Or, query with a SQL STRUCT as a typed Data object:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

user_type = db.fields id: :INT64, name: :STRING, active: :BOOL
user_data = user_type.struct id: 1, name: nil, active: false

results = db.execute_query(
  "SELECT * FROM users WHERE " \
  "ID = @user_struct.id " \
  "AND name = @user_struct.name " \
  "AND active = @user_struct.active",
  params: { user_struct: user_data }
)

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Query using query options:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

results = db.execute_query \
  "SELECT * FROM users", query_options: {
    optimizer_version: "1",
    optimizer_statistics_package: "auto_20191128_14_47_22UTC"
  }

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Query using custom timeout and retry policy:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

timeout = 30.0
retry_policy = {
  initial_delay: 0.25,
  max_delay:     32.0,
  multiplier:    1.3,
  retry_codes:   ["UNAVAILABLE"]
}
call_options = { timeout: timeout, retry_policy: retry_policy }

results = db.execute_query \
  "SELECT * FROM users", call_options: call_options

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Using request options.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { priority: :PRIORITY_MEDIUM }
results = db.execute_query "SELECT * FROM users",
                           request_options: request_options

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Query using tag for request query statistics collection.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { tag: "Read-Users" }
results = db.execute_query "SELECT * FROM users",
                           request_options: request_options

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Parameters:

sql (String) —
The SQL query string. See Query syntax.

The SQL query string can contain parameter placeholders. A parameter placeholder consists of "@" followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores.

params (Hash) (defaults to: nil) —

SQL parameters for the query string. The parameter placeholders, minus the "@", are the the hash keys, and the literal values are the hash values. If the query string contains something like "WHERE id > @msg_id", then the params must contain something like :msg_id => 1.

Ruby types are mapped to Spanner types as follows:

Spanner	Ruby	Notes
`BOOL`	`true`/`false`
`INT64`	`Integer`
`FLOAT64`	`Float`
`FLOAT32`	`Float`
`NUMERIC`	`BigDecimal`
`STRING`	`String`
`UUID`	`String`
`DATE`	`Date`
`TIMESTAMP`	`Time`, `DateTime`
`BYTES`	`File`, `IO`, `StringIO`, or similar
`ARRAY`	`Array`	Nested arrays are not supported.
`STRUCT`	`Hash`, Data

See Data types.

See Data Types - Constructing a STRUCT.

types (Hash) (defaults to: nil) —
Types of the SQL parameters in params. It is not always possible for Cloud Spanner to infer the right SQL type from a value in params. In these cases, the types hash must be used to specify the SQL type for these values.

The keys of the hash should be query string parameter placeholders, minus the "@". The values of the hash should be Cloud Spanner type codes from the following list:
- :BOOL
- :BYTES
- :DATE
- :FLOAT64
- :FLOAT32
- :NUMERIC
- :INT64
- :STRING
- :TIMESTAMP
- :UUID
- Array - Lists are specified by providing the type code in an array. For example, an array of integers are specified as [:INT64].
- Fields - Types for STRUCT values (Hash/Data objects) are specified using a Fields object.
Types are optional.
single_use (Hash) (defaults to: nil) —
Perform the read with a single-use snapshot (read-only transaction). (See TransactionOptions.) If no value is specified for this parameter, Cloud Spanner will use a single use read-only transaction with strong timestamp bound as default. The snapshot can be created by providing exactly one of the following options in the hash:
- Strong
  - :strong (true, false) Read at a timestamp where all previously committed transactions are visible.
- Exact
  - :timestamp/:read_timestamp (Time, DateTime) Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline.
  Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data.
  - :staleness/:exact_staleness (Numeric) Executes all reads at a timestamp that is exactly the number of seconds provided old. The timestamp is chosen soon after the read is started.
  Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps.
  
  Useful for reading at nearby replicas without the distributed timestamp negotiation overhead of single-use bounded_staleness.
- Bounded
  - :bounded_timestamp/:min_read_timestamp (Time, DateTime) Executes all reads at a timestamp greater than the value provided.
  This is useful for requesting fresher data than some previous read, or data that is fresh enough to observe the effects of some previously committed transaction whose timestamp is known.
  - :bounded_staleness/:max_staleness (Numeric) Read data at a timestamp greater than or equal to the number of seconds provided. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps.
  Useful for reading the freshest data available at a nearby replica, while bounding the possible staleness if the local replica has fallen behind.
query_options (Hash) (defaults to: nil) —
A hash of values to specify the custom query options for executing SQL query. Query options are optional. The following settings can be provided:
- :optimizer_version (String) The version of optimizer to use. Empty to use database default. "latest" to use the latest available optimizer version.
- :optimizer_statistics_package (String) Statistics package to use. Empty to use the database default.
request_options (Hash) (defaults to: nil) —
Common request options.
- :priority (Symbol) The relative priority for requests. The priority acts as a hint to the Cloud Spanner scheduler and does not guarantee priority or order of execution. Valid values are :PRIORITY_LOW, :PRIORITY_MEDIUM, :PRIORITY_HIGH. If priority not set then default is PRIORITY_UNSPECIFIED is equivalent to :PRIORITY_HIGH.
- :tag (String) A per-request tag which can be applied to queries or reads, used for statistics collection. Tag must be a valid identifier of the form: [a-zA-Z][a-zA-Z0-9_\-] between 2 and 64 characters in length.
call_options (Hash) (defaults to: nil) —
A hash of values to specify the custom call options, e.g., timeout, retries, etc. Call options are optional. The following settings can be provided:
- :timeout (Numeric) A numeric value of custom timeout in seconds that overrides the default setting.
- :retry_policy (Hash) A hash of values that overrides the default setting of retry policy with the following keys:
  - :initial_delay (Numeric) - The initial delay in seconds.
  - :max_delay (Numeric) - The max delay in seconds.
  - :multiplier (Numeric) - The incremental backoff multiplier.
  - :retry_codes (Array<String>) - The error codes that should trigger a retry.
directed_read_options (Hash) (defaults to: nil) —
Client options used to set the directed_read_options for all ReadRequests and ExecuteSqlRequests that indicates which replicas or regions should be used for non-transactional reads or queries. Will represent Google::Cloud::Spanner::V1::DirectedReadOptions

Returns:

(Google::Cloud::Spanner::Results) —
The results of the query execution.

# File 'lib/google/cloud/spanner/client.rb', line 509

def execute_query sql, params: nil, types: nil, single_use: nil,
                  query_options: nil, request_options: nil,
                  call_options: nil, directed_read_options: nil
  validate_single_use_args! single_use
  ensure_service!

  params, types = Convert.to_input_params_and_types params, types
  request_options = Convert.to_request_options request_options,
                                               tag_type: :request_tag
  single_use_tx = single_use_transaction single_use
  route_to_leader = LARHeaders.execute_query false
  results = nil
  @pool.with_session do |session|
    results = session.execute_query \
      sql, params: params, types: types, transaction: single_use_tx,
      query_options: query_options, request_options: request_options,
      call_options: call_options, directed_read_options: directed_read_options || @directed_read_options,
      route_to_leader: route_to_leader
  end
  results
end

#fields(types) ⇒ `Fields`

Creates a configuration object (Fields) that may be provided to queries or used to create STRUCT objects. (The STRUCT will be represented by the Data class.) See #execute and/or Fields#struct.

For more information, see Data Types - Constructing a STRUCT.

Examples:

Create a STRUCT value with named fields using Fields object:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

named_type = db.fields(
  { id: :INT64, name: :STRING, active: :BOOL }
)
named_data = named_type.struct(
  { id: 42, name: nil, active: false }
)

Create a STRUCT value with anonymous field names:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

anon_type = db.fields [:INT64, :STRING, :BOOL]
anon_data = anon_type.struct [42, nil, false]

Create a STRUCT value with duplicate field names:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

dup_type = db.fields [[:x, :INT64], [:x, :STRING], [:x, :BOOL]]
dup_data = dup_type.struct [42, nil, false]

Parameters:

types (Array, Hash) —
Accepts an array or hash types.

Arrays can contain just the type value, or a sub-array of the field's name and type value. Hash keys must contain the field name as a Symbol or String, or the field position as an Integer. Hash values must contain the type value. If a Hash is used the fields will be created using the same order as the Hash keys.

Supported type values include:
- :BOOL
- :BYTES
- :DATE
- :FLOAT64
- :FLOAT32
- :NUMERIC
- :INT64
- :STRING
- :TIMESTAMP
- Array - Lists are specified by providing the type code in an array. For example, an array of integers are specified as [:INT64].
- Fields - Nested Structs are specified by providing a Fields object.

Returns:

(Fields) —
The fields of the given types.



2548
2549
2550

# File 'lib/google/cloud/spanner/client.rb', line 2548

def fields types
  Fields.new types
end

#insert(table, rows, exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ `Time`, `CommitResponse`

Inserts new rows in a table. If any of the rows already exist, the write or request fails with AlreadyExistsError.

Changes are made immediately upon calling this method using a single-use transaction. To make multiple changes in the same single-use transaction use #commit. To make changes in a transaction that supports reads and automatic retry protection use #transaction.

Note: This method does not feature replay protection present in Transaction#insert (See #transaction). This method makes a single RPC, whereas Transaction#insert requires two RPCs (one of which may be performed in advance), and so this method may be appropriate for latency sensitive and/or high throughput blind inserts.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

db.insert "users", [{ id: 1, name: "Charlie", active: false },
                    { id: 2, name: "Harvey",  active: true }]

Get commit stats

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

records = [{ id: 1, name: "Charlie", active: false },
           { id: 2, name: "Harvey",  active: true }]
commit_options = { return_commit_stats: true }
commit_resp = db.insert "users", records, commit_options: commit_options

puts commit_resp.timestamp
puts commit_resp.stats.mutation_count

Using request options.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { priority: :PRIORITY_MEDIUM }
db.insert "users", [{ id: 1, name: "Charlie", active: false }],
                   request_options: request_options

Insert using tag for transaction statistics collection.


require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { tag: "BulkInsert-Users" }
db.insert "users", [{ id: 1, name: "Charlie", active: false },
                    { id: 2, name: "Harvey",  active: true }],
                    request_options: request_options

Parameters:

table (String) —
The name of the table in the database to be modified.

rows (Array<Hash>) —

One or more hash objects with the hash keys matching the table's columns, and the hash values matching the table's values.

Ruby types are mapped to Spanner types as follows:

Spanner	Ruby	Notes
`BOOL`	`true`/`false`
`INT64`	`Integer`
`FLOAT64`	`Float`
`FLOAT32`	`Float`
`NUMERIC`	`BigDecimal`
`STRING`	`String`
`DATE`	`Date`
`TIMESTAMP`	`Time`, `DateTime`
`BYTES`	`File`, `IO`, `StringIO`, or similar
`ARRAY`	`Array`	Nested arrays are not supported.
`PROTO`	Determined by proto_fqn

See Data types.

exclude_txn_from_change_streams (Boolean) (defaults to: false) —
If set to true, mutations will not be recorded in change streams with DDL option allow_txn_exclusion=true.
commit_options (Hash) (defaults to: nil) —
A hash of commit options. e.g., return_commit_stats. Commit options are optional. The following options can be provided:
- :return_commit_stats (Boolean) A boolean value. If true, then statistics related to the transaction will be included in Google::Cloud::Spanner::CommitResponse. Default value is false
- :maxCommitDelay (Numeric) The amount of latency in millisecond in this request is willing to incur in order to improve throughput. The commit delay must be at least 0ms and at most 500ms. Default value is nil.
request_options (Hash) (defaults to: nil) —
Common request options.
- :priority (String) The relative priority for requests. The priority acts as a hint to the Cloud Spanner scheduler and does not guarantee priority or order of execution. Valid values are :PRIORITY_LOW, :PRIORITY_MEDIUM, :PRIORITY_HIGH. If priority not set then default is PRIORITY_UNSPECIFIED is equivalent to :PRIORITY_HIGH.
- :tag (String) A tag used for statistics collection about transaction. A tag must be a valid identifier of the format: [a-zA-Z][a-zA-Z0-9_\-]{0,49}.
call_options (Hash) (defaults to: nil) —
A hash of values to specify the custom call options, e.g., timeout, retries, etc. Call options are optional. The following settings can be provided:
- :timeout (Numeric) A numeric value of custom timeout in seconds that overrides the default setting.
- :retry_policy (Hash) A hash of values that overrides the default setting of retry policy with the following keys:
  - :initial_delay (Numeric) - The initial delay in seconds.
  - :max_delay (Numeric) - The max delay in seconds.
  - :multiplier (Numeric) - The incremental backoff multiplier.
  - :retry_codes (Array<String>) - The error codes that should trigger a retry.
read_lock_mode (Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode) (defaults to: nil) —
The read lock mode for the transaction. If not specified, the client-level read lock mode will be used. Can be one of the following:
- :READ_LOCK_MODE_UNSPECIFIED : The default unspecified read lock mode.
- :PESSIMISTIC : The pessimistic lock mode, where depending on the isolation level and/or lock requested, locks are acquired on read.
- :OPTIMISTIC : The optimistic lock mode, where locks are not acquired on read. Depending on the isolation level and/or lock requested on a read, data may be validated at commit time to be not changed since the transaction started.
isolation_level (::Symbol, nil) (defaults to: nil) —
Optional. The isolation level for the transaction. If not specified, the client-level isolation level will be used. Can be one of the following:
- :ISOLATION_LEVEL_UNSPECIFIED : The default unspecified isolation level.
- :SERIALIZABLE : The serializable isolation level.
- :REPEATABLE_READ : The repeatable read isolation level.

Returns:

(Time, CommitResponse) —
The timestamp at which the operation committed. If commit options are set it returns Google::Cloud::Spanner::CommitResponse.

# File 'lib/google/cloud/spanner/client.rb', line 1364

def insert table, rows,
           exclude_txn_from_change_streams: false,
           isolation_level: nil, commit_options: nil, request_options: nil,
           call_options: nil, read_lock_mode: nil
  request_options = Convert.to_request_options \
    request_options, tag_type: :transaction_tag

  @pool.with_session do |session|
    session.insert table, rows,
                   exclude_txn_from_change_streams: exclude_txn_from_change_streams,
                   isolation_level: isolation_level || @isolation_level,
                   commit_options: commit_options,
                   request_options: request_options,
                   call_options: call_options,
                   read_lock_mode: read_lock_mode || @read_lock_mode
  end
end

#instance ⇒ `Instance`

The Spanner instance connected to.

Returns:

(Instance)



143
144
145

# File 'lib/google/cloud/spanner/client.rb', line 143

def instance
  @project.instance instance_id
end

#instance_id ⇒ `String`

The unique identifier for the instance.

Returns:

(String)



125
126
127

# File 'lib/google/cloud/spanner/client.rb', line 125

def instance_id
  @instance_id
end

#project ⇒ `::Google::Cloud::Spanner::Project`

The Spanner project connected to.

Returns:

(::Google::Cloud::Spanner::Project)



137
138
139

# File 'lib/google/cloud/spanner/client.rb', line 137

def project
  @project
end

#project_id ⇒ `String`

The unique identifier for the project.

Returns:

(String)



119
120
121

# File 'lib/google/cloud/spanner/client.rb', line 119

def project_id
  @project.service.project
end

#query_options ⇒ `Hash`

A hash of values to specify the custom query options for executing SQL query.

Returns:

(Hash)



162
163
164

# File 'lib/google/cloud/spanner/client.rb', line 162

def query_options
  @query_options
end

#range(beginning, ending, exclude_begin: false, exclude_end: false) ⇒ `Google::Cloud::Spanner::Range`

Creates a Spanner Range. This can be used in place of a Ruby Range when needing to exclude the beginning value.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

key_range = db.range 1, 100
results = db.read "users", [:id, :name], keys: key_range

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Parameters:

beginning (Object) —
The object that defines the beginning of the range.
ending (Object) —
The object that defines the end of the range.
exclude_begin (Boolean) (defaults to: false) —
Determines if the range excludes its beginning value. Default is false.
exclude_end (Boolean) (defaults to: false) —
Determines if the range excludes its ending value. Default is false.

Returns:

(Google::Cloud::Spanner::Range) —
The new Range instance.

# File 'lib/google/cloud/spanner/client.rb', line 2605

def range beginning, ending, exclude_begin: false, exclude_end: false
  Range.new beginning, ending,
            exclude_begin: exclude_begin,
            exclude_end: exclude_end
end

#read(table, columns, keys: nil, index: nil, limit: nil, single_use: nil, request_options: nil, call_options: nil, directed_read_options: nil, order_by: nil, lock_hint: nil) ⇒ `Google::Cloud::Spanner::Results`

Read rows from a database table, as a simple alternative to #execute_query.

The following settings can be provided:

:exclude_replicas (Hash) Exclude_replicas indicates what replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list.
:include_replicas (Hash) Include_replicas indicates the order of replicas to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner will wait for a replica in the list to become available, requests may fail due to DEADLINE_EXCEEDED errors.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

results = db.read "users", [:id, :name]

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Use the `keys` option to pass keys and/or key ranges to read.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

results = db.read "users", [:id, :name], keys: 1..5

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Read using custom timeout and retry.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

timeout = 30.0
retry_policy = {
  initial_delay: 0.25,
  max_delay:     32.0,
  multiplier:    1.3,
  retry_codes:   ["UNAVAILABLE"]
}
call_options = { timeout: timeout, retry_policy: retry_policy }

results = db.read "users", [:id, :name], call_options: call_options

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Using request options.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { priority: :PRIORITY_MEDIUM }
results = db.read "users", [:id, :name],
                  request_options: request_options

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Read using tag for read statistics collection.


require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { tag: "Read-Users-All" }
results = db.read "users", [:id, :name],
                  request_options: request_options

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Parameters:

table (String) —
The name of the table in the database to be read.
columns (Array<String, Symbol>) —
The columns of table to be returned for each row matching this request.
keys (Object, Array<Object>) (defaults to: nil) —
A single, or list of keys or key ranges to match returned data to. Values should have exactly as many elements as there are columns in the primary key.
index (String) (defaults to: nil) —
The name of an index to use instead of the table's primary key when interpreting id and sorting result rows. Optional.
limit (Integer) (defaults to: nil) —
If greater than zero, no more than this number of rows will be returned. The default is no limit.
single_use (Hash) (defaults to: nil) —
Perform the read with a single-use snapshot (read-only transaction). (See TransactionOptions.) If no value is specified for this parameter, Cloud Spanner will use a single use read-only transaction with strong timestamp bound as default. The snapshot can be created by providing exactly one of the following options in the hash:
- Strong
  - :strong (true, false) Read at a timestamp where all previously committed transactions are visible.
- Exact
  - :timestamp/:read_timestamp (Time, DateTime) Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline.
  Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data.
  - :staleness/:exact_staleness (Numeric) Executes all reads at a timestamp that is exactly the number of seconds provided old. The timestamp is chosen soon after the read is started.
  Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps.
  
  Useful for reading at nearby replicas without the distributed timestamp negotiation overhead of single-use bounded_staleness.
- Bounded
  - :bounded_timestamp/:min_read_timestamp (Time, DateTime) Executes all reads at a timestamp greater than the value provided.
  This is useful for requesting fresher data than some previous read, or data that is fresh enough to observe the effects of some previously committed transaction whose timestamp is known.
  - :bounded_staleness/:max_staleness (Numeric) Read data at a timestamp greater than or equal to the number of seconds provided. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps.
  Useful for reading the freshest data available at a nearby replica, while bounding the possible staleness if the local replica has fallen behind.
request_options (Hash) (defaults to: nil) —
Common request options.
- :priority (Symbol) The relative priority for requests. The priority acts as a hint to the Cloud Spanner scheduler and does not guarantee priority or order of execution. Valid values are :PRIORITY_LOW, :PRIORITY_MEDIUM, :PRIORITY_HIGH. If priority not set then default is PRIORITY_UNSPECIFIED is equivalent to :PRIORITY_HIGH.
- :tag (String) A per-request tag which can be applied to queries or reads, used for statistics collection. Tag must be a valid identifier of the form: [a-zA-Z][a-zA-Z0-9_\-] between 2 and 64 characters in length.
call_options (Hash) (defaults to: nil) —
A hash of values to specify the custom call options, e.g., timeout, retries, etc. Call options are optional. The following settings can be provided:
- :timeout (Numeric) A numeric value of custom timeout in seconds that overrides the default setting.
- :retry_policy (Hash) A hash of values that overrides the default setting of retry policy with the following keys:
  - :initial_delay (Numeric) - The initial delay in seconds.
  - :max_delay (Numeric) - The max delay in seconds.
  - :multiplier (Numeric) - The incremental backoff multiplier.
  - :retry_codes (Array<String>) - The error codes that should trigger a retry.
directed_read_options (Hash) (defaults to: nil) —
Client options used to set the directed_read_options for all ReadRequests and ExecuteSqlRequests that indicates which replicas or regions should be used for non-transactional reads or queries. Will represent Google::Cloud::Spanner::V1::DirectedReadOptions
order_by (::Google::Cloud::Spanner::V1::ReadRequest::OrderBy) (defaults to: nil) —
An option to control the order in which rows are returned from a read. To see the available options refer to Google::Cloud::Spanner::V1::ReadRequest::OrderBy
lock_hint (::Google::Cloud::Spanner::V1::ReadRequest::LockHint) (defaults to: nil) —
A lock hint mechanism for reads done within a transaction. To see the available options refer to Google::Cloud::Spanner::V1::ReadRequest::LockHint

Returns:

(Google::Cloud::Spanner::Results) —
The results of the read.

# File 'lib/google/cloud/spanner/client.rb', line 1019

def read table, columns, keys: nil, index: nil, limit: nil,
         single_use: nil, request_options: nil, call_options: nil,
         directed_read_options: nil, order_by: nil, lock_hint: nil
  validate_single_use_args! single_use
  ensure_service!

  columns = Array(columns).map(&:to_s)
  keys = Convert.to_key_set keys
  single_use_tx = single_use_transaction single_use
  route_to_leader = LARHeaders.read false
  request_options = Convert.to_request_options request_options,
                                               tag_type: :request_tag

  results = nil
  @pool.with_session do |session|
    results = session.read \
      table, columns, keys: keys, index: index, limit: limit,
                      transaction: single_use_tx,
                      request_options: request_options,
                      call_options: call_options,
                      directed_read_options: directed_read_options || @directed_read_options,
                      route_to_leader: route_to_leader,
                      order_by: order_by,
                      lock_hint: lock_hint
  end
  results
end

#replace(table, rows, exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ `Time`, `CommitResponse`

Inserts or replaces rows in a table. If any of the rows already exist, it is deleted, and the column values provided are inserted instead. Unlike #upsert, this means any values not explicitly written become NULL.

Changes are made immediately upon calling this method using a single-use transaction. To make multiple changes in the same single-use transaction use #commit. To make changes in a transaction that supports reads and automatic retry protection use #transaction.

Note: This method does not feature replay protection present in Transaction#replace (See #transaction). This method makes a single RPC, whereas Transaction#replace requires two RPCs (one of which may be performed in advance), and so this method may be appropriate for latency sensitive and/or high throughput blind replaces.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

db.replace "users", [{ id: 1, name: "Charlie", active: false },
                     { id: 2, name: "Harvey",  active: true }]

Get commit stats

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

records = [{ id: 1, name: "Charlie", active: false },
           { id: 2, name: "Harvey",  active: true }]
commit_options = { return_commit_stats: true }
commit_resp = db.replace "users", records, commit_options: commit_options

puts commit_resp.timestamp
puts commit_resp.stats.mutation_count

Using request options.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { priority: :PRIORITY_MEDIUM }
db.replace "users", [{ id: 1, name: "Charlie", active: false }],
                    request_options: request_options

Replace using tag for transaction statistics collection.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { tag: "BulkReplace-Users" }
db.replace "users", [{ id: 1, name: "Charlie", active: false },
                     { id: 2, name: "Harvey",  active: true }],
                    request_options: request_options

Parameters:

table (String) —
The name of the table in the database to be modified.

rows (Array<Hash>) —

One or more hash objects with the hash keys matching the table's columns, and the hash values matching the table's values.

Ruby types are mapped to Spanner types as follows:

Spanner	Ruby	Notes
`BOOL`	`true`/`false`
`INT64`	`Integer`
`FLOAT64`	`Float`
`FLOAT32`	`Float`
`NUMERIC`	`BigDecimal`
`STRING`	`String`
`DATE`	`Date`
`TIMESTAMP`	`Time`, `DateTime`
`BYTES`	`File`, `IO`, `StringIO`, or similar
`ARRAY`	`Array`	Nested arrays are not supported.
`PROTO`	Determined by proto_fqn

See Data types.

exclude_txn_from_change_streams (Boolean) (defaults to: false) —
If set to true, mutations will not be recorded in change streams with DDL option allow_txn_exclusion=true.
commit_options (Hash) (defaults to: nil) —
A hash of commit options. e.g., return_commit_stats. Commit options are optional. The following options can be provided:
- :return_commit_stats (Boolean) A boolean value. If true, then statistics related to the transaction will be included in Google::Cloud::Spanner::CommitResponse. Default value is false
- :maxCommitDelay (Numeric) The amount of latency in millisecond in this request is willing to incur in order to improve throughput. The commit delay must be at least 0ms and at most 500ms. Default value is nil.
request_options (Hash) (defaults to: nil) —
Common request options.
- :priority (String) The relative priority for requests. The priority acts as a hint to the Cloud Spanner scheduler and does not guarantee priority or order of execution. Valid values are :PRIORITY_LOW, :PRIORITY_MEDIUM, :PRIORITY_HIGH. If priority not set then default is PRIORITY_UNSPECIFIED is equivalent to :PRIORITY_HIGH.
- :tag (String) A tag used for statistics collection about transaction. A tag must be a valid identifier of the format: [a-zA-Z][a-zA-Z0-9_\-]{0,49}.
call_options (Hash) (defaults to: nil) —
A hash of values to specify the custom call options, e.g., timeout, retries, etc. Call options are optional. The following settings can be provided:
- :timeout (Numeric) A numeric value of custom timeout in seconds that overrides the default setting.
- :retry_policy (Hash) A hash of values that overrides the default setting of retry policy with the following keys:
  - :initial_delay (Numeric) - The initial delay in seconds.
  - :max_delay (Numeric) - The max delay in seconds.
  - :multiplier (Numeric) - The incremental backoff multiplier.
  - :retry_codes (Array<String>) - The error codes that should trigger a retry.
read_lock_mode (Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode) (defaults to: nil) —
The read lock mode for the transaction. If not specified, the client-level read lock mode will be used. Can be one of the following:
- :READ_LOCK_MODE_UNSPECIFIED : The default unspecified read lock mode.
- :PESSIMISTIC : The pessimistic lock mode, where depending on the isolation level and/or lock requested, locks are acquired on read.
- :OPTIMISTIC : The optimistic lock mode, where locks are not acquired on read. Depending on the isolation level and/or lock requested on a read, data may be validated at commit time to be not changed since the transaction started.
isolation_level (::Symbol, nil) (defaults to: nil) —
Optional. The isolation level for the transaction. If not specified, the client-level isolation level will be used. Can be one of the following:
- :ISOLATION_LEVEL_UNSPECIFIED : The default unspecified isolation level.
- :SERIALIZABLE : The serializable isolation level.
- :REPEATABLE_READ : The repeatable read isolation level.

Returns:

(Time, CommitResponse) —
The timestamp at which the operation committed. If commit options are set it returns Google::Cloud::Spanner::CommitResponse.

# File 'lib/google/cloud/spanner/client.rb', line 1696

def replace table, rows,
            exclude_txn_from_change_streams: false,
            isolation_level: nil, commit_options: nil, request_options: nil,
            call_options: nil, read_lock_mode: nil
  @pool.with_session do |session|
    session.replace table, rows,
                    exclude_txn_from_change_streams: exclude_txn_from_change_streams,
                    isolation_level: isolation_level || @isolation_level,
                    commit_options: commit_options,
                    request_options: request_options,
                    call_options: call_options,
                    read_lock_mode: read_lock_mode || @read_lock_mode
  end
end

#reset! ⇒ `Object`

Reset the client sessions.



2650
2651
2652

# File 'lib/google/cloud/spanner/client.rb', line 2650

def reset!
  @pool.reset!
end

#snapshot(strong: nil, timestamp: nil, read_timestamp: nil, staleness: nil, exact_staleness: nil, call_options: nil) {|snapshot| ... } ⇒ `Object`

Creates a snapshot read-only transaction for reads that execute atomically at a single logical point in time across columns, rows, and tables in a database. For transactions that only read, snapshot read-only transactions provide simpler semantics and are almost always faster than read-write transactions.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new
db = spanner.client "my-instance", "my-database"

db.snapshot do |snp|
  results = snp.execute_query "SELECT * FROM users"

  results.rows.each do |row|
    puts "User #{row[:id]} is #{row[:name]}"
  end
end

Parameters:

strong (true, false) (defaults to: nil) —
Read at a timestamp where all previously committed transactions are visible.
timestamp (Time, DateTime) (defaults to: nil) —
Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline.

Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data. (See TransactionOptions.)
read_timestamp (Time, DateTime) (defaults to: nil) —
Same as timestamp.
staleness (Numeric) (defaults to: nil) —
Executes all reads at a timestamp that is staleness seconds old. For example, the number 10.1 is translated to 10 seconds and 100 milliseconds.

Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps.

Useful for reading at nearby replicas without the distributed timestamp negotiation overhead of single-use staleness. (See TransactionOptions.)
exact_staleness (Numeric) (defaults to: nil) —
Same as staleness.
call_options (Hash) (defaults to: nil) —
A hash of values to specify the custom call options, e.g., timeout, retries, etc. Call options are optional. The following settings can be provided:
- :timeout (Numeric) A numeric value of custom timeout in seconds that overrides the default setting.
- :retry_policy (Hash) A hash of values that overrides the default setting of retry policy with the following keys:
  - :initial_delay (Numeric) - The initial delay in seconds.
  - :max_delay (Numeric) - The max delay in seconds.
  - :multiplier (Numeric) - The incremental backoff multiplier.
  - :retry_codes (Array<String>) - The error codes that should trigger a retry.

Yields:

(snapshot) —
The block for reading and writing data.

Yield Parameters:

snapshot (Google::Cloud::Spanner::Snapshot) —
The Snapshot object.

# File 'lib/google/cloud/spanner/client.rb', line 2451

def snapshot strong: nil, timestamp: nil, read_timestamp: nil,
             staleness: nil, exact_staleness: nil, call_options: nil
  validate_snapshot_args! strong: strong, timestamp: timestamp,
                          read_timestamp: read_timestamp,
                          staleness: staleness,
                          exact_staleness: exact_staleness

  ensure_service!
  unless Thread.current[IS_TRANSACTION_RUNNING_KEY].nil?
    raise "Nested snapshots are not allowed"
  end

  @pool.with_session do |session|
    snp_grpc = @project.service.create_snapshot \
      session.path, strong: strong,
                    timestamp: timestamp || read_timestamp,
                    staleness: staleness || exact_staleness,
                    call_options: call_options
    Thread.current[IS_TRANSACTION_RUNNING_KEY] = true
    snp = Snapshot.from_grpc snp_grpc, session, directed_read_options: @directed_read_options
    yield snp if block_given?
  ensure
    Thread.current[IS_TRANSACTION_RUNNING_KEY] = nil
  end
  nil
end

#transaction(deadline: 120, exclude_txn_from_change_streams: false, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil, isolation_level: nil) {|transaction| ... } ⇒ `Time`, `CommitResponse`

Creates a transaction for reads and writes that execute atomically at a single logical point in time across columns, rows, and tables in a database.

The transaction will always commit unless an error is raised. If the error raised is Rollback the transaction method will return without passing on the error. All other errors will be passed on.

All changes are accumulated in memory until the block completes. Transactions will be automatically retried when possible, until deadline is reached. This operation makes separate API requests to begin and commit the transaction.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new
db = spanner.client "my-instance", "my-database"

db.transaction do |tx|
  results = tx.execute_query "SELECT * FROM users"

  results.rows.each do |row|
    puts "User #{row[:id]} is #{row[:name]}"
  end

  tx.update "users", [{ id: 1, name: "Charlie", active: false }]
  tx.insert "users", [{ id: 2, name: "Harvey",  active: true }]
end

Manually rollback the transaction using Rollback:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new
db = spanner.client "my-instance", "my-database"

db.transaction do |tx|
  tx.update "users", [{ id: 1, name: "Charlie", active: false }]
  tx.insert "users", [{ id: 2, name: "Harvey",  active: true }]

  if something_wrong?
    # Rollback the transaction without passing on the error
    # outside of the transaction method.
    raise Google::Cloud::Spanner::Rollback
  end
end

Get commit stats

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new
db = spanner.client "my-instance", "my-database"

commit_options = { return_commit_stats: true }
commit_resp = db.transaction commit_options: commit_options do |tx|
  results = tx.execute_query "SELECT * FROM users"

  results.rows.each do |row|
    puts "User #{row[:id]} is #{row[:name]}"
  end

  tx.update "users", [{ id: 1, name: "Charlie", active: false }]
  tx.insert "users", [{ id: 2, name: "Harvey",  active: true }]
end

puts commit_resp.timestamp
puts commit_resp.stats.mutation_count

Using request options.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new
db = spanner.client "my-instance", "my-database"

db.transaction request_options: { priority: :PRIORITY_MEDIUM } do |tx|
  tx.update "users", [{ id: 1, name: "Charlie", active: false }]
  tx.insert "users", [{ id: 2, name: "Harvey",  active: true }]

  request_options = { priority: :PRIORITY_LOW }
  results = tx.execute_query "SELECT * FROM users",
                            request_options: request_options
end

Tags for request and transaction statistics collection.


require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new
db = spanner.client "my-instance", "my-database"

# Transaction tag will be set to "Users-Txn"
db.transaction request_options: { tag: "Users-Txn" } do |tx|
  # The transaction tag set as "Users-Txn"
  # The request tag set as "Users-Txn-1"
  request_options = { tag: "Users-Txn-1" }
  results = tx.execute_query "SELECT * FROM users",
                             request_options: request_options

  results.rows.each do |row|
    puts "User #{row[:id]} is #{row[:name]}"
  end

  # The transaction tag set as "Users-Txn"
  tx.update "users", [{ id: 1, name: "Charlie", active: false }]
  tx.insert "users", [{ id: 2, name: "Harvey",  active: true }]
end

Parameters:

deadline (Numeric) (defaults to: 120) —
The total amount of time in seconds the transaction has to succeed. The default is 120.
exclude_txn_from_change_streams (Boolean) (defaults to: false) —
If set to true, mutations will not be recorded in change streams with DDL option allow_txn_exclusion=true.
commit_options (Hash) (defaults to: nil) —
A hash of commit options. e.g., return_commit_stats. Commit options are optional. The following options can be provided:
- :return_commit_stats (Boolean) A boolean value. If true, then statistics related to the transaction will be included in Google::Cloud::Spanner::CommitResponse. Default value is false
- :maxCommitDelay (Numeric) The amount of latency in millisecond in this request is willing to incur in order to improve throughput. The commit delay must be at least 0ms and at most 500ms. Default value is nil.
request_options (Hash) (defaults to: nil) —
Common request options.
- :priority (String) The relative priority for requests. The priority acts as a hint to the Cloud Spanner scheduler and does not guarantee priority or order of execution. Valid values are :PRIORITY_LOW, :PRIORITY_MEDIUM, :PRIORITY_HIGH. If priority not set then default is PRIORITY_UNSPECIFIED is equivalent to :PRIORITY_HIGH.
- :tag (String)A tag used for statistics collection about transaction. The value of a transaction tag should be the same for all requests belonging to the same transaction. A tag must be a valid identifier of the format: [a-zA-Z][a-zA-Z0-9_\-]{0,49}
call_options (Hash) (defaults to: nil) —
A hash of values to specify the custom call options, e.g., timeout, retries, etc. Call options are optional. The following settings can be provided:
- :timeout (Numeric) A numeric value of custom timeout in seconds that overrides the default setting.
- :retry_policy (Hash) A hash of values that overrides the default setting of retry policy with the following keys:
  - :initial_delay (Numeric) - The initial delay in seconds.
  - :max_delay (Numeric) - The max delay in seconds.
  - :multiplier (Numeric) - The incremental backoff multiplier.
  - :retry_codes (Array<String>) - The error codes that should trigger a retry.
read_lock_mode (Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode) (defaults to: nil) —
The read lock mode for the transaction. If not specified, the client-level read lock mode will be used. Can be one of the following:
- :READ_LOCK_MODE_UNSPECIFIED : The default unspecified read lock mode.
- :PESSIMISTIC : The pessimistic lock mode, where depending on the isolation level and/or lock requested, locks are acquired on read.
- :OPTIMISTIC : The optimistic lock mode, where locks are not acquired on read. Depending on the isolation level and/or lock requested on a read, data may be validated at commit time to be not changed since the transaction started.
isolation_level (::Symbol, nil) (defaults to: nil) —
Optional. The isolation level for the transaction. If not specified, the client-level isolation level will be used. Can be one of the following:
- :ISOLATION_LEVEL_UNSPECIFIED : The default unspecified isolation level.
- :SERIALIZABLE : The serializable isolation level.
- :REPEATABLE_READ : The repeatable read isolation level.

Yields:

(transaction) —
The block for reading and writing data.

Yield Parameters:

transaction (Google::Cloud::Spanner::Transaction) —
The Transaction object.

Returns:

(Time, CommitResponse) —
The timestamp at which the operation committed. If commit options are set it returns Google::Cloud::Spanner::CommitResponse.

# File 'lib/google/cloud/spanner/client.rb', line 2282

def transaction deadline: 120, exclude_txn_from_change_streams: false,
                commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil,
                isolation_level: nil
  ensure_service!
  unless Thread.current[IS_TRANSACTION_RUNNING_KEY].nil?
    raise "Nested transactions are not allowed"
  end

  deadline = validate_deadline deadline
  backoff = 1.0
  start_time = current_time

  request_options = Convert.to_request_options \
    request_options, tag_type: :transaction_tag

  @pool.with_session do |session|
    transaction_tag = request_options[:transaction_tag] if request_options
    tx = session.create_empty_transaction \
      exclude_txn_from_change_streams: exclude_txn_from_change_streams,
      read_lock_mode: read_lock_mode || @read_lock_mode,
      transaction_tag: transaction_tag,
      isolation_level: isolation_level || @isolation_level

    begin
      Thread.current[IS_TRANSACTION_RUNNING_KEY] = true
      yield tx

      unless tx.existing_transaction?
        # This typically will happen if the yielded `tx` object was only used to add mutations.
        # Then it never called any RPCs and didn't create a server-side Transaction object.
        # In which case we should make an explicit BeginTransaction call here.

        tx.safe_begin_transaction!(
          exclude_from_change_streams: exclude_txn_from_change_streams,
          request_options: request_options,
          call_options: call_options,
          read_lock_mode: read_lock_mode
        )
      end

      transaction_id = tx.transaction_id

      # This "inner retry" mechanism is for Commit Response protocol.
      # Unlike the retry on `Aborted` errors it will not re-create a transaction.
      # This is intentional, as these retries are not related to e.g.
      # transactions deadlocking, so it's OK to retry "as-is".
      should_retry = true
      while should_retry
        commit_resp = @project.service.commit(
          tx.session.path,
          tx.mutations,
          transaction_id: transaction_id,
          exclude_txn_from_change_streams: exclude_txn_from_change_streams,
          commit_options: commit_options,
          request_options: request_options,
          call_options: call_options,
          precommit_token: tx.precommit_token,
          read_lock_mode: read_lock_mode
        )

        tx.precommit_token = commit_resp.precommit_token
        should_retry = !commit_resp.precommit_token.nil?
      end

      resp = CommitResponse.from_grpc commit_resp
      commit_options ? resp : resp.timestamp
    rescue GRPC::Aborted,
           Google::Cloud::AbortedError,
           GRPC::Internal,
           Google::Cloud::InternalError => e
      check_and_propagate_err! e, (current_time - start_time > deadline)
      # Sleep the amount from RetryDelay, or incremental backoff
      sleep(delay_from_aborted(e) || backoff *= 1.3)

      # Create new transaction on the session and retry the block
      previous_transaction_id = tx.transaction_id if tx.existing_transaction?
      tx = session.create_empty_transaction(
        exclude_txn_from_change_streams: exclude_txn_from_change_streams,
        previous_transaction_id: previous_transaction_id,
        read_lock_mode: read_lock_mode,
        transaction_tag: transaction_tag
      )
      retry
    rescue StandardError => e
      # Rollback transaction when handling unexpected error
      tx.session.rollback tx.transaction_id if tx.existing_transaction?
      # Return nil if raised with rollback.
      return nil if e.is_a? Rollback
      # Re-raise error.
      raise e
    ensure
      Thread.current[IS_TRANSACTION_RUNNING_KEY] = nil
    end
  end
end

#update(table, rows, exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ `Time`, `CommitResponse`

Updates existing rows in a table. If any of the rows does not already exist, the request fails with NotFoundError.

Changes are made immediately upon calling this method using a single-use transaction. To make multiple changes in the same single-use transaction use #commit. To make changes in a transaction that supports reads and automatic retry protection use #transaction.

Note: This method does not feature replay protection present in Transaction#update (See #transaction). This method makes a single RPC, whereas Transaction#update requires two RPCs (one of which may be performed in advance), and so this method may be appropriate for latency sensitive and/or high throughput blind updates.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

db.update "users", [{ id: 1, name: "Charlie", active: false },
                    { id: 2, name: "Harvey",  active: true }]

Get commit stats

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

records = [{ id: 1, name: "Charlie", active: false },
           { id: 2, name: "Harvey",  active: true }]
commit_options = { return_commit_stats: true }
commit_resp = db.update "users", records, commit_options: commit_options

puts commit_resp.timestamp
puts commit_resp.stats.mutation_count

Using request options.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { priority: :PRIORITY_MEDIUM }
db.update "users", [{ id: 1, name: "Charlie", active: false }],
                   request_options: request_options

Updte using tag for transaction statistics collection.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { tag: "BulkUpdate-Users" }
db.update "users", [{ id: 1, name: "Charlie", active: false },
                    { id: 2, name: "Harvey",  active: true }],
                   request_options: request_options

Parameters:

table (String) —
The name of the table in the database to be modified.

rows (Array<Hash>) —

One or more hash objects with the hash keys matching the table's columns, and the hash values matching the table's values.

Ruby types are mapped to Spanner types as follows:

Spanner	Ruby	Notes
`BOOL`	`true`/`false`
`INT64`	`Integer`
`FLOAT64`	`Float`
`FLOAT32`	`Float`
`NUMERIC`	`BigDecimal`
`STRING`	`String`
`DATE`	`Date`
`TIMESTAMP`	`Time`, `DateTime`
`BYTES`	`File`, `IO`, `StringIO`, or similar
`ARRAY`	`Array`	Nested arrays are not supported.
`PROTO`	Determined by proto_fqn

See Data types.

exclude_txn_from_change_streams (Boolean) (defaults to: false) —
If set to true, mutations will not be recorded in change streams with DDL option allow_txn_exclusion=true.
commit_options (Hash) (defaults to: nil) —
A hash of commit options. e.g., return_commit_stats. Commit options are optional. The following options can be provided:
- :return_commit_stats (Boolean) A boolean value. If true, then statistics related to the transaction will be included in Google::Cloud::Spanner::CommitResponse. Default value is false
- :maxCommitDelay (Numeric) The amount of latency in millisecond in this request is willing to incur in order to improve throughput. The commit delay must be at least 0ms and at most 500ms. Default value is nil.
request_options (Hash) (defaults to: nil) —
Common request options.
- :priority (String) The relative priority for requests. The priority acts as a hint to the Cloud Spanner scheduler and does not guarantee priority or order of execution. Valid values are :PRIORITY_LOW, :PRIORITY_MEDIUM, :PRIORITY_HIGH. If priority not set then default is PRIORITY_UNSPECIFIED is equivalent to :PRIORITY_HIGH.
- :tag (String) A tag used for statistics collection about transaction. A tag must be a valid identifier of the format: [a-zA-Z][a-zA-Z0-9_\-]{0,49}.
call_options (Hash) (defaults to: nil) —
A hash of values to specify the custom call options, e.g., timeout, retries, etc. Call options are optional. The following settings can be provided:
- :timeout (Numeric) A numeric value of custom timeout in seconds that overrides the default setting.
- :retry_policy (Hash) A hash of values that overrides the default setting of retry policy with the following keys:
  - :initial_delay (Numeric) - The initial delay in seconds.
  - :max_delay (Numeric) - The max delay in seconds.
  - :multiplier (Numeric) - The incremental backoff multiplier.
  - :retry_codes (Array<String>) - The error codes that should trigger a retry.
read_lock_mode (Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode) (defaults to: nil) —
The read lock mode for the transaction. If not specified, the client-level read lock mode will be used. Can be one of the following:
- :READ_LOCK_MODE_UNSPECIFIED : The default unspecified read lock mode.
- :PESSIMISTIC : The pessimistic lock mode, where depending on the isolation level and/or lock requested, locks are acquired on read.
- :OPTIMISTIC : The optimistic lock mode, where locks are not acquired on read. Depending on the isolation level and/or lock requested on a read, data may be validated at commit time to be not changed since the transaction started.
isolation_level (::Symbol, nil) (defaults to: nil) —
Optional. The isolation level for the transaction. If not specified, the client-level isolation level will be used. Can be one of the following:
- :ISOLATION_LEVEL_UNSPECIFIED : The default unspecified isolation level.
- :SERIALIZABLE : The serializable isolation level.
- :REPEATABLE_READ : The repeatable read isolation level.

Returns:

(Time, CommitResponse) —
The timestamp at which the operation committed. If commit options are set it returns Google::Cloud::Spanner::CommitResponse.

# File 'lib/google/cloud/spanner/client.rb', line 1529

def update table, rows,
           exclude_txn_from_change_streams: false,
           isolation_level: nil, commit_options: nil, request_options: nil,
           call_options: nil, read_lock_mode: nil
  request_options = Convert.to_request_options \
    request_options, tag_type: :transaction_tag

  @pool.with_session do |session|
    session.update table, rows,
                   exclude_txn_from_change_streams: exclude_txn_from_change_streams,
                   isolation_level: isolation_level || @isolation_level,
                   commit_options: commit_options,
                   request_options: request_options,
                   call_options: call_options,
                   read_lock_mode: read_lock_mode || @read_lock_mode
  end
end

#upsert(table, rows, exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ `Time`, `CommitResponse` Also known as: save

Inserts or updates rows in a table. If any of the rows already exist, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved.

Changes are made immediately upon calling this method using a single-use transaction. To make multiple changes in the same single-use transaction use #commit. To make changes in a transaction that supports reads and automatic retry protection use #transaction.

Note: This method does not feature replay protection present in Transaction#upsert (See #transaction). This method makes a single RPC, whereas Transaction#upsert requires two RPCs (one of which may be performed in advance), and so this method may be appropriate for latency sensitive and/or high throughput blind upserts.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

db.upsert "users", [{ id: 1, name: "Charlie", active: false },
                    { id: 2, name: "Harvey",  active: true }]

Get commit stats

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

records = [{ id: 1, name: "Charlie", active: false },
           { id: 2, name: "Harvey",  active: true }]
commit_options = { return_commit_stats: true }
commit_resp = db.upsert "users", records, commit_options: commit_options

puts commit_resp.timestamp
puts commit_resp.stats.mutation_count

Using request options.

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { priority: :PRIORITY_MEDIUM }
db.upsert "users", [{ id: 1, name: "Charlie", active: false }],
                   request_options: request_options

Upsert using tag for transaction statistics collection.


require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

request_options = { tag: "Bulk-Upsert" }
db.upsert "users", [{ id: 1, name: "Charlie", active: false },
                    { id: 2, name: "Harvey",  active: true }],
                    request_options: request_options

Parameters:

table (String) —
The name of the table in the database to be modified.

rows (Array<Hash>) —

One or more hash objects with the hash keys matching the table's columns, and the hash values matching the table's values.

Ruby types are mapped to Spanner types as follows:

Spanner	Ruby	Notes
`BOOL`	`true`/`false`
`INT64`	`Integer`
`FLOAT64`	`Float`
`FLOAT32`	`Float`
`NUMERIC`	`BigDecimal`
`STRING`	`String`
`DATE`	`Date`
`TIMESTAMP`	`Time`, `DateTime`
`BYTES`	`File`, `IO`, `StringIO`, or similar
`ARRAY`	`Array`	Nested arrays are not supported.
`PROTO`	Determined by proto_fqn

See Data types.

exclude_txn_from_change_streams (Boolean) (defaults to: false) —
If set to true, mutations will not be recorded in change streams with DDL option allow_txn_exclusion=true.
commit_options (Hash) (defaults to: nil) —
A hash of commit options. e.g., return_commit_stats. Commit options are optional. The following options can be provided:
- :return_commit_stats (Boolean) A boolean value. If true, then statistics related to the transaction will be included in Google::Cloud::Spanner::CommitResponse. Default value is false
- :maxCommitDelay (Numeric) The amount of latency in millisecond in this request is willing to incur in order to improve throughput. The commit delay must be at least 0ms and at most 500ms. Default value is nil.
request_options (Hash) (defaults to: nil) —
Common request options.
- :priority (String) The relative priority for requests. The priority acts as a hint to the Cloud Spanner scheduler and does not guarantee priority or order of execution. Valid values are :PRIORITY_LOW, :PRIORITY_MEDIUM, :PRIORITY_HIGH. If priority not set then default is PRIORITY_UNSPECIFIED is equivalent to :PRIORITY_HIGH.
- :tag (String) A tag used for statistics collection about transaction. A tag must be a valid identifier of the format: [a-zA-Z][a-zA-Z0-9_\-]{0,49}.
call_options (Hash) (defaults to: nil) —
A hash of values to specify the custom call options, e.g., timeout, retries, etc. Call options are optional. The following settings can be provided:
- :timeout (Numeric) A numeric value of custom timeout in seconds that overrides the default setting.
- :retry_policy (Hash) A hash of values that overrides the default setting of retry policy with the following keys:
  - :initial_delay (Numeric) - The initial delay in seconds.
  - :max_delay (Numeric) - The max delay in seconds.
  - :multiplier (Numeric) - The incremental backoff multiplier.
  - :retry_codes (Array<String>) - The error codes that should trigger a retry.
read_lock_mode (Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode) (defaults to: nil) —
The read lock mode for the transaction. If not specified, the client-level read lock mode will be used. Can be one of the following:
- :READ_LOCK_MODE_UNSPECIFIED : The default unspecified read lock mode.
- :PESSIMISTIC : The pessimistic lock mode, where depending on the isolation level and/or lock requested, locks are acquired on read.
- :OPTIMISTIC : The optimistic lock mode, where locks are not acquired on read. Depending on the isolation level and/or lock requested on a read, data may be validated at commit time to be not changed since the transaction started.
isolation_level (::Symbol, nil) (defaults to: nil) —
Optional. The isolation level for the transaction. If not specified, the client-level isolation level will be used. Can be one of the following:
- :ISOLATION_LEVEL_UNSPECIFIED : The default unspecified isolation level.
- :SERIALIZABLE : The serializable isolation level.
- :REPEATABLE_READ : The repeatable read isolation level.

Returns:

(Time, CommitResponse) —
The timestamp at which the operation committed. If commit options are set it returns Google::Cloud::Spanner::CommitResponse.

# File 'lib/google/cloud/spanner/client.rb', line 1196

def upsert table, rows,
           exclude_txn_from_change_streams: false,
           isolation_level: nil, commit_options: nil, request_options: nil,
           call_options: nil, read_lock_mode: nil
  request_options = Convert.to_request_options \
    request_options, tag_type: :transaction_tag

  @pool.with_session do |session|
    session.upsert table, rows,
                   exclude_txn_from_change_streams: exclude_txn_from_change_streams,
                   isolation_level: isolation_level || @isolation_level,
                   commit_options: commit_options,
                   request_options: request_options,
                   call_options: call_options,
                   read_lock_mode: read_lock_mode || @read_lock_mode
  end
end

Class: Google::Cloud::Spanner::Client

Overview

Client

Examples:

Instance Method Summary collapse

Instance Method Details

#batch_write(exclude_txn_from_change_streams: false, request_options: nil, call_options: nil) {|batch_write| ... } ⇒ Google::Cloud::Spanner::BatchWriteResults

Examples:

#close ⇒ Object

#commit(exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) {|commit| ... } ⇒ Time, CommitResponse

Examples:

Get commit stats

With request options

Commit using tag for transaction statistics collection.

#commit_timestamp ⇒ ColumnValue

Examples:

#database ⇒ Database

#database_id ⇒ String

#database_role ⇒ String

#delete(table, keys = [], exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ Time, CommitResponse

Examples:

Get commit stats

With request optinos

Delete using tag for transaction statistics collection.

#directed_read_options ⇒ Hash

#execute_partition_update(sql, params: nil, types: nil, exclude_txn_from_change_streams: false, query_options: nil, request_options: nil, call_options: nil) ⇒ Integer Also known as: execute_pdml

Examples:

Query using query parameters:

Query using query options:

Query using custom timeout and retry policy:

Using request options.

Query using tag for request query statistics collection.

#execute_query(sql, params: nil, types: nil, single_use: nil, query_options: nil, request_options: nil, call_options: nil, directed_read_options: nil) ⇒ Google::Cloud::Spanner::Results Also known as: execute, query, execute_sql

Examples:

Query using query parameters:

Query with a SQL STRUCT query parameter as a Hash:

Specify the SQL STRUCT type using Fields object:

Or, query with a SQL STRUCT as a typed Data object:

Query using query options:

Query using custom timeout and retry policy:

Using request options.

Query using tag for request query statistics collection.

#fields(types) ⇒ Fields

Examples:

Create a STRUCT value with named fields using Fields object:

Create a STRUCT value with anonymous field names:

Create a STRUCT value with duplicate field names:

#insert(table, rows, exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ Time, CommitResponse

Examples:

Get commit stats

Using request options.

Insert using tag for transaction statistics collection.

#instance ⇒ Instance

#instance_id ⇒ String

#project ⇒ ::Google::Cloud::Spanner::Project

#project_id ⇒ String

#query_options ⇒ Hash

#range(beginning, ending, exclude_begin: false, exclude_end: false) ⇒ Google::Cloud::Spanner::Range

Examples:

#read(table, columns, keys: nil, index: nil, limit: nil, single_use: nil, request_options: nil, call_options: nil, directed_read_options: nil, order_by: nil, lock_hint: nil) ⇒ Google::Cloud::Spanner::Results

Examples:

Use the keys option to pass keys and/or key ranges to read.

Read using custom timeout and retry.

Using request options.

Read using tag for read statistics collection.

#replace(table, rows, exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ Time, CommitResponse

Examples:

Get commit stats

Using request options.

Replace using tag for transaction statistics collection.

#reset! ⇒ Object

#snapshot(strong: nil, timestamp: nil, read_timestamp: nil, staleness: nil, exact_staleness: nil, call_options: nil) {|snapshot| ... } ⇒ Object

Examples:

#transaction(deadline: 120, exclude_txn_from_change_streams: false, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil, isolation_level: nil) {|transaction| ... } ⇒ Time, CommitResponse

Examples:

Manually rollback the transaction using Rollback:

Get commit stats

Using request options.

Tags for request and transaction statistics collection.

#update(table, rows, exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ Time, CommitResponse

#batch_write(exclude_txn_from_change_streams: false, request_options: nil, call_options: nil) {|batch_write| ... } ⇒ `Google::Cloud::Spanner::BatchWriteResults`

#close ⇒ `Object`

#commit(exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) {|commit| ... } ⇒ `Time`, `CommitResponse`

#commit_timestamp ⇒ `ColumnValue`

#database ⇒ `Database`

#database_id ⇒ `String`

#database_role ⇒ `String`

#delete(table, keys = [], exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ `Time`, `CommitResponse`

#directed_read_options ⇒ `Hash`

#execute_partition_update(sql, params: nil, types: nil, exclude_txn_from_change_streams: false, query_options: nil, request_options: nil, call_options: nil) ⇒ `Integer` Also known as: execute_pdml

#execute_query(sql, params: nil, types: nil, single_use: nil, query_options: nil, request_options: nil, call_options: nil, directed_read_options: nil) ⇒ `Google::Cloud::Spanner::Results` Also known as: execute, query, execute_sql

#fields(types) ⇒ `Fields`

#insert(table, rows, exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ `Time`, `CommitResponse`

#instance ⇒ `Instance`

#instance_id ⇒ `String`

#project ⇒ `::Google::Cloud::Spanner::Project`

#project_id ⇒ `String`

#query_options ⇒ `Hash`

#range(beginning, ending, exclude_begin: false, exclude_end: false) ⇒ `Google::Cloud::Spanner::Range`

#read(table, columns, keys: nil, index: nil, limit: nil, single_use: nil, request_options: nil, call_options: nil, directed_read_options: nil, order_by: nil, lock_hint: nil) ⇒ `Google::Cloud::Spanner::Results`

Use the `keys` option to pass keys and/or key ranges to read.

#replace(table, rows, exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ `Time`, `CommitResponse`

#reset! ⇒ `Object`

#snapshot(strong: nil, timestamp: nil, read_timestamp: nil, staleness: nil, exact_staleness: nil, call_options: nil) {|snapshot| ... } ⇒ `Object`

#transaction(deadline: 120, exclude_txn_from_change_streams: false, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil, isolation_level: nil) {|transaction| ... } ⇒ `Time`, `CommitResponse`

#update(table, rows, exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ `Time`, `CommitResponse`

#upsert(table, rows, exclude_txn_from_change_streams: false, isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil) ⇒ `Time`, `CommitResponse` Also known as: save