Kinetica   C#   API  Version 7.2.3.1
CreateTable.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 
54 {
58  public struct Options
59  {
74  public const string NO_ERROR_IF_EXISTS = "no_error_if_exists";
75 
76  public const string TRUE = "true";
77  public const string FALSE = "false";
78 
93  public const string CREATE_TEMP_TABLE = "create_temp_table";
94 
102  public const string COLLECTION_NAME = "collection_name";
103 
119  public const string IS_COLLECTION = "is_collection";
120 
136  public const string IS_REPLICATED = "is_replicated";
137 
143  public const string FOREIGN_KEYS = "foreign_keys";
144 
147  public const string FOREIGN_SHARD_KEY = "foreign_shard_key";
148 
184  public const string PARTITION_TYPE = "partition_type";
185 
189  public const string RANGE = "RANGE";
190 
194  public const string INTERVAL = "INTERVAL";
195 
199  public const string LIST = "LIST";
200 
204  public const string HASH = "HASH";
205 
209  public const string SERIES = "SERIES";
210 
216  public const string PARTITION_KEYS = "partition_keys";
217 
233  public const string PARTITION_DEFINITIONS = "partition_definitions";
234 
249  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
250 
254  public const string TTL = "ttl";
255 
258  public const string CHUNK_SIZE = "chunk_size";
259 
262  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
263 
266  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
267 
282  public const string IS_RESULT_TABLE = "is_result_table";
283 
287  public const string STRATEGY_DEFINITION = "strategy_definition";
288 
293  public const string COMPRESSION_CODEC = "compression_codec";
294 
321  public const string LOAD_VECTORS_POLICY = "load_vectors_policy";
322 
325  public const string ALWAYS = "always";
326 
329  public const string LAZY = "lazy";
330 
333  public const string ON_DEMAND = "on_demand";
334 
337  public const string SYSTEM = "system";
338 
366  public const string BUILD_PK_INDEX_POLICY = "build_pk_index_policy";
367  } // end struct Options
368 
379  public string table_name { get; set; }
380 
385  public string type_id { get; set; }
386 
731  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
732 
735  public CreateTableRequest() { }
736 
1098  string type_id,
1099  IDictionary<string, string> options = null)
1100  {
1101  this.table_name = table_name ?? "";
1102  this.type_id = type_id ?? "";
1103  this.options = options ?? new Dictionary<string, string>();
1104  } // end constructor
1105 } // end class CreateTableRequest
1106 
1111 {
1115  public struct Info
1116  {
1119  public const string QUALIFIED_TABLE_NAME = "qualified_table_name";
1120  } // end struct Info
1121 
1124  public string table_name { get; set; }
1125 
1128  public string type_id { get; set; }
1129 
1132  public bool is_collection { get; set; }
1133 
1145  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1146 } // end class CreateTableResponse
const string CREATE_TEMP_TABLE
If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of ...
Definition: CreateTable.cs:93
A set of string constants for the parameter options.
Definition: CreateTable.cs:58
const string PARTITION_KEYS
Comma-separated list of partition keys, which are the columns or column expressions by which records ...
Definition: CreateTable.cs:216
const string CHUNK_MAX_MEMORY
Indicates the target maximum data size for all columns in a chunk to be used for this table.
Definition: CreateTable.cs:266
A set of results returned by Kinetica.createTable.
CreateTableRequest()
Constructs a CreateTableRequest object with default parameters.
Definition: CreateTable.cs:735
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for this table.
Definition: CreateTable.cs:258
IDictionary< string, string > options
Optional parameters.
Definition: CreateTable.cs:731
const string FOREIGN_SHARD_KEY
Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_k...
Definition: CreateTable.cs:147
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string NO_ERROR_IF_EXISTS
If TRUE, prevents an error from occurring if the table already exists and is of the given type.
Definition: CreateTable.cs:74
CreateTableRequest(string table_name, string type_id, IDictionary< string, string > options=null)
Constructs a CreateTableRequest object with the specified parameters.
IDictionary< string, string > info
Additional information.
string type_id
Value of type_id.
const string PARTITION_TYPE
Partitioning scheme to use.
Definition: CreateTable.cs:184
const string IS_RESULT_TABLE
Indicates whether the table is a memory-only table.
Definition: CreateTable.cs:282
const string FOREIGN_KEYS
Semicolon-separated list of foreign keys, of the format '(source_column_name [, .....
Definition: CreateTable.cs:143
A set of parameters for Kinetica.createTable.
Definition: CreateTable.cs:53
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE.
Definition: CreateTable.cs:233
const string QUALIFIED_TABLE_NAME
The fully qualified name of the new table (i.e.
const string IS_AUTOMATIC_PARTITION
If TRUE, a new partition will be created for values which don't fall into an existing partition.
Definition: CreateTable.cs:249
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema as part of table_name and use Kinetica....
Definition: CreateTable.cs:102
const string SYSTEM
Generate primary key index data using the system-configured default.
Definition: CreateTable.cs:337
string table_name
Value of table_name.
const string SERIES
Use series partitioning.
Definition: CreateTable.cs:209
const string CHUNK_COLUMN_MAX_MEMORY
Indicates the target maximum data size for each column in a chunk to be used for this table.
Definition: CreateTable.cs:262
bool is_collection
[DEPRECATED–this will always return false] Indicates if the created entity is a schema.
const string COMPRESSION_CODEC
The default compression codec for this table's columns.
Definition: CreateTable.cs:293
const string ALWAYS
Generate as much primary key index data as possible before accepting requests.
Definition: CreateTable.cs:325
const string RANGE
Use range partitioning.
Definition: CreateTable.cs:189
const string LOAD_VECTORS_POLICY
Set startup data loading scheme for the table.
Definition: CreateTable.cs:321
const string LAZY
Generate the necessary primary key index data at start, and load the remainder lazily.
Definition: CreateTable.cs:329
const string ON_DEMAND
Generate primary key index data as requests use it.
Definition: CreateTable.cs:333
const string BUILD_PK_INDEX_POLICY
Set startup primary-key index generation scheme for the table.
Definition: CreateTable.cs:366
const string STRATEGY_DEFINITION
The tier strategy for the table and its columns.
Definition: CreateTable.cs:287
string table_name
Name of the table to be created, in [schema_name.
Definition: CreateTable.cs:379
const string IS_REPLICATED
Affects the distribution scheme for the table's data.
Definition: CreateTable.cs:136
A set of string constants for the parameter info.
const string IS_COLLECTION
[DEPRECATED–please use Kinetica.createSchema to create a schema instead] Indicates whether to create ...
Definition: CreateTable.cs:119
const string TTL
Sets the TTL of the table specified in table_name.
Definition: CreateTable.cs:254
string type_id
The type for the table, specified as either an existing table's numerical type ID (as returned by Kin...
Definition: CreateTable.cs:385
const string LIST
Use list partitioning.
Definition: CreateTable.cs:199
const string HASH
Use hash partitioning.
Definition: CreateTable.cs:204
const string INTERVAL
Use interval partitioning.
Definition: CreateTable.cs:194