Kinetica C# API  Version 7.1.10.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 
73  {
74 
378  public struct Action
379  {
380 
382  public const string ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables";
383 
395  public const string CREATE_INDEX = "create_index";
396 
408  public const string DELETE_INDEX = "delete_index";
409 
417  public const string MOVE_TO_COLLECTION = "move_to_collection";
418 
424  public const string MOVE_TO_SCHEMA = "move_to_schema";
425 
430  public const string PROTECTED = "protected";
431 
436  public const string RENAME_TABLE = "rename_table";
437 
441  public const string TTL = "ttl";
442 
449  public const string ADD_COLUMN = "add_column";
450 
461  public const string CHANGE_COLUMN = "change_column";
462 
464  public const string SET_COLUMN_COMPRESSION = "set_column_compression";
465 
469  public const string DELETE_COLUMN = "delete_column";
470 
477  public const string CREATE_FOREIGN_KEY = "create_foreign_key";
478 
484  public const string DELETE_FOREIGN_KEY = "delete_foreign_key";
485 
492  public const string ADD_PARTITION = "add_partition";
493 
501  public const string REMOVE_PARTITION = "remove_partition";
502 
509  public const string DELETE_PARTITION = "delete_partition";
510 
516  public const string SET_GLOBAL_ACCESS_MODE = "set_global_access_mode";
517 
526  public const string REFRESH = "refresh";
527 
536  public const string SET_REFRESH_METHOD = "set_refresh_method";
537 
544  public const string SET_REFRESH_START_TIME = "set_refresh_start_time";
545 
551  public const string SET_REFRESH_STOP_TIME = "set_refresh_stop_time";
552 
558  public const string SET_REFRESH_PERIOD = "set_refresh_period";
559 
562  public const string SET_REFRESH_SPAN = "set_refresh_span";
563 
568  public const string SET_REFRESH_EXECUTE_AS = "set_refresh_execute_as";
569 
573  public const string REMOVE_TEXT_SEARCH_ATTRIBUTES = "remove_text_search_attributes";
574 
578  public const string REMOVE_SHARD_KEYS = "remove_shard_keys";
579 
585  public const string SET_STRATEGY_DEFINITION = "set_strategy_definition";
586 
590  public const string CANCEL_DATASOURCE_SUBSCRIPTION = "cancel_datasource_subscription";
591 
595  public const string PAUSE_DATASOURCE_SUBSCRIPTION = "pause_datasource_subscription";
596 
599  public const string RESUME_DATASOURCE_SUBSCRIPTION = "resume_datasource_subscription";
600 
603  public const string CHANGE_OWNER = "change_owner";
604  } // end struct Action
605 
606 
786  public struct Options
787  {
788  public const string ACTION = "action";
789  public const string COLUMN_NAME = "column_name";
790  public const string TABLE_NAME = "table_name";
791 
795  public const string COLUMN_DEFAULT_VALUE = "column_default_value";
796 
800  public const string COLUMN_PROPERTIES = "column_properties";
801 
805  public const string COLUMN_TYPE = "column_type";
806 
829  public const string COMPRESSION_TYPE = "compression_type";
830  public const string NONE = "none";
831  public const string SNAPPY = "snappy";
832  public const string LZ4 = "lz4";
833  public const string LZ4HC = "lz4hc";
834 
837  public const string COPY_VALUES_FROM_COLUMN = "copy_values_from_column";
838 
841  public const string RENAME_COLUMN = "rename_column";
842 
863  public const string VALIDATE_CHANGE_COLUMN = "validate_change_column";
864 
867  public const string TRUE = "true";
868 
872  public const string FALSE = "false";
873 
895  public const string UPDATE_LAST_ACCESS_TIME = "update_last_access_time";
896 
901  public const string ADD_COLUMN_EXPRESSION = "add_column_expression";
902 
908  public const string STRATEGY_DEFINITION = "strategy_definition";
909 
939  public const string INDEX_TYPE = "index_type";
940 
944  public const string COLUMN = "column";
945 
949  public const string CHUNK_SKIP = "chunk_skip";
950 
952  public const string GEOSPATIAL = "geospatial";
953  } // end struct Options
954 
955 
962  public string table_name { get; set; }
963 
1265  public string action { get; set; }
1266 
1280  public string _value { get; set; }
1281 
1459  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1460 
1461 
1464  public AlterTableRequest() { }
1465 
1968  string action,
1969  string _value,
1970  IDictionary<string, string> options = null)
1971  {
1972  this.table_name = table_name ?? "";
1973  this.action = action ?? "";
1974  this._value = _value ?? "";
1975  this.options = options ?? new Dictionary<string, string>();
1976  } // end constructor
1977 
1978  } // end class AlterTableRequest
1979 
1980 
1981 
1986  {
1987 
1989  public string table_name { get; set; }
1990 
1992  public string action { get; set; }
1993 
1996  public string _value { get; set; }
1997 
2000  public string type_id { get; set; }
2001 
2004  public string type_definition { get; set; }
2005 
2008  public IDictionary<string, IList<string>> properties { get; set; } = new Dictionary<string, IList<string>>();
2009 
2012  public string label { get; set; }
2013 
2015  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
2016 
2017  } // end class AlterTableResponse
2018 
2019 
2020 
2021 
2022 } // 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:1967
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:585
const string REFRESH
For a materialized view, replays all the table creation commands required to create the view...
Definition: AlterTable.cs:526
const string SET_REFRESH_SPAN
Sets the future time-offset(in seconds) for the view refresh to stop.
Definition: AlterTable.cs:562
const string GEOSPATIAL
Create or delete a geospatial index
Definition: AlterTable.cs:952
string action
Modification operation that was performed.
Definition: AlterTable.cs:1992
const string CANCEL_DATASOURCE_SUBSCRIPTION
Permanently unsubscribe a data source that is loading continuously as a stream.
Definition: AlterTable.cs:590
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:551
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:578
string type_id
return the type_id (when changing a table, a new type may be created)
Definition: AlterTable.cs:2000
const string TTL
Sets the time-to-live in minutes of the table or view specified in table_name.
Definition: AlterTable.cs:441
const string COPY_VALUES_FROM_COLUMN
[DEPRECATED–please use add_column_expression instead.
Definition: AlterTable.cs:837
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:544
A set of parameters for Kinetica.alterTable(string,string,string,IDictionary{string, string}).
Definition: AlterTable.cs:72
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:872
const string ADD_COLUMN
Adds the column specified in _value to the table specified in table_name.
Definition: AlterTable.cs:449
const string CHANGE_OWNER
Change the owner resource group of the table.
Definition: AlterTable.cs:603
string table_name
Table on which the operation was performed.
Definition: AlterTable.cs:1989
const string VALIDATE_CHANGE_COLUMN
When changing a column, validate the change before applying it (or not).
Definition: AlterTable.cs:863
const string MOVE_TO_COLLECTION
[DEPRECATED–please use move_to_schema and use Kinetica.createSchema(string,IDictionary{string, string}) to create the schema if non-existent] Moves a table or view into a schema named _value.
Definition: AlterTable.cs:417
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:536
const string SET_REFRESH_EXECUTE_AS
Sets the user name to refresh this materialized view to the value specified in _value.
Definition: AlterTable.cs:568
string action
Modification operation to be applied Supported values: ALLOW_HOMOGENEOUS_TABLES: No longer supported;...
Definition: AlterTable.cs:1265
string _value
The value of the modification that was performed.
Definition: AlterTable.cs:1996
const string CREATE_INDEX
Creates a column (attribute) index, chunk skip index, or geospatial index (depending on the specified...
Definition: AlterTable.cs:395
const string COLUMN_TYPE
When adding or changing a column, set the column type (strings, separated by a comma: int...
Definition: AlterTable.cs:805
const string TRUE
Reset the expiration countdown timer to the table&#39;s configured TTL.
Definition: AlterTable.cs:867
const string COLUMN
Create or delete a column (attribute) index.
Definition: AlterTable.cs:944
AlterTableRequest()
Constructs an AlterTableRequest object with default parameters.
Definition: AlterTable.cs:1464
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:939
const string COLUMN_PROPERTIES
When adding or changing a column, set the column properties (strings, separated by a comma: data...
Definition: AlterTable.cs:800
const string SET_COLUMN_COMPRESSION
No longer supported; action will be ignored.
Definition: AlterTable.cs:464
string type_definition
return the type_definition (when changing a table, a new type may be created)
Definition: AlterTable.cs:2004
const string ADD_COLUMN_EXPRESSION
When adding a column, an optional expression to use for the new column&#39;s values.
Definition: AlterTable.cs:901
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:509
const string ALLOW_HOMOGENEOUS_TABLES
No longer supported; action will be ignored.
Definition: AlterTable.cs:382
const string COLUMN_DEFAULT_VALUE
When adding a column, set a default value for existing records.
Definition: AlterTable.cs:795
const string DELETE_COLUMN
Deletes the column specified in _value from the table specified in table_name.
Definition: AlterTable.cs:469
string _value
The value of the modification, depending on .
Definition: AlterTable.cs:1280
const string CHANGE_COLUMN
Changes type and properties of the column specified in _value.
Definition: AlterTable.cs:461
const string MOVE_TO_SCHEMA
Moves a table or view into a schema named _value.
Definition: AlterTable.cs:424
const string REMOVE_PARTITION
Removes the partition specified in _value (and relocates all of its data to the default partition) fr...
Definition: AlterTable.cs:501
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:895
const string RESUME_DATASOURCE_SUBSCRIPTION
Resubscribe to a paused data source subscription.
Definition: AlterTable.cs:599
Modification operation to be applied Supported values: ALLOW_HOMOGENEOUS_TABLES: No longer supported;...
Definition: AlterTable.cs:378
const string CHUNK_SKIP
Create or delete a chunk skip index.
Definition: AlterTable.cs:949
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:558
string label
return the type label (when changing a table, a new type may be created)
Definition: AlterTable.cs:2012
const string SET_GLOBAL_ACCESS_MODE
Sets the global access mode (i.e.
Definition: AlterTable.cs:516
string table_name
Table on which the operation will be performed, in [schema_name.
Definition: AlterTable.cs:962
const string STRATEGY_DEFINITION
Optional parameter for specifying the tier strategy for the table and its columns when action is set_...
Definition: AlterTable.cs:908
const string PROTECTED
No longer used.
Definition: AlterTable.cs:430
IDictionary< string, string > options
Optional parameters.
Definition: AlterTable.cs:1459
const string COMPRESSION_TYPE
No longer supported; option will be ignored.
Definition: AlterTable.cs:829
IDictionary< string, IList< string > > properties
return the type properties (when changing a table, a new type may be created)
Definition: AlterTable.cs:2008
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string DELETE_INDEX
Deletes a column (attribute) index, chunk skip index, or geospatial index (depending on the specified...
Definition: AlterTable.cs:408
const string RENAME_COLUMN
When changing a column, specify new column name.
Definition: AlterTable.cs:841
const string DELETE_FOREIGN_KEY
Deletes a foreign key.
Definition: AlterTable.cs:484
const string ADD_PARTITION
Adds the partition specified in _value, to either a range-partitioned or manual list-partitioned tabl...
Definition: AlterTable.cs:492
const string PAUSE_DATASOURCE_SUBSCRIPTION
Temporarily unsubscribe a data source that is loading continuously as a stream.
Definition: AlterTable.cs:595
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:477
A set of results returned by Kinetica.alterTable(string,string,string,IDictionary{string, string}).
Definition: AlterTable.cs:1985
IDictionary< string, string > info
Additional information.
Definition: AlterTable.cs:2015
const string RENAME_TABLE
Renames a table or view within its current schema to _value.
Definition: AlterTable.cs:436
const string REMOVE_TEXT_SEARCH_ATTRIBUTES
Removes text search attribute from all columns.
Definition: AlterTable.cs:573