google::cloud::bigtable::RowReader Class Reference

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

#include <google/cloud/bigtable/row_reader.h>

Public Types
using	iterator = StreamRange< Row >::iterator

Public Member Functions
	RowReader ()
	Default constructs an empty RowReader. More...
	RowReader (std::shared_ptr< DataClient > client, std::string table_name, RowSet row_set, std::int64_t rows_limit, Filter filter, std::unique_ptr< RPCRetryPolicy > retry_policy, std::unique_ptr< RPCBackoffPolicy > backoff_policy, MetadataUpdatePolicy metadata_update_policy, std::unique_ptr< internal::ReadRowsParserFactory > parser_factory)
	RowReader (std::shared_ptr< DataClient > client, std::string app_profile_id, std::string table_name, RowSet row_set, std::int64_t rows_limit, Filter filter, std::unique_ptr< RPCRetryPolicy > retry_policy, std::unique_ptr< RPCBackoffPolicy > backoff_policy, MetadataUpdatePolicy metadata_update_policy, std::unique_ptr< internal::ReadRowsParserFactory > parser_factory)
	RowReader (RowReader &&)=default
	~RowReader ()=default
iterator	begin ()
	Input iterator over rows in the response. More...
iterator	end ()
	End iterator over the rows in the response. More...
void	Cancel ()
	Gracefully terminate a streaming read. More...

Static Public Attributes
static std::int64_t constexpr	NO_ROWS_LIMIT = 0
	A constant for the magic value that means "no limit, get all rows". More...

Detailed Description

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.

Member Typedef Documentation

iterator

using google::cloud::bigtable::RowReader::iterator = StreamRange<Row>::iterator

Constructor & Destructor Documentation

RowReader() [1/4]

google::cloud::bigtable::RowReader::RowReader

(

)

Default constructs an empty RowReader.

RowReader() [2/4]

google::cloud::bigtable::RowReader::RowReader	(	std::shared_ptr< DataClient >	client,
		std::string	table_name,
		RowSet	row_set,
		std::int64_t	rows_limit,
		Filter	filter,
		std::unique_ptr< RPCRetryPolicy >	retry_policy,
		std::unique_ptr< RPCBackoffPolicy >	backoff_policy,
		MetadataUpdatePolicy	metadata_update_policy,
		std::unique_ptr< internal::ReadRowsParserFactory >	parser_factory
	)

RowReader() [3/4]

google::cloud::bigtable::RowReader::RowReader	(	std::shared_ptr< DataClient >	client,
		std::string	app_profile_id,
		std::string	table_name,
		RowSet	row_set,
		std::int64_t	rows_limit,
		Filter	filter,
		std::unique_ptr< RPCRetryPolicy >	retry_policy,
		std::unique_ptr< RPCBackoffPolicy >	backoff_policy,
		MetadataUpdatePolicy	metadata_update_policy,
		std::unique_ptr< internal::ReadRowsParserFactory >	parser_factory
	)

RowReader() [4/4]

google::cloud::bigtable::RowReader::RowReader ( RowReader &&  )

default

~RowReader()

google::cloud::bigtable::RowReader::~RowReader ( )

default

Member Function Documentation

begin()

iterator google::cloud::bigtable::RowReader::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.

Cancel()

void google::cloud::bigtable::RowReader::Cancel

(

)

Gracefully terminate a streaming read.

Invalidates iterators.

end()

iterator google::cloud::bigtable::RowReader::end

(

)

End iterator over the rows in the response.

Member Data Documentation

NO_ROWS_LIMIT

std::int64_t constexpr google::cloud::bigtable::RowReader::NO_ROWS_LIMIT = 0

staticconstexpr

A constant for the magic value that means "no limit, get all rows".

Zero is used as a magic value that means "get all rows" in the Cloud Bigtable RPC protocol.