Google Cloud Spanner C++ Client  1.32.1
A C++ Client Library for Google Cloud Spanner
Public Attributes | List of all members
google::cloud::spanner::v1::ReadOptions Struct Reference

Options passed to Client::Read or Client::PartitionRead. More...

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

Public Attributes

std::string index_name
 If non-empty, the name of an index on a database table. More...
 
std::int64_t limit = 0
 Limit on the number of rows to yield, or 0 for no limit. More...
 
absl::optional< RequestPriorityrequest_priority
 Priority for the read request. More...
 
absl::optional< std::string > request_tag
 Tag for the read request. More...
 

Detailed Description

Options passed to Client::Read or Client::PartitionRead.

Definition at line 30 of file read_options.h.

Member Data Documentation

◆ index_name

std::string google::cloud::spanner::v1::ReadOptions::index_name

If non-empty, the name of an index on a database table.

This index is used instead of the table primary key when interpreting the KeySetand sorting result rows.

Definition at line 36 of file read_options.h.

◆ limit

std::int64_t google::cloud::spanner::v1::ReadOptions::limit = 0

Limit on the number of rows to yield, or 0 for no limit.

A limit cannot be specified when calling PartitionRead.

Definition at line 42 of file read_options.h.

◆ request_priority

absl::optional<RequestPriority> google::cloud::spanner::v1::ReadOptions::request_priority

Priority for the read request.

Definition at line 47 of file read_options.h.

◆ request_tag

absl::optional<std::string> google::cloud::spanner::v1::ReadOptions::request_tag

Tag for the read request.

Definition at line 52 of file read_options.h.