Class: Google::Apis::SpannerV1::PartitionQueryRequest

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PartitionQueryRequest

Returns a new instance of PartitionQueryRequest



1934
1935
1936
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1934

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

Returns:



1890
1891
1892
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1890

def param_types
  @param_types
end

#params ⇒ Hash<String,Object>

The SQL query string can contain parameter placeholders. A parameter placeholder consists of '@' followed by the parameter name. Parameter names consist of any combination of 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 an SQL query with unbound parameters. Parameter values are specified using params, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


1905
1906
1907
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1905

def params
  @params
end

#partition_options ⇒ Google::Apis::SpannerV1::PartitionOptions

Options for a PartitionQueryRequest and PartitionReadRequest. Corresponds to the JSON property partitionOptions

Returns:



1911
1912
1913
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1911

def partition_options
  @partition_options
end

#sql ⇒ String

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

Returns:

  • (String) 


1924
1925
1926
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1924

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

Returns:



1932
1933
1934
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1932

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1939
1940
1941
1942
1943
1944
1945
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1939

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