Modification operation to be applied Supported values:

ALLOW_HOMOGENEOUS_TABLES: No longer supported; action will be ignored.

Public Attributes
const string	ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables"
	No longer supported; action will be ignored. More...

const string	CREATE_INDEX = "create_index"
	Creates either a column (attribute) index or chunk skip index, depending on the specified index_type, on the column name specified in _value. More...

const string	DELETE_INDEX = "delete_index"
	Deletes either a column (attribute) index or chunk skip index, depending on the specified index_type, on the column name specified in _value. More...

const string	MOVE_TO_COLLECTION = "move_to_collection"
	Moves a table or view into a collection named _value. More...

const string	PROTECTED = "protected"
	Sets whether the given table_name should be protected or not. More...

const string	RENAME_TABLE = "rename_table"
	Renames a table, view or collection to _value. More...

const string	TTL = "ttl"
	Sets the time-to-live in minutes of the table, view, or collection specified in table_name. More...

const string	ADD_COLUMN = "add_column"
	Adds the column specified in _value to the table specified in table_name. More...

const string	CHANGE_COLUMN = "change_column"
	Changes type and properties of the column specified in _value. More...

const string	SET_COLUMN_COMPRESSION = "set_column_compression"
	Modifies the compression setting on the column specified in _value to the compression type specified in compression_type. More...

const string	DELETE_COLUMN = "delete_column"
	Deletes the column specified in _value from the table specified in table_name. More...

const string	CREATE_FOREIGN_KEY = "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]'. More...

const string	DELETE_FOREIGN_KEY = "delete_foreign_key"
	Deletes a foreign key. More...

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

const string	REMOVE_PARTITION = "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. More...

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

const string	SET_GLOBAL_ACCESS_MODE = "set_global_access_mode"
	Sets the global access mode (i.e. More...

const string	REFRESH = "refresh"
	Replays all the table creation commands required to create this materialized view. More...

const string	SET_REFRESH_METHOD = "set_refresh_method"
	Sets the method by which this materialized view is refreshed to the method specified in _value - one of 'manual', 'periodic', 'on_change'. More...

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 _value with format 'YYYY-MM-DD HH:MM:SS'. More...

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 _value. More...

const string	REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes"
	Removes text search attribute from all columns. More...

const string	SET_STRATEGY_DEFINITION = "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. More...

Detailed Description

Modification operation to be applied Supported values:

ALLOW_HOMOGENEOUS_TABLES: No longer supported; action will be ignored.

CREATE_INDEX: Creates either a column (attribute) index or chunk skip index, depending on the specified index_type, on the column name specified in . If this column already has the specified index, an error will be returned. DELETE_INDEX: Deletes either a column (attribute) index or chunk skip index, depending on the specified index_type, on the column name specified in . If this column does not have the specified index, an error will be returned. MOVE_TO_COLLECTION: Moves a table or view into a collection named . If the collection provided is non-existent, the collection will be automatically created. If is empty, then the table or view will be top-level. PROTECTED: Sets whether the given should be protected or not. The must be either 'true' or 'false'. RENAME_TABLE: Renames a table, view or collection to . Has the same naming restrictions as tables. TTL: Sets the time-to-live in minutes of the table, view, or collection specified in . ADD_COLUMN: Adds the column specified in to the table specified in . Use column_type and column_properties in to set the column's type and properties, respectively. CHANGE_COLUMN: Changes type and properties of the column specified in . Use column_type and column_properties in 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 map. SET_COLUMN_COMPRESSION: Modifies the compression setting on the column specified in to the compression type specified in compression_type. DELETE_COLUMN: Deletes the column specified in from the table specified in . CREATE_FOREIGN_KEY: Creates a foreign key specified in 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 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 , to either a range-partitioned or manual list-partitioned table. REMOVE_PARTITION: Removes the partition specified in (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 (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 . Specify the access mode in . Valid modes are 'no_access', 'read_only', 'write_only' and 'read_write'. REFRESH: Replays all the table creation commands required to create this materialized view. SET_REFRESH_METHOD: Sets the method by which this materialized view is refreshed to the method specified in - one of 'manual', 'periodic', 'on_change'. SET_REFRESH_START_TIME: Sets the time to start periodic refreshes of this materialized view to the datetime string specified in with format 'YYYY-MM-DD HH:MM:SS'. Subsequent refreshes occur at the specified time + N * the refresh period. SET_REFRESH_PERIOD: Sets the time interval in seconds at which to refresh this materialized view to the value specified in . Also, sets the refresh method to periodic if not already set. REMOVE_TEXT_SEARCH_ATTRIBUTES: Removes text search attribute from all columns. SET_STRATEGY_DEFINITION: Sets the tier strategy for the table and its columns to the one specified in , replacing the existing tier strategy in its entirety. See tier strategy usage for format and tier strategy examples for examples.

A set of string constants for the parameter action.

Definition at line 302 of file AlterTable.cs.

Member Data Documentation

const string kinetica.AlterTableRequest.Action.ADD_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.

Definition at line 357 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.ADD_PARTITION = "add_partition"

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

Definition at line 402 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables"

No longer supported; action will be ignored.

Definition at line 306 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.CHANGE_COLUMN = "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.

Definition at line 368 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.CREATE_FOREIGN_KEY = "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]'.

Definition at line 387 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.CREATE_INDEX = "create_index"

Creates either a column (attribute) index or chunk skip 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.

Definition at line 316 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.DELETE_COLUMN = "delete_column"

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

Definition at line 379 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.DELETE_FOREIGN_KEY = "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.

Definition at line 394 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.DELETE_INDEX = "delete_index"

Deletes either a column (attribute) index or chunk skip 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.

Definition at line 326 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.DELETE_PARTITION = "delete_partition"

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

Definition at line 419 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.MOVE_TO_COLLECTION = "move_to_collection"

Moves a table or view into a collection named _value.

If the collection provided is non-existent, the collection will be automatically created. If _value is empty, then the table or view will be top-level.

Definition at line 333 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.PROTECTED = "protected"

Sets whether the given table_name should be protected or not.

The _value must be either 'true' or 'false'.

Definition at line 339 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.REFRESH = "refresh"

Replays all the table creation commands required to create this materialized view.

Definition at line 431 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.REMOVE_PARTITION = "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.

Definition at line 411 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes"

Removes text search attribute from all columns.

Definition at line 458 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.RENAME_TABLE = "rename_table"

Renames a table, view or collection to _value.

Has the same naming restrictions as tables.

Definition at line 345 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_COLUMN_COMPRESSION = "set_column_compression"

Modifies the compression setting on the column specified in _value to the compression type specified in compression_type.

Definition at line 374 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_GLOBAL_ACCESS_MODE = "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'.

Definition at line 426 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_REFRESH_METHOD = "set_refresh_method"

Sets the method by which this materialized view is refreshed to the method specified in _value - one of 'manual', 'periodic', 'on_change'.

Definition at line 438 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_REFRESH_PERIOD = "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.

Definition at line 453 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.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 _value with format 'YYYY-MM-DD HH:MM:SS'.

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

Definition at line 446 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.SET_STRATEGY_DEFINITION = "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.

See tier strategy usage for format and tier strategy examples for examples.

Definition at line 469 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Action.TTL = "ttl"

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

Definition at line 350 of file AlterTable.cs.

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

Kinetica/Protocol/AlterTable.cs

Public Attributes

Detailed Description

Member Data Documentation