Kinetica   C#   API  Version 7.2.3.0
CreateType.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 namespace kinetica
10 {
56  {
64  public struct Properties
65  {
68  public const string DATA = "data";
69 
77  public const string TEXT_SEARCH = "text_search";
78 
87  public const string STORE_ONLY = "store_only";
88 
104  public const string DISK_OPTIMIZED = "disk_optimized";
105 
111  public const string TIMESTAMP = "timestamp";
112 
118  public const string ULONG = "ulong";
119 
123  public const string UUID = "uuid";
124 
133  public const string DECIMAL = "decimal";
134 
142  public const string DATE = "date";
143 
151  public const string TIME = "time";
152 
160  public const string DATETIME = "datetime";
161 
166  public const string CHAR1 = "char1";
167 
172  public const string CHAR2 = "char2";
173 
178  public const string CHAR4 = "char4";
179 
184  public const string CHAR8 = "char8";
185 
190  public const string CHAR16 = "char16";
191 
196  public const string CHAR32 = "char32";
197 
202  public const string CHAR64 = "char64";
203 
208  public const string CHAR128 = "char128";
209 
214  public const string CHAR256 = "char256";
215 
220  public const string BOOLEAN = "boolean";
221 
226  public const string INT8 = "int8";
227 
232  public const string INT16 = "int16";
233 
240  public const string IPV4 = "ipv4";
241 
249  public const string ARRAY = "array";
250 
254  public const string JSON = "json";
255 
260  public const string VECTOR = "vector";
261 
266  public const string WKT = "wkt";
267 
272  public const string PRIMARY_KEY = "primary_key";
273 
278  public const string SOFT_PRIMARY_KEY = "soft_primary_key";
279 
284  public const string SHARD_KEY = "shard_key";
285 
300  public const string NULLABLE = "nullable";
301 
310  public const string DICT = "dict";
311 
315  public const string INIT_WITH_NOW = "init_with_now";
316 
320  public const string INIT_WITH_UUID = "init_with_uuid";
321 
325  public const string UPDATE_WITH_NOW = "update_with_now";
326  } // end struct Properties
327 
330  public string type_definition { get; set; }
331 
335  public string label { get; set; }
336 
649  public IDictionary<string, IList<string>> properties { get; set; } = new Dictionary<string, IList<string>>();
650 
654  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
655 
658  public CreateTypeRequest() { }
659 
986  string label,
987  IDictionary<string, IList<string>> properties = null,
988  IDictionary<string, string> options = null)
989  {
990  this.type_definition = type_definition ?? "";
991  this.label = label ?? "";
992  this.properties = properties ?? new Dictionary<string, IList<string>>();
993  this.options = options ?? new Dictionary<string, string>();
994  } // end constructor
995  } // end class CreateTypeRequest
996 
1001  {
1006  public string type_id { get; set; }
1007 
1011  public string type_definition { get; set; }
1012 
1015  public string label { get; set; }
1016 
1019  public IDictionary<string, IList<string>> properties { get; set; } = new Dictionary<string, IList<string>>();
1020 
1022  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1023  } // end class CreateTypeResponse
1024 } // end namespace kinetica
const string INIT_WITH_UUID
For 'uuid' type, replace empty strings and invalid UUID values with randomly-generated UUIDs upon ins...
Definition: CreateType.cs:320
const string TIME
Valid only for 'string' columns.
Definition: CreateType.cs:151
CreateTypeRequest()
Constructs a CreateTypeRequest object with default parameters.
Definition: CreateType.cs:658
const string STORE_ONLY
Persist the column value but do not make it available to queries (e.g.
Definition: CreateType.cs:87
const string WKT
Valid only for 'string' and 'bytes' columns.
Definition: CreateType.cs:266
const string CHAR128
This property provides optimized memory, disk and query performance for string columns.
Definition: CreateType.cs:208
A set of parameters for Kinetica.createType.
Definition: CreateType.cs:55
IDictionary< string, string > options
Optional parameters.
Definition: CreateType.cs:654
IDictionary< string, IList< string > > properties
Value of properties.
Definition: CreateType.cs:1019
const string VECTOR
Valid only for 'bytes' columns.
Definition: CreateType.cs:260
IDictionary< string, string > info
Additional information.
Definition: CreateType.cs:1022
const string CHAR1
This property provides optimized memory, disk and query performance for string columns.
Definition: CreateType.cs:166
string type_definition
a JSON string describing the columns of the type to be registered.
Definition: CreateType.cs:330
const string DATE
Valid only for 'string' columns.
Definition: CreateType.cs:142
const string JSON
Valid only for 'string' columns.
Definition: CreateType.cs:254
const string BOOLEAN
This property provides optimized memory and query performance for int columns.
Definition: CreateType.cs:220
const string INIT_WITH_NOW
For 'date', 'time', 'datetime', or 'timestamp' column types, replace empty strings and invalid timest...
Definition: CreateType.cs:315
string label
A user-defined description string which can be used to differentiate between tables and types with ot...
Definition: CreateType.cs:335
const string DISK_OPTIMIZED
Works in conjunction with the DATA property for string columns.
Definition: CreateType.cs:104
string type_id
An identifier representing the created type.
Definition: CreateType.cs:1006
const string INT16
This property provides optimized memory and query performance for int columns.
Definition: CreateType.cs:232
const string TEXT_SEARCH
Valid only for select 'string' columns.
Definition: CreateType.cs:77
const string CHAR8
This property provides optimized memory, disk and query performance for string columns.
Definition: CreateType.cs:184
const string DICT
This property indicates that this column should be dictionary encoded.
Definition: CreateType.cs:310
const string CHAR2
This property provides optimized memory, disk and query performance for string columns.
Definition: CreateType.cs:172
const string DATETIME
Valid only for 'string' columns.
Definition: CreateType.cs:160
const string UPDATE_WITH_NOW
For 'date', 'time', 'datetime', or 'timestamp' column types, always update the field with 'NOW()' upo...
Definition: CreateType.cs:325
const string TIMESTAMP
Valid only for 'long' columns.
Definition: CreateType.cs:111
const string SHARD_KEY
This property indicates that this column will be part of (or the entire) shard key.
Definition: CreateType.cs:284
const string CHAR32
This property provides optimized memory, disk and query performance for string columns.
Definition: CreateType.cs:196
IDictionary< string, IList< string > > properties
Each key-value pair specifies the properties to use for a given column where the key is the column na...
Definition: CreateType.cs:649
const string DECIMAL
Valid only for 'string' columns.
Definition: CreateType.cs:133
const string CHAR4
This property provides optimized memory, disk and query performance for string columns.
Definition: CreateType.cs:178
CreateTypeRequest(string type_definition, string label, IDictionary< string, IList< string >> properties=null, IDictionary< string, string > options=null)
Constructs a CreateTypeRequest object with the specified parameters.
Definition: CreateType.cs:985
string type_definition
Value of type_definition.
Definition: CreateType.cs:1011
const string CHAR256
This property provides optimized memory, disk and query performance for string columns.
Definition: CreateType.cs:214
const string IPV4
This property provides optimized memory, disk and query performance for string columns representing I...
Definition: CreateType.cs:240
const string UUID
Valid only for 'string' columns.
Definition: CreateType.cs:123
const string CHAR16
This property provides optimized memory, disk and query performance for string columns.
Definition: CreateType.cs:190
const string ARRAY
Valid only for 'string' columns.
Definition: CreateType.cs:249
const string ULONG
Valid only for 'string' columns.
Definition: CreateType.cs:118
string label
Value of label.
Definition: CreateType.cs:1015
const string INT8
This property provides optimized memory and query performance for int columns.
Definition: CreateType.cs:226
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of string constants for the parameter properties.
Definition: CreateType.cs:64
const string CHAR64
This property provides optimized memory, disk and query performance for string columns.
Definition: CreateType.cs:202
const string NULLABLE
This property indicates that this column is nullable.
Definition: CreateType.cs:300
const string PRIMARY_KEY
This property indicates that this column will be part of (or the entire) primary key.
Definition: CreateType.cs:272
const string SOFT_PRIMARY_KEY
This property indicates that this column will be part of (or the entire) soft primary key.
Definition: CreateType.cs:278
A set of results returned by Kinetica.createType.
Definition: CreateType.cs:1000
const string DATA
Default property for all numeric and string type columns; makes the column available for GPU queries.
Definition: CreateType.cs:68