As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Row Data

Container for Google Cloud Bigtable Cells and Streaming Row Contents.

google.cloud.bigtable.row_data.DEFAULT_RETRY_READ_ROWS = <google.api_core.retry.retry_unary.Retry object>

The default retry strategy to be used on retry-able errors.

Used by _read_next_response().

exception google.cloud.bigtable.row_data.InvalidReadRowsResponse[source]

Bases: RuntimeError

Exception raised to invalid response data from back-end.

exception google.cloud.bigtable.row_data.InvalidRetryRequest[source]

Bases: RuntimeError

Exception raised when retry request is invalid.

class google.cloud.bigtable.row_data.PartialCellData(row_key, family_name, qualifier, timestamp_micros, labels=(), value=b'')[source]

Bases: object

This class is no longer used and will be removed in the future

class google.cloud.bigtable.row_data.PartialRowsData(read_method, request, retry=<google.api_core.retry.retry_unary.Retry object>)[source]

Bases: object

Convenience wrapper for consuming a ReadRows streaming response.

Parameters

  • 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 (Retry) – (Optional) Retry delay and deadline arguments. To override, the default value DEFAULT_RETRY_READ_ROWS can be used and modified with the with_delay() method or the with_deadline() method.

__iter__()[source]

Consume the ReadRowsResponse s from the stream. Read the rows and yield each to the reader

Parse the response and its chunks into a new/existing row in _rows. Rows are returned in order by row key.

cancel()[source]

Cancels the iterator, closing the stream.

consume_all(max_loops=None)[source]

Consume the streamed responses until there are no more.

Warning

This method will be removed in future releases. Please use this class as a generator instead.

Parameters

max_loops (int) – (Optional) Maximum number of times to try to consume an additional ReadRowsResponse. You can use this to avoid long wait times.

property state

this property is deprecated and will be removed in the future.

Type

DEPRECATED

google.cloud.bigtable.row_data.RETRYABLE_INTERNAL_ERROR_MESSAGES = ('rst_stream', 'rst stream', 'received unexpected eos on data frame from server')

Internal error messages that can be retried during read row and mutation.