Kinetica C# API  Version 6.1.0.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 
10 
11 namespace kinetica
12 {
13 
56  {
57 
186  public struct Action
187  {
188 
193  public const string ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables";
194 
200  public const string CREATE_INDEX = "create_index";
201 
207  public const string DELETE_INDEX = "delete_index";
208 
211  public const string MOVE_TO_COLLECTION = "move_to_collection";
212 
217  public const string PROTECTED = "protected";
218 
223  public const string RENAME_TABLE = "rename_table";
224 
228  public const string TTL = "ttl";
229 
235  public const string ADD_COLUMN = "add_column";
236 
241  public const string CHANGE_COLUMN = "change_column";
242 
247  public const string SET_COLUMN_COMPRESSION = "set_column_compression";
248 
252  public const string DELETE_COLUMN = "delete_column";
253 
259  public const string CREATE_FOREIGN_KEY = "create_foreign_key";
260 
266  public const string DELETE_FOREIGN_KEY = "delete_foreign_key";
267 
273  public const string SET_GLOBAL_ACCESS_MODE = "set_global_access_mode";
274  } // end struct Action
275 
276 
370  public struct Options
371  {
372 
375  public const string COLUMN_DEFAULT_VALUE = "column_default_value";
376 
380  public const string COLUMN_PROPERTIES = "column_properties";
381 
385  public const string COLUMN_TYPE = "column_type";
386 
412  public const string COMPRESSION_TYPE = "compression_type";
413  public const string NONE = "none";
414  public const string SNAPPY = "snappy";
415  public const string LZ4 = "lz4";
416  public const string LZ4HC = "lz4hc";
417 
422  public const string COPY_VALUES_FROM_COLUMN = "copy_values_from_column";
423 
426  public const string RENAME_COLUMN = "rename_column";
427 
448  public const string VALIDATE_CHANGE_COLUMN = "validate_change_column";
449 
451  public const string TRUE = "true";
452 
454  public const string FALSE = "false";
455  } // end struct Options
456 
457 
460  public string table_name { get; set; }
461 
588  public string action { get; set; }
589 
593  public string _value { get; set; }
594 
686  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
687 
688 
691  public AlterTableRequest() { }
692 
921  string action,
922  string _value,
923  IDictionary<string, string> options = null)
924  {
925  this.table_name = table_name ?? "";
926  this.action = action ?? "";
927  this._value = _value ?? "";
928  this.options = options ?? new Dictionary<string, string>();
929  } // end constructor
930 
931  } // end class AlterTableRequest
932 
933 
934 
939  {
940 
942  public string table_name { get; set; }
943 
945  public string action { get; set; }
946 
949  public string _value { get; set; }
950 
953  public string type_id { get; set; }
954 
957  public string type_definition { get; set; }
958 
961  public IDictionary<string, IList<string>> properties { get; set; } = new Dictionary<string, IList<string>>();
962 
965  public string label { get; set; }
966 
967  } // end class AlterTableResponse
968 
969 
970 
971 
972 } // 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:920
const string TTL
Sets the TTL of the table, view, or collection specified in table_name.
Definition: AlterTable.cs:228
A set of parameters for Kinetica.alterTable(string,string,string,IDictionary<string, string>).
Definition: AlterTable.cs:55
const string ADD_COLUMN
Adds the column specified in _value to the table specified in table_name.
Definition: AlterTable.cs:235
const string MOVE_TO_COLLECTION
Moves a table into a collection _value.
Definition: AlterTable.cs:211
string action
Modification operation to be applied Supported values: ALLOW_HOMOGENEOUS_TABLES: Sets whether homogen...
Definition: AlterTable.cs:588
const string CREATE_INDEX
Creates an index on the column name specified in _value.
Definition: AlterTable.cs:200
AlterTableRequest()
Constructs an AlterTableRequest object with default parameters.
Definition: AlterTable.cs:691
const string SET_COLUMN_COMPRESSION
Modifies the compression setting on the column specified in _value.
Definition: AlterTable.cs:247
const string ALLOW_HOMOGENEOUS_TABLES
Sets whether homogeneous tables are allowed in the given collection.
Definition: AlterTable.cs:193
const string DELETE_COLUMN
Deletes the column specified in _value from the table specified in table_name.
Definition: AlterTable.cs:252
string _value
The value of the modification.
Definition: AlterTable.cs:593
const string CHANGE_COLUMN
Changes type and properties of the column specified in _value.
Definition: AlterTable.cs:241
Modification operation to be applied Supported values: ALLOW_HOMOGENEOUS_TABLES: Sets whether homogen...
Definition: AlterTable.cs:186
const string SET_GLOBAL_ACCESS_MODE
Sets the global access mode (i.e.
Definition: AlterTable.cs:273
string table_name
Table on which the operation will be performed.
Definition: AlterTable.cs:460
const string PROTECTED
Sets whether the given table_name should be protected or not.
Definition: AlterTable.cs:217
IDictionary< string, string > options
Optional parameters.
Definition: AlterTable.cs:686
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:207
const string DELETE_FOREIGN_KEY
Deletes a foreign key.
Definition: AlterTable.cs:266
const string CREATE_FOREIGN_KEY
Creates a foreign key using the format &#39;source_column references target_table(primary_key_column) [ a...
Definition: AlterTable.cs:259
A set of results returned by Kinetica.alterTable(string,string,string,IDictionary<string, string>).
Definition: AlterTable.cs:938
const string RENAME_TABLE
Renames a table, view or collection to _value.
Definition: AlterTable.cs:223