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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/spanner/v1/spanner.rb

Overview

The request for PartitionRead

Instance Attribute Summary collapse

Instance Attribute Details

#columns ⇒ ::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.



788
789
790
791
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 788

class PartitionReadRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.



788
789
790
791
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 788

class PartitionReadRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#key_set ⇒ ::Google::Cloud::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::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.



788
789
790
791
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 788

class PartitionReadRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

Returns Additional options that affect how many partitions are created.

Returns:



788
789
790
791
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 788

class PartitionReadRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#session ⇒ ::String

Returns Required. The session used to create the partitions.

Returns:

  • (::String) —

    Required. The session used to create the partitions.



788
789
790
791
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 788

class PartitionReadRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.



788
789
790
791
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 788

class PartitionReadRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

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

Returns:



788
789
790
791
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 788

class PartitionReadRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end