Class: Google::Apis::SpannerV1::PartitionQueryRequest
- Inherits:
-
Object
- Object
- Google::Apis::SpannerV1::PartitionQueryRequest
- 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 PartitionQuery
Instance Attribute Summary collapse
-
#param_types ⇒ Hash<String,Google::Apis::SpannerV1::Type>
It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
-
#params ⇒ Hash<String,Object>
Parameter names and values that bind to placeholders in the SQL string.
-
#partition_options ⇒ Google::Apis::SpannerV1::PartitionOptions
Options for a PartitionQueryRequest and PartitionReadRequest.
-
#sql ⇒ 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) ⇒ PartitionQueryRequest
constructor
A new instance of PartitionQueryRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ PartitionQueryRequest
Returns a new instance of PartitionQueryRequest.
2069 2070 2071 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2069 def initialize(**args) update!(**args) end |
Instance Attribute Details
#param_types ⇒ Hash<String,Google::Apis::SpannerV1::Type>
It is not always possible for Cloud Spanner to infer the right SQL type from a
JSON value. For example, values of type BYTES
and values of type STRING
both appear in params as JSON strings. In these cases, param_types
can be
used to specify the exact SQL type for some or all of the SQL query parameters.
See the definition of Type for more information about SQL types.
Corresponds to the JSON property paramTypes
2033 2034 2035 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2033 def param_types @param_types end |
#params ⇒ Hash<String,Object>
Parameter names and values that bind to placeholders in the SQL string. A
parameter placeholder consists of the @
character followed by the parameter
name (for example, @firstName
). Parameter names can contain letters, numbers,
and underscores. Parameters can appear anywhere that a literal value is
expected. The same parameter name can be used more than once, for example: "
WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL
statement with unbound parameters.
Corresponds to the JSON property params
2044 2045 2046 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2044 def params @params end |
#partition_options ⇒ Google::Apis::SpannerV1::PartitionOptions
Options for a PartitionQueryRequest and PartitionReadRequest.
Corresponds to the JSON property partitionOptions
2049 2050 2051 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2049 def @partition_options end |
#sql ⇒ String
Required. The query request to generate partitions for. The request will fail
if the query is not root partitionable. The query plan of a root partitionable
query has a single distributed union operator. A distributed union operator
conceptually divides one or more tables into multiple splits, remotely
evaluates a subquery independently on each split, and then unions all results.
This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use
ExecuteStreamingSql with a PartitionedDml transaction for large, partition-
friendly DML operations.
Corresponds to the JSON property sql
2061 2062 2063 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2061 def sql @sql 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
2067 2068 2069 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2067 def transaction @transaction end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2074 2075 2076 2077 2078 2079 2080 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 2074 def update!(**args) @param_types = args[:param_types] if args.key?(:param_types) @params = args[:params] if args.key?(:params) @partition_options = args[:partition_options] if args.key?(:partition_options) @sql = args[:sql] if args.key?(:sql) @transaction = args[:transaction] if args.key?(:transaction) end |