A set of parameters for Kinetica.alterTable. More...

Inheritance diagram for kinetica.AlterTableRequest:

Collaboration diagram for kinetica.AlterTableRequest:

Classes
struct	Action
	A set of string constants for the parameter action. More...

struct	Options
	A set of string constants for the parameter options. More...

Public Member Functions
	AlterTableRequest ()
	Constructs an AlterTableRequest object with default parameters. More...

	AlterTableRequest (string table_name, string action, string _value, IDictionary< string, string > options=null)
	Constructs an AlterTableRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name `[get, set]`
	Table on which the operation will be performed, in [schema_name. More...

string	action `[get, set]`
	Modification operation to be applied. More...

string	_value `[get, set]`
	The value of the modification, depending on action. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.alterTable.

Apply various modifications to a table or view. The available modifications include the following:

Manage a table's columns–a column can be added, removed, or have its type and properties modified, including whether it is dictionary encoded or not.

External tables cannot be modified except for their refresh method.

Create or delete a column, low-cardinality index, chunk skip, geospatial, CAGRA, or HNSW index. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.

Create or delete a foreign key on a particular column.

Manage a range-partitioned or a manual list-partitioned table's partitions.

Set (or reset) the tier strategy of a table or view.

Refresh and manage the refresh mode of a materialized view or an external table.

Set the time-to-live (TTL). This can be applied to tables or views.

Set the global access mode (i.e. locking) for a table. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.

Definition at line 59 of file AlterTable.cs.

Constructor & Destructor Documentation

◆ AlterTableRequest() [1/2]

kinetica.AlterTableRequest.AlterTableRequest ( )

inline

Constructs an AlterTableRequest object with default parameters.

Definition at line 1208 of file AlterTable.cs.

◆ AlterTableRequest() [2/2]

kinetica.AlterTableRequest.AlterTableRequest	(	string	table_name,
		string	action,
		string	_value,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs an AlterTableRequest object with the specified parameters.

Parameters

table_name	Table on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view.
action	Modification operation to be applied. Supported values: ALLOW_HOMOGENEOUS_TABLES: No longer supported; action will be ignored. 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 _value . If this column already has the specified index, an error will be returned. REFRESH_INDEX: Refreshes an index identified by INDEX_TYPE, on the column name specified in _value . Currently applicable only to CAGRA indices. 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 _value . If this column does not have the specified index, an error will be returned. 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 _value . If the schema provided is non-existent, it will be automatically created. MOVE_TO_SCHEMA: Moves a table or view into a schema named _value . If the schema provided is nonexistent, an error will be thrown. If _value is empty, then the table or view will be placed in the user's default schema. PROTECTED: No longer used. Previously set whether the given table_name should be protected or not. The _value would have been either 'true' or 'false'. RENAME_TABLE: Renames a table or view to _value . Has the same naming restrictions as tables. TTL: Sets the time-to-live in minutes of the table or view specified in table_name . ADD_COMMENT: Adds the comment specified in _value to the table specified in table_name . Use COLUMN_NAME to set the comment for a column. ADD_COLUMN: Adds the column specified in _value to the table specified in table_name . Use COLUMN_TYPE and COLUMN_PROPERTIES in options to set the column's type and properties, respectively. CHANGE_COLUMN: Changes type and properties of the column specified in _value . Use COLUMN_TYPE and COLUMN_PROPERTIES in 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 options map. SET_COLUMN_COMPRESSION: No longer supported; action will be ignored. DELETE_COLUMN: Deletes the column specified in _value from the table specified in table_name . CREATE_FOREIGN_KEY: Creates a foreign key specified in _value using the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'. DELETE_FOREIGN_KEY: Deletes a foreign key. The _value should be the foreign_key_name specified when creating the key or the complete string used to define it. ADD_PARTITION: Adds the partition specified in _value , to either a range-partitioned or manual list-partitioned table. REMOVE_PARTITION: Removes the partition specified in _value (and relocates all of its data to the default partition) from either a range-partitioned or manual list-partitioned table. DELETE_PARTITION: Deletes the partition specified in _value (and all of its data) from either a range-partitioned or manual list-partitioned table. SET_GLOBAL_ACCESS_MODE: Sets the global access mode (i.e. locking) for the table specified in table_name . Specify the access mode in _value . Valid modes are 'no_access', 'read_only', 'write_only' and 'read_write'. REFRESH: 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. SET_REFRESH_METHOD: For a materialized view, sets the method by which the view is refreshed to the method specified in _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 _value - either 'manual' or 'on_start'. SET_REFRESH_START_TIME: Sets the time to start periodic refreshes of this materialized view to the datetime string specified in _value with format 'YYYY-MM-DD HH:MM:SS'. Subsequent refreshes occur at the specified time + N * the refresh period. SET_REFRESH_STOP_TIME: Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in _value with format 'YYYY-MM-DD HH:MM:SS'. SET_REFRESH_PERIOD: Sets the time interval in seconds at which to refresh this materialized view to the value specified in _value . Also, sets the refresh method to periodic if not already set. SET_REFRESH_SPAN: Sets the future time-offset(in seconds) for the view refresh to stop. SET_REFRESH_EXECUTE_AS: Sets the user name to refresh this materialized view to the value specified in _value . REMOVE_TEXT_SEARCH_ATTRIBUTES: Removes text search attribute from all columns. REMOVE_SHARD_KEYS: Removes the shard key property from all columns, so that the table will be considered randomly sharded. The data is not moved. The _value is ignored. SET_STRATEGY_DEFINITION: Sets the tier strategy for the table and its columns to the one specified in _value , replacing the existing tier strategy in its entirety. CANCEL_DATASOURCE_SUBSCRIPTION: Permanently unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure. PAUSE_DATASOURCE_SUBSCRIPTION: Temporarily unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure. RESUME_DATASOURCE_SUBSCRIPTION: Resubscribe to a paused data source subscription. The data source can be Kafka / S3 / Azure. CHANGE_OWNER: Change the owner resource group of the table. 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 _value 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 _value 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 _value
_value	The value of the modification, depending on action . For example, if action is ADD_COLUMN, this would be the column name; while the column's definition would be covered by the COLUMN_TYPE, COLUMN_PROPERTIES, COLUMN_DEFAULT_VALUE, and ADD_COLUMN_EXPRESSION in options . If action is TTL, it would be the number of minutes for the new TTL. If action is REFRESH, this field would be blank.
options	Optional parameters. ACTION COLUMN_NAME TABLE_NAME COLUMN_DEFAULT_VALUE: When adding a column, set a default value for existing records. For nullable columns, the default value will be null, regardless of data type. COLUMN_PROPERTIES: When adding or changing a column, set the column properties (strings, separated by a comma: data, store_only, text_search, char8, int8 etc). COLUMN_TYPE: When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc). COMPRESSION_TYPE: No longer supported; option will be ignored. Supported values: NONE SNAPPY LZ4 LZ4HC The default value is SNAPPY. COPY_VALUES_FROM_COLUMN: [DEPRECATED–please use ADD_COLUMN_EXPRESSION instead.] RENAME_COLUMN: When changing a column, specify new column name. VALIDATE_CHANGE_COLUMN: When changing a column, validate the change before applying it (or not). Supported values: TRUE: Validate all values. A value too large (or too long) for the new type will prevent any change. FALSE: When a value is too large or long, it will be truncated. The default value is TRUE. UPDATE_LAST_ACCESS_TIME: Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table's TTL. Supported values: TRUE: Reset the expiration countdown timer to the table's configured TTL. FALSE: Don't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed. The default value is TRUE. ADD_COLUMN_EXPRESSION: When adding a column, an optional expression to use for the new column's values. Any valid expression may be used, including one containing references to existing columns in the same table. STRATEGY_DEFINITION: Optional parameter for specifying the tier strategy for the table and its columns when action is SET_STRATEGY_DEFINITION, replacing the existing tier strategy in its entirety. INDEX_TYPE: Type of index to create, when action is CREATE_INDEX; to refresh, when action is REFRESH_INDEX; or to delete, when action is DELETE_INDEX. Supported values: COLUMN: Create or delete a column (attribute) index. LOW_CARDINALITY: Create a low-cardinality column (attribute) index. CHUNK_SKIP: Create or delete a chunk skip index. GEOSPATIAL: Create or delete a geospatial index CAGRA: Create or delete a CAGRA index on a vector column HNSW: Create or delete an HNSW index on a vector column The default value is COLUMN. INDEX_OPTIONS: Options to use when creating an index, in the format "key: value [, key: value [, ...]]". Valid options vary by index type. The default value is an empty Dictionary.

Definition at line 1836 of file AlterTable.cs.

Property Documentation

◆ _value

string kinetica.AlterTableRequest._value

getset

The value of the modification, depending on action.

For example, if action is ADD_COLUMN, this would be the column name; while the column's definition would be covered by the COLUMN_TYPE, COLUMN_PROPERTIES, COLUMN_DEFAULT_VALUE, and ADD_COLUMN_EXPRESSION in options. If action is TTL, it would be the number of minutes for the new TTL. If action is REFRESH, this field would be blank.

Definition at line 987 of file AlterTable.cs.

◆ action

string kinetica.AlterTableRequest.action

getset

Modification operation to be applied.

Supported values:

ALLOW_HOMOGENEOUS_TABLES: No longer supported; action will be ignored.
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 _value. If this column already has the specified index, an error will be returned.
REFRESH_INDEX: Refreshes an index identified by INDEX_TYPE, on the column name specified in _value. Currently applicable only to CAGRA indices.
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 _value. If this column does not have the specified index, an error will be returned.
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 _value. If the schema provided is non-existent, it will be automatically created.
MOVE_TO_SCHEMA: Moves a table or view into a schema named _value. If the schema provided is nonexistent, an error will be thrown. If _value is empty, then the table or view will be placed in the user's default schema.
PROTECTED: No longer used. Previously set whether the given table_name should be protected or not. The _value would have been either 'true' or 'false'.
RENAME_TABLE: Renames a table or view to _value. Has the same naming restrictions as tables.
TTL: Sets the time-to-live in minutes of the table or view specified in table_name.
ADD_COMMENT: Adds the comment specified in _value to the table specified in table_name. Use COLUMN_NAME to set the comment for a column.
ADD_COLUMN: Adds the column specified in _value to the table specified in table_name. Use COLUMN_TYPE and COLUMN_PROPERTIES in options to set the column's type and properties, respectively.
CHANGE_COLUMN: Changes type and properties of the column specified in _value. Use COLUMN_TYPE and COLUMN_PROPERTIES in 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 options map.
SET_COLUMN_COMPRESSION: No longer supported; action will be ignored.
DELETE_COLUMN: Deletes the column specified in _value from the table specified in table_name.
CREATE_FOREIGN_KEY: Creates a foreign key specified in _value using the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
DELETE_FOREIGN_KEY: Deletes a foreign key. The _value should be the foreign_key_name specified when creating the key or the complete string used to define it.
ADD_PARTITION: Adds the partition specified in _value, to either a range-partitioned or manual list-partitioned table.
REMOVE_PARTITION: Removes the partition specified in _value (and relocates all of its data to the default partition) from either a range-partitioned or manual list-partitioned table.
DELETE_PARTITION: Deletes the partition specified in _value (and all of its data) from either a range-partitioned or manual list-partitioned table.
SET_GLOBAL_ACCESS_MODE: Sets the global access mode (i.e. locking) for the table specified in table_name. Specify the access mode in _value. Valid modes are 'no_access', 'read_only', 'write_only' and 'read_write'.
REFRESH: 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.
SET_REFRESH_METHOD: For a materialized view, sets the method by which the view is refreshed to the method specified in _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 _value - either 'manual' or 'on_start'.
SET_REFRESH_START_TIME: Sets the time to start periodic refreshes of this materialized view to the datetime string specified in _value with format 'YYYY-MM-DD HH:MM:SS'. Subsequent refreshes occur at the specified time + N * the refresh period.
SET_REFRESH_STOP_TIME: Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in _value with format 'YYYY-MM-DD HH:MM:SS'.
SET_REFRESH_PERIOD: Sets the time interval in seconds at which to refresh this materialized view to the value specified in _value. Also, sets the refresh method to periodic if not already set.
SET_REFRESH_SPAN: Sets the future time-offset(in seconds) for the view refresh to stop.
SET_REFRESH_EXECUTE_AS: Sets the user name to refresh this materialized view to the value specified in _value.
REMOVE_TEXT_SEARCH_ATTRIBUTES: Removes text search attribute from all columns.
REMOVE_SHARD_KEYS: Removes the shard key property from all columns, so that the table will be considered randomly sharded. The data is not moved. The _value is ignored.
SET_STRATEGY_DEFINITION: Sets the tier strategy for the table and its columns to the one specified in _value, replacing the existing tier strategy in its entirety.
CANCEL_DATASOURCE_SUBSCRIPTION: Permanently unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure.
PAUSE_DATASOURCE_SUBSCRIPTION: Temporarily unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure.
RESUME_DATASOURCE_SUBSCRIPTION: Resubscribe to a paused data source subscription. The data source can be Kafka / S3 / Azure.
CHANGE_OWNER: Change the owner resource group of the table.
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 _value
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 _value
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 _value

Definition at line 970 of file AlterTable.cs.

◆ options

IDictionary<string, string> kinetica.AlterTableRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

ACTION
COLUMN_NAME
TABLE_NAME
COLUMN_DEFAULT_VALUE: When adding a column, set a default value for existing records. For nullable columns, the default value will be null, regardless of data type.
COLUMN_PROPERTIES: When adding or changing a column, set the column properties (strings, separated by a comma: data, store_only, text_search, char8, int8 etc).
COLUMN_TYPE: When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).
COMPRESSION_TYPE: No longer supported; option will be ignored. Supported values:
- NONE
- SNAPPY
- LZ4
- LZ4HC
The default value is SNAPPY.
COPY_VALUES_FROM_COLUMN: [DEPRECATED–please use ADD_COLUMN_EXPRESSION instead.]
RENAME_COLUMN: When changing a column, specify new column name.
VALIDATE_CHANGE_COLUMN: When changing a column, validate the change before applying it (or not). Supported values:
- TRUE: Validate all values. A value too large (or too long) for the new type will prevent any change.
- FALSE: When a value is too large or long, it will be truncated.
The default value is TRUE.
UPDATE_LAST_ACCESS_TIME: Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table's TTL. Supported values:
- TRUE: Reset the expiration countdown timer to the table's configured TTL.
- FALSE: Don't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed.
The default value is TRUE.
ADD_COLUMN_EXPRESSION: When adding a column, an optional expression to use for the new column's values. Any valid expression may be used, including one containing references to existing columns in the same table.
STRATEGY_DEFINITION: Optional parameter for specifying the tier strategy for the table and its columns when action is SET_STRATEGY_DEFINITION, replacing the existing tier strategy in its entirety.
INDEX_TYPE: Type of index to create, when action is CREATE_INDEX; to refresh, when action is REFRESH_INDEX; or to delete, when action is DELETE_INDEX. Supported values:
- COLUMN: Create or delete a column (attribute) index.
- LOW_CARDINALITY: Create a low-cardinality column (attribute) index.
- CHUNK_SKIP: Create or delete a chunk skip index.
- GEOSPATIAL: Create or delete a geospatial index
- CAGRA: Create or delete a CAGRA index on a vector column
- HNSW: Create or delete an HNSW index on a vector column
The default value is COLUMN.
INDEX_OPTIONS: Options to use when creating an index, in the format "key: value [, key: value [, ...]]". Valid options vary by index type.

The default value is an empty Dictionary.

Definition at line 1204 of file AlterTable.cs.

◆ table_name

string kinetica.AlterTableRequest.table_name

getset

Table on which the operation will be performed, in [schema_name.

]table_name format, using standard name resolution rules.

Must be an existing table or view.

Definition at line 584 of file AlterTable.cs.

The documentation for this class was generated from the following file:

Kinetica/Protocol/AlterTable.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AlterTableRequest() [1/2]

◆ AlterTableRequest() [2/2]

Property Documentation

◆ _value

◆ action

◆ options

◆ table_name