Ydb.Table.AlterTableRequest
*/
class AlterTableRequest extends \Google\Protobuf\Internal\Message
{
/**
* Session identifier
*
* Generated from protobuf field string session_id = 1;
*/
protected $session_id = '';
/**
* Full path
*
* Generated from protobuf field string path = 2;
*/
protected $path = '';
/**
* Columns (name, type) to add
*
* Generated from protobuf field repeated .Ydb.Table.ColumnMeta add_columns = 3;
*/
private $add_columns;
/**
* Columns to remove
*
* Generated from protobuf field repeated string drop_columns = 4;
*/
private $drop_columns;
/**
* Generated from protobuf field .Ydb.Operations.OperationParams operation_params = 5;
*/
protected $operation_params = null;
/**
* Columns to alter
*
* Generated from protobuf field repeated .Ydb.Table.ColumnMeta alter_columns = 6;
*/
private $alter_columns;
/**
* Add secondary indexes
*
* Generated from protobuf field repeated .Ydb.Table.TableIndex add_indexes = 9;
*/
private $add_indexes;
/**
* Remove secondary indexes
*
* Generated from protobuf field repeated string drop_indexes = 10;
*/
private $drop_indexes;
/**
* Change table storage settings
*
* Generated from protobuf field .Ydb.Table.StorageSettings alter_storage_settings = 11;
*/
protected $alter_storage_settings = null;
/**
* Add/alter column families
*
* Generated from protobuf field repeated .Ydb.Table.ColumnFamily add_column_families = 12;
*/
private $add_column_families;
/**
* Generated from protobuf field repeated .Ydb.Table.ColumnFamily alter_column_families = 13;
*/
private $alter_column_families;
/**
* Alter attributes. Leave the value blank to drop an attribute.
* Cannot be used in combination with other fields (except session_id and path) at the moment.
*
* Generated from protobuf field map alter_attributes = 14 [(.Ydb.length) = {
*/
private $alter_attributes;
/**
* Set predefined named set of settings for table compaction ["default", "small_table", "log_table"].
* Set "default" to use default preset.
*
* Generated from protobuf field string set_compaction_policy = 15;
*/
protected $set_compaction_policy = '';
/**
* Change table partitioning settings
*
* Generated from protobuf field .Ydb.Table.PartitioningSettings alter_partitioning_settings = 16;
*/
protected $alter_partitioning_settings = null;
/**
* Enable/disable bloom filter by key
*
* Generated from protobuf field .Ydb.FeatureFlag.Status set_key_bloom_filter = 17;
*/
protected $set_key_bloom_filter = 0;
/**
* Set read replicas settings for table
*
* Generated from protobuf field .Ydb.Table.ReadReplicasSettings set_read_replicas_settings = 18;
*/
protected $set_read_replicas_settings = null;
/**
* Add change feeds
*
* Generated from protobuf field repeated .Ydb.Table.Changefeed add_changefeeds = 19;
*/
private $add_changefeeds;
/**
* Remove change feeds (by its names)
*
* Generated from protobuf field repeated string drop_changefeeds = 20;
*/
private $drop_changefeeds;
/**
* Rename existed index
*
* Generated from protobuf field repeated .Ydb.Table.RenameIndexItem rename_indexes = 21;
*/
private $rename_indexes;
protected $ttl_action;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $session_id
* Session identifier
* @type string $path
* Full path
* @type array<\Ydb\Table\ColumnMeta>|\Google\Protobuf\Internal\RepeatedField $add_columns
* Columns (name, type) to add
* @type array|\Google\Protobuf\Internal\RepeatedField $drop_columns
* Columns to remove
* @type \Ydb\Operations\OperationParams $operation_params
* @type array<\Ydb\Table\ColumnMeta>|\Google\Protobuf\Internal\RepeatedField $alter_columns
* Columns to alter
* @type \Ydb\Table\TtlSettings $set_ttl_settings
* @type \Google\Protobuf\GPBEmpty $drop_ttl_settings
* @type array<\Ydb\Table\TableIndex>|\Google\Protobuf\Internal\RepeatedField $add_indexes
* Add secondary indexes
* @type array|\Google\Protobuf\Internal\RepeatedField $drop_indexes
* Remove secondary indexes
* @type \Ydb\Table\StorageSettings $alter_storage_settings
* Change table storage settings
* @type array<\Ydb\Table\ColumnFamily>|\Google\Protobuf\Internal\RepeatedField $add_column_families
* Add/alter column families
* @type array<\Ydb\Table\ColumnFamily>|\Google\Protobuf\Internal\RepeatedField $alter_column_families
* @type array|\Google\Protobuf\Internal\MapField $alter_attributes
* Alter attributes. Leave the value blank to drop an attribute.
* Cannot be used in combination with other fields (except session_id and path) at the moment.
* @type string $set_compaction_policy
* Set predefined named set of settings for table compaction ["default", "small_table", "log_table"].
* Set "default" to use default preset.
* @type \Ydb\Table\PartitioningSettings $alter_partitioning_settings
* Change table partitioning settings
* @type int $set_key_bloom_filter
* Enable/disable bloom filter by key
* @type \Ydb\Table\ReadReplicasSettings $set_read_replicas_settings
* Set read replicas settings for table
* @type array<\Ydb\Table\Changefeed>|\Google\Protobuf\Internal\RepeatedField $add_changefeeds
* Add change feeds
* @type array|\Google\Protobuf\Internal\RepeatedField $drop_changefeeds
* Remove change feeds (by its names)
* @type array<\Ydb\Table\RenameIndexItem>|\Google\Protobuf\Internal\RepeatedField $rename_indexes
* Rename existed index
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Protos\YdbTable::initOnce();
parent::__construct($data);
}
/**
* Session identifier
*
* Generated from protobuf field string session_id = 1;
* @return string
*/
public function getSessionId()
{
return $this->session_id;
}
/**
* Session identifier
*
* Generated from protobuf field string session_id = 1;
* @param string $var
* @return $this
*/
public function setSessionId($var)
{
GPBUtil::checkString($var, True);
$this->session_id = $var;
return $this;
}
/**
* Full path
*
* Generated from protobuf field string path = 2;
* @return string
*/
public function getPath()
{
return $this->path;
}
/**
* Full path
*
* Generated from protobuf field string path = 2;
* @param string $var
* @return $this
*/
public function setPath($var)
{
GPBUtil::checkString($var, True);
$this->path = $var;
return $this;
}
/**
* Columns (name, type) to add
*
* Generated from protobuf field repeated .Ydb.Table.ColumnMeta add_columns = 3;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getAddColumns()
{
return $this->add_columns;
}
/**
* Columns (name, type) to add
*
* Generated from protobuf field repeated .Ydb.Table.ColumnMeta add_columns = 3;
* @param array<\Ydb\Table\ColumnMeta>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setAddColumns($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Ydb\Table\ColumnMeta::class);
$this->add_columns = $arr;
return $this;
}
/**
* Columns to remove
*
* Generated from protobuf field repeated string drop_columns = 4;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getDropColumns()
{
return $this->drop_columns;
}
/**
* Columns to remove
*
* Generated from protobuf field repeated string drop_columns = 4;
* @param array|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setDropColumns($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->drop_columns = $arr;
return $this;
}
/**
* Generated from protobuf field .Ydb.Operations.OperationParams operation_params = 5;
* @return \Ydb\Operations\OperationParams|null
*/
public function getOperationParams()
{
return $this->operation_params;
}
public function hasOperationParams()
{
return isset($this->operation_params);
}
public function clearOperationParams()
{
unset($this->operation_params);
}
/**
* Generated from protobuf field .Ydb.Operations.OperationParams operation_params = 5;
* @param \Ydb\Operations\OperationParams $var
* @return $this
*/
public function setOperationParams($var)
{
GPBUtil::checkMessage($var, \Ydb\Operations\OperationParams::class);
$this->operation_params = $var;
return $this;
}
/**
* Columns to alter
*
* Generated from protobuf field repeated .Ydb.Table.ColumnMeta alter_columns = 6;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getAlterColumns()
{
return $this->alter_columns;
}
/**
* Columns to alter
*
* Generated from protobuf field repeated .Ydb.Table.ColumnMeta alter_columns = 6;
* @param array<\Ydb\Table\ColumnMeta>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setAlterColumns($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Ydb\Table\ColumnMeta::class);
$this->alter_columns = $arr;
return $this;
}
/**
* Generated from protobuf field .Ydb.Table.TtlSettings set_ttl_settings = 7;
* @return \Ydb\Table\TtlSettings|null
*/
public function getSetTtlSettings()
{
return $this->readOneof(7);
}
public function hasSetTtlSettings()
{
return $this->hasOneof(7);
}
/**
* Generated from protobuf field .Ydb.Table.TtlSettings set_ttl_settings = 7;
* @param \Ydb\Table\TtlSettings $var
* @return $this
*/
public function setSetTtlSettings($var)
{
GPBUtil::checkMessage($var, \Ydb\Table\TtlSettings::class);
$this->writeOneof(7, $var);
return $this;
}
/**
* Generated from protobuf field .google.protobuf.Empty drop_ttl_settings = 8;
* @return \Google\Protobuf\GPBEmpty|null
*/
public function getDropTtlSettings()
{
return $this->readOneof(8);
}
public function hasDropTtlSettings()
{
return $this->hasOneof(8);
}
/**
* Generated from protobuf field .google.protobuf.Empty drop_ttl_settings = 8;
* @param \Google\Protobuf\GPBEmpty $var
* @return $this
*/
public function setDropTtlSettings($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\GPBEmpty::class);
$this->writeOneof(8, $var);
return $this;
}
/**
* Add secondary indexes
*
* Generated from protobuf field repeated .Ydb.Table.TableIndex add_indexes = 9;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getAddIndexes()
{
return $this->add_indexes;
}
/**
* Add secondary indexes
*
* Generated from protobuf field repeated .Ydb.Table.TableIndex add_indexes = 9;
* @param array<\Ydb\Table\TableIndex>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setAddIndexes($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Ydb\Table\TableIndex::class);
$this->add_indexes = $arr;
return $this;
}
/**
* Remove secondary indexes
*
* Generated from protobuf field repeated string drop_indexes = 10;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getDropIndexes()
{
return $this->drop_indexes;
}
/**
* Remove secondary indexes
*
* Generated from protobuf field repeated string drop_indexes = 10;
* @param array|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setDropIndexes($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->drop_indexes = $arr;
return $this;
}
/**
* Change table storage settings
*
* Generated from protobuf field .Ydb.Table.StorageSettings alter_storage_settings = 11;
* @return \Ydb\Table\StorageSettings|null
*/
public function getAlterStorageSettings()
{
return $this->alter_storage_settings;
}
public function hasAlterStorageSettings()
{
return isset($this->alter_storage_settings);
}
public function clearAlterStorageSettings()
{
unset($this->alter_storage_settings);
}
/**
* Change table storage settings
*
* Generated from protobuf field .Ydb.Table.StorageSettings alter_storage_settings = 11;
* @param \Ydb\Table\StorageSettings $var
* @return $this
*/
public function setAlterStorageSettings($var)
{
GPBUtil::checkMessage($var, \Ydb\Table\StorageSettings::class);
$this->alter_storage_settings = $var;
return $this;
}
/**
* Add/alter column families
*
* Generated from protobuf field repeated .Ydb.Table.ColumnFamily add_column_families = 12;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getAddColumnFamilies()
{
return $this->add_column_families;
}
/**
* Add/alter column families
*
* Generated from protobuf field repeated .Ydb.Table.ColumnFamily add_column_families = 12;
* @param array<\Ydb\Table\ColumnFamily>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setAddColumnFamilies($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Ydb\Table\ColumnFamily::class);
$this->add_column_families = $arr;
return $this;
}
/**
* Generated from protobuf field repeated .Ydb.Table.ColumnFamily alter_column_families = 13;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getAlterColumnFamilies()
{
return $this->alter_column_families;
}
/**
* Generated from protobuf field repeated .Ydb.Table.ColumnFamily alter_column_families = 13;
* @param array<\Ydb\Table\ColumnFamily>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setAlterColumnFamilies($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Ydb\Table\ColumnFamily::class);
$this->alter_column_families = $arr;
return $this;
}
/**
* Alter attributes. Leave the value blank to drop an attribute.
* Cannot be used in combination with other fields (except session_id and path) at the moment.
*
* Generated from protobuf field map alter_attributes = 14 [(.Ydb.length) = {
* @return \Google\Protobuf\Internal\MapField
*/
public function getAlterAttributes()
{
return $this->alter_attributes;
}
/**
* Alter attributes. Leave the value blank to drop an attribute.
* Cannot be used in combination with other fields (except session_id and path) at the moment.
*
* Generated from protobuf field map alter_attributes = 14 [(.Ydb.length) = {
* @param array|\Google\Protobuf\Internal\MapField $var
* @return $this
*/
public function setAlterAttributes($var)
{
$arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING);
$this->alter_attributes = $arr;
return $this;
}
/**
* Set predefined named set of settings for table compaction ["default", "small_table", "log_table"].
* Set "default" to use default preset.
*
* Generated from protobuf field string set_compaction_policy = 15;
* @return string
*/
public function getSetCompactionPolicy()
{
return $this->set_compaction_policy;
}
/**
* Set predefined named set of settings for table compaction ["default", "small_table", "log_table"].
* Set "default" to use default preset.
*
* Generated from protobuf field string set_compaction_policy = 15;
* @param string $var
* @return $this
*/
public function setSetCompactionPolicy($var)
{
GPBUtil::checkString($var, True);
$this->set_compaction_policy = $var;
return $this;
}
/**
* Change table partitioning settings
*
* Generated from protobuf field .Ydb.Table.PartitioningSettings alter_partitioning_settings = 16;
* @return \Ydb\Table\PartitioningSettings|null
*/
public function getAlterPartitioningSettings()
{
return $this->alter_partitioning_settings;
}
public function hasAlterPartitioningSettings()
{
return isset($this->alter_partitioning_settings);
}
public function clearAlterPartitioningSettings()
{
unset($this->alter_partitioning_settings);
}
/**
* Change table partitioning settings
*
* Generated from protobuf field .Ydb.Table.PartitioningSettings alter_partitioning_settings = 16;
* @param \Ydb\Table\PartitioningSettings $var
* @return $this
*/
public function setAlterPartitioningSettings($var)
{
GPBUtil::checkMessage($var, \Ydb\Table\PartitioningSettings::class);
$this->alter_partitioning_settings = $var;
return $this;
}
/**
* Enable/disable bloom filter by key
*
* Generated from protobuf field .Ydb.FeatureFlag.Status set_key_bloom_filter = 17;
* @return int
*/
public function getSetKeyBloomFilter()
{
return $this->set_key_bloom_filter;
}
/**
* Enable/disable bloom filter by key
*
* Generated from protobuf field .Ydb.FeatureFlag.Status set_key_bloom_filter = 17;
* @param int $var
* @return $this
*/
public function setSetKeyBloomFilter($var)
{
GPBUtil::checkEnum($var, \Ydb\FeatureFlag\Status::class);
$this->set_key_bloom_filter = $var;
return $this;
}
/**
* Set read replicas settings for table
*
* Generated from protobuf field .Ydb.Table.ReadReplicasSettings set_read_replicas_settings = 18;
* @return \Ydb\Table\ReadReplicasSettings|null
*/
public function getSetReadReplicasSettings()
{
return $this->set_read_replicas_settings;
}
public function hasSetReadReplicasSettings()
{
return isset($this->set_read_replicas_settings);
}
public function clearSetReadReplicasSettings()
{
unset($this->set_read_replicas_settings);
}
/**
* Set read replicas settings for table
*
* Generated from protobuf field .Ydb.Table.ReadReplicasSettings set_read_replicas_settings = 18;
* @param \Ydb\Table\ReadReplicasSettings $var
* @return $this
*/
public function setSetReadReplicasSettings($var)
{
GPBUtil::checkMessage($var, \Ydb\Table\ReadReplicasSettings::class);
$this->set_read_replicas_settings = $var;
return $this;
}
/**
* Add change feeds
*
* Generated from protobuf field repeated .Ydb.Table.Changefeed add_changefeeds = 19;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getAddChangefeeds()
{
return $this->add_changefeeds;
}
/**
* Add change feeds
*
* Generated from protobuf field repeated .Ydb.Table.Changefeed add_changefeeds = 19;
* @param array<\Ydb\Table\Changefeed>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setAddChangefeeds($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Ydb\Table\Changefeed::class);
$this->add_changefeeds = $arr;
return $this;
}
/**
* Remove change feeds (by its names)
*
* Generated from protobuf field repeated string drop_changefeeds = 20;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getDropChangefeeds()
{
return $this->drop_changefeeds;
}
/**
* Remove change feeds (by its names)
*
* Generated from protobuf field repeated string drop_changefeeds = 20;
* @param array|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setDropChangefeeds($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->drop_changefeeds = $arr;
return $this;
}
/**
* Rename existed index
*
* Generated from protobuf field repeated .Ydb.Table.RenameIndexItem rename_indexes = 21;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getRenameIndexes()
{
return $this->rename_indexes;
}
/**
* Rename existed index
*
* Generated from protobuf field repeated .Ydb.Table.RenameIndexItem rename_indexes = 21;
* @param array<\Ydb\Table\RenameIndexItem>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setRenameIndexes($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Ydb\Table\RenameIndexItem::class);
$this->rename_indexes = $arr;
return $this;
}
/**
* @return string
*/
public function getTtlAction()
{
return $this->whichOneof("ttl_action");
}
}