Kinetica C# API  Version 6.0.1.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 
38  {
39 
46  public struct Action
47  {
48 
52  public const string CREATE_INDEX = "create_index";
53 
57  public const string DELETE_INDEX = "delete_index";
58 
63  public const string ALLOW_HOMOGENEOUS_TABLES = "allow_homogeneous_tables";
64 
68  public const string PROTECTED = "protected";
69 
73  public const string TTL = "ttl";
74 
77  public const string ADD_COLUMN = "add_column";
78 
81  public const string DELETE_COLUMN = "delete_column";
82 
85  public const string CHANGE_COLUMN = "change_column";
86 
91  public const string RENAME_TABLE = "rename_table";
92  } // end struct Action
93 
94 
133  public struct Options
134  {
135 
138  public const string COLUMN_DEFAULT_VALUE = "column_default_value";
139 
143  public const string COLUMN_PROPERTIES = "column_properties";
144 
148  public const string COLUMN_TYPE = "column_type";
149 
157  public const string VALIDATE_CHANGE_COLUMN = "validate_change_column";
158 
160  public const string TRUE = "true";
161 
163  public const string FALSE = "false";
164 
167  public const string COPY_VALUES_FROM_COLUMN = "copy_values_from_column";
168  } // end struct Options
169 
170 
173  public string table_name { get; set; }
174 
179  public string action { get; set; }
180 
184  public string _value { get; set; }
185 
222  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
223 
224 
227  public AlterTableRequest() { }
228 
280  string action,
281  string _value,
282  IDictionary<string, string> options = null)
283  {
284  this.table_name = table_name ?? "";
285  this.action = action ?? "";
286  this._value = _value ?? "";
287  this.options = options ?? new Dictionary<string, string>();
288  } // end constructor
289 
290  } // end class AlterTableRequest
291 
292 
293 
296  {
297 
299  public string table_name { get; set; }
300 
302  public string action { get; set; }
303 
306  public string _value { get; set; }
307 
308  } // end class AlterTableResponse
309 
310 
311 
312 
313 } // 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:279
string action
Modification operation that was performed.
Definition: AlterTable.cs:302
const string TTL
Sets the TTL of the table, view, or collection specified in &lt;member name=&quot;table_name&quot;&gt;.
Definition: AlterTable.cs:73
const string COPY_VALUES_FROM_COLUMN
when adding or changing a column: enter column name - from where to copy values.
Definition: AlterTable.cs:167
A set of parameters for /alter/table.
Definition: AlterTable.cs:37
const string ADD_COLUMN
Add a column &lt;member name=&quot;_value&quot;&gt; to the table.
Definition: AlterTable.cs:77
string table_name
Table on which the operation was performed.
Definition: AlterTable.cs:299
const string VALIDATE_CHANGE_COLUMN
Validate the type change before applying column_change request.
Definition: AlterTable.cs:157
string action
Modification operation to be applied Values: create_index, delete_index, allow_homogeneous_tables, protected, ttl, add_column, delete_column, change_column, rename_table.
Definition: AlterTable.cs:179
string _value
The value of the modification that was performed.
Definition: AlterTable.cs:306
const string CREATE_INDEX
Creates an index on the column name specified in &lt;member name=&quot;_value&quot;&gt;.
Definition: AlterTable.cs:52
const string COLUMN_TYPE
when adding or changing a column: set the column type (strings, separated by a comma: int...
Definition: AlterTable.cs:148
AlterTableRequest()
Constructs an AlterTableRequest object with default parameters.
Definition: AlterTable.cs:227
const string COLUMN_PROPERTIES
when adding or changing a column: set the column properties (strings, separated by a comma: data...
Definition: AlterTable.cs:143
const string ALLOW_HOMOGENEOUS_TABLES
Sets whether homogeneous tables are allowed in the given collection.
Definition: AlterTable.cs:63
const string COLUMN_DEFAULT_VALUE
when adding a column: set a default value, for existing data.
Definition: AlterTable.cs:138
const string DELETE_COLUMN
Delete a column &lt;member name=&quot;_value&quot;&gt; from the table
Definition: AlterTable.cs:81
string _value
The value of the modification.
Definition: AlterTable.cs:184
const string CHANGE_COLUMN
Change properties of a column &lt;member name=&quot;_value&quot;&gt; in the table.
Definition: AlterTable.cs:85
Modification operation to be applied Values: create_index, delete_index, allow_homogeneous_tables, protected, ttl, add_column, delete_column, change_column, rename_table.
Definition: AlterTable.cs:46
string table_name
Table on which the operation will be performed.
Definition: AlterTable.cs:173
const string PROTECTED
Sets whether the given &lt;member name=&quot;table_name&quot;&gt; should be protected or not.
Definition: AlterTable.cs:68
IDictionary< string, string > options
Optional parameters.
Definition: AlterTable.cs:222
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 &lt;member name=&quot;_value&quot;&gt;. ...
Definition: AlterTable.cs:57
A set of results returned by /alter/table.
Definition: AlterTable.cs:295
const string RENAME_TABLE
Rename a table, view or collection to &lt;member name=&quot;_value&quot;&gt;.
Definition: AlterTable.cs:91