Kinetica C# API  Version 6.2.0.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 
10 
11 namespace kinetica
12 {
13 
59  {
60 
241  public struct Action
242  {
243 
248  public const string ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables";
249 
255  public const string CREATE_INDEX = "create_index";
256 
262  public const string DELETE_INDEX = "delete_index";
263 
266  public const string MOVE_TO_COLLECTION = "move_to_collection";
267 
272  public const string PROTECTED = "protected";
273 
278  public const string RENAME_TABLE = "rename_table";
279 
283  public const string TTL = "ttl";
284 
291  public const string MEMORY_TTL = "memory_ttl";
292 
298  public const string ADD_COLUMN = "add_column";
299 
309  public const string CHANGE_COLUMN = "change_column";
310 
314  public const string SET_COLUMN_COMPRESSION = "set_column_compression";
315 
319  public const string DELETE_COLUMN = "delete_column";
320 
327  public const string CREATE_FOREIGN_KEY = "create_foreign_key";
328 
334  public const string DELETE_FOREIGN_KEY = "delete_foreign_key";
335 
341  public const string SET_GLOBAL_ACCESS_MODE = "set_global_access_mode";
342 
346  public const string REFRESH = "refresh";
347 
352  public const string SET_REFRESH_METHOD = "set_refresh_method";
353 
359  public const string SET_REFRESH_START_TIME = "set_refresh_start_time";
360 
365  public const string SET_REFRESH_PERIOD = "set_refresh_period";
366 
369  public const string REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes";
370  } // end struct Action
371 
372 
491  public struct Options
492  {
493 
497  public const string COLUMN_DEFAULT_VALUE = "column_default_value";
498 
502  public const string COLUMN_PROPERTIES = "column_properties";
503 
507  public const string COLUMN_TYPE = "column_type";
508 
534  public const string COMPRESSION_TYPE = "compression_type";
535  public const string NONE = "none";
536  public const string SNAPPY = "snappy";
537  public const string LZ4 = "lz4";
538  public const string LZ4HC = "lz4hc";
539 
541  public const string COPY_VALUES_FROM_COLUMN = "copy_values_from_column";
542 
545  public const string RENAME_COLUMN = "rename_column";
546 
567  public const string VALIDATE_CHANGE_COLUMN = "validate_change_column";
568  public const string TRUE = "true";
569  public const string FALSE = "false";
570 
585  public const string UPDATE_LAST_ACCESS_TIME = "update_last_access_time";
586 
590  public const string ADD_COLUMN_EXPRESSION = "add_column_expression";
591  } // end struct Options
592 
593 
596  public string table_name { get; set; }
597 
776  public string action { get; set; }
777 
781  public string _value { get; set; }
782 
899  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
900 
901 
904  public AlterTableRequest() { }
905 
1211  string action,
1212  string _value,
1213  IDictionary<string, string> options = null)
1214  {
1215  this.table_name = table_name ?? "";
1216  this.action = action ?? "";
1217  this._value = _value ?? "";
1218  this.options = options ?? new Dictionary<string, string>();
1219  } // end constructor
1220 
1221  } // end class AlterTableRequest
1222 
1223 
1224 
1229  {
1230 
1232  public string table_name { get; set; }
1233 
1235  public string action { get; set; }
1236 
1239  public string _value { get; set; }
1240 
1243  public string type_id { get; set; }
1244 
1247  public string type_definition { get; set; }
1248 
1251  public IDictionary<string, IList<string>> properties { get; set; } = new Dictionary<string, IList<string>>();
1252 
1255  public string label { get; set; }
1256 
1257  } // end class AlterTableResponse
1258 
1259 
1260 
1261 
1262 } // 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:1210
const string REFRESH
Replays all the table creation commands required to create this materialized view.
Definition: AlterTable.cs:346
const string TTL
Sets the time-to-live in minutes of the table, view, or collection specified in table_name.
Definition: AlterTable.cs:283
const string SET_REFRESH_START_TIME
Sets the time to start periodic refreshes of this materialized view to datetime string with format &#39;Y...
Definition: AlterTable.cs:359
A set of parameters for Kinetica.alterTable(string,string,string,IDictionary<string, string>).
Definition: AlterTable.cs:58
const string ADD_COLUMN
Adds the column specified in _value to the table specified in table_name.
Definition: AlterTable.cs:298
const string MOVE_TO_COLLECTION
Moves a table into a collection _value.
Definition: AlterTable.cs:266
const string SET_REFRESH_METHOD
Sets the method by which this materialized view is refreshed - one of &#39;manual&#39;, &#39;periodic&#39;, &#39;on_change&#39;.
Definition: AlterTable.cs:352
string action
Modification operation to be applied Supported values: ALLOW_HOMOGENEOUS_TABLES: Sets whether homogen...
Definition: AlterTable.cs:776
const string CREATE_INDEX
Creates an index on the column name specified in _value.
Definition: AlterTable.cs:255
AlterTableRequest()
Constructs an AlterTableRequest object with default parameters.
Definition: AlterTable.cs:904
const string SET_COLUMN_COMPRESSION
Modifies the compression setting on the column specified in _value.
Definition: AlterTable.cs:314
const string ALLOW_HOMOGENEOUS_TABLES
Sets whether homogeneous tables are allowed in the given collection.
Definition: AlterTable.cs:248
const string DELETE_COLUMN
Deletes the column specified in _value from the table specified in table_name.
Definition: AlterTable.cs:319
string _value
The value of the modification.
Definition: AlterTable.cs:781
const string CHANGE_COLUMN
Changes type and properties of the column specified in _value.
Definition: AlterTable.cs:309
const string MEMORY_TTL
Sets the time-to-live in minutes for the individual chunks of the columns of the table, view, or collection specified in table_name to free their memory if unused longer than the given time.
Definition: AlterTable.cs:291
Modification operation to be applied Supported values: ALLOW_HOMOGENEOUS_TABLES: Sets whether homogen...
Definition: AlterTable.cs:241
const string SET_REFRESH_PERIOD
Sets the time interval in seconds at which to refresh this materialized view.
Definition: AlterTable.cs:365
const string SET_GLOBAL_ACCESS_MODE
Sets the global access mode (i.e.
Definition: AlterTable.cs:341
string table_name
Table on which the operation will be performed.
Definition: AlterTable.cs:596
const string PROTECTED
Sets whether the given table_name should be protected or not.
Definition: AlterTable.cs:272
IDictionary< string, string > options
Optional parameters.
Definition: AlterTable.cs:899
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string DELETE_INDEX
Deletes an existing index on the column name specified in _value.
Definition: AlterTable.cs:262
const string DELETE_FOREIGN_KEY
Deletes a foreign key.
Definition: AlterTable.cs:334
const string CREATE_FOREIGN_KEY
Creates a foreign key using the format &#39;(source_column_name [, ...]) references target_table_name(pri...
Definition: AlterTable.cs:327
A set of results returned by Kinetica.alterTable(string,string,string,IDictionary<string, string>).
Definition: AlterTable.cs:1228
const string RENAME_TABLE
Renames a table, view or collection to _value.
Definition: AlterTable.cs:278
const string REMOVE_TEXT_SEARCH_ATTRIBUTES
remove text_search attribute from all columns, if exists.
Definition: AlterTable.cs:369