Module row_data (1.5.1)

Container for Google Cloud Bigtable Cells and Streaming Row Contents.

Classes

Cell

Cell(value, timestamp_micros, labels=None)

Representation of a Google Cloud Bigtable Cell.

Parameters
NameDescription
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.

InvalidChunk

Exception raised to to invalid chunk data from back-end.

InvalidReadRowsResponse

Exception raised to to invalid response data from back-end.

PartialCellData

PartialCellData(
    row_key, family_name, qualifier, timestamp_micros, labels=(), value=b""
)

Representation of partial cell in a Google Cloud Bigtable Table.

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

Parameters
NameDescription
row_key bytes

The key for the row holding the (partial) cell.

family_name str

The family name of the (partial) cell.

qualifier bytes

The column qualifier of the (partial) cell.

timestamp_micros int

The timestamp (in microsecods) of the (partial) cell.

labels list of str

labels assigned to the (partial) cell

value bytes

The (accumulated) value of the (partial) cell.

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
NameDescription
row_key bytes

The key for the row holding the (partial) data.

PartialRowsData

PartialRowsData(read_method, request, retry=<google.api_core.retry.Retry object>)

Convenience wrapper for consuming a ReadRows streaming response.

Parameters
NameDescription
read_method `client._table_data_client.read_rows`

ReadRows method.

request `data_messages_v2_pb2.ReadRowsRequest`

The ReadRowsRequest message used to create a ReadRowsResponse iterator. If the iterator fails, a new iterator is created, allowing the scan to continue from the point just beyond the last successfully read row, identified by self.last_scanned_row_key. The retry happens inside of the Retry class, using a predicate for the expected exceptions during iteration.

retry `google.api_core.retry.Retry`

(Optional) Retry delay and deadline arguments. To override, the default value DEFAULT_RETRY_READ_ROWS can be used and modified with the google.api_core.retry.Retry.with_delay method or the google.api_core.retry.Retry.with_deadline method.