Option for google::cloud::Options to indicate which replicas or regions should be used for reads/queries in read-only or single-use transactions.
Use of DirectedReadOptions within a read-write transaction will result in a kInvalidArgument error.
The IncludeReplicas variant lists the replicas to try (in order) to process the request, and what to do if the list is exhausted without finding a healthy replica.
Alternately, the ExcludeReplicas variant lists replicas that should be excluded from serving the request.
Type Aliases
Type
Alias Of: absl::variant< absl::monostate, IncludeReplicas, ExcludeReplicas >
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-18 UTC."],[[["Version 2.37.0-rc is the latest release candidate, while version 2.35.0 is the currently displayed version."],["This page provides versioned documentation for the `DirectedReadOption` struct in the Google Cloud Spanner C++ library, from versions 2.11.0 to the latest release candidate."],["`DirectedReadOption` is used within `google::cloud::Options` to specify which replicas or regions should be used for read-only or single-use transactions."],["The struct features `IncludeReplicas` and `ExcludeReplicas` variants to list replicas to include or exclude from serving read requests."],["Using `DirectedReadOptions` within a read-write transaction will produce a `kInvalidArgument` error."]]],[]]
