Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::PartitionReadRequest (v1.5.0)

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

The request for PartitionRead

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#columns

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

#columns=

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

#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.

    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.

    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.

    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.

#partition_options

def partition_options() -> ::Google::Cloud::Spanner::V1::PartitionOptions
Returns

#partition_options=

def partition_options=(value) -> ::Google::Cloud::Spanner::V1::PartitionOptions
Parameter
Returns

#session

def session() -> ::String
Returns
  • (::String) — Required. The session used to create the partitions.

#session=

def session=(value) -> ::String
Parameter
  • value (::String) — Required. The session used to create the partitions.
Returns
  • (::String) — Required. The session used to create the partitions.

#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