Class: Google::Apis::SpannerV1::PartialResultSet

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/spanner_v1/classes.rb,
generated/google/apis/spanner_v1/representations.rb,
generated/google/apis/spanner_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PartialResultSet

Returns a new instance of PartialResultSet



1510
1511
1512
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1510

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#chunked_value ⇒ Boolean Also known as: chunked_value?

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. Corresponds to the JSON property chunkedValue

Returns:

  • (Boolean) 


1424
1425
1426
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1424

def chunked_value
  @chunked_value
end

#metadata ⇒ Google::Apis::SpannerV1::ResultSetMetadata

Metadata about a ResultSet or PartialResultSet. Corresponds to the JSON property metadata

Returns:



1430
1431
1432
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1430

def metadata
  @metadata
end

#resume_token ⇒ String

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. Corresponds to the JSON property resumeToken NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1440
1441
1442
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1440

def resume_token
  @resume_token
end

#stats ⇒ Google::Apis::SpannerV1::ResultSetStats

Additional statistics about a ResultSet or PartialResultSet. Corresponds to the JSON property stats

Returns:



1445
1446
1447
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1445

def stats
  @stats
end

#values ⇒ Array<Object>

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". Corresponds to the JSON property values

Returns:

  • (Array<Object>) 


1508
1509
1510
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1508

def values
  @values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1515
1516
1517
1518
1519
1520
1521
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1515

def update!(**args)
  @chunked_value = args[:chunked_value] if args.key?(:chunked_value)
  @metadata = args[:metadata] if args.key?(:metadata)
  @resume_token = args[:resume_token] if args.key?(:resume_token)
  @stats = args[:stats] if args.key?(:stats)
  @values = args[:values] if args.key?(:values)
end