Class: Google::Apis::SpannerV1::ExecuteSqlRequest
- Inherits:
-
Object
- Object
- Google::Apis::SpannerV1::ExecuteSqlRequest
- 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 ExecuteSql and ExecuteStreamingSql.
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>
The SQL query string can contain parameter placeholders.
-
#partition_token ⇒ String
If present, results will be restricted to the specified partition previously created using PartitionQuery().
-
#query_mode ⇒ String
Used to control the amount of debugging information returned in ResultSetStats.
-
#resume_token ⇒ String
If this request is resuming a previously interrupted SQL query execution,
resume_token
should be copied from the last PartialResultSet yielded before the interruption. -
#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) ⇒ ExecuteSqlRequest
constructor
A new instance of ExecuteSqlRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ExecuteSqlRequest
Returns a new instance of ExecuteSqlRequest
802 803 804 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 802 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
745 746 747 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 745 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
760 761 762 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 760 def params @params end |
#partition_token ⇒ String
If present, results will be restricted to the specified partition
previously created using PartitionQuery(). There must be an exact
match for the values of fields common to this message and the
PartitionQueryRequest message used to create this partition_token.
Corresponds to the JSON property partitionToken
NOTE: Values are automatically base64 encoded/decoded in the client library.
769 770 771 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 769 def partition_token @partition_token end |
#query_mode ⇒ String
Used to control the amount of debugging information returned in
ResultSetStats. If partition_token is set, query_mode can only
be set to QueryMode.NORMAL.
Corresponds to the JSON property queryMode
776 777 778 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 776 def query_mode @query_mode end |
#resume_token ⇒ String
If this request is resuming a previously interrupted SQL query
execution, resume_token
should be copied from the last
PartialResultSet yielded before the interruption. Doing this
enables the new SQL query execution to resume where the last one left
off. The rest of the request parameters must exactly match the
request that yielded this token.
Corresponds to the JSON property resumeToken
NOTE: Values are automatically base64 encoded/decoded in the client library.
787 788 789 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 787 def resume_token @resume_token end |
#sql ⇒ String
Required. The SQL query string.
Corresponds to the JSON property sql
792 793 794 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 792 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
800 801 802 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 800 def transaction @transaction end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
807 808 809 810 811 812 813 814 815 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 807 def update!(**args) @param_types = args[:param_types] if args.key?(:param_types) @params = args[:params] if args.key?(:params) @partition_token = args[:partition_token] if args.key?(:partition_token) @query_mode = args[:query_mode] if args.key?(:query_mode) @resume_token = args[:resume_token] if args.key?(:resume_token) @sql = args[:sql] if args.key?(:sql) @transaction = args[:transaction] if args.key?(:transaction) end |