Class PartialRowsData (2.17.0)

Version 2.17.0

• 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

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

Convenience wrapper for consuming a ReadRows streaming response.

Parameters
Name	Description
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.

Properties

state

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

Methods

__iter__

__iter__()

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

cancel()

Cancels the iterator, closing the stream.

consume_all

consume_all(max_loops=None)

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.

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