Class ReadRowsIterable (0.8.0)

ReadRowsIterable(reader, read_session)

An iterable of rows from a read session.

Parameters

NameDescription
reader google.cloud.bigquery_storage_v1beta1.reader.ReadRowsStream

A read rows stream.

read_session google.cloud.bigquery_storage_v1beta1.types.ReadSession

A read session. This is required because it contains the schema used in the stream messages.

Inheritance

builtins.object > ReadRowsIterable

Properties

pages

A generator of all pages in the stream.

Returns
TypeDescription
types.GeneratorType[google.cloud.bigquery_storage_v1beta1.ReadRowsPage]A generator of pages.

total_rows

int: Number of estimated rows in the current stream.

May change over time.

Methods

__iter__

__iter__()

Iterator for each row in all pages.

to_arrow

to_arrow()

Create a pyarrow.Table of all rows in the stream.

This method requires the pyarrow library and a stream using the Arrow format.

Returns
TypeDescription
pyarrow.TableA table of all rows in the stream.

to_dataframe

to_dataframe(dtypes=None)

Create a pandas.DataFrame of all rows in the stream.

This method requires the pandas libary to create a data frame and the fastavro library to parse row messages.

Parameter
NameDescription
dtypes Map[str, Union[str, pandas.Series.dtype]]

Optional. A dictionary of column names pandas dtypes. The provided dtype is used when constructing the series for the column specified. Otherwise, the default pandas behavior is used.

Returns
TypeDescription
pandas.DataFrameA data frame of all rows in the stream.