Kinetica C# API
Version 7.2.3.0
|
A set of string constants for the parameter action. More...
Public Attributes | |
const string | CREATE_INDEX = "create_index" |
Creates a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified INDEX_TYPE), on the column name specified in _value. More... | |
const string | REFRESH_INDEX = "refresh_index" |
Refreshes an index identified by INDEX_TYPE, on the column name specified in _value. More... | |
const string | DELETE_INDEX = "delete_index" |
Deletes a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified INDEX_TYPE), on the column name specified in _value. More... | |
const string | MOVE_TO_COLLECTION = "move_to_collection" |
[DEPRECATED–please use MOVE_TO_SCHEMA and use Kinetica.createSchema to create the schema if non-existent] Moves a table or view into a schema named _value. More... | |
const string | MOVE_TO_SCHEMA = "move_to_schema" |
Moves a table or view into a schema named _value. More... | |
const string | PROTECTED = "protected" |
No longer used. More... | |
const string | RENAME_TABLE = "rename_table" |
Renames a table or view to _value. More... | |
const string | TTL = "ttl" |
Sets the time-to-live in minutes of the table or view specified in table_name. More... | |
const string | ADD_COMMENT = "add_comment" |
Adds the comment specified in _value to the table 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 | 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 specified in _value 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 | ADD_PARTITION = "add_partition" |
Adds the partition specified in _value, to either a range-partitioned or manual list-partitioned table. More... | |
const string | REMOVE_PARTITION = "remove_partition" |
Removes the partition specified in _value (and relocates all of its data to the default partition) from either a range-partitioned or manual list-partitioned table. More... | |
const string | DELETE_PARTITION = "delete_partition" |
Deletes the partition specified in _value (and all of its data) from either a range-partitioned or manual list-partitioned table. More... | |
const string | SET_GLOBAL_ACCESS_MODE = "set_global_access_mode" |
Sets the global access mode (i.e. More... | |
const string | REFRESH = "refresh" |
For a materialized view, replays all the table creation commands required to create the view. More... | |
const string | SET_REFRESH_METHOD = "set_refresh_method" |
For a materialized view, sets the method by which the view is refreshed to the method specified in _value - one of 'manual', 'periodic', or '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 the datetime string specified in _value with format 'YYYY-MM-DD HH:MM:SS'. More... | |
const string | SET_REFRESH_STOP_TIME = "set_refresh_stop_time" |
Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in _value 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 to the value specified in _value. More... | |
const string | SET_REFRESH_SPAN = "set_refresh_span" |
Sets the future time-offset(in seconds) for the view refresh to stop. More... | |
const string | SET_REFRESH_EXECUTE_AS = "set_refresh_execute_as" |
Sets the user name to refresh this materialized view to the value specified in _value. More... | |
const string | REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes" |
Removes text search attribute from all columns. More... | |
const string | REMOVE_SHARD_KEYS = "remove_shard_keys" |
Removes the shard key property from all columns, so that the table will be considered randomly sharded. More... | |
const string | SET_STRATEGY_DEFINITION = "set_strategy_definition" |
Sets the tier strategy for the table and its columns to the one specified in _value, replacing the existing tier strategy in its entirety. More... | |
const string | CANCEL_DATASOURCE_SUBSCRIPTION = "cancel_datasource_subscription" |
Permanently unsubscribe a data source that is loading continuously as a stream. More... | |
const string | PAUSE_DATASOURCE_SUBSCRIPTION = "pause_datasource_subscription" |
Temporarily unsubscribe a data source that is loading continuously as a stream. More... | |
const string | RESUME_DATASOURCE_SUBSCRIPTION = "resume_datasource_subscription" |
Resubscribe to a paused data source subscription. More... | |
const string | CHANGE_OWNER = "change_owner" |
Change the owner resource group of the table. More... | |
const string | SET_LOAD_VECTORS_POLICY = "set_load_vectors_policy" |
Set startup data loading scheme for the table; see description of 'load_vectors_policy' in Kinetica.createTable for possible values for _value More... | |
const string | SET_BUILD_PK_INDEX_POLICY = "set_build_pk_index_policy" |
Set startup primary key generation scheme for the table; see description of 'build_pk_index_policy' in Kinetica.createTable for possible values for _value More... | |
const string | SET_BUILD_MATERIALIZED_VIEW_POLICY = "set_build_materialized_view_policy" |
Set startup rebuilding scheme for the materialized view; see description of 'build_materialized_view_policy' in Kinetica.createMaterializedView for possible values for _value More... | |
A set of string constants for the parameter action.
Modification operation to be applied
Definition at line 65 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 162 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.ADD_COMMENT = "add_comment" |
Adds the comment specified in _value to the table specified in table_name.
Use COLUMN_NAME to set the comment for a column.
Definition at line 153 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.ADD_PARTITION = "add_partition" |
Adds the partition specified in _value, to either a range-partitioned or manual list-partitioned table.
Definition at line 205 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.CANCEL_DATASOURCE_SUBSCRIPTION = "cancel_datasource_subscription" |
Permanently unsubscribe a data source that is loading continuously as a stream.
The data source can be Kafka / S3 / Azure.
Definition at line 311 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 176 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.CHANGE_OWNER = "change_owner" |
Change the owner resource group of the table.
Definition at line 327 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.CREATE_FOREIGN_KEY = "create_foreign_key" |
Creates a foreign key specified in _value using the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
Definition at line 189 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.CREATE_INDEX = "create_index" |
Creates a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified INDEX_TYPE), on the column name specified in _value.
If this column already has the specified index, an error will be returned.
Definition at line 84 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 181 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 197 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.DELETE_INDEX = "delete_index" |
Deletes a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified INDEX_TYPE), on the column name specified in _value.
If this column does not have the specified index, an error will be returned.
Definition at line 110 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.DELETE_PARTITION = "delete_partition" |
Deletes the partition specified in _value (and all of its data) from either a range-partitioned or manual list-partitioned table.
Definition at line 222 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.MOVE_TO_COLLECTION = "move_to_collection" |
[DEPRECATED–please use MOVE_TO_SCHEMA and use Kinetica.createSchema to create the schema if non-existent] Moves a table or view into a schema named _value.
If the schema provided is non-existent, it will be automatically created.
Definition at line 119 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.MOVE_TO_SCHEMA = "move_to_schema" |
Moves a table or view into a schema named _value.
If the schema provided is nonexistent, an error will be thrown. If _value is empty, then the table or view will be placed in the user's default schema.
Definition at line 127 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.PAUSE_DATASOURCE_SUBSCRIPTION = "pause_datasource_subscription" |
Temporarily unsubscribe a data source that is loading continuously as a stream.
The data source can be Kafka / S3 / Azure.
Definition at line 317 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.PROTECTED = "protected" |
No longer used.
Previously set whether the given table_name should be protected or not. The _value would have been either 'true' or 'false'.
Definition at line 134 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.REFRESH = "refresh" |
For a materialized view, replays all the table creation commands required to create the view.
For an external table, reloads all data in the table from its associated source files or data source.
Definition at line 240 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.REFRESH_INDEX = "refresh_index" |
Refreshes an index identified by INDEX_TYPE, on the column name specified in _value.
Currently applicable only to CAGRA indices.
Definition at line 91 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.REMOVE_PARTITION = "remove_partition" |
Removes the partition specified in _value (and relocates all of its data to the default partition) from either a range-partitioned or manual list-partitioned table.
Definition at line 214 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.REMOVE_SHARD_KEYS = "remove_shard_keys" |
Removes the shard key property from all columns, so that the table will be considered randomly sharded.
The data is not moved. The _value is ignored.
Definition at line 298 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes" |
Removes text search attribute from all columns.
Definition at line 292 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.RENAME_TABLE = "rename_table" |
Renames a table or view to _value.
Has the same naming restrictions as tables.
Definition at line 141 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.RESUME_DATASOURCE_SUBSCRIPTION = "resume_datasource_subscription" |
Resubscribe to a paused data source subscription.
The data source can be Kafka / S3 / Azure.
Definition at line 323 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.SET_BUILD_MATERIALIZED_VIEW_POLICY = "set_build_materialized_view_policy" |
Set startup rebuilding scheme for the materialized view; see description of 'build_materialized_view_policy' in Kinetica.createMaterializedView for possible values for _value
Definition at line 346 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.SET_BUILD_PK_INDEX_POLICY = "set_build_pk_index_policy" |
Set startup primary key generation scheme for the table; see description of 'build_pk_index_policy' in Kinetica.createTable for possible values for _value
Definition at line 339 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 229 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.SET_LOAD_VECTORS_POLICY = "set_load_vectors_policy" |
Set startup data loading scheme for the table; see description of 'load_vectors_policy' in Kinetica.createTable for possible values for _value
Definition at line 333 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.SET_REFRESH_EXECUTE_AS = "set_refresh_execute_as" |
Sets the user name to refresh this materialized view to the value specified in _value.
Definition at line 287 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.SET_REFRESH_METHOD = "set_refresh_method" |
For a materialized view, sets the method by which the view is refreshed to the method specified in _value - one of 'manual', 'periodic', or 'on_change'.
For an external table, sets the method by which the table is refreshed to the method specified in _value - either 'manual' or 'on_start'.
Definition at line 253 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 to the value specified in _value.
Also, sets the refresh method to periodic if not already set.
Definition at line 277 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.SET_REFRESH_SPAN = "set_refresh_span" |
Sets the future time-offset(in seconds) for the view refresh to stop.
Definition at line 281 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 the datetime string specified in _value with format 'YYYY-MM-DD HH:MM:SS'.
Subsequent refreshes occur at the specified time + N * the refresh period.
Definition at line 262 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.SET_REFRESH_STOP_TIME = "set_refresh_stop_time" |
Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in _value with format 'YYYY-MM-DD HH:MM:SS'.
Definition at line 269 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.SET_STRATEGY_DEFINITION = "set_strategy_definition" |
Sets the tier strategy for the table and its columns to the one specified in _value, replacing the existing tier strategy in its entirety.
Definition at line 305 of file AlterTable.cs.
const string kinetica.AlterTableRequest.Action.TTL = "ttl" |
Sets the time-to-live in minutes of the table or view specified in table_name.
Definition at line 146 of file AlterTable.cs.