Reference documentation and code samples for the Cloud Bigtable Client class ReadModifyWriteRowRules.
This is a builder class which builds read/modify/write rules specifying how the specified rows contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones. This is intended to be used in combination with Google\Cloud\Bigtable\Table::readModifyWriteRow().
Methods
append
Appends the value to the existing value of the cell. If targeted cell is unset, it will be treated as containing the empty string.
| Parameters | |
|---|---|
| Name | Description |
familyName |
string
Family name of the row. |
qualifier |
string
Column qualifier of the row. |
value |
string
Value of the Column qualifier. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\ReadModifyWriteRowRules | returns current ReadModifyWriteRowRules object. |
increment
Adds amount to the existing value. If the targeted cell is unset, it will be treated
as containing a zero. Otherwise, the targeted cell must containt an 8-byte value (interpreted
as a 64-bit big-endian signed integer), or the entire request will fail.
| Parameters | |
|---|---|
| Name | Description |
familyName |
string
Family name of the row. |
qualifier |
string
Column qualifier of the row. |
amount |
int
Amount to add to value of column qualifier. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\ReadModifyWriteRowRules | returns current ReadModifyWriteRowRules object. |
toProto
Returns proto representation of ReadModifyWriteRule.
| Returns | |
|---|---|
| Type | Description |
array<Google\Cloud\Bigtable\V2\ReadModifyWriteRule> | Returns array of ReadModifyWriteRule rules. |