Cloud Spanner V1 Client - Class Group (2.1.0)

Version latest

• 2.1.0 (latest)
• 2.1.0-RC1
• 2.0.1-RC1
• 1.106.0
• 1.105.1
• 1.104.1
• 1.103.0
• 1.102.0
• 1.101.0
• 1.100.0
• 1.98.0
• 1.97.0
• 1.96.0
• 1.95.0
• 1.94.0
• 1.93.1
• 1.92.1
• 1.91.0
• 1.90.0
• 1.89.0
• 1.88.0
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.1
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

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

A Group represents a paxos group in a database. A group is a set of tablets that are replicated across multiple servers. Groups may have a leader tablet. Groups store one (or sometimes more) ranges of keys.

Generated from protobuf message google.spanner.v1.Group

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ group_uid	int|string The UID of the paxos group, unique within the database. Matches the group_uid field in Range.
↳ tablets	array<Tablet> A list of tablets that are part of the group. Note that this list may not be exhaustive; it will only include tablets the server considers useful to the client. The returned list is ordered ascending by distance. Tablet UIDs reference Tablet.tablet_uid.
↳ leader_index	int The last known leader tablet of the group as an index into tablets. May be negative if the group has no known leader.
↳ generation	string generation indicates the freshness of the group information (including leader information) contained in this proto. Generations can be compared lexicographically; if generation A is greater than generation B, then the Group corresponding to A is newer than the Group corresponding to B, and should be used preferentially.

getGroupUid

The UID of the paxos group, unique within the database. Matches the group_uid field in Range.

Returns
Type	Description
int|string

setGroupUid

The UID of the paxos group, unique within the database. Matches the group_uid field in Range.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getTablets

A list of tablets that are part of the group. Note that this list may not be exhaustive; it will only include tablets the server considers useful to the client. The returned list is ordered ascending by distance.

Tablet UIDs reference Tablet.tablet_uid.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setTablets

A list of tablets that are part of the group. Note that this list may not be exhaustive; it will only include tablets the server considers useful to the client. The returned list is ordered ascending by distance.

Tablet UIDs reference Tablet.tablet_uid.

Parameter
Name	Description
var	array<Tablet>

Returns
Type	Description
$this

getLeaderIndex

The last known leader tablet of the group as an index into tablets. May be negative if the group has no known leader.

Returns
Type	Description
int

setLeaderIndex

The last known leader tablet of the group as an index into tablets. May be negative if the group has no known leader.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getGeneration

generation indicates the freshness of the group information (including leader information) contained in this proto. Generations can be compared lexicographically; if generation A is greater than generation B, then the Group corresponding to A is newer than the Group corresponding to B, and should be used preferentially.

Returns
Type	Description
string

setGeneration

generation indicates the freshness of the group information (including leader information) contained in this proto. Generations can be compared lexicographically; if generation A is greater than generation B, then the Group corresponding to A is newer than the Group corresponding to B, and should be used preferentially.

Parameter
Name	Description
var	string

Returns
Type	Description
$this