Class: Google::Spanner::V1::ExecuteSqlRequest
- Inherits:
-
Object
- Object
- Google::Spanner::V1::ExecuteSqlRequest
- Defined in:
- lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb
Overview
The request for ExecuteSql and ExecuteStreamingSql.
Defined Under Namespace
Modules: QueryMode
Instance Attribute Summary collapse
-
#param_types ⇒ Hash{String => Google::Spanner::V1::Type}
It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
-
#params ⇒ Google::Protobuf::Struct
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 ⇒ Google::Spanner::V1::ExecuteSqlRequest::QueryMode
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.
-
#session ⇒ String
Required.
-
#sql ⇒ String
Required.
-
#transaction ⇒ Google::Spanner::V1::TransactionSelector
The transaction to use.
Instance Attribute Details
#param_types ⇒ Hash{String => Google::Spanner::V1::Type}
Returns 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.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 159 class ExecuteSqlRequest # Mode in which the query must be processed. module QueryMode # The default mode where only the query result, without any information # about the query plan is returned. NORMAL = 0 # This mode returns only the query plan, without any result rows or # execution statistics information. PLAN = 1 # This mode returns both the query plan and the execution statistics along # with the result rows. PROFILE = 2 end end |
#params ⇒ Google::Protobuf::Struct
Returns 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.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 159 class ExecuteSqlRequest # Mode in which the query must be processed. module QueryMode # The default mode where only the query result, without any information # about the query plan is returned. NORMAL = 0 # This mode returns only the query plan, without any result rows or # execution statistics information. PLAN = 1 # This mode returns both the query plan and the execution statistics along # with the result rows. PROFILE = 2 end end |
#partition_token ⇒ String
Returns 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.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 159 class ExecuteSqlRequest # Mode in which the query must be processed. module QueryMode # The default mode where only the query result, without any information # about the query plan is returned. NORMAL = 0 # This mode returns only the query plan, without any result rows or # execution statistics information. PLAN = 1 # This mode returns both the query plan and the execution statistics along # with the result rows. PROFILE = 2 end end |
#query_mode ⇒ Google::Spanner::V1::ExecuteSqlRequest::QueryMode
Returns 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.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 159 class ExecuteSqlRequest # Mode in which the query must be processed. module QueryMode # The default mode where only the query result, without any information # about the query plan is returned. NORMAL = 0 # This mode returns only the query plan, without any result rows or # execution statistics information. PLAN = 1 # This mode returns both the query plan and the execution statistics along # with the result rows. PROFILE = 2 end end |
#resume_token ⇒ String
Returns 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.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 159 class ExecuteSqlRequest # Mode in which the query must be processed. module QueryMode # The default mode where only the query result, without any information # about the query plan is returned. NORMAL = 0 # This mode returns only the query plan, without any result rows or # execution statistics information. PLAN = 1 # This mode returns both the query plan and the execution statistics along # with the result rows. PROFILE = 2 end end |
#session ⇒ String
Returns Required. The session in which the SQL query should be performed.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 159 class ExecuteSqlRequest # Mode in which the query must be processed. module QueryMode # The default mode where only the query result, without any information # about the query plan is returned. NORMAL = 0 # This mode returns only the query plan, without any result rows or # execution statistics information. PLAN = 1 # This mode returns both the query plan and the execution statistics along # with the result rows. PROFILE = 2 end end |
#sql ⇒ String
Returns Required. The SQL query string.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 159 class ExecuteSqlRequest # Mode in which the query must be processed. module QueryMode # The default mode where only the query result, without any information # about the query plan is returned. NORMAL = 0 # This mode returns only the query plan, without any result rows or # execution statistics information. PLAN = 1 # This mode returns both the query plan and the execution statistics along # with the result rows. PROFILE = 2 end end |
#transaction ⇒ Google::Spanner::V1::TransactionSelector
Returns The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 159 class ExecuteSqlRequest # Mode in which the query must be processed. module QueryMode # The default mode where only the query result, without any information # about the query plan is returned. NORMAL = 0 # This mode returns only the query plan, without any result rows or # execution statistics information. PLAN = 1 # This mode returns both the query plan and the execution statistics along # with the result rows. PROFILE = 2 end end |