Class: Google::Cloud::Spanner::Commit

Inherits:

Object

• Object
• Google::Cloud::Spanner::Commit

Defined in:

lib/google/cloud/spanner/commit.rb

Overview

Commit

Accepts mutations for execution within a transaction. All writes will 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 passed to Google::Cloud::Spanner::Client#commit completes.

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

Instance Method Summary

• #delete(table, keys = []) ⇒ Object

  Deletes rows from a table.

• #insert(table, *rows) ⇒ Object

  Inserts new rows in a table.

• #replace(table, *rows) ⇒ Object

  Inserts or replaces rows in a table.

• #update(table, *rows) ⇒ Object

  Updates existing rows in a table.

• #upsert(table, *rows) ⇒ Object (also: #save)

  Inserts or updates rows in a table.

Instance Method Details

#delete(table, keys = []) ⇒ Object

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

All changes are accumulated in memory until the block passed to Google::Cloud::Spanner::Client#commit completes.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

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

db.commit do |c|
  c.delete "users", [1, 2, 3]
end

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.

# File 'lib/google/cloud/spanner/commit.rb', line 271

def delete table, keys = []
  @mutations += [
    V1::Mutation.new(
      delete: V1::Mutation::Delete.new(
        table: table, key_set: key_set(keys)
      )
    )
  ]
  keys
end

#insert(table, *rows) ⇒ Object

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

All changes are accumulated in memory until the block passed to Google::Cloud::Spanner::Client#commit completes.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

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

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

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.

# File 'lib/google/cloud/spanner/commit.rb', line 145

def insert table, *rows
  mutations_from_rows table, rows, "insert"
end

#replace(table, *rows) ⇒ Object

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.

All changes are accumulated in memory until the block passed to Google::Cloud::Spanner::Client#commit completes.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

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

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

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.

# File 'lib/google/cloud/spanner/commit.rb', line 243

def replace table, *rows
  mutations_from_rows table, rows, "replace"
end

#update(table, *rows) ⇒ Object

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

All changes are accumulated in memory until the block passed to Google::Cloud::Spanner::Client#commit completes.

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 },
                     { id: 2, name: "Harvey",  active: true }]
end

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.

# File 'lib/google/cloud/spanner/commit.rb', line 193

def update table, *rows
  mutations_from_rows table, rows, "update"
end

#upsert(table, *rows) ⇒ Object 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.

All changes are accumulated in memory until the block passed to Google::Cloud::Spanner::Client#commit completes.

Examples:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

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

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

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.

# File 'lib/google/cloud/spanner/commit.rb', line 96

def upsert table, *rows
  mutations_from_rows table, rows, "insert_or_update"
end