Reference documentation and code samples for the Cloud Spanner V1 Client class KeySet.
KeySetdefines 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 messagegoogle.spanner.v1.KeySet
A list of specific keys. Entries inkeysshould have exactly as many elements as there are columns in the primary or index key with which thisKeySetis used. Individual key values are encoded as describedhere.
A list of key ranges. SeeKeyRangefor more information about key range specifications.
↳ all
bool
For convenienceallcan be set totrueto indicate that thisKeySetmatches all keys in the table or index. Note that any keys specified inkeysorrangesare only yielded once.
getKeys
A list of specific keys. Entries inkeysshould have exactly as
many elements as there are columns in the primary or index key
with which thisKeySetis used. Individual key values are
encoded as describedhere.
A list of specific keys. Entries inkeysshould have exactly as
many elements as there are columns in the primary or index key
with which thisKeySetis used. Individual key values are
encoded as describedhere.
For convenienceallcan be set totrueto indicate that thisKeySetmatches all keys in the table or index. Note that any keys
specified inkeysorrangesare only yielded once.
Returns
Type
Description
bool
setAll
For convenienceallcan be set totrueto indicate that thisKeySetmatches all keys in the table or index. Note that any keys
specified inkeysorrangesare only yielded once.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Spanner V1 Client - Class KeySet (1.104.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.104.0 (latest)](/php/docs/reference/cloud-spanner/latest/V1.KeySet)\n- [1.103.0](/php/docs/reference/cloud-spanner/1.103.0/V1.KeySet)\n- [1.102.0](/php/docs/reference/cloud-spanner/1.102.0/V1.KeySet)\n- [1.101.0](/php/docs/reference/cloud-spanner/1.101.0/V1.KeySet)\n- [1.100.0](/php/docs/reference/cloud-spanner/1.100.0/V1.KeySet)\n- [1.98.0](/php/docs/reference/cloud-spanner/1.98.0/V1.KeySet)\n- [1.97.0](/php/docs/reference/cloud-spanner/1.97.0/V1.KeySet)\n- [1.96.0](/php/docs/reference/cloud-spanner/1.96.0/V1.KeySet)\n- [1.95.0](/php/docs/reference/cloud-spanner/1.95.0/V1.KeySet)\n- [1.94.0](/php/docs/reference/cloud-spanner/1.94.0/V1.KeySet)\n- [1.93.1](/php/docs/reference/cloud-spanner/1.93.1/V1.KeySet)\n- [1.92.1](/php/docs/reference/cloud-spanner/1.92.1/V1.KeySet)\n- [1.91.0](/php/docs/reference/cloud-spanner/1.91.0/V1.KeySet)\n- [1.90.0](/php/docs/reference/cloud-spanner/1.90.0/V1.KeySet)\n- [1.89.0](/php/docs/reference/cloud-spanner/1.89.0/V1.KeySet)\n- [1.88.0](/php/docs/reference/cloud-spanner/1.88.0/V1.KeySet)\n- [1.87.0](/php/docs/reference/cloud-spanner/1.87.0/V1.KeySet)\n- [1.86.0](/php/docs/reference/cloud-spanner/1.86.0/V1.KeySet)\n- [1.85.0](/php/docs/reference/cloud-spanner/1.85.0/V1.KeySet)\n- [1.84.0](/php/docs/reference/cloud-spanner/1.84.0/V1.KeySet)\n- [1.83.0](/php/docs/reference/cloud-spanner/1.83.0/V1.KeySet)\n- [1.82.0](/php/docs/reference/cloud-spanner/1.82.0/V1.KeySet)\n- [1.81.0](/php/docs/reference/cloud-spanner/1.81.0/V1.KeySet)\n- [1.80.0](/php/docs/reference/cloud-spanner/1.80.0/V1.KeySet)\n- [1.79.0](/php/docs/reference/cloud-spanner/1.79.0/V1.KeySet)\n- [1.78.0](/php/docs/reference/cloud-spanner/1.78.0/V1.KeySet)\n- [1.77.0](/php/docs/reference/cloud-spanner/1.77.0/V1.KeySet)\n- [1.76.1](/php/docs/reference/cloud-spanner/1.76.1/V1.KeySet)\n- [1.68.0](/php/docs/reference/cloud-spanner/1.68.0/V1.KeySet)\n- [1.67.0](/php/docs/reference/cloud-spanner/1.67.0/V1.KeySet)\n- [1.66.0](/php/docs/reference/cloud-spanner/1.66.0/V1.KeySet)\n- [1.65.0](/php/docs/reference/cloud-spanner/1.65.0/V1.KeySet)\n- [1.64.0](/php/docs/reference/cloud-spanner/1.64.0/V1.KeySet)\n- [1.63.2](/php/docs/reference/cloud-spanner/1.63.2/V1.KeySet)\n- [1.62.1](/php/docs/reference/cloud-spanner/1.62.1/V1.KeySet)\n- [1.61.0](/php/docs/reference/cloud-spanner/1.61.0/V1.KeySet)\n- [1.60.0](/php/docs/reference/cloud-spanner/1.60.0/V1.KeySet)\n- [1.59.0](/php/docs/reference/cloud-spanner/1.59.0/V1.KeySet)\n- [1.58.4](/php/docs/reference/cloud-spanner/1.58.4/V1.KeySet)\n- [1.57.0](/php/docs/reference/cloud-spanner/1.57.0/V1.KeySet)\n- [1.56.0](/php/docs/reference/cloud-spanner/1.56.0/V1.KeySet)\n- [1.55.0](/php/docs/reference/cloud-spanner/1.55.0/V1.KeySet)\n- [1.54.2](/php/docs/reference/cloud-spanner/1.54.2/V1.KeySet) \nReference documentation and code samples for the Cloud Spanner V1 Client class KeySet.\n\n`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All\nthe keys are expected to be in the same table or index. The keys need\nnot be sorted in any particular way.\n\nIf the same key is specified multiple times in the set (for example\nif two ranges, two keys, or a key and a range overlap), Cloud Spanner\nbehaves as if the key were only specified once.\n\nGenerated from protobuf message `google.spanner.v1.KeySet`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Spanner \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getKeys\n\nA list of specific keys. Entries in `keys` should have exactly as\nmany elements as there are columns in the primary or index key\nwith which this `KeySet` is used. Individual key values are\nencoded as described [here](/php/docs/reference/cloud-spanner/latest/V1.TypeCode).\n\n### setKeys\n\nA list of specific keys. Entries in `keys` should have exactly as\nmany elements as there are columns in the primary or index key\nwith which this `KeySet` is used. Individual key values are\nencoded as described [here](/php/docs/reference/cloud-spanner/latest/V1.TypeCode).\n\n### getRanges\n\nA list of key ranges. See [KeyRange](/php/docs/reference/cloud-spanner/latest/V1.KeyRange) for more information about\nkey range specifications.\n\n### setRanges\n\nA list of key ranges. See [KeyRange](/php/docs/reference/cloud-spanner/latest/V1.KeyRange) for more information about\nkey range specifications.\n\n### getAll\n\nFor convenience `all` can be set to `true` to indicate that this\n`KeySet` matches all keys in the table or index. Note that any keys\nspecified in `keys` or `ranges` are only yielded once.\n\n### setAll\n\nFor convenience `all` can be set to `true` to indicate that this\n`KeySet` matches all keys in the table or index. Note that any keys\nspecified in `keys` or `ranges` are only yielded once."]]
