Cloud Spanner Client - Class KeyRange (1.67.0)

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

Represents a Cloud Spanner KeyRange.

Example:

use Google\Cloud\Spanner\SpannerClient;

$spanner = new SpannerClient();

// Create a KeyRange for all people named Bob, born in 1969.
$start = $spanner->date(new \DateTime('1969-01-01'));
$end = $spanner->date(new \DateTime('1969-12-31'));

$range = $spanner->keyRange([
    'startType' => KeyRange::TYPE_CLOSED,
    'start' => ['Bob', $start],
    'endType' => KeyRange::TYPE_CLOSED,
    'end' => ['Bob', $end]
]);

Create a KeyRange.

Get the range start.

Example:

$start = $range->start();

Set the range start.

Example:

$range->setStart(KeyRange::TYPE_OPEN, ['Bob']);

Get the range end.

Example:

$end = $range->end();

Set the range end.

Example:

$range->setEnd(KeyRange::TYPE_CLOSED, ['Jill']);

Get the start and end types

Example:

$types = $range->types();

Returns an API-compliant representation of a KeyRange.

Returns a key range that covers all keys where the first components match.

Equivalent to calling KeyRange::__construct() with closed type for start and end, and the same key for the start and end.

Example:

$range = KeyRange::prefixMatch($key);

Create a KeyRange from an array created by Google\Cloud\Spanner\KeyRange::keyRangeObject().