Kinetica C# API
Version 6.1.0.0
|
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 TTL of the table, view, or collection specified in table_name. 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 references target_table(primary_key_column) [ 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... | |
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 TTL 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. 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 references target_table(primary_key_column) [ 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'.
A set of string constants for the parameter action.
Definition at line 186 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 235 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 193 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.
Definition at line 241 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.CREATE_FOREIGN_KEY = "create_foreign_key" |
Creates a foreign key using the format 'source_column references target_table(primary_key_column) [ as <foreign_key_name> ]'.
Definition at line 259 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 200 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 252 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 266 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 207 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 211 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 217 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 223 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 247 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 273 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.TTL = "ttl" |
Sets the TTL of the table, view, or collection specified in table_name.
Definition at line 228 of file AlterTable.cs.