Class PartialResultSet (6.66.0)

public final class PartialResultSet extends GeneratedMessageV3 implements PartialResultSetOrBuilder

Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume.

Protobuf type google.spanner.v1.PartialResultSet

Inheritance

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

Static Fields

CHUNKED_VALUE_FIELD_NUMBER

public static final int CHUNKED_VALUE_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

RESUME_TOKEN_FIELD_NUMBER

public static final int RESUME_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

STATS_FIELD_NUMBER

public static final int STATS_FIELD_NUMBER
Field Value
Type Description
int

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PartialResultSet getDefaultInstance()
Returns
Type Description
PartialResultSet

getDescriptor()

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

newBuilder()

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

newBuilder(PartialResultSet prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getChunkedValue()

public boolean getChunkedValue()

If true, then the final value in values is chunked, and must be combined with more values from subsequent PartialResultSets to obtain a complete field value.

bool chunked_value = 3;

Returns
Type Description
boolean

The chunkedValue.

getDefaultInstanceForType()

public PartialResultSet getDefaultInstanceForType()
Returns
Type Description
PartialResultSet

getMetadata()

public ResultSetMetadata getMetadata()

Metadata about the result set, such as row type information. Only present in the first response.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Returns
Type Description
ResultSetMetadata

The metadata.

getMetadataOrBuilder()

public ResultSetMetadataOrBuilder getMetadataOrBuilder()

Metadata about the result set, such as row type information. Only present in the first response.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Returns
Type Description
ResultSetMetadataOrBuilder

getParserForType()

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

getResumeToken()

public ByteString getResumeToken()

Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including resume_token. Note that executing any other transaction in the same session invalidates the token.

bytes resume_token = 4;

Returns
Type Description
ByteString

The resumeToken.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStats()

public ResultSetStats getStats()

Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements.

.google.spanner.v1.ResultSetStats stats = 5;

Returns
Type Description
ResultSetStats

The stats.

getStatsOrBuilder()

public ResultSetStatsOrBuilder getStatsOrBuilder()

Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements.

.google.spanner.v1.ResultSetStats stats = 5;

Returns
Type Description
ResultSetStatsOrBuilder

getValues(int index)

public Value getValues(int index)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

  • bool/number/null: cannot be chunked
  • string: concatenate the strings
  • list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

  • object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

    Some examples of merging:

    Strings are concatenated.

    "foo", "bar" => "foobar"

    Lists of non-strings are concatenated.

    [2, 3], [4] => [2, 3, 4]

    Lists are concatenated, but the last and first elements are merged

    because they are strings.

    ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

    Lists are concatenated, but the last and first elements are merged

    because they are lists. Recursively, the last and first elements

    of the inner lists are merged because they are strings.

    ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

    Non-overlapping object fields are combined.

    {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

    Overlapping object fields are merged.

    {"a": "1"}, {"a": "2"} => {"a": "12"}

    Examples of merging objects containing lists of strings.

    {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

    For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

    { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

    This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameter
Name Description
index int
Returns
Type Description
Value

getValuesCount()

public int getValuesCount()

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

  • bool/number/null: cannot be chunked
  • string: concatenate the strings
  • list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

  • object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

    Some examples of merging:

    Strings are concatenated.

    "foo", "bar" => "foobar"

    Lists of non-strings are concatenated.

    [2, 3], [4] => [2, 3, 4]

    Lists are concatenated, but the last and first elements are merged

    because they are strings.

    ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

    Lists are concatenated, but the last and first elements are merged

    because they are lists. Recursively, the last and first elements

    of the inner lists are merged because they are strings.

    ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

    Non-overlapping object fields are combined.

    {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

    Overlapping object fields are merged.

    {"a": "1"}, {"a": "2"} => {"a": "12"}

    Examples of merging objects containing lists of strings.

    {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

    For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

    { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

    This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Returns
Type Description
int

getValuesList()

public List<Value> getValuesList()

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

  • bool/number/null: cannot be chunked
  • string: concatenate the strings
  • list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

  • object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

    Some examples of merging:

    Strings are concatenated.

    "foo", "bar" => "foobar"

    Lists of non-strings are concatenated.

    [2, 3], [4] => [2, 3, 4]

    Lists are concatenated, but the last and first elements are merged

    because they are strings.

    ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

    Lists are concatenated, but the last and first elements are merged

    because they are lists. Recursively, the last and first elements

    of the inner lists are merged because they are strings.

    ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

    Non-overlapping object fields are combined.

    {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

    Overlapping object fields are merged.

    {"a": "1"}, {"a": "2"} => {"a": "12"}

    Examples of merging objects containing lists of strings.

    {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

    For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

    { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

    This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Returns
Type Description
List<Value>

getValuesOrBuilder(int index)

public ValueOrBuilder getValuesOrBuilder(int index)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

  • bool/number/null: cannot be chunked
  • string: concatenate the strings
  • list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

  • object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

    Some examples of merging:

    Strings are concatenated.

    "foo", "bar" => "foobar"

    Lists of non-strings are concatenated.

    [2, 3], [4] => [2, 3, 4]

    Lists are concatenated, but the last and first elements are merged

    because they are strings.

    ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

    Lists are concatenated, but the last and first elements are merged

    because they are lists. Recursively, the last and first elements

    of the inner lists are merged because they are strings.

    ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

    Non-overlapping object fields are combined.

    {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

    Overlapping object fields are merged.

    {"a": "1"}, {"a": "2"} => {"a": "12"}

    Examples of merging objects containing lists of strings.

    {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

    For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

    { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

    This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameter
Name Description
index int
Returns
Type Description
ValueOrBuilder

getValuesOrBuilderList()

public List<? extends ValueOrBuilder> getValuesOrBuilderList()

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

  • bool/number/null: cannot be chunked
  • string: concatenate the strings
  • list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

  • object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

    Some examples of merging:

    Strings are concatenated.

    "foo", "bar" => "foobar"

    Lists of non-strings are concatenated.

    [2, 3], [4] => [2, 3, 4]

    Lists are concatenated, but the last and first elements are merged

    because they are strings.

    ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

    Lists are concatenated, but the last and first elements are merged

    because they are lists. Recursively, the last and first elements

    of the inner lists are merged because they are strings.

    ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

    Non-overlapping object fields are combined.

    {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

    Overlapping object fields are merged.

    {"a": "1"}, {"a": "2"} => {"a": "12"}

    Examples of merging objects containing lists of strings.

    {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

    For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

    { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

    This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Returns
Type Description
List<? extends com.google.protobuf.ValueOrBuilder>

hasMetadata()

public boolean hasMetadata()

Metadata about the result set, such as row type information. Only present in the first response.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Returns
Type Description
boolean

Whether the metadata field is set.

hasStats()

public boolean hasStats()

Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements.

.google.spanner.v1.ResultSetStats stats = 5;

Returns
Type Description
boolean

Whether the stats 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 PartialResultSet.Builder newBuilderForType()
Returns
Type Description
PartialResultSet.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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