Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::Mutation (v1.6.0)

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::Mutation.

A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#delete

def delete() -> ::Google::Cloud::Spanner::V1::Mutation::Delete
Returns
  • (::Google::Cloud::Spanner::V1::Mutation::Delete) — Delete rows from a table. Succeeds whether or not the named rows were present.

    Note: The following fields are mutually exclusive: delete, insert, update, insert_or_update, replace. If a field in that set is populated, all other fields in the set will automatically be cleared.

#delete=

def delete=(value) -> ::Google::Cloud::Spanner::V1::Mutation::Delete
Parameter
  • value (::Google::Cloud::Spanner::V1::Mutation::Delete) — Delete rows from a table. Succeeds whether or not the named rows were present.

    Note: The following fields are mutually exclusive: delete, insert, update, insert_or_update, replace. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Spanner::V1::Mutation::Delete) — Delete rows from a table. Succeeds whether or not the named rows were present.

    Note: The following fields are mutually exclusive: delete, insert, update, insert_or_update, replace. If a field in that set is populated, all other fields in the set will automatically be cleared.

#insert

def insert() -> ::Google::Cloud::Spanner::V1::Mutation::Write
Returns
  • (::Google::Cloud::Spanner::V1::Mutation::Write) — Insert new rows in a table. If any of the rows already exist, the write or transaction fails with error ALREADY_EXISTS.

    Note: The following fields are mutually exclusive: insert, update, insert_or_update, replace, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.

#insert=

def insert=(value) -> ::Google::Cloud::Spanner::V1::Mutation::Write
Parameter
  • value (::Google::Cloud::Spanner::V1::Mutation::Write) — Insert new rows in a table. If any of the rows already exist, the write or transaction fails with error ALREADY_EXISTS.

    Note: The following fields are mutually exclusive: insert, update, insert_or_update, replace, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Spanner::V1::Mutation::Write) — Insert new rows in a table. If any of the rows already exist, the write or transaction fails with error ALREADY_EXISTS.

    Note: The following fields are mutually exclusive: insert, update, insert_or_update, replace, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.

#insert_or_update

def insert_or_update() -> ::Google::Cloud::Spanner::V1::Mutation::Write
Returns
  • (::Google::Cloud::Spanner::V1::Mutation::Write) — Like insert, except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved.

    When using insert_or_update, just as when using insert, all NOT NULL columns in the table must be given a value. This holds true even when the row already exists and will therefore actually be updated.

    Note: The following fields are mutually exclusive: insert_or_update, insert, update, replace, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.

#insert_or_update=

def insert_or_update=(value) -> ::Google::Cloud::Spanner::V1::Mutation::Write
Parameter
  • value (::Google::Cloud::Spanner::V1::Mutation::Write) — Like insert, except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved.

    When using insert_or_update, just as when using insert, all NOT NULL columns in the table must be given a value. This holds true even when the row already exists and will therefore actually be updated.

    Note: The following fields are mutually exclusive: insert_or_update, insert, update, replace, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Spanner::V1::Mutation::Write) — Like insert, except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved.

    When using insert_or_update, just as when using insert, all NOT NULL columns in the table must be given a value. This holds true even when the row already exists and will therefore actually be updated.

    Note: The following fields are mutually exclusive: insert_or_update, insert, update, replace, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.

#replace

def replace() -> ::Google::Cloud::Spanner::V1::Mutation::Write
Returns
  • (::Google::Cloud::Spanner::V1::Mutation::Write) — Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become NULL.

    In an interleaved table, if you create the child table with the ON DELETE CASCADE annotation, then replacing a parent row also deletes the child rows. Otherwise, you must delete the child rows before you replace the parent row.

    Note: The following fields are mutually exclusive: replace, insert, update, insert_or_update, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.

#replace=

def replace=(value) -> ::Google::Cloud::Spanner::V1::Mutation::Write
Parameter
  • value (::Google::Cloud::Spanner::V1::Mutation::Write) — Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become NULL.

    In an interleaved table, if you create the child table with the ON DELETE CASCADE annotation, then replacing a parent row also deletes the child rows. Otherwise, you must delete the child rows before you replace the parent row.

    Note: The following fields are mutually exclusive: replace, insert, update, insert_or_update, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Spanner::V1::Mutation::Write) — Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become NULL.

    In an interleaved table, if you create the child table with the ON DELETE CASCADE annotation, then replacing a parent row also deletes the child rows. Otherwise, you must delete the child rows before you replace the parent row.

    Note: The following fields are mutually exclusive: replace, insert, update, insert_or_update, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.

#update

def update() -> ::Google::Cloud::Spanner::V1::Mutation::Write
Returns
  • (::Google::Cloud::Spanner::V1::Mutation::Write) — Update existing rows in a table. If any of the rows does not already exist, the transaction fails with error NOT_FOUND.

    Note: The following fields are mutually exclusive: update, insert, insert_or_update, replace, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.

#update=

def update=(value) -> ::Google::Cloud::Spanner::V1::Mutation::Write
Parameter
  • value (::Google::Cloud::Spanner::V1::Mutation::Write) — Update existing rows in a table. If any of the rows does not already exist, the transaction fails with error NOT_FOUND.

    Note: The following fields are mutually exclusive: update, insert, insert_or_update, replace, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Spanner::V1::Mutation::Write) — Update existing rows in a table. If any of the rows does not already exist, the transaction fails with error NOT_FOUND.

    Note: The following fields are mutually exclusive: update, insert, insert_or_update, replace, delete. If a field in that set is populated, all other fields in the set will automatically be cleared.