Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::ReadRequest (v1.0.0)

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::ReadRequest.

The request for Read and StreamingRead.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#columns

def columns() -> ::Array<::String>
Returns
  • (::Array<::String>) — Required. The columns of table to be returned for each row matching this request.

#columns=

def columns=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Required. The columns of table to be returned for each row matching this request.
Returns
  • (::Array<::String>) — Required. The columns of table to be returned for each row matching this request.

#data_boost_enabled

def data_boost_enabled() -> ::Boolean
Returns
  • (::Boolean) — If this is for a partitioned read and this field is set to true, the request is executed with Spanner Data Boost independent compute resources.

    If the field is set to true but the request does not set partition_token, the API returns an INVALID_ARGUMENT error.

#data_boost_enabled=

def data_boost_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If this is for a partitioned read and this field is set to true, the request is executed with Spanner Data Boost independent compute resources.

    If the field is set to true but the request does not set partition_token, the API returns an INVALID_ARGUMENT error.

Returns
  • (::Boolean) — If this is for a partitioned read and this field is set to true, the request is executed with Spanner Data Boost independent compute resources.

    If the field is set to true but the request does not set partition_token, the API returns an INVALID_ARGUMENT error.

#directed_read_options

def directed_read_options() -> ::Google::Cloud::Spanner::V1::DirectedReadOptions
Returns

#directed_read_options=

def directed_read_options=(value) -> ::Google::Cloud::Spanner::V1::DirectedReadOptions
Parameter
Returns

#index

def index() -> ::String
Returns
  • (::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.

#index=

def index=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#key_set

def key_set() -> ::Google::Cloud::Spanner::V1::KeySet
Returns
  • (::Google::Cloud::Spanner::V1::KeySet) — 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.

#key_set=

def key_set=(value) -> ::Google::Cloud::Spanner::V1::KeySet
Parameter
  • value (::Google::Cloud::Spanner::V1::KeySet) — 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.

Returns
  • (::Google::Cloud::Spanner::V1::KeySet) — 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.

#limit

def limit() -> ::Integer
Returns
  • (::Integer) — 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.

#limit=

def limit=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#lock_hint

def lock_hint() -> ::Google::Cloud::Spanner::V1::ReadRequest::LockHint
Returns

#lock_hint=

def lock_hint=(value) -> ::Google::Cloud::Spanner::V1::ReadRequest::LockHint
Parameter
Returns

#order_by

def order_by() -> ::Google::Cloud::Spanner::V1::ReadRequest::OrderBy
Returns
  • (::Google::Cloud::Spanner::V1::ReadRequest::OrderBy) — Optional. Order for the returned rows.

    By default, Spanner will return result rows in primary key order except for PartitionRead requests. For applications that do not require rows to be returned in primary key (ORDER_BY_PRIMARY_KEY) order, setting ORDER_BY_NO_ORDER option allows Spanner to optimize row retrieval, resulting in lower latencies in certain cases (e.g. bulk point lookups).

#order_by=

def order_by=(value) -> ::Google::Cloud::Spanner::V1::ReadRequest::OrderBy
Parameter
  • value (::Google::Cloud::Spanner::V1::ReadRequest::OrderBy) — Optional. Order for the returned rows.

    By default, Spanner will return result rows in primary key order except for PartitionRead requests. For applications that do not require rows to be returned in primary key (ORDER_BY_PRIMARY_KEY) order, setting ORDER_BY_NO_ORDER option allows Spanner to optimize row retrieval, resulting in lower latencies in certain cases (e.g. bulk point lookups).

Returns
  • (::Google::Cloud::Spanner::V1::ReadRequest::OrderBy) — Optional. Order for the returned rows.

    By default, Spanner will return result rows in primary key order except for PartitionRead requests. For applications that do not require rows to be returned in primary key (ORDER_BY_PRIMARY_KEY) order, setting ORDER_BY_NO_ORDER option allows Spanner to optimize row retrieval, resulting in lower latencies in certain cases (e.g. bulk point lookups).

#partition_token

def partition_token() -> ::String
Returns
  • (::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.

#partition_token=

def partition_token=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#request_options

def request_options() -> ::Google::Cloud::Spanner::V1::RequestOptions
Returns

#request_options=

def request_options=(value) -> ::Google::Cloud::Spanner::V1::RequestOptions
Parameter
Returns

#resume_token

def resume_token() -> ::String
Returns
  • (::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.

#resume_token=

def resume_token=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#session

def session() -> ::String
Returns
  • (::String) — Required. The session in which the read should be performed.

#session=

def session=(value) -> ::String
Parameter
  • value (::String) — Required. The session in which the read should be performed.
Returns
  • (::String) — Required. The session in which the read should be performed.

#table

def table() -> ::String
Returns
  • (::String) — Required. The name of the table in the database to be read.

#table=

def table=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the table in the database to be read.
Returns
  • (::String) — Required. The name of the table in the database to be read.

#transaction

def transaction() -> ::Google::Cloud::Spanner::V1::TransactionSelector
Returns

#transaction=

def transaction=(value) -> ::Google::Cloud::Spanner::V1::TransactionSelector
Parameter
Returns