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: Sets whether homogeneous tables are allowed in the given collection. 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: Sets whether homogeneous tables are allowed in the given collection. More...

string	_value `[get, set]`
	The value of the modification. 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:
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.
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.
Allow homogeneous tables within a collection.
Manage a table's columns–a column can be added, removed, or have its type and properties modified.
Set or unset compression for a column.

Definition at line 58 of file AlterTable.cs.

Constructor & Destructor Documentation

◆ AlterTableRequest() [1/2]

kinetica.AlterTableRequest.AlterTableRequest ( )

inline

Constructs an AlterTableRequest object with default parameters.

Definition at line 904 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. Must be an existing table, view, or collection.
action	Modification operation to be applied Supported values: ALLOW_HOMOGENEOUS_TABLES: Sets whether homogeneous tables are allowed in the given collection. This action is only valid if is a collection. The must be either 'true' or 'false'. CREATE_INDEX: Creates an index on the column name specified in . If this column is already indexed, an error will be returned. DELETE_INDEX: Deletes an existing index on the column name specified in . If this column does not have indexing turned on, an error will be returned. MOVE_TO_COLLECTION: Moves a table into a collection . 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 . MEMORY_TTL: Sets the time-to-live in minutes for the individual chunks of the columns of the table, view, or collection specified in to free their memory if unused longer than the given time. Specify an empty string to restore the global memory_ttl setting and a value of '-1' for an infinite timeout. 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 . DELETE_COLUMN: Deletes the column specified in from the table specified in . CREATE_FOREIGN_KEY: Creates a foreign key 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. 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 - one of 'manual', 'periodic', 'on_change'. SET_REFRESH_START_TIME: Sets the time to start periodic refreshes of this materialized view to datetime string 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. Also, sets the refresh method to periodic if not alreay set. REMOVE_TEXT_SEARCH_ATTRIBUTES: remove text_search attribute from all columns, if exists.
_value	The value of the modification. May be a column name, 'true' or 'false', a TTL, or the global access mode depending on .
options	Optional parameters. 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: please see 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 need to update the last_access_time. Supported values: TRUE FALSE The default value is TRUE. ADD_COLUMN_EXPRESSION: expression for new column's values (optional with add_column). Any valid expressions including existing columns. The default value is an empty Dictionary.

Definition at line 1210 of file AlterTable.cs.

Property Documentation

◆ _value

string kinetica.AlterTableRequest._value

getset

The value of the modification.

May be a column name, 'true' or 'false', a TTL, or the global access mode depending on .

Definition at line 781 of file AlterTable.cs.

◆ action

string kinetica.AlterTableRequest.action

getset

Modification operation to be applied Supported values:

ALLOW_HOMOGENEOUS_TABLES: Sets whether homogeneous tables are allowed in the given collection.

This action is only valid if is a collection. The must be either 'true' or 'false'. CREATE_INDEX: Creates an index on the column name specified in . If this column is already indexed, an error will be returned. DELETE_INDEX: Deletes an existing index on the column name specified in . If this column does not have indexing turned on, an error will be returned. MOVE_TO_COLLECTION: Moves a table into a collection . 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 . MEMORY_TTL: Sets the time-to-live in minutes for the individual chunks of the columns of the table, view, or collection specified in to free their memory if unused longer than the given time. Specify an empty string to restore the global memory_ttl setting and a value of '-1' for an infinite timeout. 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 . DELETE_COLUMN: Deletes the column specified in from the table specified in . CREATE_FOREIGN_KEY: Creates a foreign key 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. 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 - one of 'manual', 'periodic', 'on_change'. SET_REFRESH_START_TIME: Sets the time to start periodic refreshes of this materialized view to datetime string 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. Also, sets the refresh method to periodic if not alreay set. REMOVE_TEXT_SEARCH_ATTRIBUTES: remove text_search attribute from all columns, if exists.

Definition at line 776 of file AlterTable.cs.

◆ options

IDictionary<string, string> kinetica.AlterTableRequest.options

getset

Optional parameters.

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: please see 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 need to update the last_access_time. Supported values:
- TRUE
- FALSE
The default value is TRUE.
ADD_COLUMN_EXPRESSION: expression for new column's values (optional with add_column). Any valid expressions including existing columns.

The default value is an empty Dictionary.

Definition at line 899 of file AlterTable.cs.

◆ table_name

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