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

Inherits:

Object

Object
Google::Spanner::V1::ExecuteSqlRequest

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

#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
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 ⇒ 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 statement execution, resume_token should be copied from the last PartialResultSet yielded before the interruption.
#seqno ⇒ Integer
A per-transaction sequence number used to identify this request.
#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 statement 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 statement parameters. See the definition of Type for more information about SQL types.

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 208

class ExecuteSqlRequest
  # Mode in which the statement must be processed.
  module QueryMode
    # The default mode. Only the statement results are returned.
    NORMAL = 0

    # This mode returns only the query plan, without any results or
    # execution statistics information.
    PLAN = 1

    # This mode returns both the query plan and the execution statistics along
    # with the results.
    PROFILE = 2
  end
end

#params ⇒ `Google::Protobuf::Struct`

Returns 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.

Returns:

(Google::Protobuf::Struct) —
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.

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 208

class ExecuteSqlRequest
  # Mode in which the statement must be processed.
  module QueryMode
    # The default mode. Only the statement results are returned.
    NORMAL = 0

    # This mode returns only the query plan, without any results or
    # execution statistics information.
    PLAN = 1

    # This mode returns both the query plan and the execution statistics along
    # with the results.
    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.

Returns:

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

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 208

class ExecuteSqlRequest
  # Mode in which the statement must be processed.
  module QueryMode
    # The default mode. Only the statement results are returned.
    NORMAL = 0

    # This mode returns only the query plan, without any results or
    # execution statistics information.
    PLAN = 1

    # This mode returns both the query plan and the execution statistics along
    # with the results.
    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.

Returns:

(Google::Spanner::V1::ExecuteSqlRequest::QueryMode) —
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.

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 208

class ExecuteSqlRequest
  # Mode in which the statement must be processed.
  module QueryMode
    # The default mode. Only the statement results are returned.
    NORMAL = 0

    # This mode returns only the query plan, without any results or
    # execution statistics information.
    PLAN = 1

    # This mode returns both the query plan and the execution statistics along
    # with the results.
    PROFILE = 2
  end
end

#resume_token ⇒ `String`

Returns 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.

Returns:

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

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 208

class ExecuteSqlRequest
  # Mode in which the statement must be processed.
  module QueryMode
    # The default mode. Only the statement results are returned.
    NORMAL = 0

    # This mode returns only the query plan, without any results or
    # execution statistics information.
    PLAN = 1

    # This mode returns both the query plan and the execution statistics along
    # with the results.
    PROFILE = 2
  end
end

#seqno ⇒ `Integer`

Returns 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.

Returns:

(Integer) —
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.

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 208

class ExecuteSqlRequest
  # Mode in which the statement must be processed.
  module QueryMode
    # The default mode. Only the statement results are returned.
    NORMAL = 0

    # This mode returns only the query plan, without any results or
    # execution statistics information.
    PLAN = 1

    # This mode returns both the query plan and the execution statistics along
    # with the results.
    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.

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 208

class ExecuteSqlRequest
  # Mode in which the statement must be processed.
  module QueryMode
    # The default mode. Only the statement results are returned.
    NORMAL = 0

    # This mode returns only the query plan, without any results or
    # execution statistics information.
    PLAN = 1

    # This mode returns both the query plan and the execution statistics along
    # with the results.
    PROFILE = 2
  end
end

#sql ⇒ `String`

Returns Required. The SQL string.

Returns:

(String) —
Required. The SQL string.

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 208

class ExecuteSqlRequest
  # Mode in which the statement must be processed.
  module QueryMode
    # The default mode. Only the statement results are returned.
    NORMAL = 0

    # This mode returns only the query plan, without any results or
    # execution statistics information.
    PLAN = 1

    # This mode returns both the query plan and the execution statistics along
    # with the results.
    PROFILE = 2
  end
end

#transaction ⇒ `Google::Spanner::V1::TransactionSelector`

Returns The transaction to use.

For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency.

Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.

Partitioned DML requires an existing Partitioned DML transaction ID.

Returns:

(Google::Spanner::V1::TransactionSelector) —
The transaction to use.

For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency.

Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.

Partitioned DML requires an existing Partitioned DML transaction ID.

# File 'lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb', line 208

class ExecuteSqlRequest
  # Mode in which the statement must be processed.
  module QueryMode
    # The default mode. Only the statement results are returned.
    NORMAL = 0

    # This mode returns only the query plan, without any results or
    # execution statistics information.
    PLAN = 1

    # This mode returns both the query plan and the execution statistics along
    # with the results.
    PROFILE = 2
  end
end

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

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#param_types ⇒ Hash{String => Google::Spanner::V1::Type}

#params ⇒ Google::Protobuf::Struct

#partition_token ⇒ String

#query_mode ⇒ Google::Spanner::V1::ExecuteSqlRequest::QueryMode

#resume_token ⇒ String

#seqno ⇒ Integer

#session ⇒ String

#sql ⇒ String

#transaction ⇒ Google::Spanner::V1::TransactionSelector

#param_types ⇒ `Hash{String => Google::Spanner::V1::Type}`

#params ⇒ `Google::Protobuf::Struct`

#partition_token ⇒ `String`

#query_mode ⇒ `Google::Spanner::V1::ExecuteSqlRequest::QueryMode`

#resume_token ⇒ `String`

#seqno ⇒ `Integer`

#session ⇒ `String`

#sql ⇒ `String`

#transaction ⇒ `Google::Spanner::V1::TransactionSelector`