google.spanner.v1.PartitionQueryRequest */ class PartitionQueryRequest extends \Google\Protobuf\Internal\Message { /** * Required. The session used to create the partitions. * * Generated from protobuf field string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ private $session = ''; /** * Read only snapshot transactions are supported, read/write and single use * transactions are not. * * Generated from protobuf field .google.spanner.v1.TransactionSelector transaction = 2; */ private $transaction = null; /** * Required. The query request to generate partitions for. The request will fail if * the query is not root partitionable. The query plan of a root * partitionable query has a single distributed union operator. A distributed * union operator conceptually divides one or more tables into multiple * splits, remotely evaluates a subquery independently on each split, and * then unions all results. * This must not contain DML commands, such as INSERT, UPDATE, or * DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a * PartitionedDml transaction for large, partition-friendly DML operations. * * 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 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. * * 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.PartitionQueryRequest.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][google.spanner.v1.Type] for more information * about SQL types. * * Generated from protobuf field map param_types = 5; */ private $param_types; /** * Additional options that affect how many partitions are created. * * Generated from protobuf field .google.spanner.v1.PartitionOptions partition_options = 6; */ private $partition_options = null; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type string $session * Required. The session used to create the partitions. * @type \Google\Cloud\Spanner\V1\TransactionSelector $transaction * Read only snapshot transactions are supported, read/write and single use * transactions are not. * @type string $sql * Required. The query request to generate partitions for. The request will fail if * the query is not root partitionable. The query plan of a root * partitionable query has a single distributed union operator. A distributed * union operator conceptually divides one or more tables into multiple * splits, remotely evaluates a subquery independently on each split, and * then unions all results. * This must not contain DML commands, such as INSERT, UPDATE, or * DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a * PartitionedDml transaction for large, partition-friendly DML operations. * @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 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. * @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.PartitionQueryRequest.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][google.spanner.v1.Type] for more information * about SQL types. * @type \Google\Cloud\Spanner\V1\PartitionOptions $partition_options * Additional options that affect how many partitions are created. * } */ public function __construct($data = NULL) { \GPBMetadata\Google\Spanner\V1\Spanner::initOnce(); parent::__construct($data); } /** * Required. The session used to create the partitions. * * 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 used to create the partitions. * * 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; } /** * Read only snapshot transactions are supported, read/write and single use * transactions are not. * * 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); } /** * Read only snapshot transactions are supported, read/write and single use * transactions are not. * * 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 query request to generate partitions for. The request will fail if * the query is not root partitionable. The query plan of a root * partitionable query has a single distributed union operator. A distributed * union operator conceptually divides one or more tables into multiple * splits, remotely evaluates a subquery independently on each split, and * then unions all results. * This must not contain DML commands, such as INSERT, UPDATE, or * DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a * PartitionedDml transaction for large, partition-friendly DML operations. * * Generated from protobuf field string sql = 3 [(.google.api.field_behavior) = REQUIRED]; * @return string */ public function getSql() { return $this->sql; } /** * Required. The query request to generate partitions for. The request will fail if * the query is not root partitionable. The query plan of a root * partitionable query has a single distributed union operator. A distributed * union operator conceptually divides one or more tables into multiple * splits, remotely evaluates a subquery independently on each split, and * then unions all results. * This must not contain DML commands, such as INSERT, UPDATE, or * DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a * PartitionedDml transaction for large, partition-friendly DML operations. * * 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 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. * * 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 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. * * 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.PartitionQueryRequest.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][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.PartitionQueryRequest.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][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; } /** * Additional options that affect how many partitions are created. * * Generated from protobuf field .google.spanner.v1.PartitionOptions partition_options = 6; * @return \Google\Cloud\Spanner\V1\PartitionOptions|null */ public function getPartitionOptions() { return $this->partition_options; } public function hasPartitionOptions() { return isset($this->partition_options); } public function clearPartitionOptions() { unset($this->partition_options); } /** * Additional options that affect how many partitions are created. * * Generated from protobuf field .google.spanner.v1.PartitionOptions partition_options = 6; * @param \Google\Cloud\Spanner\V1\PartitionOptions $var * @return $this */ public function setPartitionOptions($var) { GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\PartitionOptions::class); $this->partition_options = $var; return $this; } }