- 3.58.0 (latest)
- 3.57.0
- 3.56.0
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.51.0
- 3.50.1
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.1
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.1
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.27.1
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.2
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.1
- 3.14.1
- 3.13.0
- 3.12.1
- 3.11.1
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.1.1
- 2.0.0
- 1.19.3
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.1
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
DirectedReadOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The DirectedReadOptions
can be used to indicate which replicas
or regions should be used for non-transactional reads or queries.
DirectedReadOptions
can only be specified for a read-only
transaction, otherwise the API returns an INVALID_ARGUMENT
error.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
---|---|
Name | Description |
include_replicas |
google.cloud.spanner_v1.types.DirectedReadOptions.IncludeReplicas
Include_replicas indicates the order of replicas (as
they appear in this list) to process the request. If
auto_failover_disabled is set to true and all
replicas are exhausted without finding a healthy replica,
Spanner waits for a replica in the list to become available,
requests might fail due to DEADLINE_EXCEEDED errors.
This field is a member of oneof _ replicas .
|
exclude_replicas |
google.cloud.spanner_v1.types.DirectedReadOptions.ExcludeReplicas
Exclude_replicas indicates that specified replicas
should be excluded from serving requests. Spanner doesn't
route requests to the replicas in this list.
This field is a member of oneof _ replicas .
|
Classes
ExcludeReplicas
ExcludeReplicas(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests.
IncludeReplicas
IncludeReplicas(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An IncludeReplicas
contains a repeated set of
ReplicaSelection
which indicates the order in which replicas
should be considered.
ReplicaSelection
ReplicaSelection(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The directed read replica selector. Callers must provide one or more of the following fields for replica selection:
location
- The location must be one of the regions within the multi-region configuration of your database.type
- The type of the replica.
Some examples of using replica_selectors are:
location:us-east1
--> The "us-east1" replica(s) of any available type is used to process the request.type:READ_ONLY
--> The "READ_ONLY" type replica(s) in the nearest available location are used to process the request.location:us-east1 type:READ_ONLY
--> The "READ_ONLY" type replica(s) in location "us-east1" is used to process the request.