Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::Range (v1.12.0)

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#generation

def generation() -> ::String
Returns
  • (::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.

#generation=

def generation=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#group_uid

def group_uid() -> ::Integer
Returns
  • (::Integer) — The UID of the paxos group where this range is stored. UIDs are unique within the database. References Group.group_uid.

#group_uid=

def group_uid=(value) -> ::Integer
Parameter
  • value (::Integer) — The UID of the paxos group where this range is stored. UIDs are unique within the database. References Group.group_uid.
Returns
  • (::Integer) — The UID of the paxos group where this range is stored. UIDs are unique within the database. References Group.group_uid.

#limit_key

def limit_key() -> ::String
Returns
  • (::String) — The limit key of the range, exclusive. Encoded in "sortable string format" (ssformat).

#limit_key=

def limit_key=(value) -> ::String
Parameter
  • value (::String) — The limit key of the range, exclusive. Encoded in "sortable string format" (ssformat).
Returns
  • (::String) — The limit key of the range, exclusive. Encoded in "sortable string format" (ssformat).

#split_id

def split_id() -> ::Integer
Returns
  • (::Integer) — 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.

#split_id=

def split_id=(value) -> ::Integer
Parameter
  • value (::Integer) — 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
  • (::Integer) — 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.

#start_key

def start_key() -> ::String
Returns
  • (::String) — The start key of the range, inclusive. Encoded in "sortable string format" (ssformat).

#start_key=

def start_key=(value) -> ::String
Parameter
  • value (::String) — The start key of the range, inclusive. Encoded in "sortable string format" (ssformat).
Returns
  • (::String) — The start key of the range, inclusive. Encoded in "sortable string format" (ssformat).