Module reader (2.5.0)

API documentation for bigquery_storage_v1.reader module.

Classes

ReadRowsIterable(reader, read_session)

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`	`google.cloud.bigquery_storage_v1.types.ReadSession` A read session. This is required because it contains the schema used in the stream messages.

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(wrapped, client, name, offset, read_rows_kwargs)

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.