Cloud Spanner V1 Client - Class Delete (1.84.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class Delete.

Arguments to delete operations.

Generated from protobuf message google.spanner.v1.Mutation.Delete

Namespace

Google \ Cloud \ Spanner \ V1 \ Mutation

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ table string

Required. The table whose rows will be deleted.
↳ key_set Google\Cloud\Spanner\V1\KeySet

Required. The primary keys of the rows within table to delete. The primary keys must be specified in the order in which they appear in the PRIMARY KEY() clause of the table's equivalent DDL statement (the DDL statement used to create the table). Delete is idempotent. The transaction will succeed even if some or all rows do not exist.

getTable

Required. The table whose rows will be deleted.

Returns
Type Description
string

setTable

Required. The table whose rows will be deleted.

Parameter
Name Description
var string
Returns
Type Description
$this

getKeySet

Required. The primary keys of the rows within table to delete. The primary keys must be specified in the order in which they appear in the PRIMARY KEY() clause of the table's equivalent DDL statement (the DDL statement used to create the table).

Delete is idempotent. The transaction will succeed even if some or all rows do not exist.

Returns
Type Description
Google\Cloud\Spanner\V1\KeySet|null

hasKeySet

clearKeySet

setKeySet

Required. The primary keys of the rows within table to delete. The primary keys must be specified in the order in which they appear in the PRIMARY KEY() clause of the table's equivalent DDL statement (the DDL statement used to create the table).

Delete is idempotent. The transaction will succeed even if some or all rows do not exist.

Parameter
Name Description
var Google\Cloud\Spanner\V1\KeySet
Returns
Type Description
$this