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 {
59  public class AlterTableRequest : KineticaData
60  {
65  public struct Action
66  {
84  public const string CREATE_INDEX = "create_index";
85 
91  public const string REFRESH_INDEX = "refresh_index";
92 
110  public const string DELETE_INDEX = "delete_index";
111 
119  public const string MOVE_TO_COLLECTION = "move_to_collection";
120 
127  public const string MOVE_TO_SCHEMA = "move_to_schema";
128 
134  public const string PROTECTED = "protected";
135 
141  public const string RENAME_TABLE = "rename_table";
142 
146  public const string TTL = "ttl";
147 
153  public const string ADD_COMMENT = "add_comment";
154 
162  public const string ADD_COLUMN = "add_column";
163 
176  public const string CHANGE_COLUMN = "change_column";
177 
181  public const string DELETE_COLUMN = "delete_column";
182 
189  public const string CREATE_FOREIGN_KEY = "create_foreign_key";
190 
197  public const string DELETE_FOREIGN_KEY = "delete_foreign_key";
198 
205  public const string ADD_PARTITION = "add_partition";
206 
214  public const string REMOVE_PARTITION = "remove_partition";
215 
222  public const string DELETE_PARTITION = "delete_partition";
223 
229  public const string SET_GLOBAL_ACCESS_MODE = "set_global_access_mode";
230 
240  public const string REFRESH = "refresh";
241 
253  public const string SET_REFRESH_METHOD = "set_refresh_method";
254 
262  public const string SET_REFRESH_START_TIME = "set_refresh_start_time";
263 
269  public const string SET_REFRESH_STOP_TIME = "set_refresh_stop_time";
270 
277  public const string SET_REFRESH_PERIOD = "set_refresh_period";
278 
281  public const string SET_REFRESH_SPAN = "set_refresh_span";
282 
287  public const string SET_REFRESH_EXECUTE_AS = "set_refresh_execute_as";
288 
292  public const string REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes";
293 
298  public const string REMOVE_SHARD_KEYS = "remove_shard_keys";
299 
305  public const string SET_STRATEGY_DEFINITION = "set_strategy_definition";
306 
311  public const string CANCEL_DATASOURCE_SUBSCRIPTION = "cancel_datasource_subscription";
312 
317  public const string PAUSE_DATASOURCE_SUBSCRIPTION = "pause_datasource_subscription";
318 
323  public const string RESUME_DATASOURCE_SUBSCRIPTION = "resume_datasource_subscription";
324 
327  public const string CHANGE_OWNER = "change_owner";
328 
333  public const string SET_LOAD_VECTORS_POLICY = "set_load_vectors_policy";
334 
339  public const string SET_BUILD_PK_INDEX_POLICY = "set_build_pk_index_policy";
340 
346  public const string SET_BUILD_MATERIALIZED_VIEW_POLICY = "set_build_materialized_view_policy";
347  } // end struct Action
348 
352  public struct Options
353  {
354  public const string ACTION = "action";
355  public const string COLUMN_NAME = "column_name";
356  public const string TABLE_NAME = "table_name";
357 
362  public const string COLUMN_DEFAULT_VALUE = "column_default_value";
363 
367  public const string COLUMN_PROPERTIES = "column_properties";
368 
372  public const string COLUMN_TYPE = "column_type";
373 
377  public const string COPY_VALUES_FROM_COLUMN = "copy_values_from_column";
378 
381  public const string RENAME_COLUMN = "rename_column";
382 
401  public const string VALIDATE_CHANGE_COLUMN = "validate_change_column";
402 
405  public const string TRUE = "true";
406 
410  public const string FALSE = "false";
411 
431  public const string UPDATE_LAST_ACCESS_TIME = "update_last_access_time";
432 
438  public const string ADD_COLUMN_EXPRESSION = "add_column_expression";
439 
446  public const string STRATEGY_DEFINITION = "strategy_definition";
447 
505  public const string INDEX_TYPE = "index_type";
506 
510  public const string COLUMN = "column";
511 
516  public const string LOW_CARDINALITY = "low_cardinality";
517 
521  public const string CHUNK_SKIP = "chunk_skip";
522 
526  public const string GEOSPATIAL = "geospatial";
527 
533  public const string CAGRA = "cagra";
534 
539  public const string HNSW = "hnsw";
540 
545  public const string INDEX_OPTIONS = "index_options";
546  } // end struct Options
547 
553  public string table_name { get; set; }
554 
925  public string action { get; set; }
926 
942  public string _value { get; set; }
943 
1135  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1136 
1139  public AlterTableRequest() { }
1140 
1730  string action,
1731  string _value,
1732  IDictionary<string, string> options = null)
1733  {
1734  this.table_name = table_name ?? "";
1735  this.action = action ?? "";
1736  this._value = _value ?? "";
1737  this.options = options ?? new Dictionary<string, string>();
1738  } // end constructor
1739  } // end class AlterTableRequest
1740 
1744  public class AlterTableResponse : KineticaData
1745  {
1747  public string table_name { get; set; }
1748 
1750  public string action { get; set; }
1751 
1754  public string _value { get; set; }
1755 
1758  public string type_id { get; set; }
1759 
1762  public string type_definition { get; set; }
1763 
1766  public IDictionary<string, IList<string>> properties { get; set; } = new Dictionary<string, IList<string>>();
1767 
1770  public string label { get; set; }
1771 
1773  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1774  } // end class AlterTableResponse
1775 } // end namespace kinetica
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:269
const string MOVE_TO_SCHEMA
Moves a table or view into a schema named _value.
Definition: AlterTable.cs:127
AlterTableRequest(string table_name, string action, string _value, IDictionary< string, string > options=null)
Constructs an AlterTableRequest object with the specified parameters.
Definition: AlterTable.cs:1729
string table_name
Table on which the operation was performed.
Definition: AlterTable.cs:1747
const string DELETE_COLUMN
Deletes the column specified in _value from the table specified in table_name.
Definition: AlterTable.cs:181
const string CREATE_INDEX
Creates a column (attribute) index, low-cardinality index, chunk skip index, geospatial index,...
Definition: AlterTable.cs:84
const string COPY_VALUES_FROM_COLUMN
[DEPRECATED–please use ADD_COLUMN_EXPRESSION instead.
Definition: AlterTable.cs:377
const string HNSW
Create or delete an HNSW index on a vector column
Definition: AlterTable.cs:539
const string DELETE_INDEX
Deletes a column (attribute) index, low-cardinality index, chunk skip index, geospatial index,...
Definition: AlterTable.cs:110
const string COLUMN
Create or delete a column (attribute) index.
Definition: AlterTable.cs:510
const string SET_STRATEGY_DEFINITION
Sets the tier strategy for the table and its columns to the one specified in _value,...
Definition: AlterTable.cs:305
const string GEOSPATIAL
Create or delete a geospatial index
Definition: AlterTable.cs:526
string action
Modification operation to be applied.
Definition: AlterTable.cs:925
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:298
const string COLUMN_DEFAULT_VALUE
When adding a column, set a default value for existing records.
Definition: AlterTable.cs:362
const string SET_GLOBAL_ACCESS_MODE
Sets the global access mode (i.e.
Definition: AlterTable.cs:229
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:222
const string COLUMN_TYPE
When adding or changing a column, set the column type (strings, separated by a comma: int,...
Definition: AlterTable.cs:372
const string ADD_PARTITION
Adds the partition specified in _value, to either a range-partitioned or manual list-partitioned tabl...
Definition: AlterTable.cs:205
const string REFRESH
For a materialized view, replays all the table creation commands required to create the view.
Definition: AlterTable.cs:240
const string VALIDATE_CHANGE_COLUMN
When changing a column, validate the change before applying it (or not).
Definition: AlterTable.cs:401
IDictionary< string, string > options
Optional parameters.
Definition: AlterTable.cs:1135
const string CREATE_FOREIGN_KEY
Creates a foreign key specified in _value using the format '(source_column_name [,...
Definition: AlterTable.cs:189
const string RESUME_DATASOURCE_SUBSCRIPTION
Resubscribe to a paused data source subscription.
Definition: AlterTable.cs:323
string action
Modification operation that was performed.
Definition: AlterTable.cs:1750
const string COLUMN_PROPERTIES
When adding or changing a column, set the column properties (strings, separated by a comma: data,...
Definition: AlterTable.cs:367
AlterTableRequest()
Constructs an AlterTableRequest object with default parameters.
Definition: AlterTable.cs:1139
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:253
const string REMOVE_TEXT_SEARCH_ATTRIBUTES
Removes text search attribute from all columns.
Definition: AlterTable.cs:292
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:333
const string CANCEL_DATASOURCE_SUBSCRIPTION
Permanently unsubscribe a data source that is loading continuously as a stream.
Definition: AlterTable.cs:311
const string SET_REFRESH_EXECUTE_AS
Sets the user name to refresh this materialized view to the value specified in _value.
Definition: AlterTable.cs:287
string label
return the type label (when changing a table, a new type may be created)
Definition: AlterTable.cs:1770
const string DELETE_FOREIGN_KEY
Deletes a foreign key.
Definition: AlterTable.cs:197
const string LOW_CARDINALITY
Create a low-cardinality column (attribute) index.
Definition: AlterTable.cs:516
const string SET_REFRESH_SPAN
Sets the future time-offset(in seconds) for the view refresh to stop.
Definition: AlterTable.cs:281
const string REMOVE_PARTITION
Removes the partition specified in _value (and relocates all of its data to the default partition) fr...
Definition: AlterTable.cs:214
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:410
const string ADD_COLUMN
Adds the column specified in _value to the table specified in table_name.
Definition: AlterTable.cs:162
string _value
The value of the modification that was performed.
Definition: AlterTable.cs:1754
string type_id
return the type_id (when changing a table, a new type may be created)
Definition: AlterTable.cs:1758
const string INDEX_OPTIONS
Options to use when creating an index, in the format "key: value [, key: value [, ....
Definition: AlterTable.cs:545
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:262
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:119
const string CHUNK_SKIP
Create or delete a chunk skip index.
Definition: AlterTable.cs:521
IDictionary< string, IList< string > > properties
return the type properties (when changing a table, a new type may be created)
Definition: AlterTable.cs:1766
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:277
const string PROTECTED
No longer used.
Definition: AlterTable.cs:134
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:431
string table_name
Table on which the operation will be performed, in [schema_name.
Definition: AlterTable.cs:553
const string ADD_COMMENT
Adds the comment specified in _value to the table specified in table_name.
Definition: AlterTable.cs:153
const string CHANGE_COLUMN
Changes type and properties of the column specified in _value.
Definition: AlterTable.cs:176
const string CHANGE_OWNER
Change the owner resource group of the table.
Definition: AlterTable.cs:327
const string RENAME_COLUMN
When changing a column, specify new column name.
Definition: AlterTable.cs:381
const string TTL
Sets the time-to-live in minutes of the table or view specified in table_name.
Definition: AlterTable.cs:146
string _value
The value of the modification, depending on action.
Definition: AlterTable.cs:942
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:339
const string TRUE
Reset the expiration countdown timer to the table's configured TTL.
Definition: AlterTable.cs:405
const string RENAME_TABLE
Renames a table or view to _value.
Definition: AlterTable.cs:141
const string SET_BUILD_MATERIALIZED_VIEW_POLICY
Set startup rebuilding scheme for the materialized view; see description of 'build_materialized_view_...
Definition: AlterTable.cs:346
const string PAUSE_DATASOURCE_SUBSCRIPTION
Temporarily unsubscribe a data source that is loading continuously as a stream.
Definition: AlterTable.cs:317
const string REFRESH_INDEX
Refreshes an index identified by INDEX_TYPE, on the column name specified in _value.
Definition: AlterTable.cs:91
const string STRATEGY_DEFINITION
Optional parameter for specifying the tier strategy for the table and its columns when action is SET_...
Definition: AlterTable.cs:446
IDictionary< string, string > info
Additional information.
Definition: AlterTable.cs:1773
string type_definition
return the type_definition (when changing a table, a new type may be created)
Definition: AlterTable.cs:1762
const string CAGRA
Create or delete a CAGRA index on a vector column
Definition: AlterTable.cs:533
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:505
const string ADD_COLUMN_EXPRESSION
When adding a column, an optional expression to use for the new column's values.
Definition: AlterTable.cs:438