Kinetica   C#   API  Version 7.2.3.0
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 {
60  {
65  public struct Action
66  {
68  public const string ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables";
69 
87  public const string CREATE_INDEX = "create_index";
88 
94  public const string REFRESH_INDEX = "refresh_index";
95 
113  public const string DELETE_INDEX = "delete_index";
114 
122  public const string MOVE_TO_COLLECTION = "move_to_collection";
123 
130  public const string MOVE_TO_SCHEMA = "move_to_schema";
131 
137  public const string PROTECTED = "protected";
138 
144  public const string RENAME_TABLE = "rename_table";
145 
149  public const string TTL = "ttl";
150 
156  public const string ADD_COMMENT = "add_comment";
157 
165  public const string ADD_COLUMN = "add_column";
166 
179  public const string CHANGE_COLUMN = "change_column";
180 
182  public const string SET_COLUMN_COMPRESSION = "set_column_compression";
183 
187  public const string DELETE_COLUMN = "delete_column";
188 
195  public const string CREATE_FOREIGN_KEY = "create_foreign_key";
196 
203  public const string DELETE_FOREIGN_KEY = "delete_foreign_key";
204 
211  public const string ADD_PARTITION = "add_partition";
212 
220  public const string REMOVE_PARTITION = "remove_partition";
221 
228  public const string DELETE_PARTITION = "delete_partition";
229 
235  public const string SET_GLOBAL_ACCESS_MODE = "set_global_access_mode";
236 
246  public const string REFRESH = "refresh";
247 
259  public const string SET_REFRESH_METHOD = "set_refresh_method";
260 
268  public const string SET_REFRESH_START_TIME = "set_refresh_start_time";
269 
275  public const string SET_REFRESH_STOP_TIME = "set_refresh_stop_time";
276 
283  public const string SET_REFRESH_PERIOD = "set_refresh_period";
284 
287  public const string SET_REFRESH_SPAN = "set_refresh_span";
288 
293  public const string SET_REFRESH_EXECUTE_AS = "set_refresh_execute_as";
294 
298  public const string REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes";
299 
304  public const string REMOVE_SHARD_KEYS = "remove_shard_keys";
305 
311  public const string SET_STRATEGY_DEFINITION = "set_strategy_definition";
312 
317  public const string CANCEL_DATASOURCE_SUBSCRIPTION = "cancel_datasource_subscription";
318 
323  public const string PAUSE_DATASOURCE_SUBSCRIPTION = "pause_datasource_subscription";
324 
329  public const string RESUME_DATASOURCE_SUBSCRIPTION = "resume_datasource_subscription";
330 
333  public const string CHANGE_OWNER = "change_owner";
334 
339  public const string SET_LOAD_VECTORS_POLICY = "set_load_vectors_policy";
340 
345  public const string SET_BUILD_PK_INDEX_POLICY = "set_build_pk_index_policy";
346 
352  public const string SET_BUILD_MATERIALIZED_VIEW_POLICY = "set_build_materialized_view_policy";
353  } // end struct Action
354 
358  public struct Options
359  {
360  public const string ACTION = "action";
361  public const string COLUMN_NAME = "column_name";
362  public const string TABLE_NAME = "table_name";
363 
368  public const string COLUMN_DEFAULT_VALUE = "column_default_value";
369 
373  public const string COLUMN_PROPERTIES = "column_properties";
374 
378  public const string COLUMN_TYPE = "column_type";
379 
398  public const string COMPRESSION_TYPE = "compression_type";
399 
400  public const string NONE = "none";
401  public const string SNAPPY = "snappy";
402  public const string LZ4 = "lz4";
403  public const string LZ4HC = "lz4hc";
404 
408  public const string COPY_VALUES_FROM_COLUMN = "copy_values_from_column";
409 
412  public const string RENAME_COLUMN = "rename_column";
413 
432  public const string VALIDATE_CHANGE_COLUMN = "validate_change_column";
433 
436  public const string TRUE = "true";
437 
441  public const string FALSE = "false";
442 
462  public const string UPDATE_LAST_ACCESS_TIME = "update_last_access_time";
463 
469  public const string ADD_COLUMN_EXPRESSION = "add_column_expression";
470 
477  public const string STRATEGY_DEFINITION = "strategy_definition";
478 
536  public const string INDEX_TYPE = "index_type";
537 
541  public const string COLUMN = "column";
542 
547  public const string LOW_CARDINALITY = "low_cardinality";
548 
552  public const string CHUNK_SKIP = "chunk_skip";
553 
557  public const string GEOSPATIAL = "geospatial";
558 
564  public const string CAGRA = "cagra";
565 
570  public const string HNSW = "hnsw";
571 
576  public const string INDEX_OPTIONS = "index_options";
577  } // end struct Options
578 
584  public string table_name { get; set; }
585 
970  public string action { get; set; }
971 
987  public string _value { get; set; }
988 
1204  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1205 
1208  public AlterTableRequest() { }
1209 
1837  string action,
1838  string _value,
1839  IDictionary<string, string> options = null)
1840  {
1841  this.table_name = table_name ?? "";
1842  this.action = action ?? "";
1843  this._value = _value ?? "";
1844  this.options = options ?? new Dictionary<string, string>();
1845  } // end constructor
1846  } // end class AlterTableRequest
1847 
1852  {
1854  public string table_name { get; set; }
1855 
1857  public string action { get; set; }
1858 
1861  public string _value { get; set; }
1862 
1865  public string type_id { get; set; }
1866 
1869  public string type_definition { get; set; }
1870 
1873  public IDictionary<string, IList<string>> properties { get; set; } = new Dictionary<string, IList<string>>();
1874 
1877  public string label { get; set; }
1878 
1880  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1881  } // end class AlterTableResponse
1882 } // end namespace kinetica
AlterTableRequest(string table_name, string action, string _value, IDictionary< string, string > options=null)
Constructs an AlterTableRequest object with the specified parameters.
Definition: AlterTable.cs:1836
const string SET_STRATEGY_DEFINITION
Sets the tier strategy for the table and its columns to the one specified in _value,...
Definition: AlterTable.cs:311
const string REFRESH
For a materialized view, replays all the table creation commands required to create the view.
Definition: AlterTable.cs:246
const string INDEX_OPTIONS
Options to use when creating an index, in the format "key: value [, key: value [, ....
Definition: AlterTable.cs:576
const string SET_REFRESH_SPAN
Sets the future time-offset(in seconds) for the view refresh to stop.
Definition: AlterTable.cs:287
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:345
const string GEOSPATIAL
Create or delete a geospatial index
Definition: AlterTable.cs:557
string action
Modification operation that was performed.
Definition: AlterTable.cs:1857
const string CANCEL_DATASOURCE_SUBSCRIPTION
Permanently unsubscribe a data source that is loading continuously as a stream.
Definition: AlterTable.cs:317
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:275
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:304
string type_id
return the type_id (when changing a table, a new type may be created)
Definition: AlterTable.cs:1865
const string TTL
Sets the time-to-live in minutes of the table or view specified in table_name.
Definition: AlterTable.cs:149
const string COPY_VALUES_FROM_COLUMN
[DEPRECATED–please use ADD_COLUMN_EXPRESSION instead.
Definition: AlterTable.cs:408
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:268
A set of parameters for Kinetica.alterTable.
Definition: AlterTable.cs:59
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:441
const string ADD_COLUMN
Adds the column specified in _value to the table specified in table_name.
Definition: AlterTable.cs:165
const string CHANGE_OWNER
Change the owner resource group of the table.
Definition: AlterTable.cs:333
string table_name
Table on which the operation was performed.
Definition: AlterTable.cs:1854
const string VALIDATE_CHANGE_COLUMN
When changing a column, validate the change before applying it (or not).
Definition: AlterTable.cs:432
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:122
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:259
const string CAGRA
Create or delete a CAGRA index on a vector column
Definition: AlterTable.cs:564
const string SET_REFRESH_EXECUTE_AS
Sets the user name to refresh this materialized view to the value specified in _value.
Definition: AlterTable.cs:293
string action
Modification operation to be applied.
Definition: AlterTable.cs:970
string _value
The value of the modification that was performed.
Definition: AlterTable.cs:1861
const string CREATE_INDEX
Creates a column (attribute) index, low-cardinality index, chunk skip index, geospatial index,...
Definition: AlterTable.cs:87
const string COLUMN_TYPE
When adding or changing a column, set the column type (strings, separated by a comma: int,...
Definition: AlterTable.cs:378
const string TRUE
Reset the expiration countdown timer to the table's configured TTL.
Definition: AlterTable.cs:436
const string COLUMN
Create or delete a column (attribute) index.
Definition: AlterTable.cs:541
AlterTableRequest()
Constructs an AlterTableRequest object with default parameters.
Definition: AlterTable.cs:1208
A set of string constants for the parameter options.
Definition: AlterTable.cs:358
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:536
const string HNSW
Create or delete an HNSW index on a vector column
Definition: AlterTable.cs:570
const string COLUMN_PROPERTIES
When adding or changing a column, set the column properties (strings, separated by a comma: data,...
Definition: AlterTable.cs:373
const string SET_COLUMN_COMPRESSION
No longer supported; action will be ignored.
Definition: AlterTable.cs:182
string type_definition
return the type_definition (when changing a table, a new type may be created)
Definition: AlterTable.cs:1869
const string ADD_COLUMN_EXPRESSION
When adding a column, an optional expression to use for the new column's values.
Definition: AlterTable.cs:469
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:228
const string ALLOW_HOMOGENEOUS_TABLES
No longer supported; action will be ignored.
Definition: AlterTable.cs:68
const string COLUMN_DEFAULT_VALUE
When adding a column, set a default value for existing records.
Definition: AlterTable.cs:368
const string DELETE_COLUMN
Deletes the column specified in _value from the table specified in table_name.
Definition: AlterTable.cs:187
string _value
The value of the modification, depending on action.
Definition: AlterTable.cs:987
const string CHANGE_COLUMN
Changes type and properties of the column specified in _value.
Definition: AlterTable.cs:179
const string REFRESH_INDEX
Refreshes an index identified by INDEX_TYPE, on the column name specified in _value.
Definition: AlterTable.cs:94
const string ADD_COMMENT
Adds the comment specified in _value to the table specified in table_name.
Definition: AlterTable.cs:156
const string MOVE_TO_SCHEMA
Moves a table or view into a schema named _value.
Definition: AlterTable.cs:130
const string REMOVE_PARTITION
Removes the partition specified in _value (and relocates all of its data to the default partition) fr...
Definition: AlterTable.cs:220
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:462
const string RESUME_DATASOURCE_SUBSCRIPTION
Resubscribe to a paused data source subscription.
Definition: AlterTable.cs:329
A set of string constants for the parameter action.
Definition: AlterTable.cs:65
const string CHUNK_SKIP
Create or delete a chunk skip index.
Definition: AlterTable.cs:552
const string LOW_CARDINALITY
Create a low-cardinality column (attribute) index.
Definition: AlterTable.cs:547
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:283
string label
return the type label (when changing a table, a new type may be created)
Definition: AlterTable.cs:1877
const string SET_GLOBAL_ACCESS_MODE
Sets the global access mode (i.e.
Definition: AlterTable.cs:235
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:339
string table_name
Table on which the operation will be performed, in [schema_name.
Definition: AlterTable.cs:584
const string STRATEGY_DEFINITION
Optional parameter for specifying the tier strategy for the table and its columns when action is SET_...
Definition: AlterTable.cs:477
const string PROTECTED
No longer used.
Definition: AlterTable.cs:137
IDictionary< string, string > options
Optional parameters.
Definition: AlterTable.cs:1204
const string COMPRESSION_TYPE
No longer supported; option will be ignored.
Definition: AlterTable.cs:398
IDictionary< string, IList< string > > properties
return the type properties (when changing a table, a new type may be created)
Definition: AlterTable.cs:1873
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:113
const string RENAME_COLUMN
When changing a column, specify new column name.
Definition: AlterTable.cs:412
const string DELETE_FOREIGN_KEY
Deletes a foreign key.
Definition: AlterTable.cs:203
const string ADD_PARTITION
Adds the partition specified in _value, to either a range-partitioned or manual list-partitioned tabl...
Definition: AlterTable.cs:211
const string PAUSE_DATASOURCE_SUBSCRIPTION
Temporarily unsubscribe a data source that is loading continuously as a stream.
Definition: AlterTable.cs:323
const string CREATE_FOREIGN_KEY
Creates a foreign key specified in _value using the format '(source_column_name [,...
Definition: AlterTable.cs:195
A set of results returned by Kinetica.alterTable.
Definition: AlterTable.cs:1851
IDictionary< string, string > info
Additional information.
Definition: AlterTable.cs:1880
const string RENAME_TABLE
Renames a table or view to _value.
Definition: AlterTable.cs:144
const string REMOVE_TEXT_SEARCH_ATTRIBUTES
Removes text search attribute from all columns.
Definition: AlterTable.cs:298
const string SET_BUILD_MATERIALIZED_VIEW_POLICY
Set startup rebuilding scheme for the materialized view; see description of 'build_materialized_view_...
Definition: AlterTable.cs:352