public static final class PartialResultSet.Builder extends GeneratedMessageV3.Builder<PartialResultSet.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PartialResultSet.BuilderImplements
PartialResultSetOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllValues(Iterable<? extends Value> values)
public PartialResultSet.Builder addAllValues(Iterable<? extends Value> values)
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 chunkedstring
: concatenate the stringslist
: concatenate the lists. If the last element in a list is astring
,list
, orobject
, 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
PartialResultSet
s 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
PartialResultSet
s 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 |
values |
Iterable<? extends com.google.protobuf.Value> |
Returns | |
---|---|
Type | Description |
PartialResultSet.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PartialResultSet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
PartialResultSet.Builder |
addValues(Value value)
public PartialResultSet.Builder addValues(Value value)
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 chunkedstring
: concatenate the stringslist
: concatenate the lists. If the last element in a list is astring
,list
, orobject
, 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
PartialResultSet
s 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
PartialResultSet
s 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 |
value |
Value |
Returns | |
---|---|
Type | Description |
PartialResultSet.Builder |
addValues(Value.Builder builderForValue)
public PartialResultSet.Builder addValues(Value.Builder builderForValue)
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 chunkedstring
: concatenate the stringslist
: concatenate the lists. If the last element in a list is astring
,list
, orobject
, 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
PartialResultSet
s 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
PartialResultSet
s 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 |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
PartialResultSet.Builder |
addValues(int index, Value value)
public PartialResultSet.Builder addValues(int index, Value value)
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 chunkedstring
: concatenate the stringslist
: concatenate the lists. If the last element in a list is astring
,list
, orobject
, 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