Cloud Bigtable Client - Class Mutations (1.23.0)

Reference documentation and code samples for the Cloud Bigtable Client class Mutations.

Represents a Mutation to perform data operation on Bigtable table.

This is used to insert,update, delete operation on row in Bigtable table.

Methods

upsert

Creates Insert/Update mutation for a row.

Parameters
NameDescription
family string

Family name of the row.

qualifier string

Column qualifier of the row.

value string

Value of the column qualifier.

timeStamp string|int

[optional] A timestamp value, in microseconds. Use the value -1 to utilize the current Bigtable server time. Defaults to the current local system time.

Returns
TypeDescription
Google\Cloud\Bigtable\Mutationsreturns current Mutations object.

deleteFromFamily

Creates delete from family mutation for a row.

Parameter
NameDescription
family string

Family name of the row.

Returns
TypeDescription
Google\Cloud\Bigtable\Mutationsreturns current Mutations object.

deleteFromColumn

Creates delete from column mutation for a row.

Parameters
NameDescription
family string

Family name of the row.

qualifier string

Column qualifier of the row.

timeRange array

[optional] Array of values value, in microseconds to delete from column, keyed by start and end representing time range window. start Defaults to 0 end Defaults to infinity

Returns
TypeDescription
Google\Cloud\Bigtable\Mutationsreturns current Mutations object.

deleteRow

Creates delete row mutation for a row.

Returns
TypeDescription
Google\Cloud\Bigtable\Mutationsreturns current Mutations object.

toProto

Returns protobuf representation of Mutations.

Returns
TypeDescription
arrayreturns array of protobuf representation of Mutations.