Cloud Spanner V1 Client - Class ReplicaSelection (1.105.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class ReplicaSelection.

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.

Generated from protobuf message google.spanner.v1.DirectedReadOptions.ReplicaSelection

Namespace

Google \ Cloud \ Spanner \ V1 \ DirectedReadOptions

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ location string

The location or region of the serving requests, for example, "us-east1".
↳ type int

The type of replica.

getLocation

The location or region of the serving requests, for example, "us-east1".

Returns
Type Description
string

setLocation

The location or region of the serving requests, for example, "us-east1".

Parameter
Name Description
var string
Returns
Type Description
$this

getType

The type of replica.

Returns
Type Description
int Enum of type Type.

setType

The type of replica.

Parameter
Name Description
var int

Enum of type Type.

Returns
Type Description
$this