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-08-22 UTC."],[[["\u003cp\u003eVersion 2.37.0-rc is the latest release candidate, while version 2.35.0 is the currently displayed version.\u003c/p\u003e\n"],["\u003cp\u003eThis page provides versioned documentation for the \u003ccode\u003eDirectedReadOption\u003c/code\u003e struct in the Google Cloud Spanner C++ library, from versions 2.11.0 to the latest release candidate.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDirectedReadOption\u003c/code\u003e is used within \u003ccode\u003egoogle::cloud::Options\u003c/code\u003e to specify which replicas or regions should be used for read-only or single-use transactions.\u003c/p\u003e\n"],["\u003cp\u003eThe struct features \u003ccode\u003eIncludeReplicas\u003c/code\u003e and \u003ccode\u003eExcludeReplicas\u003c/code\u003e variants to list replicas to include or exclude from serving read requests.\u003c/p\u003e\n"],["\u003cp\u003eUsing \u003ccode\u003eDirectedReadOptions\u003c/code\u003e within a read-write transaction will produce a \u003ccode\u003ekInvalidArgument\u003c/code\u003e error.\u003c/p\u003e\n"]]],[],null,[]]
