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>
Parameter names and values that bind to placeholders in the SQL string.
-
#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 statement execution,
resume_token
should be copied from the last PartialResultSet yielded before the interruption. -
#seqno ⇒ Fixnum
A per-transaction sequence number used to identify this request.
-
#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.
1094 1095 1096 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1094 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 statement parameters. See the
definition of Type for more information
about SQL types.
Corresponds to the JSON property paramTypes
1028 1029 1030 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1028 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
1040 1041 1042 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1040 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.
1049 1050 1051 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1049 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
1056 1057 1058 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1056 def query_mode @query_mode end |
#resume_token ⇒ String
If this request is resuming a previously interrupted SQL statement
execution, resume_token
should be copied from the last
PartialResultSet yielded before the interruption. Doing this
enables the new SQL statement 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.
1067 1068 1069 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1067 def resume_token @resume_token end |
#seqno ⇒ Fixnum
A per-transaction sequence number used to identify this request. This field
makes each request idempotent such that if the request is received multiple
times, at most one will succeed.
The sequence number must be monotonically increasing within the
transaction. If a request arrives for the first time with an out-of-order
sequence number, the transaction may be aborted. Replays of previously
handled requests will yield the same response as the first execution.
Required for DML statements. Ignored for queries.
Corresponds to the JSON property seqno
1079 1080 1081 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1079 def seqno @seqno end |
#sql ⇒ String
Required. The SQL string.
Corresponds to the JSON property sql
1084 1085 1086 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1084 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
1092 1093 1094 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1092 def transaction @transaction end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 1099 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) @seqno = args[:seqno] if args.key?(:seqno) @sql = args[:sql] if args.key?(:sql) @transaction = args[:transaction] if args.key?(:transaction) end |