google.spanner.v1.ExecuteSqlRequest */ class ExecuteSqlRequest extends \Google\Protobuf\Internal\Message { /** * Required. The session in which the SQL query should be performed. * * Generated from protobuf field string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ private $session = ''; /** * 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. * * Generated from protobuf field .google.spanner.v1.TransactionSelector transaction = 2; */ private $transaction = null; /** * Required. The SQL string. * * Generated from protobuf field string sql = 3 [(.google.api.field_behavior) = REQUIRED]; */ private $sql = ''; /** * 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. * * Generated from protobuf field .google.protobuf.Struct params = 4; */ private $params = null; /** * 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. * * Generated from protobuf field map param_types = 5; */ private $param_types; /** * 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. * * Generated from protobuf field bytes resume_token = 6; */ private $resume_token = ''; /** * 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]. * * Generated from protobuf field .google.spanner.v1.ExecuteSqlRequest.QueryMode query_mode = 7; */ private $query_mode = 0; /** * 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. * * Generated from protobuf field bytes partition_token = 8; */ private $partition_token = ''; /** * 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. * * Generated from protobuf field int64 seqno = 9; */ private $seqno = 0; /** * Query optimizer configuration to use for the given query. * * Generated from protobuf field .google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10; */ private $query_options = null; /** * Common options for this request. * * Generated from protobuf field .google.spanner.v1.RequestOptions request_options = 11; */ private $request_options = null; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type string $session * Required. The session in which the SQL query should be performed. * @type \Google\Cloud\Spanner\V1\TransactionSelector $transaction * 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. * @type string $sql * Required. The SQL string. * @type \Google\Protobuf\Struct $params * 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. * @type array|\Google\Protobuf\Internal\MapField $param_types * 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. * @type string $resume_token * 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. * @type int $query_mode * 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]. * @type string $partition_token * 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. * @type int|string $seqno * 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. * @type \Google\Cloud\Spanner\V1\ExecuteSqlRequest\QueryOptions $query_options * Query optimizer configuration to use for the given query. * @type \Google\Cloud\Spanner\V1\RequestOptions $request_options * Common options for this request. * } */ public function __construct($data = NULL) { \GPBMetadata\Google\Spanner\V1\Spanner::initOnce(); parent::__construct($data); } /** * Required. The session in which the SQL query should be performed. * * Generated from protobuf field string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string */ public function getSession() { return $this->session; } /** * Required. The session in which the SQL query should be performed. * * Generated from protobuf field string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var * @return $this */ public function setSession($var) { GPBUtil::checkString($var, True); $this->session = $var; return $this; } /** * 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. * * Generated from protobuf field .google.spanner.v1.TransactionSelector transaction = 2; * @return \Google\Cloud\Spanner\V1\TransactionSelector|null */ public function getTransaction() { return $this->transaction; } public function hasTransaction() { return isset($this->transaction); } public function clearTransaction() { unset($this->transaction); } /** * 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. * * Generated from protobuf field .google.spanner.v1.TransactionSelector transaction = 2; * @param \Google\Cloud\Spanner\V1\TransactionSelector $var * @return $this */ public function setTransaction($var) { GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\TransactionSelector::class); $this->transaction = $var; return $this; } /** * Required. The SQL string. * * Generated from protobuf field string sql = 3 [(.google.api.field_behavior) = REQUIRED]; * @return string */ public function getSql() { return $this->sql; } /** * Required. The SQL string. * * Generated from protobuf field string sql = 3 [(.google.api.field_behavior) = REQUIRED]; * @param string $var * @return $this */ public function setSql($var) { GPBUtil::checkString($var, True); $this->sql = $var; return $this; } /** * 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. * * Generated from protobuf field .google.protobuf.Struct params = 4; * @return \Google\Protobuf\Struct|null */ public function getParams() { return $this->params; } public function hasParams() { return isset($this->params); } public function clearParams() { unset($this->params); } /** * 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. * * Generated from protobuf field .google.protobuf.Struct params = 4; * @param \Google\Protobuf\Struct $var * @return $this */ public function setParams($var) { GPBUtil::checkMessage($var, \Google\Protobuf\Struct::class); $this->params = $var; return $this; } /** * 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. * * Generated from protobuf field map param_types = 5; * @return \Google\Protobuf\Internal\MapField */ public function getParamTypes() { return $this->param_types; } /** * 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. * * Generated from protobuf field map param_types = 5; * @param array|\Google\Protobuf\Internal\MapField $var * @return $this */ public function setParamTypes($var) { $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Spanner\V1\Type::class); $this->param_types = $arr; return $this; } /** * 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. * * Generated from protobuf field bytes resume_token = 6; * @return string */ public function getResumeToken() { return $this->resume_token; } /** * 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. * * Generated from protobuf field bytes resume_token = 6; * @param string $var * @return $this */ public function setResumeToken($var) { GPBUtil::checkString($var, False); $this->resume_token = $var; return $this; } /** * 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]. * * Generated from protobuf field .google.spanner.v1.ExecuteSqlRequest.QueryMode query_mode = 7; * @return int */ public function getQueryMode() { return $this->query_mode; } /** * 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]. * * Generated from protobuf field .google.spanner.v1.ExecuteSqlRequest.QueryMode query_mode = 7; * @param int $var * @return $this */ public function setQueryMode($var) { GPBUtil::checkEnum($var, \Google\Cloud\Spanner\V1\ExecuteSqlRequest\QueryMode::class); $this->query_mode = $var; return $this; } /** * 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. * * Generated from protobuf field bytes partition_token = 8; * @return string */ public function getPartitionToken() { return $this->partition_token; } /** * 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. * * Generated from protobuf field bytes partition_token = 8; * @param string $var * @return $this */ public function setPartitionToken($var) { GPBUtil::checkString($var, False); $this->partition_token = $var; return $this; } /** * 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. * * Generated from protobuf field int64 seqno = 9; * @return int|string */ public function getSeqno() { return $this->seqno; } /** * 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. * * Generated from protobuf field int64 seqno = 9; * @param int|string $var * @return $this */ public function setSeqno($var) { GPBUtil::checkInt64($var); $this->seqno = $var; return $this; } /** * Query optimizer configuration to use for the given query. * * Generated from protobuf field .google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10; * @return \Google\Cloud\Spanner\V1\ExecuteSqlRequest\QueryOptions|null */ public function getQueryOptions() { return $this->query_options; } public function hasQueryOptions() { return isset($this->query_options); } public function clearQueryOptions() { unset($this->query_options); } /** * Query optimizer configuration to use for the given query. * * Generated from protobuf field .google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10; * @param \Google\Cloud\Spanner\V1\ExecuteSqlRequest\QueryOptions $var * @return $this */ public function setQueryOptions($var) { GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\ExecuteSqlRequest\QueryOptions::class); $this->query_options = $var; return $this; } /** * Common options for this request. * * Generated from protobuf field .google.spanner.v1.RequestOptions request_options = 11; * @return \Google\Cloud\Spanner\V1\RequestOptions|null */ public function getRequestOptions() { return $this->request_options; } public function hasRequestOptions() { return isset($this->request_options); } public function clearRequestOptions() { unset($this->request_options); } /** * Common options for this request. * * Generated from protobuf field .google.spanner.v1.RequestOptions request_options = 11; * @param \Google\Cloud\Spanner\V1\RequestOptions $var * @return $this */ public function setRequestOptions($var) { GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\RequestOptions::class); $this->request_options = $var; return $this; } }