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
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 |
↳ 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 |
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.
Generated from protobuf field repeated .google.protobuf.ListValue keys = 1;
| 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.
Generated from protobuf field repeated .google.protobuf.ListValue keys = 1;
| 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.
Generated from protobuf field repeated .google.spanner.v1.KeyRange ranges = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setRanges
A list of key ranges. See KeyRange for more information about key range specifications.
Generated from protobuf field repeated .google.spanner.v1.KeyRange ranges = 2;
| 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.
Generated from protobuf field bool all = 3;
| 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.
Generated from protobuf field bool all = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |