Optional parameters. More...

Public Attributes
const string	ACTION = "action"

const string	COLUMN_NAME = "column_name"

const string	TABLE_NAME = "table_name"

const string	COLUMN_DEFAULT_VALUE = "column_default_value"
	When adding a column, set a default value for existing records. More...

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

const string	COLUMN_TYPE = "column_type"
	When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc). More...

const string	COMPRESSION_TYPE = "compression_type"
	When setting column compression (set_column_compression for action), compression type to use: none (to use no compression) or a valid compression type. More...

const string	NONE = "none"

const string	SNAPPY = "snappy"

const string	LZ4 = "lz4"

const string	LZ4HC = "lz4hc"

const string	COPY_VALUES_FROM_COLUMN = "copy_values_from_column"
	Deprecated. More...

const string	RENAME_COLUMN = "rename_column"
	When changing a column, specify new column name. More...

const string	VALIDATE_CHANGE_COLUMN = "validate_change_column"
	When changing a column, validate the change before applying it. More...

const string	TRUE = "true"
	Reset the expiration countdown timer to the table's configured TTL. More...

const string	FALSE = "false"
	Don't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed. More...

const string	UPDATE_LAST_ACCESS_TIME = "update_last_access_time"
	Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table's TTL. More...

const string	ADD_COLUMN_EXPRESSION = "add_column_expression"
	When adding a column, an optional expression to use for the new column's values. More...

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

const string	INDEX_TYPE = "index_type"
	Type of index to create, when action is create_index, or to delete, when action is delete_index. More...

const string	COLUMN = "column"
	Create or delete a column (attribute) index. More...

const string	CHUNK_SKIP = "chunk_skip"
	Create or delete a chunk skip index. More...

Detailed Description

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. A set of string constants for the parameter options.

Definition at line 656 of file AlterTable.cs.

Member Data Documentation

const string kinetica.AlterTableRequest.Options.ACTION = "action"

Definition at line 658 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.ADD_COLUMN_EXPRESSION = "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.

Definition at line 775 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.CHUNK_SKIP = "chunk_skip"

Create or delete a chunk skip index.

Definition at line 821 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.COLUMN = "column"

Create or delete a column (attribute) index.

Definition at line 816 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.COLUMN_DEFAULT_VALUE = "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.

Definition at line 665 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.COLUMN_NAME = "column_name"

Definition at line 659 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.COLUMN_PROPERTIES = "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).

Definition at line 670 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.COLUMN_TYPE = "column_type"

When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).

Definition at line 675 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.COMPRESSION_TYPE = "compression_type"

When setting column compression (set_column_compression for action), compression type to use: none (to use no compression) or a valid compression type.

Supported values:

The default value is SNAPPY.

Definition at line 702 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.COPY_VALUES_FROM_COLUMN = "copy_values_from_column"

Deprecated.

Please use add_column_expression instead.

Definition at line 710 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.FALSE = "false"

Don't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed.

Definition at line 745 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.INDEX_TYPE = "index_type"

Type of index to create, when action is create_index, or to delete, when action 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.

Definition at line 811 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.LZ4 = "lz4"

Definition at line 705 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.LZ4HC = "lz4hc"

Definition at line 706 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.NONE = "none"

Definition at line 703 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.RENAME_COLUMN = "rename_column"

When changing a column, specify new column name.

Definition at line 714 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.SNAPPY = "snappy"

Definition at line 704 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.STRATEGY_DEFINITION = "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.

See tier strategy usage for format and tier strategy examples for examples. This option will be ignored if _value is also specified.

Definition at line 787 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.TABLE_NAME = "table_name"

Definition at line 660 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.TRUE = "true"

Reset the expiration countdown timer to the table's configured TTL.

Definition at line 740 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.UPDATE_LAST_ACCESS_TIME = "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.

Definition at line 769 of file AlterTable.cs.

const string kinetica.AlterTableRequest.Options.VALIDATE_CHANGE_COLUMN = "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.

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