Cloud Spanner Client - Class KeySet (1.82.0)

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

Represents a Cloud Spanner KeySet.

Example:

use Google\Cloud\Spanner\SpannerClient;

$spanner = new SpannerClient();

$keySet = $spanner->keySet();

Create a KeySet.

Fetch the KeyRanges

Example:

$ranges = $keySet->ranges();

Add a single KeyRange.

Example:

$range = new KeyRange();
$keySet->addRange($range);

Set the KeySet's KeyRanges.

Any existing KeyRanges will be overridden.

Example:

$range = new KeyRange();
$keySet->setRanges([$range]);

Fetch the keys.

Example:

$keys = $keySet->keys();

Add a single key.

A Key should have exactly as many elements as there are columns in the primary or index key with which this KeySet is used.

Example:

$keySet->addKey('Bob');

Set the KeySet keys.

Any existing keys will be overridden.

Example:

$keySet->setKeys(['Bob', 'Jill']);

Get the value of Match All.

Example:

if ($keySet->matchAll()) {
    echo "All keys will match";
}

Choose whether the KeySet should match all keys in a table.

Example:

$keySet->setMatchAll(true);

Format a KeySet object for use in the Spanner API.

Create a KeySet from an array created by Google\Cloud\Spanner\KeySet::keySetObject().