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\u003eThe page provides documentation for \u003ccode\u003eDirectedReadOption\u003c/code\u003e, a feature to specify which replicas or regions to use for reads in read-only or single-use transactions within the Google Cloud Spanner C++ client library.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDirectedReadOption\u003c/code\u003e should not be used within read-write transactions, as it will result in a \u003ccode\u003ekInvalidArgument\u003c/code\u003e error.\u003c/p\u003e\n"],["\u003cp\u003eThe latest release is 2.37.0-rc, with multiple documented versions going back to version 2.11.0.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDirectedReadOption\u003c/code\u003e uses either \u003ccode\u003eIncludeReplicas\u003c/code\u003e to list replicas to try or \u003ccode\u003eExcludeReplicas\u003c/code\u003e to list replicas to exclude.\u003c/p\u003e\n"],["\u003cp\u003eThe type alias of \u003ccode\u003eDirectedReadOption\u003c/code\u003e is \u003ccode\u003eabsl::variant< absl::monostate, IncludeReplicas, ExcludeReplicas >\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]
