kinetica.AlterTableRequest.Action

A set of string constants for the parameter AlterTableRequest.action. More…

Static Public Attributes
const string	CREATE_INDEX = “create_index”
	Creates a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified INDEX_TYPE), on the column name specified in AlterTableRequest._value.

const string	REFRESH_INDEX = “refresh_index”
	Refreshes an index identified by INDEX_TYPE, on the column name specified in AlterTableRequest._value.

const string	DELETE_INDEX = “delete_index”
	Deletes a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified INDEX_TYPE), on the column name specified in AlterTableRequest._value.

const string	MOVE_TO_COLLECTION = “move_to_collection”
	[DEPRECATED–please use MOVE_TO_SCHEMA and use Kinetica.createSchema to create the schema if non-existent] Moves a table or view into a schema named AlterTableRequest._value.

const string	MOVE_TO_SCHEMA = “move_to_schema”
	Moves a table or view into a schema named AlterTableRequest._value.

const string	PROTECTED = “protected”
	No longer used.

const string	RENAME_TABLE = “rename_table”
	Renames a table or view to AlterTableRequest._value.

const string	TTL = “ttl”
	Sets the time-to-live in minutes of the table or view specified in AlterTableRequest.table_name.

const string	ADD_COMMENT = “add_comment”
	Adds the comment specified in AlterTableRequest._value to the table specified in AlterTableRequest.table_name.

const string	ADD_COLUMN = “add_column”
	Adds the column specified in AlterTableRequest._value to the table specified in AlterTableRequest.table_name.

const string	CHANGE_COLUMN = “change_column”
	Changes type and properties of the column specified in AlterTableRequest._value.

const string	DELETE_COLUMN = “delete_column”
	Deletes the column specified in AlterTableRequest._value from the table specified in AlterTableRequest.table_name.

const string	SET_DEFAULT = “set_default”
	Sets or replaces the default value expression for the column specified in AlterTableRequest._value.

const string	DELETE_DEFAULT = “delete_default”
	Removes the default value expression from the column specified in AlterTableRequest._value.

const string	CREATE_FOREIGN_KEY = “create_foreign_key”
	Creates a foreign key specified in AlterTableRequest._value using the format ‘(source_column_name [, …]) references target_table_name(primary_key_column_name [, …]) [as foreign_key_name]’.

const string	DELETE_FOREIGN_KEY = “delete_foreign_key”
	Deletes a foreign key.

const string	ADD_PARTITION = “add_partition”
	Adds the partition specified in AlterTableRequest._value, to either a range-partitioned or manual list-partitioned table.

const string	REMOVE_PARTITION = “remove_partition”
	Removes the partition specified in AlterTableRequest._value (and relocates all of its data to the default partition) from either a range-partitioned or manual list-partitioned table.

const string	DELETE_PARTITION = “delete_partition”
	Deletes the partition specified in AlterTableRequest._value (and all of its data) from either a range-partitioned or manual list-partitioned table.

const string	SET_GLOBAL_ACCESS_MODE = “set_global_access_mode”
	Sets the global access mode (i.e.

const string	REFRESH = “refresh”
	For a materialized view, replays all the table creation commands required to create the view.

const string	SET_REFRESH_METHOD = “set_refresh_method”
	For a materialized view, sets the method by which the view is refreshed to the method specified in AlterTableRequest._value - one of ‘manual’, ‘periodic’, or ‘on_change’.

const string	SET_REFRESH_START_TIME = “set_refresh_start_time”
	Sets the time to start periodic refreshes of this materialized view to the datetime string specified in AlterTableRequest._value with format ‘YYYY-MM-DD HH:MM:SS’.

const string	SET_REFRESH_STOP_TIME = “set_refresh_stop_time”
	Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in AlterTableRequest._value with format ‘YYYY-MM-DD HH:MM:SS’.

const string	SET_REFRESH_PERIOD = “set_refresh_period”
	Sets the time interval in seconds at which to refresh this materialized view to the value specified in AlterTableRequest._value.

const string	SET_REFRESH_SPAN = “set_refresh_span”
	Sets the future time-offset(in seconds) for the view refresh to stop.

const string	SET_REFRESH_EXECUTE_AS = “set_refresh_execute_as”
	Sets the user name to refresh this materialized view to the value specified in AlterTableRequest._value.

const string	REMOVE_TEXT_SEARCH_ATTRIBUTES = “remove_text_search_attributes”
	Removes text search attribute from all columns.

const string	REMOVE_SHARD_KEYS = “remove_shard_keys”
	Removes the shard key property from all columns, so that the table will be considered randomly sharded.

const string	SET_STRATEGY_DEFINITION = “set_strategy_definition”
	Sets the tier strategy for the table and its columns to the one specified in AlterTableRequest._value, replacing the existing tier strategy in its entirety.

const string	CANCEL_DATASOURCE_SUBSCRIPTION = “cancel_datasource_subscription”
	Permanently unsubscribe a data source that is loading continuously as a stream.

const string	DROP_DATASOURCE_SUBSCRIPTION = “drop_datasource_subscription”
	Permanently delete a cancelled data source subscription.

const string	PAUSE_DATASOURCE_SUBSCRIPTION = “pause_datasource_subscription”
	Temporarily unsubscribe a data source that is loading continuously as a stream.

const string	RESUME_DATASOURCE_SUBSCRIPTION = “resume_datasource_subscription”
	Resubscribe to a paused data source subscription.

const string	CHANGE_OWNER = “change_owner”
	Change the owner resource group of the table.

const string	SET_LOAD_VECTORS_POLICY = “set_load_vectors_policy”
	Set startup data loading scheme for the table; see description of ‘load_vectors_policy’ in Kinetica.createTable for possible values for AlterTableRequest._value.

const string	SET_BUILD_PK_INDEX_POLICY = “set_build_pk_index_policy”
	Set startup primary key generation scheme for the table; see description of ‘build_pk_index_policy’ in Kinetica.createTable for possible values for AlterTableRequest._value.

const string	SET_BUILD_MATERIALIZED_VIEW_POLICY = “set_build_materialized_view_policy”
	Set startup rebuilding scheme for the materialized view; see description of ‘build_materialized_view_policy’ in Kinetica.createMaterializedView for possible values for AlterTableRequest._value.

Detailed Description

A set of string constants for the parameter AlterTableRequest.action.

Modification operation to be applied.

Definition at line 59 of file AlterTable.cs.

Member Data Documentation

◆ ADD_COLUMN

const string kinetica.AlterTableRequest.Action.ADD_COLUMN = “add_column”

static

Adds the column specified in AlterTableRequest._value to the table specified in AlterTableRequest.table_name.

Use COLUMN_TYPE and COLUMN_PROPERTIES in AlterTableRequest.options to set the column’s type and properties, respectively.

Definition at line 161 of file AlterTable.cs.

◆ ADD_COMMENT

const string kinetica.AlterTableRequest.Action.ADD_COMMENT = “add_comment”

static

Adds the comment specified in AlterTableRequest._value to the table specified in AlterTableRequest.table_name.

Use COLUMN_NAME to set the comment for a column.

Definition at line 150 of file AlterTable.cs.

◆ ADD_PARTITION

const string kinetica.AlterTableRequest.Action.ADD_PARTITION = “add_partition”

static

Adds the partition specified in AlterTableRequest._value, to either a range-partitioned or manual list-partitioned table.

Definition at line 218 of file AlterTable.cs.

◆ CANCEL_DATASOURCE_SUBSCRIPTION

const string kinetica.AlterTableRequest.Action.CANCEL_DATASOURCE_SUBSCRIPTION = “cancel_datasource_subscription”

static

Permanently unsubscribe a data source that is loading continuously as a stream.

The data source can be Kafka / S3 / Azure / GCS.

Definition at line 320 of file AlterTable.cs.

◆ CHANGE_COLUMN

const string kinetica.AlterTableRequest.Action.CHANGE_COLUMN = “change_column”

static

Changes type and properties of the column specified in AlterTableRequest._value.

Use COLUMN_TYPE and COLUMN_PROPERTIES in AlterTableRequest.options to set the column’s type and properties, respectively. Note that primary key and/or shard key columns cannot be changed. All unchanging column properties must be listed for the change to take place, e.g., to add dictionary encoding to an existing ‘char4’ column, both ‘char4’ and ‘dict’ must be specified in the AlterTableRequest.options map.

Definition at line 176 of file AlterTable.cs.

◆ CHANGE_OWNER

const string kinetica.AlterTableRequest.Action.CHANGE_OWNER = “change_owner”

static

Change the owner resource group of the table.

Definition at line 339 of file AlterTable.cs.

◆ CREATE_FOREIGN_KEY

const string kinetica.AlterTableRequest.Action.CREATE_FOREIGN_KEY = “create_foreign_key”

static

Creates a foreign key specified in AlterTableRequest._value using the format ‘(source_column_name [, …]) references target_table_name(primary_key_column_name [, …]) [as foreign_key_name]’.

Definition at line 203 of file AlterTable.cs.

◆ CREATE_INDEX

const string kinetica.AlterTableRequest.Action.CREATE_INDEX = “create_index”

static

Creates a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified INDEX_TYPE), on the column name specified in AlterTableRequest._value.

If this column already has the specified index, an error will be returned.

Definition at line 78 of file AlterTable.cs.

◆ DELETE_COLUMN

const string kinetica.AlterTableRequest.Action.DELETE_COLUMN = “delete_column”

static

Deletes the column specified in AlterTableRequest._value from the table specified in AlterTableRequest.table_name.

Definition at line 181 of file AlterTable.cs.

◆ DELETE_DEFAULT

const string kinetica.AlterTableRequest.Action.DELETE_DEFAULT = “delete_default”

static

Removes the default value expression from the column specified in AlterTableRequest._value.

Other column properties are preserved.

Definition at line 195 of file AlterTable.cs.

◆ DELETE_FOREIGN_KEY

const string kinetica.AlterTableRequest.Action.DELETE_FOREIGN_KEY = “delete_foreign_key”

static

Deletes a foreign key.

The AlterTableRequest._value should be the foreign_key_name specified when creating the key or the complete string used to define it.

Definition at line 210 of file AlterTable.cs.

◆ DELETE_INDEX

const string kinetica.AlterTableRequest.Action.DELETE_INDEX = “delete_index”

static

Deletes a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified INDEX_TYPE), on the column name specified in AlterTableRequest._value.

If this column does not have the specified index, an error will be returned.

Definition at line 105 of file AlterTable.cs.

◆ DELETE_PARTITION

const string kinetica.AlterTableRequest.Action.DELETE_PARTITION = “delete_partition”

static

Deletes the partition specified in AlterTableRequest._value (and all of its data) from either a range-partitioned or manual list-partitioned table.

Definition at line 235 of file AlterTable.cs.

◆ DROP_DATASOURCE_SUBSCRIPTION

const string kinetica.AlterTableRequest.Action.DROP_DATASOURCE_SUBSCRIPTION = “drop_datasource_subscription”

static

Permanently delete a cancelled data source subscription.

Definition at line 324 of file AlterTable.cs.

◆ MOVE_TO_COLLECTION

const string kinetica.AlterTableRequest.Action.MOVE_TO_COLLECTION = “move_to_collection”

static

[DEPRECATED–please use MOVE_TO_SCHEMA and use Kinetica.createSchema to create the schema if non-existent] Moves a table or view into a schema named AlterTableRequest._value.

If the schema provided is non-existent, it will be automatically created.

Definition at line 115 of file AlterTable.cs.

◆ MOVE_TO_SCHEMA

const string kinetica.AlterTableRequest.Action.MOVE_TO_SCHEMA = “move_to_schema”

static

Moves a table or view into a schema named AlterTableRequest._value.

If the schema provided is nonexistent, an error will be thrown. If AlterTableRequest._value is empty, then the table or view will be placed in the user’s default schema.

Definition at line 123 of file AlterTable.cs.

◆ PAUSE_DATASOURCE_SUBSCRIPTION

const string kinetica.AlterTableRequest.Action.PAUSE_DATASOURCE_SUBSCRIPTION = “pause_datasource_subscription”

static

Temporarily unsubscribe a data source that is loading continuously as a stream.

The data source can be Kafka / S3 / Azure / GCS.

Definition at line 330 of file AlterTable.cs.

◆ PROTECTED

const string kinetica.AlterTableRequest.Action.PROTECTED = “protected”

static

No longer used.

Previously set whether the given AlterTableRequest.table_name should be protected or not. The AlterTableRequest._value would have been either ‘true’ or ‘false’.

Definition at line 130 of file AlterTable.cs.

◆ REFRESH

const string kinetica.AlterTableRequest.Action.REFRESH = “refresh”

static

For a materialized view, replays all the table creation commands required to create the view.

For an external table, reloads all data in the table from its associated source files or data source.

Definition at line 252 of file AlterTable.cs.

◆ REFRESH_INDEX

const string kinetica.AlterTableRequest.Action.REFRESH_INDEX = “refresh_index”

static

Refreshes an index identified by INDEX_TYPE, on the column name specified in AlterTableRequest._value.

Currently applicable only to CAGRA indices.

Definition at line 86 of file AlterTable.cs.

◆ REMOVE_PARTITION

const string kinetica.AlterTableRequest.Action.REMOVE_PARTITION = “remove_partition”

static

Removes the partition specified in AlterTableRequest._value (and relocates all of its data to the default partition) from either a range-partitioned or manual list-partitioned table.

Definition at line 227 of file AlterTable.cs.

◆ REMOVE_SHARD_KEYS

const string kinetica.AlterTableRequest.Action.REMOVE_SHARD_KEYS = “remove_shard_keys”

static

Removes the shard key property from all columns, so that the table will be considered randomly sharded.

The data is not moved. The AlterTableRequest._value is ignored.

Definition at line 308 of file AlterTable.cs.

◆ REMOVE_TEXT_SEARCH_ATTRIBUTES

const string kinetica.AlterTableRequest.Action.REMOVE_TEXT_SEARCH_ATTRIBUTES = “remove_text_search_attributes”

static

Removes text search attribute from all columns.

Definition at line 302 of file AlterTable.cs.

◆ RENAME_TABLE

const string kinetica.AlterTableRequest.Action.RENAME_TABLE = “rename_table”

static

Renames a table or view to AlterTableRequest._value.

Has the same naming restrictions as tables.

Definition at line 137 of file AlterTable.cs.

◆ RESUME_DATASOURCE_SUBSCRIPTION

const string kinetica.AlterTableRequest.Action.RESUME_DATASOURCE_SUBSCRIPTION = “resume_datasource_subscription”

static

Resubscribe to a paused data source subscription.

The data source can be Kafka / S3 / Azure / GCS.

Definition at line 336 of file AlterTable.cs.

◆ SET_BUILD_MATERIALIZED_VIEW_POLICY

const string kinetica.AlterTableRequest.Action.SET_BUILD_MATERIALIZED_VIEW_POLICY = “set_build_materialized_view_policy”

static

Set startup rebuilding scheme for the materialized view; see description of ‘build_materialized_view_policy’ in Kinetica.createMaterializedView for possible values for AlterTableRequest._value.

Definition at line 360 of file AlterTable.cs.

◆ SET_BUILD_PK_INDEX_POLICY

const string kinetica.AlterTableRequest.Action.SET_BUILD_PK_INDEX_POLICY = “set_build_pk_index_policy”

static

Set startup primary key generation scheme for the table; see description of ‘build_pk_index_policy’ in Kinetica.createTable for possible values for AlterTableRequest._value.

Definition at line 353 of file AlterTable.cs.

◆ SET_DEFAULT

const string kinetica.AlterTableRequest.Action.SET_DEFAULT = “set_default”

static

Sets or replaces the default value expression for the column specified in AlterTableRequest._value.

The new default is taken from ADD_COLUMN_EXPRESSION. Existing properties on the column are preserved.

Definition at line 189 of file AlterTable.cs.

◆ SET_GLOBAL_ACCESS_MODE

const string kinetica.AlterTableRequest.Action.SET_GLOBAL_ACCESS_MODE = “set_global_access_mode”

static

Sets the global access mode (i.e.

locking) for the table specified in AlterTableRequest.table_name.

Specify the access mode in AlterTableRequest._value. Valid modes are ‘no_access’, ‘read_only’, ‘write_only’ and ‘read_write’.

Definition at line 242 of file AlterTable.cs.

◆ SET_LOAD_VECTORS_POLICY

const string kinetica.AlterTableRequest.Action.SET_LOAD_VECTORS_POLICY = “set_load_vectors_policy”

static

Set startup data loading scheme for the table; see description of ‘load_vectors_policy’ in Kinetica.createTable for possible values for AlterTableRequest._value.

Definition at line 346 of file AlterTable.cs.

◆ SET_REFRESH_EXECUTE_AS

const string kinetica.AlterTableRequest.Action.SET_REFRESH_EXECUTE_AS = “set_refresh_execute_as”

static

Sets the user name to refresh this materialized view to the value specified in AlterTableRequest._value.

Definition at line 298 of file AlterTable.cs.

◆ SET_REFRESH_METHOD

const string kinetica.AlterTableRequest.Action.SET_REFRESH_METHOD = “set_refresh_method”

static

For a materialized view, sets the method by which the view is refreshed to the method specified in AlterTableRequest._value - one of ‘manual’, ‘periodic’, or ‘on_change’.

For an external table, sets the method by which the table is refreshed to the method specified in AlterTableRequest._value - either ‘manual’ or ‘on_start’.

Definition at line 264 of file AlterTable.cs.

◆ SET_REFRESH_PERIOD

const string kinetica.AlterTableRequest.Action.SET_REFRESH_PERIOD = “set_refresh_period”

static

Sets the time interval in seconds at which to refresh this materialized view to the value specified in AlterTableRequest._value.

Also, sets the refresh method to periodic if not already set.

Definition at line 288 of file AlterTable.cs.

◆ SET_REFRESH_SPAN

const string kinetica.AlterTableRequest.Action.SET_REFRESH_SPAN = “set_refresh_span”

static

Sets the future time-offset(in seconds) for the view refresh to stop.

Definition at line 292 of file AlterTable.cs.

◆ SET_REFRESH_START_TIME

const string kinetica.AlterTableRequest.Action.SET_REFRESH_START_TIME = “set_refresh_start_time”

static

Sets the time to start periodic refreshes of this materialized view to the datetime string specified in AlterTableRequest._value with format ‘YYYY-MM-DD HH:MM:SS’.

Subsequent refreshes occur at the specified time + N * the refresh period.

Definition at line 273 of file AlterTable.cs.

◆ SET_REFRESH_STOP_TIME

const string kinetica.AlterTableRequest.Action.SET_REFRESH_STOP_TIME = “set_refresh_stop_time”

static

Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in AlterTableRequest._value with format ‘YYYY-MM-DD HH:MM:SS’.

Definition at line 280 of file AlterTable.cs.

◆ SET_STRATEGY_DEFINITION

const string kinetica.AlterTableRequest.Action.SET_STRATEGY_DEFINITION = “set_strategy_definition”

static

Sets the tier strategy for the table and its columns to the one specified in AlterTableRequest._value, replacing the existing tier strategy in its entirety.

Definition at line 314 of file AlterTable.cs.

◆ TTL

const string kinetica.AlterTableRequest.Action.TTL = “ttl”

static

Sets the time-to-live in minutes of the table or view specified in AlterTableRequest.table_name.

Definition at line 142 of file AlterTable.cs.

The documentation for this struct was generated from the following files:

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/AlterTable.cs
Kinetica/Protocol/AlterTable.cs

​ Static Public Attributes

​Detailed Description

​Member Data Documentation

​◆ ADD_COLUMN

​◆ ADD_COMMENT

​◆ ADD_PARTITION

​◆ CANCEL_DATASOURCE_SUBSCRIPTION

​◆ CHANGE_COLUMN

​◆ CHANGE_OWNER

​◆ CREATE_FOREIGN_KEY

​◆ CREATE_INDEX

​◆ DELETE_COLUMN

​◆ DELETE_DEFAULT

​◆ DELETE_FOREIGN_KEY

​◆ DELETE_INDEX

​◆ DELETE_PARTITION

​◆ DROP_DATASOURCE_SUBSCRIPTION

​◆ MOVE_TO_COLLECTION

​◆ MOVE_TO_SCHEMA

​◆ PAUSE_DATASOURCE_SUBSCRIPTION

​◆ PROTECTED

​◆ REFRESH

​◆ REFRESH_INDEX

​◆ REMOVE_PARTITION

​◆ REMOVE_SHARD_KEYS

​◆ REMOVE_TEXT_SEARCH_ATTRIBUTES

​◆ RENAME_TABLE

​◆ RESUME_DATASOURCE_SUBSCRIPTION

​◆ SET_BUILD_MATERIALIZED_VIEW_POLICY

​◆ SET_BUILD_PK_INDEX_POLICY

​◆ SET_DEFAULT

​◆ SET_GLOBAL_ACCESS_MODE

​◆ SET_LOAD_VECTORS_POLICY

​◆ SET_REFRESH_EXECUTE_AS

​◆ SET_REFRESH_METHOD

​◆ SET_REFRESH_PERIOD

​◆ SET_REFRESH_SPAN

​◆ SET_REFRESH_START_TIME

​◆ SET_REFRESH_STOP_TIME

​◆ SET_STRATEGY_DEFINITION

​◆ TTL

Static Public Attributes

Detailed Description

Member Data Documentation

◆ ADD_COLUMN

◆ ADD_COMMENT

◆ ADD_PARTITION

◆ CANCEL_DATASOURCE_SUBSCRIPTION

◆ CHANGE_COLUMN

◆ CHANGE_OWNER

◆ CREATE_FOREIGN_KEY

◆ CREATE_INDEX

◆ DELETE_COLUMN

◆ DELETE_DEFAULT

◆ DELETE_FOREIGN_KEY

◆ DELETE_INDEX

◆ DELETE_PARTITION

◆ DROP_DATASOURCE_SUBSCRIPTION

◆ MOVE_TO_COLLECTION

◆ MOVE_TO_SCHEMA

◆ PAUSE_DATASOURCE_SUBSCRIPTION

◆ PROTECTED

◆ REFRESH

◆ REFRESH_INDEX

◆ REMOVE_PARTITION

◆ REMOVE_SHARD_KEYS

◆ REMOVE_TEXT_SEARCH_ATTRIBUTES

◆ RENAME_TABLE

◆ RESUME_DATASOURCE_SUBSCRIPTION

◆ SET_BUILD_MATERIALIZED_VIEW_POLICY

◆ SET_BUILD_PK_INDEX_POLICY

◆ SET_DEFAULT

◆ SET_GLOBAL_ACCESS_MODE

◆ SET_LOAD_VECTORS_POLICY

◆ SET_REFRESH_EXECUTE_AS

◆ SET_REFRESH_METHOD

◆ SET_REFRESH_PERIOD

◆ SET_REFRESH_SPAN

◆ SET_REFRESH_START_TIME

◆ SET_REFRESH_STOP_TIME

◆ SET_STRATEGY_DEFINITION

◆ TTL