Cloud Spanner V1 Client - Class Range (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 Range.

A Range represents a range of keys in a database. The keys themselves are encoded in "sortable string format", also known as ssformat. Consult Spanner's open source client libraries for details on the encoding.

Each range represents a contiguous range of rows, possibly from multiple tables/indexes. Each range is associated with a single paxos group (known as a "group" throughout this API), a split (which names the exact range within the group), and a generation that can be used to determine whether a given Range represents a newer or older location for the key range.

Generated from protobuf message google.spanner.v1.Range

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ start_key	string The start key of the range, inclusive. Encoded in "sortable string format" (ssformat).
↳ limit_key	string The limit key of the range, exclusive. Encoded in "sortable string format" (ssformat).
↳ group_uid	int|string The UID of the paxos group where this range is stored. UIDs are unique within the database. References Group.group_uid.
↳ split_id	int|string A group can store multiple ranges of keys. Each key range is named by an ID (the split ID). Within a group, split IDs are unique. The split_id names the exact split in group_uid where this range is stored.
↳ generation	string generation indicates the freshness of the range information contained in this proto. Generations can be compared lexicographically; if generation A is greater than generation B, then the Range corresponding to A is newer than the Range corresponding to B, and should be used preferentially.

getStartKey

The start key of the range, inclusive. Encoded in "sortable string format" (ssformat).

Returns
Type	Description
string

setStartKey

The start key of the range, inclusive. Encoded in "sortable string format" (ssformat).

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLimitKey

The limit key of the range, exclusive. Encoded in "sortable string format" (ssformat).

Returns
Type	Description
string

setLimitKey

The limit key of the range, exclusive. Encoded in "sortable string format" (ssformat).

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getGroupUid

The UID of the paxos group where this range is stored. UIDs are unique within the database. References Group.group_uid.

Returns
Type	Description
int|string

setGroupUid

The UID of the paxos group where this range is stored. UIDs are unique within the database. References Group.group_uid.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getSplitId

A group can store multiple ranges of keys. Each key range is named by an ID (the split ID). Within a group, split IDs are unique. The split_id names the exact split in group_uid where this range is stored.

Returns
Type	Description
int|string

setSplitId

A group can store multiple ranges of keys. Each key range is named by an ID (the split ID). Within a group, split IDs are unique. The split_id names the exact split in group_uid where this range is stored.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getGeneration

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

Returns
Type	Description
string

setGeneration

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this