Class KeyRange.Builder (6.58.0)

public static final class KeyRange.Builder extends GeneratedMessageV3.Builder<KeyRange.Builder> 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

Implements

KeyRangeOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public KeyRange.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
KeyRange.Builder
Overrides

build()

public KeyRange build()
Returns
TypeDescription
KeyRange

buildPartial()

public KeyRange buildPartial()
Returns
TypeDescription
KeyRange

clear()

public KeyRange.Builder clear()
Returns
TypeDescription
KeyRange.Builder
Overrides

clearEndClosed()

public KeyRange.Builder clearEndClosed()

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
TypeDescription
KeyRange.Builder

clearEndKeyType()

public KeyRange.Builder clearEndKeyType()
Returns
TypeDescription
KeyRange.Builder

clearEndOpen()

public KeyRange.Builder clearEndOpen()

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
TypeDescription
KeyRange.Builder

clearField(Descriptors.FieldDescriptor field)

public KeyRange.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
KeyRange.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public KeyRange.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
KeyRange.Builder
Overrides

clearStartClosed()

public KeyRange.Builder clearStartClosed()

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
TypeDescription
KeyRange.Builder

clearStartKeyType()

public KeyRange.Builder clearStartKeyType()
Returns
TypeDescription
KeyRange.Builder

clearStartOpen()

public KeyRange.Builder clearStartOpen()

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
TypeDescription
KeyRange.Builder

clone()

public KeyRange.Builder clone()
Returns
TypeDescription
KeyRange.Builder
Overrides

getDefaultInstanceForType()

public KeyRange getDefaultInstanceForType()
Returns
TypeDescription
KeyRange

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
ListValue

The endClosed.

getEndClosedBuilder()

public ListValue.Builder getEndClosedBuilder()

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
TypeDescription
Builder

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
TypeDescription
ListValueOrBuilder

getEndKeyTypeCase()

public KeyRange.EndKeyTypeCase getEndKeyTypeCase()
Returns
TypeDescription
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
TypeDescription
ListValue

The endOpen.

getEndOpenBuilder()

public ListValue.Builder getEndOpenBuilder()

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
TypeDescription
Builder

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
TypeDescription
ListValueOrBuilder

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
TypeDescription
ListValue

The startClosed.

getStartClosedBuilder()

public ListValue.Builder getStartClosedBuilder()

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
TypeDescription
Builder

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
TypeDescription
ListValueOrBuilder

getStartKeyTypeCase()

public KeyRange.StartKeyTypeCase getStartKeyTypeCase()
Returns
TypeDescription
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
TypeDescription
ListValue

The startOpen.

getStartOpenBuilder()

public ListValue.Builder getStartOpenBuilder()

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
TypeDescription
Builder

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the startOpen field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEndClosed(ListValue value)

public KeyRange.Builder mergeEndClosed(ListValue value)

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;

Parameter
NameDescription
valueListValue
Returns
TypeDescription
KeyRange.Builder

mergeEndOpen(ListValue value)

public KeyRange.Builder mergeEndOpen(ListValue value)

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;

Parameter
NameDescription
valueListValue
Returns
TypeDescription
KeyRange.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public KeyRange.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeyRange.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public KeyRange.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
KeyRange.Builder
Overrides

mergeFrom(KeyRange other)

public KeyRange.Builder mergeFrom(KeyRange other)
Parameter
NameDescription
otherKeyRange
Returns
TypeDescription
KeyRange.Builder

mergeStartClosed(ListValue value)

public KeyRange.Builder mergeStartClosed(ListValue value)

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;

Parameter
NameDescription
valueListValue
Returns
TypeDescription
KeyRange.Builder

mergeStartOpen(ListValue value)

public KeyRange.Builder mergeStartOpen(ListValue value)

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;

Parameter
NameDescription
valueListValue
Returns
TypeDescription
KeyRange.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final KeyRange.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
KeyRange.Builder
Overrides

setEndClosed(ListValue value)

public KeyRange.Builder setEndClosed(ListValue value)

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;

Parameter
NameDescription
valueListValue
Returns
TypeDescription
KeyRange.Builder

setEndClosed(ListValue.Builder builderForValue)

public KeyRange.Builder setEndClosed(ListValue.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
KeyRange.Builder

setEndOpen(ListValue value)

public KeyRange.Builder setEndOpen(ListValue value)

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;

Parameter
NameDescription
valueListValue
Returns
TypeDescription
KeyRange.Builder

setEndOpen(ListValue.Builder builderForValue)

public KeyRange.Builder setEndOpen(ListValue.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
KeyRange.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public KeyRange.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
KeyRange.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public KeyRange.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
KeyRange.Builder
Overrides

setStartClosed(ListValue value)

public KeyRange.Builder setStartClosed(ListValue value)

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;

Parameter
NameDescription
valueListValue
Returns
TypeDescription
KeyRange.Builder

setStartClosed(ListValue.Builder builderForValue)

public KeyRange.Builder setStartClosed(ListValue.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
KeyRange.Builder

setStartOpen(ListValue value)

public KeyRange.Builder setStartOpen(ListValue value)

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;

Parameter
NameDescription
valueListValue
Returns
TypeDescription
KeyRange.Builder

setStartOpen(ListValue.Builder builderForValue)

public KeyRange.Builder setStartOpen(ListValue.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
KeyRange.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final KeyRange.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
KeyRange.Builder
Overrides