- Generated on Sat Nov 23 2019 13:42:22 for Kinetica C# API by
1.8.13
|
Kinetica C# API
Version 6.2.0.1
|
Modification operation to be applied Supported values:
Public Attributes | |
| const string | ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables" |
| Sets whether homogeneous tables are allowed in the given collection. More... | |
| const string | CREATE_INDEX = "create_index" |
| Creates an index on the column name specified in _value. More... | |
| const string | DELETE_INDEX = "delete_index" |
| Deletes an existing index on the column name specified in _value. More... | |
| const string | MOVE_TO_COLLECTION = "move_to_collection" |
| Moves a table into a collection _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 | MEMORY_TTL = "memory_ttl" |
| Sets the time-to-live in minutes for the individual chunks of the columns of the table, view, or collection specified in table_name to free their memory if unused longer than the given time. 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. 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 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 | 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 - 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 datetime string 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. More... | |
| const string | REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes" |
| remove text_search attribute from all columns, if exists. More... | |
Modification operation to be applied Supported values:
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.
A set of string constants for the parameter action.
Definition at line 241 of file AlterTable.cs.
| 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 298 of file AlterTable.cs.
| const string kinetica.AlterTableRequest.Action.ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables" |
Sets whether homogeneous tables are allowed in the given collection.
This action is only valid if table_name is a collection. The _value must be either 'true' or 'false'.
Definition at line 248 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 309 of file AlterTable.cs.
| const string kinetica.AlterTableRequest.Action.CREATE_FOREIGN_KEY = "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]'.
Definition at line 327 of file AlterTable.cs.
| const string kinetica.AlterTableRequest.Action.CREATE_INDEX = "create_index" |
Creates an index on the column name specified in _value.
If this column is already indexed, an error will be returned.
Definition at line 255 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 319 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 334 of file AlterTable.cs.
| const string kinetica.AlterTableRequest.Action.DELETE_INDEX = "delete_index" |
Deletes an existing index on the column name specified in _value.
If this column does not have indexing turned on, an error will be returned.
Definition at line 262 of file AlterTable.cs.
| const string kinetica.AlterTableRequest.Action.MEMORY_TTL = "memory_ttl" |
Sets the time-to-live in minutes for the individual chunks of the columns of the table, view, or collection specified in table_name 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.
Definition at line 291 of file AlterTable.cs.
| const string kinetica.AlterTableRequest.Action.MOVE_TO_COLLECTION = "move_to_collection" |
Moves a table into a collection _value.
Definition at line 266 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 272 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 346 of file AlterTable.cs.
| const string kinetica.AlterTableRequest.Action.REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes" |
remove text_search attribute from all columns, if exists.
Definition at line 369 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 278 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.
Definition at line 314 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 341 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 - one of 'manual', 'periodic', 'on_change'.
Definition at line 352 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.
Also, sets the refresh method to periodic if not alreay set.
Definition at line 365 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 datetime string with format 'YYYY-MM-DD HH:MM:SS'.
Subsequent refreshes occur at the specified time + N * the refresh period.
Definition at line 359 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 283 of file AlterTable.cs.
1.8.13