Class StreamedResultSet (3.51.0)

Version latest

• 3.51.0 (latest)
• 3.50.1
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.1
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.1
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.1
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.2
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.1
• 3.14.1
• 3.13.0
• 3.12.1
• 3.11.1
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.1.1
• 2.0.0
• 1.19.3
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.1
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0

StreamedResultSet(
    response_iterator, source=None, column_info=None, lazy_decode: bool = False
)

Process a sequence of partial result sets into a single set of row data.

Parameter
Name	Description
source	Snapshot Snapshot from which the result set was fetched.

Properties

fields

Field descriptors for result set columns.

Returns
Type	Description
list of Field	list of fields describing column names / types.

metadata

Result set metadata

Returns
Type	Description
ResultSetMetadata	structure describing the results

stats

Result set statistics

Returns
Type	Description
ResultSetStats	structure describing status about the response

Methods

decode_column

decode_column(row: [], column_index: int)

Decodes a column from a protobuf value to a Python object. This function should only be called for result sets that use lazy_decoding=True. The object that is returned by this function is the same as the object that would have been returned by the rows iterator if lazy_decoding=False.

decode_row

decode_row(row: []) -> []

Decodes a row from protobuf values to Python objects. This function should only be called for result sets that use lazy_decoding=True. The array that is returned by this function is the same as the array that would have been returned by the rows iterator if lazy_decoding=False.

one

one()

Return exactly one result, or raise an exception.

Exceptions
Type	Description
NotFound	If there are no results.
ValueError	If there are multiple results.
RuntimeError	If consumption has already occurred, in whole or in part.

one_or_none

one_or_none()

Return exactly one result, or None if there are no results.

Exceptions
Type	Description
ValueError	If there are multiple results.
RuntimeError	If consumption has already occurred, in whole or in part.

to_dict_list

to_dict_list()

Return the result of a query as a list of dictionaries. In each dictionary the key is the column name and the value is the value of the that column in a given row.

Returns
Type	Description
list of dict	result rows as a list of dictionaries