Cloud Spanner V1 Client - Class KeySet (1.76.0)

Version latest

• 1.76.0 (latest)
• 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 KeySet.

KeySet defines a collection of Cloud Spanner keys and/or key ranges. All the keys are expected to be in the same table or index. The keys need not be sorted in any particular way.

If the same key is specified multiple times in the set (for example if two ranges, two keys, or a key and a range overlap), Cloud Spanner behaves as if the key were only specified once.

Generated from protobuf message google.spanner.v1.KeySet

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ keys	array<Google\Protobuf\ListValue> A list of specific keys. Entries in keys should have exactly as many elements as there are columns in the primary or index key with which this KeySet is used. Individual key values are encoded as described here.
↳ ranges	array<Google\Cloud\Spanner\V1\KeyRange> A list of key ranges. See KeyRange for more information about key range specifications.
↳ all	bool For convenience all can be set to true to indicate that this KeySet matches all keys in the table or index. Note that any keys specified in keys or ranges are only yielded once.

getKeys

A list of specific keys. Entries in keys should have exactly as many elements as there are columns in the primary or index key with which this KeySet is used. Individual key values are encoded as described here.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setKeys

A list of specific keys. Entries in keys should have exactly as many elements as there are columns in the primary or index key with which this KeySet is used. Individual key values are encoded as described here.

Parameter
Name	Description
var	array<Google\Protobuf\ListValue>

Returns
Type	Description
$this

getRanges

A list of key ranges. See KeyRange for more information about key range specifications.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setRanges

A list of key ranges. See KeyRange for more information about key range specifications.

Parameter
Name	Description
var	array<Google\Cloud\Spanner\V1\KeyRange>

Returns
Type	Description
$this

getAll

For convenience all can be set to true to indicate that this KeySet matches all keys in the table or index. Note that any keys specified in keys or ranges are only yielded once.

Returns
Type	Description
bool

setAll

For convenience all can be set to true to indicate that this KeySet matches all keys in the table or index. Note that any keys specified in keys or ranges are only yielded once.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this