Class KeySet (6.55.0)

public final class KeySet implements Serializable

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), the Cloud Spanner backend behaves as if the key were only specified once. However, the KeySet object itself does not perform any de-duplication.

KeySet instances are immutable.

Inheritance

Object > KeySet

Implements

Serializable

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

all()

public static KeySet all()

Creates a key set that will retrieve all rows of a table or index.

Returns
Type	Description
`KeySet`

newBuilder()

public static KeySet.Builder newBuilder()

Returns a new builder that can be used to construct a key set.

Returns
Type	Description
`KeySet.Builder`

prefixRange(Key prefix)

public static KeySet prefixRange(Key prefix)

Creates a key set that covers all keys where the first prefix.size() components match prefix exactly.

Parameter
Name	Description
`prefix`	`Key`

Returns
Type	Description
`KeySet`

range(KeyRange range)

public static KeySet range(KeyRange range)

Creates a key set containing a single range. See KeyRange for details of how to specify ranges.

Parameter
Name	Description
`range`	`KeyRange`

Returns
Type	Description
`KeySet`

singleKey(Key key)

public static KeySet singleKey(Key key)

Creates a key set containing a single key. key should contain exactly as many elements as there are columns in the primary or index key with this this key set is used.

Parameter
Name	Description
`key`	`Key`

Returns
Type	Description
`KeySet`

Methods

equals(Object o)

public boolean equals(Object o)

Parameter
Name	Description
`o`	`Object`

Returns
Type	Description
`boolean`

Overrides

Object.equals(Object)

getKeys()

public Iterable<Key> getKeys()

Returns the keys in this set.

Returns
Type	Description
`Iterable<Key>`

getRanges()

public Iterable<KeyRange> getRanges()

Returns the ranges in this set.

Returns
Type	Description
`Iterable<KeyRange>`

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

Object.hashCode()

isAll()

public boolean isAll()

Indicates whether the set will retrieve all rows in a table or index.

Returns
Type	Description
`boolean`

toBuilder()

public KeySet.Builder toBuilder()

Returns a builder initialized with the contents of this set.

Returns
Type	Description
`KeySet.Builder`

toString()

public String toString()

Returns
Type	Description
`String`

Overrides

Object.toString()