Class ReadRowsPage (2.27.0)

Version latest

• 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

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.

Properties

num_items

int: Total items in the page.

remaining

int: Remaining items in the page.

Methods

__iter__

__iter__()

A ReadRowsPage is an iterator.

__next__

__next__()

Get the next row in the page.

next

next()

Get the next row in the page.

to_arrow

to_arrow()

Create an pyarrow.RecordBatch of rows in the page.

Returns
Type	Description
pyarrow.RecordBatch	Rows from the message, as an Arrow record batch.

to_dataframe

to_dataframe(dtypes=None)

Create a pandas.DataFrame of rows in the page.

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

Warning: DATETIME columns are not supported. They are currently parsed as strings in the fastavro library.

Parameter
Name	Description
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
Type	Description
pandas.DataFrame	A data frame of all rows in the stream.