A set of parameters for Kinetica.alterTable(string,string,string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.AlterTableRequest:

Collaboration diagram for kinetica.AlterTableRequest:

Classes
struct	Action
	Modification operation to be applied Supported values: ALLOW_HOMOGENEOUS_TABLES: No longer supported; action will be ignored. More...

struct	Options
	Optional parameters. 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. More...

string	action `[get, set]`
	Modification operation to be applied Supported values: ALLOW_HOMOGENEOUS_TABLES: No longer supported; action will be ignored. More...

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

IDictionary< string, string >	options `[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(string,string,string,IDictionary{string, string}).

Apply various modifications to a table, view, or collection. 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 compressed or not.
Create or delete an index on a particular column. 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.
Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.
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.
Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.

Definition at line 73 of file AlterTable.cs.

Constructor & Destructor Documentation

kinetica.AlterTableRequest.AlterTableRequest ( )

inline

Constructs an AlterTableRequest object with default parameters.

Definition at line 1254 of file AlterTable.cs.

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. Must be an existing table, view, or collection.
action	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.
_value	The value of the modification, depending on . For example, if 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 . If is ttl, it would be the number of minutes for the new TTL. If 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: When setting column compression (set_column_compression for ), compression type to use: none (to use no compression) or a valid compression type. 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. If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. Supported values: TRUE: true FALSE: false 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 is set_strategy_definition, replacing the existing tier strategy in its entirety. See tier strategy usage for format and tier strategy examples for examples. This option will be ignored if is also specified. INDEX_TYPE: Type of index to create, when is create_index, or to delete, when is delete_index. Supported values: COLUMN: Create or delete a column (attribute) index. CHUNK_SKIP: Create or delete a chunk skip index. The default value is COLUMN. The default value is an empty Dictionary.

Definition at line 1679 of file AlterTable.cs.

Property Documentation

string kinetica.AlterTableRequest._value

getset

The value of the modification, depending on .

For example, if 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 . If is ttl, it would be the number of minutes for the new TTL. If is refresh, this field would be blank.

Definition at line 1066 of file AlterTable.cs.

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

Definition at line 1053 of file AlterTable.cs.

IDictionary<string, string> kinetica.AlterTableRequest.options

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: When setting column compression (set_column_compression for ), compression type to use: none (to use no compression) or a valid compression type. 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. If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. Supported values:
- TRUE: true
- FALSE: false
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 is set_strategy_definition, replacing the existing tier strategy in its entirety. See tier strategy usage for format and tier strategy examples for examples. This option will be ignored if is also specified.
INDEX_TYPE: Type of index to create, when is create_index, or to delete, when is delete_index. Supported values:
- COLUMN: Create or delete a column (attribute) index.
- CHUNK_SKIP: Create or delete a chunk skip index.
The default value is COLUMN.

The default value is an empty Dictionary.

Definition at line 1249 of file AlterTable.cs.

string kinetica.AlterTableRequest.table_name

getset

Table on which the operation will be performed.

Must be an existing table, view, or collection.

Definition at line 827 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

Property Documentation