Class: Google::Spanner::V1::ExecuteSqlRequest

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

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.

Returns:

  • (Hash{String => Google::Spanner::V1::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.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 92

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.

Returns:

  • (Google::Protobuf::Struct) —

    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.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 92

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.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 92

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.

Returns:

  • (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.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 92

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.

Returns:

  • (String) —

    Required. The session in which the SQL query should be performed.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 92

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.

Returns:

  • (String) —

    Required. The SQL query string.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 92

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.

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 92

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