Class: Google::Spanner::V1::KeySet

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/spanner/v1/doc/google/spanner/v1/keys.rb

Overview

+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.

Instance Attribute Summary collapse

Instance Attribute Details

#all ⇒ true, false

Returns 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:

  • (true, false) —

    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.



145
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/keys.rb', line 145

class KeySet; end

#keys ⇒ Array<Google::Protobuf::ListValue>

Returns 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:

  • (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.



145
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/keys.rb', line 145

class KeySet; end

#ranges ⇒ Array<Google::Spanner::V1::KeyRange>

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

Returns:



145
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/keys.rb', line 145

class KeySet; end