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\u003eThis webpage provides documentation for the \u003ccode\u003eDirectedReadOption\u003c/code\u003e feature in the Google Cloud Spanner C++ library across multiple versions, ranging from version 2.11.0 to the latest release candidate 2.37.0-rc.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDirectedReadOption\u003c/code\u003e allows users to specify which replicas or regions to utilize when performing read-only or single-use transactions, optimizing query execution.\u003c/p\u003e\n"],["\u003cp\u003eAttempting to use \u003ccode\u003eDirectedReadOption\u003c/code\u003e in read-write transactions will result in an error, specifically a \u003ccode\u003ekInvalidArgument\u003c/code\u003e error.\u003c/p\u003e\n"],["\u003cp\u003eThe feature supports two variants: \u003ccode\u003eIncludeReplicas\u003c/code\u003e to specify a list of preferred replicas, and \u003ccode\u003eExcludeReplicas\u003c/code\u003e to specify a list of replicas that should be avoided.\u003c/p\u003e\n"],["\u003cp\u003eThe type alias for the \u003ccode\u003eDirectedReadOption\u003c/code\u003e is defined as \u003ccode\u003eabsl::variant< absl::monostate, IncludeReplicas, ExcludeReplicas >\u003c/code\u003e, representing the different possible configurations.\u003c/p\u003e\n"]]],[],null,[]]
