Class RowReader (2.18.0)

Object returned by Table::ReadRows(), enumerates rows in the response.

Thread-safety

Two threads operating concurrently on the same instance of this class or the iterators obtained from it are not guaranteed to work. Iterate over the results of ReadRows() using the STL idioms.

Constructors

RowReader()

Default constructs an empty RowReader.

RowReader(std::shared_ptr< DataClient >, std::string, RowSet, std::int64_t, Filter, std::unique_ptr< RPCRetryPolicy >, std::unique_ptr< RPCBackoffPolicy >, MetadataUpdatePolicy, std::unique_ptr< internal::ReadRowsParserFactory >)

Parameters
Name Description
client std::shared_ptr< DataClient >
table_name std::string
row_set RowSet
rows_limit std::int64_t
filter Filter
retry_policy std::unique_ptr< RPCRetryPolicy >
backoff_policy std::unique_ptr< RPCBackoffPolicy >
metadata_update_policy MetadataUpdatePolicy
parser_factory std::unique_ptr< internal::ReadRowsParserFactory >

RowReader(std::shared_ptr< DataClient >, std::string, std::string, RowSet, std::int64_t, Filter, std::unique_ptr< RPCRetryPolicy >, std::unique_ptr< RPCBackoffPolicy >, MetadataUpdatePolicy, std::unique_ptr< internal::ReadRowsParserFactory >)

Parameters
Name Description
client std::shared_ptr< DataClient >
app_profile_id std::string
table_name std::string
row_set RowSet
rows_limit std::int64_t
filter Filter
retry_policy std::unique_ptr< RPCRetryPolicy >
backoff_policy std::unique_ptr< RPCBackoffPolicy >
metadata_update_policy MetadataUpdatePolicy
parser_factory std::unique_ptr< internal::ReadRowsParserFactory >

RowReader(RowReader &&)

Parameter
Name Description
RowReader &&

Functions

begin()

Input iterator over rows in the response.

The returned iterator is a single-pass input iterator that reads rows from the RowReader when incremented. The first row may be read when the iterator is constructed.

Creating, and particularly incrementing, multiple iterators on the same RowReader is unsupported and can produce incorrect results.

Retry and backoff policies are honored.

Returns
Type Description
iterator

end()

End iterator over the rows in the response.

Returns
Type Description
iterator

Cancel()

Gracefully terminate a streaming read.

Invalidates iterators.

Returns
Type Description
void

Type Aliases

iterator

Alias Of: StreamRange< Row >::iterator