Kinetica   C#   API  Version 7.2.3.1
AlterTable.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica;
10 
55 {
59  public struct Action
60  {
77  public const string CREATE_INDEX = "create_index";
78 
84  public const string REFRESH_INDEX = "refresh_index";
85 
102  public const string DELETE_INDEX = "delete_index";
103 
111  public const string MOVE_TO_COLLECTION = "move_to_collection";
112 
118  public const string MOVE_TO_SCHEMA = "move_to_schema";
119 
125  public const string PROTECTED = "protected";
126 
132  public const string RENAME_TABLE = "rename_table";
133 
137  public const string TTL = "ttl";
138 
144  public const string ADD_COMMENT = "add_comment";
145 
153  public const string ADD_COLUMN = "add_column";
154 
166  public const string CHANGE_COLUMN = "change_column";
167 
170  public const string DELETE_COLUMN = "delete_column";
171 
177  public const string CREATE_FOREIGN_KEY = "create_foreign_key";
178 
184  public const string DELETE_FOREIGN_KEY = "delete_foreign_key";
185 
191  public const string ADD_PARTITION = "add_partition";
192 
199  public const string REMOVE_PARTITION = "remove_partition";
200 
207  public const string DELETE_PARTITION = "delete_partition";
208 
214  public const string SET_GLOBAL_ACCESS_MODE = "set_global_access_mode";
215 
224  public const string REFRESH = "refresh";
225 
234  public const string SET_REFRESH_METHOD = "set_refresh_method";
235 
243  public const string SET_REFRESH_START_TIME = "set_refresh_start_time";
244 
250  public const string SET_REFRESH_STOP_TIME = "set_refresh_stop_time";
251 
258  public const string SET_REFRESH_PERIOD = "set_refresh_period";
259 
262  public const string SET_REFRESH_SPAN = "set_refresh_span";
263 
268  public const string SET_REFRESH_EXECUTE_AS = "set_refresh_execute_as";
269 
272  public const string REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes";
273 
278  public const string REMOVE_SHARD_KEYS = "remove_shard_keys";
279 
284  public const string SET_STRATEGY_DEFINITION = "set_strategy_definition";
285 
290  public const string CANCEL_DATASOURCE_SUBSCRIPTION = "cancel_datasource_subscription";
291 
294  public const string DROP_DATASOURCE_SUBSCRIPTION = "drop_datasource_subscription";
295 
300  public const string PAUSE_DATASOURCE_SUBSCRIPTION = "pause_datasource_subscription";
301 
306  public const string RESUME_DATASOURCE_SUBSCRIPTION = "resume_datasource_subscription";
307 
309  public const string CHANGE_OWNER = "change_owner";
310 
315  public const string SET_LOAD_VECTORS_POLICY = "set_load_vectors_policy";
316 
321  public const string SET_BUILD_PK_INDEX_POLICY = "set_build_pk_index_policy";
322 
327  public const string SET_BUILD_MATERIALIZED_VIEW_POLICY = "set_build_materialized_view_policy";
328  } // end struct Action
329 
333  public struct Options
334  {
335  public const string ACTION = "action";
336  public const string COLUMN_NAME = "column_name";
337  public const string TABLE_NAME = "table_name";
338 
343  public const string COLUMN_DEFAULT_VALUE = "column_default_value";
344 
348  public const string COLUMN_PROPERTIES = "column_properties";
349 
353  public const string COLUMN_TYPE = "column_type";
354 
358  public const string COPY_VALUES_FROM_COLUMN = "copy_values_from_column";
359 
361  public const string RENAME_COLUMN = "rename_column";
362 
381  public const string VALIDATE_CHANGE_COLUMN = "validate_change_column";
382 
385  public const string TRUE = "true";
386 
389  public const string FALSE = "false";
390 
410  public const string UPDATE_LAST_ACCESS_TIME = "update_last_access_time";
411 
417  public const string ADD_COLUMN_EXPRESSION = "add_column_expression";
418 
425  public const string STRATEGY_DEFINITION = "strategy_definition";
426 
483  public const string INDEX_TYPE = "index_type";
484 
488  public const string COLUMN = "column";
489 
494  public const string LOW_CARDINALITY = "low_cardinality";
495 
499  public const string CHUNK_SKIP = "chunk_skip";
500 
504  public const string GEOSPATIAL = "geospatial";
505 
510  public const string CAGRA = "cagra";
511 
516  public const string HNSW = "hnsw";
517 
521  public const string INDEX_OPTIONS = "index_options";
522  } // end struct Options
523 
529  public string table_name { get; set; }
530 
888  public string action { get; set; }
889 
904  public string _value { get; set; }
905 
1091  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1092 
1095  public AlterTableRequest() { }
1096 
1667  string action,
1668  string _value,
1669  IDictionary<string, string> options = null)
1670  {
1671  this.table_name = table_name ?? "";
1672  this.action = action ?? "";
1673  this._value = _value ?? "";
1674  this.options = options ?? new Dictionary<string, string>();
1675  } // end constructor
1676 } // end class AlterTableRequest
1677 
1682 {
1684  public string table_name { get; set; }
1685 
1687  public string action { get; set; }
1688 
1690  public string _value { get; set; }
1691 
1694  public string type_id { get; set; }
1695 
1698  public string type_definition { get; set; }
1699 
1702  public IDictionary<string, IList<string>> properties { get; set; } = new Dictionary<string, IList<string>>();
1703 
1706  public string label { get; set; }
1707 
1709  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1710 } // end class AlterTableResponse
const string CANCEL_DATASOURCE_SUBSCRIPTION
Permanently unsubscribe a data source that is loading continuously as a stream.
Definition: AlterTable.cs:290
const string CREATE_INDEX
Creates a column (attribute) index, low-cardinality index, chunk skip index, geospatial index,...
Definition: AlterTable.cs:77
const string INDEX_TYPE
Type of index to create, when action is CREATE_INDEX; to refresh, when action is REFRESH_INDEX; or to...
Definition: AlterTable.cs:483
const string ADD_COLUMN
Adds the column specified in _value to the table specified in table_name.
Definition: AlterTable.cs:153
const string FALSE
Don't reset the timer; expiration countdown will continue from where it is, as if the table had not b...
Definition: AlterTable.cs:389
const string GEOSPATIAL
Create or delete a geospatial index.
Definition: AlterTable.cs:504
const string RESUME_DATASOURCE_SUBSCRIPTION
Resubscribe to a paused data source subscription.
Definition: AlterTable.cs:306
const string COPY_VALUES_FROM_COLUMN
[DEPRECATED] Please use ADD_COLUMN_EXPRESSION instead.
Definition: AlterTable.cs:358
const string COLUMN_TYPE
When adding or changing a column, set the column type (strings, separated by a comma: int,...
Definition: AlterTable.cs:353
IDictionary< string, string > options
Optional parameters.
Definition: AlterTable.cs:1091
const string TTL
Sets the time-to-live in minutes of the table or view specified in table_name.
Definition: AlterTable.cs:137
const string REFRESH
For a materialized view, replays all the table creation commands required to create the view.
Definition: AlterTable.cs:224
IDictionary< string, IList< string > > properties
Return the type properties (when changing a table, a new type may be created).
Definition: AlterTable.cs:1702
const string PROTECTED
No longer used.
Definition: AlterTable.cs:125
const string SET_REFRESH_SPAN
Sets the future time-offset(in seconds) for the view refresh to stop.
Definition: AlterTable.cs:262
const string SET_REFRESH_EXECUTE_AS
Sets the user name to refresh this materialized view to the value specified in _value.
Definition: AlterTable.cs:268
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string DELETE_INDEX
Deletes a column (attribute) index, low-cardinality index, chunk skip index, geospatial index,...
Definition: AlterTable.cs:102
const string SET_LOAD_VECTORS_POLICY
Set startup data loading scheme for the table; see description of 'load_vectors_policy' in Kinetica....
Definition: AlterTable.cs:315
string action
Modification operation to be applied.
Definition: AlterTable.cs:888
const string ADD_PARTITION
Adds the partition specified in _value, to either a range-partitioned or manual list-partitioned tabl...
Definition: AlterTable.cs:191
const string DELETE_PARTITION
Deletes the partition specified in _value (and all of its data) from either a range-partitioned or ma...
Definition: AlterTable.cs:207
string table_name
Table on which the operation will be performed, in [schema_name.
Definition: AlterTable.cs:529
const string REMOVE_SHARD_KEYS
Removes the shard key property from all columns, so that the table will be considered randomly sharde...
Definition: AlterTable.cs:278
const string LOW_CARDINALITY
Create a low-cardinality column (attribute) index.
Definition: AlterTable.cs:494
AlterTableRequest()
Constructs an AlterTableRequest object with default parameters.
Definition: AlterTable.cs:1095
const string SET_GLOBAL_ACCESS_MODE
Sets the global access mode (i.e.
Definition: AlterTable.cs:214
const string DROP_DATASOURCE_SUBSCRIPTION
Permanently delete a cancelled data source subscription.
Definition: AlterTable.cs:294
string type_id
Return the type_id (when changing a table, a new type may be created).
Definition: AlterTable.cs:1694
const string MOVE_TO_COLLECTION
[DEPRECATED–please use MOVE_TO_SCHEMA and use Kinetica.createSchema to create the schema if non-exist...
Definition: AlterTable.cs:111
A set of string constants for the parameter action.
Definition: AlterTable.cs:59
const string TRUE
Reset the expiration countdown timer to the table's configured TTL.
Definition: AlterTable.cs:385
A set of results returned by Kinetica.alterTable.
Definition: AlterTable.cs:1681
const string DELETE_FOREIGN_KEY
Deletes a foreign key.
Definition: AlterTable.cs:184
A set of string constants for the parameter options.
Definition: AlterTable.cs:333
const string STRATEGY_DEFINITION
Parameter for specifying the tier strategy for the table and its columns when action is SET_STRATEGY_...
Definition: AlterTable.cs:425
const string CHANGE_OWNER
Change the owner resource group of the table.
Definition: AlterTable.cs:309
string label
Return the type label (when changing a table, a new type may be created).
Definition: AlterTable.cs:1706
A set of parameters for Kinetica.alterTable.
Definition: AlterTable.cs:54
const string SET_BUILD_MATERIALIZED_VIEW_POLICY
Set startup rebuilding scheme for the materialized view; see description of 'build_materialized_view_...
Definition: AlterTable.cs:327
const string RENAME_TABLE
Renames a table or view to _value.
Definition: AlterTable.cs:132
string _value
The value of the modification, depending on action.
Definition: AlterTable.cs:904
AlterTableRequest(string table_name, string action, string _value, IDictionary< string, string > options=null)
Constructs an AlterTableRequest object with the specified parameters.
Definition: AlterTable.cs:1666
const string REMOVE_TEXT_SEARCH_ATTRIBUTES
Removes text search attribute from all columns.
Definition: AlterTable.cs:272
const string INDEX_OPTIONS
Options to use when creating an index, in the format "key: value [, key: value [, ....
Definition: AlterTable.cs:521
const string CHANGE_COLUMN
Changes type and properties of the column specified in _value.
Definition: AlterTable.cs:166
const string HNSW
Create or delete an HNSW index on a vector column.
Definition: AlterTable.cs:516
const string UPDATE_LAST_ACCESS_TIME
Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table's TT...
Definition: AlterTable.cs:410
string table_name
Table on which the operation was performed.
Definition: AlterTable.cs:1684
const string PAUSE_DATASOURCE_SUBSCRIPTION
Temporarily unsubscribe a data source that is loading continuously as a stream.
Definition: AlterTable.cs:300
const string CHUNK_SKIP
Create or delete a chunk skip index.
Definition: AlterTable.cs:499
const string REFRESH_INDEX
Refreshes an index identified by INDEX_TYPE, on the column name specified in _value.
Definition: AlterTable.cs:84
const string CREATE_FOREIGN_KEY
Creates a foreign key specified in _value using the format '(source_column_name [,...
Definition: AlterTable.cs:177
const string RENAME_COLUMN
When changing a column, specify new column name.
Definition: AlterTable.cs:361
string type_definition
Return the type_definition (when changing a table, a new type may be created).
Definition: AlterTable.cs:1698
const string SET_REFRESH_STOP_TIME
Sets the time to stop periodic refreshes of this materialized view to the datetime string specified i...
Definition: AlterTable.cs:250
string _value
The value of the modification that was performed.
Definition: AlterTable.cs:1690
IDictionary< string, string > info
Additional information.
Definition: AlterTable.cs:1709
const string MOVE_TO_SCHEMA
Moves a table or view into a schema named _value.
Definition: AlterTable.cs:118
const string DELETE_COLUMN
Deletes the column specified in _value from the table specified in table_name.
Definition: AlterTable.cs:170
const string SET_REFRESH_PERIOD
Sets the time interval in seconds at which to refresh this materialized view to the value specified i...
Definition: AlterTable.cs:258
const string COLUMN_DEFAULT_VALUE
When adding a column, set a default value for existing records.
Definition: AlterTable.cs:343
const string COLUMN_NAME
Definition: AlterTable.cs:336
const string SET_REFRESH_METHOD
For a materialized view, sets the method by which the view is refreshed to the method specified in _v...
Definition: AlterTable.cs:234
const string COLUMN
Create or delete a column (attribute) index.
Definition: AlterTable.cs:488
const string COLUMN_PROPERTIES
When adding or changing a column, set the column properties (strings, separated by a comma: data,...
Definition: AlterTable.cs:348
string action
Modification operation that was performed.
Definition: AlterTable.cs:1687
const string SET_REFRESH_START_TIME
Sets the time to start periodic refreshes of this materialized view to the datetime string specified ...
Definition: AlterTable.cs:243
const string VALIDATE_CHANGE_COLUMN
When changing a column, validate the change before applying it (or not).
Definition: AlterTable.cs:381
const string ADD_COMMENT
Adds the comment specified in _value to the table specified in table_name.
Definition: AlterTable.cs:144
const string SET_STRATEGY_DEFINITION
Sets the tier strategy for the table and its columns to the one specified in _value,...
Definition: AlterTable.cs:284
const string CAGRA
Create or delete a CAGRA index on a vector column.
Definition: AlterTable.cs:510
const string ADD_COLUMN_EXPRESSION
When adding a column, an optional expression to use for the new column's values.
Definition: AlterTable.cs:417
const string REMOVE_PARTITION
Removes the partition specified in _value (and relocates all of its data to the default partition) fr...
Definition: AlterTable.cs:199
const string SET_BUILD_PK_INDEX_POLICY
Set startup primary key generation scheme for the table; see description of 'build_pk_index_policy' i...
Definition: AlterTable.cs:321