Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 
74  {
75 
302  public struct Action
303  {
304 
306  public const string ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables";
307 
316  public const string CREATE_INDEX = "create_index";
317 
326  public const string DELETE_INDEX = "delete_index";
327 
333  public const string MOVE_TO_COLLECTION = "move_to_collection";
334 
339  public const string PROTECTED = "protected";
340 
345  public const string RENAME_TABLE = "rename_table";
346 
350  public const string TTL = "ttl";
351 
357  public const string ADD_COLUMN = "add_column";
358 
368  public const string CHANGE_COLUMN = "change_column";
369 
374  public const string SET_COLUMN_COMPRESSION = "set_column_compression";
375 
379  public const string DELETE_COLUMN = "delete_column";
380 
387  public const string CREATE_FOREIGN_KEY = "create_foreign_key";
388 
394  public const string DELETE_FOREIGN_KEY = "delete_foreign_key";
395 
402  public const string ADD_PARTITION = "add_partition";
403 
411  public const string REMOVE_PARTITION = "remove_partition";
412 
419  public const string DELETE_PARTITION = "delete_partition";
420 
426  public const string SET_GLOBAL_ACCESS_MODE = "set_global_access_mode";
427 
431  public const string REFRESH = "refresh";
432 
438  public const string SET_REFRESH_METHOD = "set_refresh_method";
439 
446  public const string SET_REFRESH_START_TIME = "set_refresh_start_time";
447 
453  public const string SET_REFRESH_PERIOD = "set_refresh_period";
454 
458  public const string REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes";
459 
469  public const string SET_STRATEGY_DEFINITION = "set_strategy_definition";
470  } // end struct Action
471 
472 
656  public struct Options
657  {
658  public const string ACTION = "action";
659  public const string COLUMN_NAME = "column_name";
660  public const string TABLE_NAME = "table_name";
661 
665  public const string COLUMN_DEFAULT_VALUE = "column_default_value";
666 
670  public const string COLUMN_PROPERTIES = "column_properties";
671 
675  public const string COLUMN_TYPE = "column_type";
676 
702  public const string COMPRESSION_TYPE = "compression_type";
703  public const string NONE = "none";
704  public const string SNAPPY = "snappy";
705  public const string LZ4 = "lz4";
706  public const string LZ4HC = "lz4hc";
707 
710  public const string COPY_VALUES_FROM_COLUMN = "copy_values_from_column";
711 
714  public const string RENAME_COLUMN = "rename_column";
715 
736  public const string VALIDATE_CHANGE_COLUMN = "validate_change_column";
737 
740  public const string TRUE = "true";
741 
745  public const string FALSE = "false";
746 
769  public const string UPDATE_LAST_ACCESS_TIME = "update_last_access_time";
770 
775  public const string ADD_COLUMN_EXPRESSION = "add_column_expression";
776 
787  public const string STRATEGY_DEFINITION = "strategy_definition";
788 
811  public const string INDEX_TYPE = "index_type";
812 
816  public const string COLUMN = "column";
817 
821  public const string CHUNK_SKIP = "chunk_skip";
822  } // end struct Options
823 
824 
827  public string table_name { get; set; }
828 
1053  public string action { get; set; }
1054 
1066  public string _value { get; set; }
1067 
1249  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1250 
1251 
1254  public AlterTableRequest() { }
1255 
1680  string action,
1681  string _value,
1682  IDictionary<string, string> options = null)
1683  {
1684  this.table_name = table_name ?? "";
1685  this.action = action ?? "";
1686  this._value = _value ?? "";
1687  this.options = options ?? new Dictionary<string, string>();
1688  } // end constructor
1689 
1690  } // end class AlterTableRequest
1691 
1692 
1693 
1698  {
1699 
1701  public string table_name { get; set; }
1702 
1704  public string action { get; set; }
1705 
1708  public string _value { get; set; }
1709 
1712  public string type_id { get; set; }
1713 
1716  public string type_definition { get; set; }
1717 
1720  public IDictionary<string, IList<string>> properties { get; set; } = new Dictionary<string, IList<string>>();
1721 
1724  public string label { get; set; }
1725 
1727  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1728 
1729  } // end class AlterTableResponse
1730 
1731 
1732 
1733 
1734 } // 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:1679
const string 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: AlterTable.cs:469
const string REFRESH
Replays all the table creation commands required to create this materialized view.
Definition: AlterTable.cs:431
string action
Modification operation that was performed.
Definition: AlterTable.cs:1704
string type_id
return the type_id (when changing a table, a new type may be created)
Definition: AlterTable.cs:1712
const string TTL
Sets the time-to-live in minutes of the table, view, or collection specified in table_name.
Definition: AlterTable.cs:350
const string COPY_VALUES_FROM_COLUMN
Deprecated.
Definition: AlterTable.cs:710
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:446
A set of parameters for Kinetica.alterTable(string,string,string,IDictionary{string, string}).
Definition: AlterTable.cs:73
const string FALSE
Don&#39;t reset the timer; expiration countdown will continue from where it is, as if the table had not b...
Definition: AlterTable.cs:745
const string ADD_COLUMN
Adds the column specified in _value to the table specified in table_name.
Definition: AlterTable.cs:357
string table_name
Table on which the operation was performed.
Definition: AlterTable.cs:1701
const string VALIDATE_CHANGE_COLUMN
When changing a column, validate the change before applying it.
Definition: AlterTable.cs:736
const string MOVE_TO_COLLECTION
Moves a table or view into a collection named _value.
Definition: AlterTable.cs:333
const string SET_REFRESH_METHOD
Sets the method by which this materialized view is refreshed to the method specified in _value - one ...
Definition: AlterTable.cs:438
string action
Modification operation to be applied Supported values: ALLOW_HOMOGENEOUS_TABLES: No longer supported;...
Definition: AlterTable.cs:1053
string _value
The value of the modification that was performed.
Definition: AlterTable.cs:1708
const string CREATE_INDEX
Creates either a column (attribute) index or chunk skip index, depending on the specified index_type...
Definition: AlterTable.cs:316
const string COLUMN_TYPE
When adding or changing a column, set the column type (strings, separated by a comma: int...
Definition: AlterTable.cs:675
const string TRUE
Reset the expiration countdown timer to the table&#39;s configured TTL.
Definition: AlterTable.cs:740
const string COLUMN
Create or delete a column (attribute) index.
Definition: AlterTable.cs:816
AlterTableRequest()
Constructs an AlterTableRequest object with default parameters.
Definition: AlterTable.cs:1254
const string INDEX_TYPE
Type of index to create, when action is create_index, or to delete, when action is delete_index...
Definition: AlterTable.cs:811
const string COLUMN_PROPERTIES
When adding or changing a column, set the column properties (strings, separated by a comma: data...
Definition: AlterTable.cs:670
const string SET_COLUMN_COMPRESSION
Modifies the compression setting on the column specified in _value to the compression type specified ...
Definition: AlterTable.cs:374
string type_definition
return the type_definition (when changing a table, a new type may be created)
Definition: AlterTable.cs:1716
const string ADD_COLUMN_EXPRESSION
When adding a column, an optional expression to use for the new column&#39;s values.
Definition: AlterTable.cs:775
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:419
const string ALLOW_HOMOGENEOUS_TABLES
No longer supported; action will be ignored.
Definition: AlterTable.cs:306
const string COLUMN_DEFAULT_VALUE
When adding a column, set a default value for existing records.
Definition: AlterTable.cs:665
const string DELETE_COLUMN
Deletes the column specified in _value from the table specified in table_name.
Definition: AlterTable.cs:379
string _value
The value of the modification, depending on .
Definition: AlterTable.cs:1066
const string CHANGE_COLUMN
Changes type and properties of the column specified in _value.
Definition: AlterTable.cs:368
const string REMOVE_PARTITION
Removes the partition specified in _value (and relocates all of its data to the default partition) fr...
Definition: AlterTable.cs:411
const string UPDATE_LAST_ACCESS_TIME
Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table&#39;s TT...
Definition: AlterTable.cs:769
Modification operation to be applied Supported values: ALLOW_HOMOGENEOUS_TABLES: No longer supported;...
Definition: AlterTable.cs:302
const string CHUNK_SKIP
Create or delete a chunk skip index.
Definition: AlterTable.cs:821
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:453
string label
return the type label (when changing a table, a new type may be created)
Definition: AlterTable.cs:1724
const string SET_GLOBAL_ACCESS_MODE
Sets the global access mode (i.e.
Definition: AlterTable.cs:426
string table_name
Table on which the operation will be performed.
Definition: AlterTable.cs:827
const string STRATEGY_DEFINITION
Optional parameter for specifying the tier strategy for the table and its columns when action is set_...
Definition: AlterTable.cs:787
const string PROTECTED
Sets whether the given table_name should be protected or not.
Definition: AlterTable.cs:339
IDictionary< string, string > options
Optional parameters.
Definition: AlterTable.cs:1249
const string COMPRESSION_TYPE
When setting column compression (set_column_compression for action), compression type to use: none (t...
Definition: AlterTable.cs:702
IDictionary< string, IList< string > > properties
return the type properties (when changing a table, a new type may be created)
Definition: AlterTable.cs:1720
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string DELETE_INDEX
Deletes either a column (attribute) index or chunk skip index, depending on the specified index_type...
Definition: AlterTable.cs:326
const string RENAME_COLUMN
When changing a column, specify new column name.
Definition: AlterTable.cs:714
const string DELETE_FOREIGN_KEY
Deletes a foreign key.
Definition: AlterTable.cs:394
const string ADD_PARTITION
Adds the partition specified in _value, to either a range-partitioned or manual list-partitioned tabl...
Definition: AlterTable.cs:402
const string CREATE_FOREIGN_KEY
Creates a foreign key specified in _value using the format &#39;(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]&#39;.
Definition: AlterTable.cs:387
A set of results returned by Kinetica.alterTable(string,string,string,IDictionary{string, string}).
Definition: AlterTable.cs:1697
IDictionary< string, string > info
Additional information.
Definition: AlterTable.cs:1727
const string RENAME_TABLE
Renames a table, view or collection to _value.
Definition: AlterTable.cs:345
const string REMOVE_TEXT_SEARCH_ATTRIBUTES
Removes text search attribute from all columns.
Definition: AlterTable.cs:458