Class KeyRange (6.71.0) 

public final class KeyRange extends GeneratedMessageV3 implements KeyRangeOrBuilder

KeyRange represents a range of rows in a table or index.

A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key.

Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described here.

For example, consider the following table definition:

 CREATE TABLE UserEvents (
   UserName STRING(MAX),
   EventDate STRING(10)
 ) PRIMARY KEY(UserName, EventDate);

The following keys name rows in this table:

 ["Bob", "2014-09-23"]
 ["Alfred", "2015-06-12"]

Since the UserEvents table's PRIMARY KEY clause names two columns, each UserEvents key has two elements; the first is the UserName, and the second is the EventDate.

Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user "Bob" that occurred in the year 2015:

 "start_closed": ["Bob", "2015-01-01"]
 "end_closed": ["Bob", "2015-12-31"]

Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included.

For example, the following range includes all events for "Bob" that occurred during and after the year 2000:

 "start_closed": ["Bob", "2000-01-01"]
 "end_closed": ["Bob"]

The next example retrieves all events for "Bob":

 "start_closed": ["Bob"]
 "end_closed": ["Bob"]

To retrieve events before the year 2000:

 "start_closed": ["Bob"]
 "end_open": ["Bob", "2000-01-01"]

The following range includes all rows in the table:

 "start_closed": []
 "end_closed": []

This range returns all users whose UserName begins with any character from A to C:

 "start_closed": ["A"]
 "end_open": ["D"]

This range returns all users whose UserName begins with B:

 "start_closed": ["B"]
 "end_open": ["C"]

Key ranges honor column sort order. For example, suppose a table is defined as follows:

 CREATE TABLE DescendingSortedTable {
   Key INT64,
   ...
 ) PRIMARY KEY(Key DESC);

The following range retrieves all rows with key values between 1 and 100 inclusive:

 "start_closed": ["100"]
 "end_closed": ["1"]

Note that 100 is passed as the start, and 1 is passed as the end, because Key is a descending column in the schema.

Protobuf type google.spanner.v1.KeyRange

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > KeyRange

Implements

KeyRangeOrBuilder

Static Fields

END_CLOSED_FIELD_NUMBER

public static final int END_CLOSED_FIELD_NUMBER
Field Value
Type Description
int

END_OPEN_FIELD_NUMBER

public static final int END_OPEN_FIELD_NUMBER
Field Value
Type Description
int

START_CLOSED_FIELD_NUMBER

public static final int START_CLOSED_FIELD_NUMBER
Field Value
Type Description
int

START_OPEN_FIELD_NUMBER

public static final int START_OPEN_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static KeyRange getDefaultInstance()
Returns
Type Description
KeyRange

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static KeyRange.Builder newBuilder()
Returns
Type Description
KeyRange.Builder

newBuilder(KeyRange prototype)

public static KeyRange.Builder newBuilder(KeyRange prototype)
Parameter
Name Description
prototype KeyRange
Returns
Type Description
KeyRange.Builder

parseDelimitedFrom(InputStream input)

public static KeyRange parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KeyRange
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyRange parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyRange
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static KeyRange parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
KeyRange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static KeyRange parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyRange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KeyRange parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
KeyRange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KeyRange parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyRange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KeyRange parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
KeyRange
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyRange parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyRange
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static KeyRange parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KeyRange
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyRange parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyRange
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static KeyRange parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
KeyRange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KeyRange parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyRange
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<KeyRange> parser()
Returns
Type Description
Parser<KeyRange>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public KeyRange getDefaultInstanceForType()
Returns
Type Description
KeyRange

getEndClosed()

public ListValue getEndClosed()

If the end is closed, then the range includes all rows whose first len(end_closed) key columns exactly match end_closed.

.google.protobuf.ListValue end_closed = 3;

Returns
Type Description
ListValue

The endClosed.

getEndClosedOrBuilder()

public ListValueOrBuilder getEndClosedOrBuilder()

If the end is closed, then the range includes all rows whose first len(end_closed) key columns exactly match end_closed.

.google.protobuf.ListValue end_closed = 3;

Returns
Type Description
ListValueOrBuilder

getEndKeyTypeCase()

public KeyRange.EndKeyTypeCase getEndKeyTypeCase()
Returns
Type Description
KeyRange.EndKeyTypeCase

getEndOpen()

public ListValue getEndOpen()

If the end is open, then the range excludes rows whose first len(end_open) key columns exactly match end_open.

.google.protobuf.ListValue end_open = 4;

Returns
Type Description
ListValue

The endOpen.

getEndOpenOrBuilder()

public ListValueOrBuilder getEndOpenOrBuilder()

If the end is open, then the range excludes rows whose first len(end_open) key columns exactly match end_open.

.google.protobuf.ListValue end_open = 4;

Returns
Type Description
ListValueOrBuilder

getParserForType()

public Parser<KeyRange> getParserForType()
Returns
Type Description
Parser<KeyRange>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartClosed()

public ListValue getStartClosed()

If the start is closed, then the range includes all rows whose first len(start_closed) key columns exactly match start_closed.

.google.protobuf.ListValue start_closed = 1;

Returns
Type Description
ListValue

The startClosed.

getStartClosedOrBuilder()

public ListValueOrBuilder getStartClosedOrBuilder()

If the start is closed, then the range includes all rows whose first len(start_closed) key columns exactly match start_closed.

.google.protobuf.ListValue start_closed = 1;

Returns
Type Description
ListValueOrBuilder

getStartKeyTypeCase()

public KeyRange.StartKeyTypeCase getStartKeyTypeCase()
Returns
Type Description
KeyRange.StartKeyTypeCase

getStartOpen()

public ListValue getStartOpen()

If the start is open, then the range excludes rows whose first len(start_open) key columns exactly match start_open.

.google.protobuf.ListValue start_open = 2;

Returns
Type Description
ListValue

The startOpen.

getStartOpenOrBuilder()

public ListValueOrBuilder getStartOpenOrBuilder()

If the start is open, then the range excludes rows whose first len(start_open) key columns exactly match start_open.

.google.protobuf.ListValue start_open = 2;

Returns
Type Description
ListValueOrBuilder

hasEndClosed()

public boolean hasEndClosed()

If the end is closed, then the range includes all rows whose first len(end_closed) key columns exactly match end_closed.

.google.protobuf.ListValue end_closed = 3;

Returns
Type Description
boolean

Whether the endClosed field is set.

hasEndOpen()

public boolean hasEndOpen()

If the end is open, then the range excludes rows whose first len(end_open) key columns exactly match end_open.

.google.protobuf.ListValue end_open = 4;

Returns
Type Description
boolean

Whether the endOpen field is set.

hasStartClosed()

public boolean hasStartClosed()

If the start is closed, then the range includes all rows whose first len(start_closed) key columns exactly match start_closed.

.google.protobuf.ListValue start_closed = 1;

Returns
Type Description
boolean

Whether the startClosed field is set.

hasStartOpen()

public boolean hasStartOpen()

If the start is open, then the range excludes rows whose first len(start_open) key columns exactly match start_open.

.google.protobuf.ListValue start_open = 2;

Returns
Type Description
boolean

Whether the startOpen field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public KeyRange.Builder newBuilderForType()
Returns
Type Description
KeyRange.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KeyRange.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
KeyRange.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public KeyRange.Builder toBuilder()
Returns
Type Description
KeyRange.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException