Package com.google.spanner.v1

Interface ExecuteSqlRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ExecuteSqlRequest, ExecuteSqlRequest.Builder
    public interface ExecuteSqlRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getSession

        String getSession()
         Required. The session in which the SQL query should be performed.
        string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The session.

      • getSessionBytes

        com.google.protobuf.ByteString getSessionBytes()
         Required. The session in which the SQL query should be performed.
        string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for session.

      • hasTransaction

        boolean hasTransaction()
         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.
        .google.spanner.v1.TransactionSelector transaction = 2;
        Returns:
        Whether the transaction field is set.

      • getTransaction

        TransactionSelector getTransaction()
         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.
        .google.spanner.v1.TransactionSelector transaction = 2;
        Returns:
        The transaction.

      • getTransactionOrBuilder

        TransactionSelectorOrBuilder getTransactionOrBuilder()
         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.
        .google.spanner.v1.TransactionSelector transaction = 2;

      • getSql

        String getSql()
         Required. The SQL string.
        string sql = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The sql.

      • getSqlBytes

        com.google.protobuf.ByteString getSqlBytes()
         Required. The SQL string.
        string sql = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for sql.

      • hasParams

        boolean hasParams()
         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 must conform
 to the naming requirements of identifiers as specified at
 https://cloud.google.com/spanner/docs/lexical#identifiers.

 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.
        .google.protobuf.Struct params = 4;
        Returns:
        Whether the params field is set.

      • getParams

        com.google.protobuf.Struct getParams()
         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 must conform
 to the naming requirements of identifiers as specified at
 https://cloud.google.com/spanner/docs/lexical#identifiers.

 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.
        .google.protobuf.Struct params = 4;
        Returns:
        The params.

      • getParamsOrBuilder

        com.google.protobuf.StructOrBuilder getParamsOrBuilder()
         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 must conform
 to the naming requirements of identifiers as specified at
 https://cloud.google.com/spanner/docs/lexical#identifiers.

 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.
        .google.protobuf.Struct params = 4;

      • getParamTypesCount

        int getParamTypesCount()
         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][google.spanner.v1.ExecuteSqlRequest.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][google.spanner.v1.Type] for more information
 about SQL types.
        map<string, .google.spanner.v1.Type> param_types = 5;

      • containsParamTypes

        boolean containsParamTypes​(String key)
         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][google.spanner.v1.ExecuteSqlRequest.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][google.spanner.v1.Type] for more information
 about SQL types.
        map<string, .google.spanner.v1.Type> param_types = 5;

      • getParamTypesMap

        Map<String,​Type> getParamTypesMap()
         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][google.spanner.v1.ExecuteSqlRequest.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][google.spanner.v1.Type] for more information
 about SQL types.
        map<string, .google.spanner.v1.Type> param_types = 5;

      • getParamTypesOrDefault

        Type getParamTypesOrDefault​(String key,
                            Type defaultValue)
         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][google.spanner.v1.ExecuteSqlRequest.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][google.spanner.v1.Type] for more information
 about SQL types.
        map<string, .google.spanner.v1.Type> param_types = 5;

      • getParamTypesOrThrow

        Type getParamTypesOrThrow​(String key)
         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][google.spanner.v1.ExecuteSqlRequest.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][google.spanner.v1.Type] for more information
 about SQL types.
        map<string, .google.spanner.v1.Type> param_types = 5;

      • getResumeToken

        com.google.protobuf.ByteString getResumeToken()
         If this request is resuming a previously interrupted SQL statement
 execution, `resume_token` should be copied from the last
 [PartialResultSet][google.spanner.v1.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.
        bytes resume_token = 6;
        Returns:
        The resumeToken.

      • getQueryModeValue

        int getQueryModeValue()
         Used to control the amount of debugging information returned in
 [ResultSetStats][google.spanner.v1.ResultSetStats]. If [partition_token][google.spanner.v1.ExecuteSqlRequest.partition_token] is set, [query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] can only
 be set to [QueryMode.NORMAL][google.spanner.v1.ExecuteSqlRequest.QueryMode.NORMAL].
        .google.spanner.v1.ExecuteSqlRequest.QueryMode query_mode = 7;
        Returns:
        The enum numeric value on the wire for queryMode.

      • getQueryMode

        ExecuteSqlRequest.QueryMode getQueryMode()
         Used to control the amount of debugging information returned in
 [ResultSetStats][google.spanner.v1.ResultSetStats]. If [partition_token][google.spanner.v1.ExecuteSqlRequest.partition_token] is set, [query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] can only
 be set to [QueryMode.NORMAL][google.spanner.v1.ExecuteSqlRequest.QueryMode.NORMAL].
        .google.spanner.v1.ExecuteSqlRequest.QueryMode query_mode = 7;
        Returns:
        The queryMode.

      • getPartitionToken

        com.google.protobuf.ByteString getPartitionToken()
         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.
        bytes partition_token = 8;
        Returns:
        The partitionToken.

      • getSeqno

        long getSeqno()
         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.
        int64 seqno = 9;
        Returns:
        The seqno.

      • hasQueryOptions

        boolean hasQueryOptions()
         Query optimizer configuration to use for the given query.
        .google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
        Returns:
        Whether the queryOptions field is set.

      • getQueryOptions

        ExecuteSqlRequest.QueryOptions getQueryOptions()
         Query optimizer configuration to use for the given query.
        .google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
        Returns:
        The queryOptions.

      • getQueryOptionsOrBuilder

        ExecuteSqlRequest.QueryOptionsOrBuilder getQueryOptionsOrBuilder()
         Query optimizer configuration to use for the given query.
        .google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;

      • hasRequestOptions

        boolean hasRequestOptions()
         Common options for this request.
        .google.spanner.v1.RequestOptions request_options = 11;
        Returns:
        Whether the requestOptions field is set.

      • getRequestOptions

        RequestOptions getRequestOptions()
         Common options for this request.
        .google.spanner.v1.RequestOptions request_options = 11;
        Returns:
        The requestOptions.

      • getRequestOptionsOrBuilder

        RequestOptionsOrBuilder getRequestOptionsOrBuilder()
         Common options for this request.
        .google.spanner.v1.RequestOptions request_options = 11;

      • getDataBoostEnabled

        boolean getDataBoostEnabled()
         If this is for a partitioned query and this field is set to `true`, the
 request will be executed via Spanner independent compute resources.

 If the field is set to `true` but the request does not set
 `partition_token`, the API will return an `INVALID_ARGUMENT` error.
        bool data_boost_enabled = 16;
        Returns:
        The dataBoostEnabled.