Class: Google::Apis::SpannerV1::PartitionReadRequest
- Inherits:
-
Object
- Object
- Google::Apis::SpannerV1::PartitionReadRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/spanner_v1/classes.rb,
generated/google/apis/spanner_v1/representations.rb,
generated/google/apis/spanner_v1/representations.rb
Overview
The request for PartitionRead
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::Apis::SpannerV1::KeySet
KeySet
defines a collection of Cloud Spanner keys and/or key ranges. -
#partition_options ⇒ Google::Apis::SpannerV1::PartitionOptions
Options for a PartitionQueryRequest and PartitionReadRequest.
-
#table ⇒ String
Required.
-
#transaction ⇒ Google::Apis::SpannerV1::TransactionSelector
This message is used to select the transaction in which a Read or ExecuteSql call runs.
Instance Method Summary collapse
-
#initialize(**args) ⇒ PartitionReadRequest
constructor
A new instance of PartitionReadRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ PartitionReadRequest
Returns a new instance of PartitionReadRequest
1699 1700 1701 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1699 def initialize(**args) update!(**args) end |
Instance Attribute Details
#columns ⇒ Array<String>
The columns of table to be returned for each row matching
this request.
Corresponds to the JSON property columns
1661 1662 1663 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1661 def columns @columns end |
#index ⇒ 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.
Corresponds to the JSON property index
1668 1669 1670 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1668 def index @index end |
#key_set ⇒ Google::Apis::SpannerV1::KeySet
KeySet
defines a collection of Cloud Spanner keys and/or key ranges. All
the keys are expected to be in the same table or index. The keys need
not be sorted in any particular way.
If the same key is specified multiple times in the set (for example
if two ranges, two keys, or a key and a range overlap), Cloud Spanner
behaves as if the key were only specified once.
Corresponds to the JSON property keySet
1678 1679 1680 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1678 def key_set @key_set end |
#partition_options ⇒ Google::Apis::SpannerV1::PartitionOptions
Options for a PartitionQueryRequest and
PartitionReadRequest.
Corresponds to the JSON property partitionOptions
1684 1685 1686 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1684 def @partition_options end |
#table ⇒ String
Required. The name of the table in the database to be read.
Corresponds to the JSON property table
1689 1690 1691 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1689 def table @table end |
#transaction ⇒ Google::Apis::SpannerV1::TransactionSelector
This message is used to select the transaction in which a
Read or
ExecuteSql call runs.
See TransactionOptions for more information about transactions.
Corresponds to the JSON property transaction
1697 1698 1699 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1697 def transaction @transaction end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1704 1705 1706 1707 1708 1709 1710 1711 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1704 def update!(**args) @columns = args[:columns] if args.key?(:columns) @index = args[:index] if args.key?(:index) @key_set = args[:key_set] if args.key?(:key_set) @partition_options = args[:partition_options] if args.key?(:partition_options) @table = args[:table] if args.key?(:table) @transaction = args[:transaction] if args.key?(:transaction) end |