Class: Google::Apis::SpannerV1::ReadRequest
- Inherits:
-
Object
- Object
- Google::Apis::SpannerV1::ReadRequest
- 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
The request for Read and StreamingRead.
Instance Attribute Summary collapse
-
#columns ⇒ Array<String>
Required.
-
#index ⇒ String
If non-empty, the name of an index on table.
-
#key_set ⇒ Google::Apis::SpannerV1::KeySet
KeySet
defines a collection of Cloud Spanner keys and/or key ranges. -
#limit ⇒ Fixnum
If greater than zero, only the first
limit
rows are yielded. -
#partition_token ⇒ String
If present, results will be restricted to the specified partition previously created using PartitionRead().
-
#resume_token ⇒ String
If this request is resuming a previously interrupted read,
resume_token
should be copied from the last PartialResultSet yielded before the interruption. -
#table ⇒ String
Required.
-
#transaction ⇒ Google::Apis::SpannerV1::TransactionSelector
This message is used to select the transaction in which a Read or ExecuteSql call runs.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ReadRequest
constructor
A new instance of ReadRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ReadRequest
Returns a new instance of ReadRequest.
2488 2489 2490 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2488 def initialize(**args) update!(**args) end |
Instance Attribute Details
#columns ⇒ Array<String>
Required. The columns of table to be returned for each row matching
this request.
Corresponds to the JSON property columns
2429 2430 2431 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2429 def columns @columns end |
#index ⇒ String
If non-empty, the name of an index on table. This index is
used instead of the table primary key when interpreting key_set
and sorting result rows. See key_set for further information.
Corresponds to the JSON property index
2436 2437 2438 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2436 def index @index end |
#key_set ⇒ Google::Apis::SpannerV1::KeySet
KeySet
defines a collection of Cloud Spanner keys and/or key ranges. All
the keys are expected to be in the same table or index. The keys need
not be sorted in any particular way.
If the same key is specified multiple times in the set (for example
if two ranges, two keys, or a key and a range overlap), Cloud Spanner
behaves as if the key were only specified once.
Corresponds to the JSON property keySet
2446 2447 2448 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2446 def key_set @key_set end |
#limit ⇒ Fixnum
If greater than zero, only the first limit
rows are yielded. If limit
is zero, the default is no limit. A limit cannot be specified if
partition_token
is set.
Corresponds to the JSON property limit
2453 2454 2455 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2453 def limit @limit end |
#partition_token ⇒ String
If present, results will be restricted to the specified partition
previously created using PartitionRead(). There must be an exact
match for the values of fields common to this message and the
PartitionReadRequest message used to create this partition_token.
Corresponds to the JSON property partitionToken
NOTE: Values are automatically base64 encoded/decoded in the client library.
2462 2463 2464 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2462 def partition_token @partition_token end |
#resume_token ⇒ String
If this request is resuming a previously interrupted read,
resume_token
should be copied from the last
PartialResultSet yielded before the interruption. Doing this
enables the new read to resume where the last read left off. The
rest of the request parameters must exactly match the request
that yielded this token.
Corresponds to the JSON property resumeToken
NOTE: Values are automatically base64 encoded/decoded in the client library.
2473 2474 2475 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2473 def resume_token @resume_token end |
#table ⇒ String
Required. The name of the table in the database to be read.
Corresponds to the JSON property table
2478 2479 2480 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2478 def table @table end |
#transaction ⇒ Google::Apis::SpannerV1::TransactionSelector
This message is used to select the transaction in which a
Read or
ExecuteSql call runs.
See TransactionOptions for more information about transactions.
Corresponds to the JSON property transaction
2486 2487 2488 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2486 def transaction @transaction end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2493 def update!(**args) @columns = args[:columns] if args.key?(:columns) @index = args[:index] if args.key?(:index) @key_set = args[:key_set] if args.key?(:key_set) @limit = args[:limit] if args.key?(:limit) @partition_token = args[:partition_token] if args.key?(:partition_token) @resume_token = args[:resume_token] if args.key?(:resume_token) @table = args[:table] if args.key?(:table) @transaction = args[:transaction] if args.key?(:transaction) end |