Module row (2.14.1)

Version 2.14.1

• 2.26.0 (latest)
• 2.25.0
• 2.24.0
• 2.23.1
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.1
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.1
• 2.13.2
• 2.12.0
• 2.11.3
• 2.10.1
• 2.9.0
• 2.8.1
• 2.7.1
• 2.6.0
• 2.5.2
• 2.4.0
• 2.3.3
• 2.2.0
• 2.1.0
• 2.0.0
• 1.7.3
• 1.6.1
• 1.5.1
• 1.4.0
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.34.0

User-friendly container for Google Cloud Bigtable Row.

Classes

AppendRow

AppendRow(row_key, table)

Google Cloud Bigtable Row for sending append mutations.

These mutations are intended to augment the value of an existing cell and uses the methods:

• append_cell_value
• increment_cell_value

The first works by appending bytes and the second by incrementing an integer (stored in the cell as 8 bytes). In either case, if the cell is empty, assumes the default empty value (empty string for bytes or 0 for integer).

Parameters

Name	Description
row_key	bytes The key for the current row.
table	Table The table that owns the row.

Cell

Cell(value, timestamp_micros, labels=None)

Representation of a Google Cloud Bigtable Cell.

Parameters

Name	Description
value	bytes The value stored in the cell.
timestamp_micros	int The timestamp_micros when the cell was stored.
labels	list (Optional) List of strings. Labels applied to the cell.

ConditionalRow

ConditionalRow(row_key, table, filter_)

Google Cloud Bigtable Row for sending mutations conditionally.

Each mutation has an associated state: :data:True or :data:False. When commit-ed, the mutations for the :data:True state will be applied if the filter matches any cells in the row, otherwise the :data:False state will be applied.

A ConditionalRow accumulates mutations in the same way a DirectRow does:

• set_cell
• delete
• delete_cell
• delete_cells

with the only change the extra state parameter::

row_cond = table.row(b'row-key2', filter_=row_filter) row_cond.set_cell(u'fam', b'col', b'cell-val', state=True) row_cond.delete_cell(u'fam', b'col', state=False)

Note: As with DirectRow, to actually send these mutations to the Google Cloud Bigtable API, you must call commit.

Parameters

Name	Description
row_key	bytes The key for the current row.
table	Table The table that owns the row.
filter_	.RowFilter Filter to be used for conditional mutations.

DirectRow

DirectRow(row_key, table=None)

Google Cloud Bigtable Row for sending "direct" mutations.

These mutations directly set or delete cell contents:

• set_cell
• delete
• delete_cell
• delete_cells

These methods can be used directly::

row = table.row(b'row-key1') row.set_cell(u'fam', b'col1', b'cell-val') row.delete_cell(u'fam', b'col2')

Note: A DirectRow accumulates mutations locally via the set_cell, delete, delete_cell and delete_cells methods. To actually send these mutations to the Google Cloud Bigtable API, you must call commit.

Parameters

Name	Description
row_key	bytes The key for the current row.
table	Table (Optional) The table that owns the row. This is used for the :meth: commit only. Alternatively, DirectRows can be persisted via mutate_rows.

InvalidChunk

Exception raised to invalid chunk data from back-end.

PartialRowData

PartialRowData(row_key)

Representation of partial row in a Google Cloud Bigtable Table.

These are expected to be updated directly from a ._generated.bigtable_service_messages_pb2.ReadRowsResponse

Parameter

Name	Description
row_key	bytes The key for the row holding the (partial) data.

Row

Row(row_key, table=None)

Base representation of a Google Cloud Bigtable Row.

This class has three subclasses corresponding to the three RPC methods for sending row mutations:

• DirectRow for MutateRow
• ConditionalRow for CheckAndMutateRow
• AppendRow for ReadModifyWriteRow

Parameters

Name	Description
row_key	bytes The key for the current row.
table	Table (Optional) The table that owns the row.