Google Cloud Spanner C++ Client  1.42.0
A C++ Client Library for Google Cloud Spanner
Public Member Functions | List of all members
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< spanner_internal::ResultSourceInterface > source)
 
 RowStream (RowStream &&)=default
 
RowStreamoperator= (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...
 
absl::optional< TimestampReadTimestamp () 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.

Definition at line 74 of file results.h.

Constructor & Destructor Documentation

◆ RowStream() [1/3]

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

◆ RowStream() [2/3]

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

Definition at line 77 of file results.h.

◆ 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.

Definition at line 86 of file results.h.

◆ end()

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

Returns a RowStreamIterator defining the end of this range.

Definition at line 92 of file results.h.

◆ 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.