Class: Google::Spanner::V1::PartitionReadRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb

Overview

The request for PartitionRead

Instance Attribute Summary collapse

Instance Attribute Details

#columns ⇒ Array<String>

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



282
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 282

class PartitionReadRequest; 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.

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.



282
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 282

class PartitionReadRequest; 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.

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



282
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 282

class PartitionReadRequest; end

#partition_options ⇒ Google::Spanner::V1::PartitionOptions

Returns Additional options that affect how many partitions are created.

Returns:



282
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 282

class PartitionReadRequest; end

#session ⇒ String

Returns Required. The session used to create the partitions.

Returns:

  • (String) —

    Required. The session used to create the partitions.



282
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 282

class PartitionReadRequest; end

#table ⇒ String

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



282
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 282

class PartitionReadRequest; end

#transaction ⇒ Google::Spanner::V1::TransactionSelector

Returns Read only snapshot transactions are supported, read/write and single use transactions are not.

Returns:



282
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 282

class PartitionReadRequest; end