Kinetica C# API
Version 7.1.10.0
|
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" |
No longer supported; option will be ignored. 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–please use add_column_expression instead. 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 (or not). 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... | |
const string | GEOSPATIAL = "geospatial" |
Create or delete a geospatial index More... | |
Optional parameters.
The default value is an empty Dictionary. A set of string constants for the parameter options.
Definition at line 786 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Options.ACTION = "action" |
Definition at line 788 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 901 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Options.CHUNK_SKIP = "chunk_skip" |
Create or delete a chunk skip index.
Definition at line 949 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Options.COLUMN = "column" |
Create or delete a column (attribute) index.
Definition at line 944 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 795 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Options.COLUMN_NAME = "column_name" |
Definition at line 789 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 800 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 805 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Options.COMPRESSION_TYPE = "compression_type" |
const string kinetica.AlterTableRequest.Options.COPY_VALUES_FROM_COLUMN = "copy_values_from_column" |
[DEPRECATED–please use add_column_expression instead.
]
Definition at line 837 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 872 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Options.GEOSPATIAL = "geospatial" |
Create or delete a geospatial index
Definition at line 952 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:
The default value is COLUMN.
Definition at line 939 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Options.LZ4 = "lz4" |
Definition at line 832 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Options.LZ4HC = "lz4hc" |
Definition at line 833 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Options.NONE = "none" |
Definition at line 830 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Options.RENAME_COLUMN = "rename_column" |
When changing a column, specify new column name.
Definition at line 841 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Options.SNAPPY = "snappy" |
Definition at line 831 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.
Definition at line 908 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Options.TABLE_NAME = "table_name" |
Definition at line 790 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 867 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:
The default value is TRUE.
Definition at line 895 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 (or not).
Supported values:
The default value is TRUE.
Definition at line 863 of file AlterTable.cs.