Module reader (2.20.0)

Version 2.20.0

• 2.27.0 (latest)
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.1
• 2.18.1
• 2.17.0
• 2.16.2
• 2.15.0
• 2.14.2
• 2.13.2
• 2.12.0
• 2.11.0
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.3
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.1.2
• 1.0.0
• 0.8.0
• 0.7.0
• 0.6.0

API documentation for bigquery_storage_v1.reader module.

Classes

ReadRowsIterable

ReadRowsIterable(reader, read_session=None)

An iterable of rows from a read session.

Parameters
Name	Description
reader	google.cloud.bigquery_storage_v1.reader.ReadRowsStream A read rows stream.
read_session	Optional[ReadSession] DEPRECATED. This argument was used to specify the schema of the rows in the stream, but now the first message in a read stream contains this information.

ReadRowsPage

ReadRowsPage(stream_parser, message)

An iterator of rows from a read session message.

Parameters
Name	Description
stream_parser	google.cloud.bigquery_storage_v1.reader._StreamParser A helper for parsing messages into rows.
message	google.cloud.bigquery_storage_v1.types.ReadRowsResponse A message of data from a read rows stream.

ReadRowsStream

ReadRowsStream(client, name, offset, read_rows_kwargs, retry_delay_callback=None)

A stream of results from a read rows request.

This stream is an iterable of ReadRowsResponse. Iterate over it to fetch all row messages.

If the fastavro library is installed, use the rows() method to parse all messages into a stream of row dictionaries.

If the pandas and fastavro libraries are installed, use the to_dataframe() method to parse all messages into a pandas.DataFrame.

This object should not be created directly, but is returned by other methods in this library.