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.
-
#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.
154 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 154 class ReadRequest; end |
#index ⇒ String
Returns 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.
154 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 154 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.
Rows are yielded in table primary key order (if Index is empty) or index key order (if Index is non-empty).
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.
154 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 154 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.
154 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 154 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.
154 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 154 class ReadRequest; end |
#session ⇒ String
Returns Required. The session in which the read should be performed.
154 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 154 class ReadRequest; end |
#table ⇒ String
Returns Required. The name of the table in the database to be read.
154 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 154 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.
154 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 154 class ReadRequest; end |