google::cloud::spanner::RowStream Class Reference

Represents the stream of Rows returned from spanner::Client::Read() or spanner::Client::ExecuteQuery(). More...

#include <google/cloud/spanner/results.h>

Public Member Functions
	RowStream ()=default
	RowStream (std::unique_ptr< ResultSourceInterface > source)
	RowStream (RowStream &&)=default
RowStream &	operator= (RowStream &&)=default
RowStreamIterator	begin ()
	Returns a RowStreamIterator defining the beginning of this range. More...
RowStreamIterator	end ()
	Returns a RowStreamIterator defining the end of this range. More...
std::int64_t	RowsModified () const
	Returns the number of rows modified by a DML statement. More...
absl::optional< Timestamp >	ReadTimestamp () const
	Retrieves the timestamp at which the read occurred. More...

Detailed Description

Represents the stream of Rows returned from spanner::Client::Read() or spanner::Client::ExecuteQuery().

This is a range defined by the Input Iterators returned from its begin() and end() members. Callers may directly iterate the RowStream instance, which will return a sequence of StatusOr<Row> objects.

For convenience, callers may wrap instances in a StreamOf<std::tuple<...>> object, which will automatically parse each Row into a std::tuple with the specified types.

Constructor & Destructor Documentation

RowStream() [1/3]

google::cloud::spanner::RowStream::RowStream ( )

default

RowStream() [2/3]

google::cloud::spanner::RowStream::RowStream ( std::unique_ptr< ResultSourceInterface >  source )

inlineexplicit

RowStream() [3/3]

google::cloud::spanner::RowStream::RowStream ( RowStream &&  )

default

Member Function Documentation

begin()

RowStreamIterator google::cloud::spanner::RowStream::begin ( )

inline

Returns a RowStreamIterator defining the beginning of this range.

end()

RowStreamIterator google::cloud::spanner::RowStream::end ( )

inline

Returns a RowStreamIterator defining the end of this range.

operator=()

RowStream & google::cloud::spanner::RowStream::operator= ( RowStream &&  )

default

ReadTimestamp()

absl::optional< Timestamp > google::cloud::spanner::RowStream::ReadTimestamp

(

)

const

Retrieves the timestamp at which the read occurred.

Note

Only available if a read-only transaction was used.

RowsModified()

std::int64_t google::cloud::spanner::RowStream::RowsModified

(

)

const

Returns the number of rows modified by a DML statement.