Class: Google::Spanner::V1::ReadRequest
- Inherits:
-
Object
- Object
- Google::Spanner::V1::ReadRequest
- Defined in:
- lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb
Overview
The request for Read and StreamingRead.
Instance Attribute Summary collapse
-
#columns ⇒ Array<String>
The columns of table to be returned for each row matching this request.
-
#index ⇒ String
If non-empty, the name of an index on table.
-
#key_set ⇒ Google::Spanner::V1::KeySet
Required.
-
#limit ⇒ Integer
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.
-
#session ⇒ String
Required.
-
#table ⇒ String
Required.
-
#transaction ⇒ Google::Spanner::V1::TransactionSelector
The transaction to use.
Instance Attribute Details
#columns ⇒ Array<String>
Returns The columns of table to be returned for each row matching this request.
357 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 357 class ReadRequest; end |
#index ⇒ String
357 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 357 class ReadRequest; end |
#key_set ⇒ Google::Spanner::V1::KeySet
Returns Required. +key_set+ identifies the rows to be yielded. +key_set+ names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.
If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order.
It is not an error for the +key_set+ to name rows that do not exist in the database. Read yields nothing for nonexistent rows.
357 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 357 class ReadRequest; end |
#limit ⇒ Integer
Returns 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.
357 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 357 class ReadRequest; end |
#partition_token ⇒ String
Returns 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.
357 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 357 class ReadRequest; end |
#resume_token ⇒ String
Returns 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.
357 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 357 class ReadRequest; end |
#session ⇒ String
Returns Required. The session in which the read should be performed.
357 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 357 class ReadRequest; end |
#table ⇒ String
Returns Required. The name of the table in the database to be read.
357 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 357 class ReadRequest; end |
#transaction ⇒ Google::Spanner::V1::TransactionSelector
Returns The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
357 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 357 class ReadRequest; end |