KeySet
class KeySet extends Message
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.
Protobuf type Google\Spanner\V1\KeySet
Methods
No description
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][google.spanner.v1.TypeCode].
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][google.spanner.v1.TypeCode].
A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about key range specifications.
A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about key range specifications.
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.
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.
Details
at line 48
__construct()
at line 62
RepeatedField
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][google.spanner.v1.TypeCode].
Generated from protobuf field repeated .google.protobuf.ListValue keys = 1;
at line 76
setKeys(array|RepeatedField $var)
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][google.spanner.v1.TypeCode].
Generated from protobuf field repeated .google.protobuf.ListValue keys = 1;
at line 89
RepeatedField
getRanges()
A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about key range specifications.
Generated from protobuf field repeated .google.spanner.v1.KeyRange ranges = 2;
at line 101
setRanges(array|RepeatedField $var)
A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about key range specifications.
Generated from protobuf field repeated .google.spanner.v1.KeyRange ranges = 2;
at line 115
bool
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;
at line 128
setAll(bool $var)
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;