A set of parameters for Kinetica.createTable. More...

Inheritance diagram for kinetica.CreateTableRequest:

Collaboration diagram for kinetica.CreateTableRequest:

Classes
struct	Options
	A set of string constants for the parameter options. More...

Public Member Functions
	CreateTableRequest ()
	Constructs a CreateTableRequest object with default parameters. More...

	CreateTableRequest (string table_name, string type_id, IDictionary< string, string > options=null)
	Constructs a CreateTableRequest object with the specified parameters. More...

	CreateTableRequest ()
	Constructs a CreateTableRequest object with default parameters. More...

	CreateTableRequest (string table_name, string type_id, IDictionary< string, string > options=null)
	Constructs a CreateTableRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name `[get, set]`
	Name of the table to be created, in [schema_name. More...

string	type_id `[get, set]`
	The type for the table, specified as either an existing table's numerical type ID (as returned by Kinetica.createType) or a type definition (as described above). More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.createTable.

Creates a new table with the given type (definition of columns). The type is specified in type_id as either a numerical type ID (as returned by Kinetica.createType) or as a list of columns, each specified as a list of the column name, data type, and any column attributes.

Example of a type definition with some parameters:

[
    ["id", "int8", "primary_key"],
    ["dept_id", "int8", "primary_key", "shard_key"],
    ["manager_id", "int8", "nullable"],
    ["first_name", "char32"],
    ["last_name", "char64"],
    ["salary", "decimal"],
    ["hire_date", "date"]
]

Each column definition consists of the column name (which should meet the standard column naming criteria), the column's specific type (int, long, float, double, string, bytes, or any of the properties map values from Kinetica.createType), and any data handling, data key, or data replacement properties.

A table may optionally be designated to use a replicated distribution scheme, or be assigned: foreign keys to other tables, a partitioning scheme, and/or a tier strategy.

Definition at line 54 of file CreateTable.cs.

Constructor & Destructor Documentation

◆ CreateTableRequest() [1/4]

kinetica.CreateTableRequest.CreateTableRequest ( )

inline

Constructs a CreateTableRequest object with default parameters.

Definition at line 762 of file CreateTable.cs.

◆ CreateTableRequest() [2/4]

kinetica.CreateTableRequest.CreateTableRequest	(	string	table_name,
		string	type_id,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateTableRequest object with the specified parameters.

Parameters

table_name	Name of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. Error for requests with existing table of the same name and type ID may be suppressed by using the NO_ERROR_IF_EXISTS option.
type_id	The type for the table, specified as either an existing table's numerical type ID (as returned by Kinetica.createType) or a type definition (as described above).
options	Optional parameters. NO_ERROR_IF_EXISTS: If TRUE, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values: TRUE FALSE The default value is FALSE. CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of table_name . If IS_RESULT_TABLE is TRUE, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_TABLE_NAME. Supported values: TRUE FALSE The default value is FALSE. COLLECTION_NAME: [DEPRECATED–please specify the containing schema as part of table_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created table. If the schema is non-existent, it will be automatically created. IS_COLLECTION: [DEPRECATED–please use Kinetica.createSchema to create a schema instead] Indicates whether to create a schema instead of a table. Supported values: TRUE FALSE The default value is FALSE. IS_REPLICATED: Affects the distribution scheme for the table's data. If TRUE and the given type has no explicit shard key defined, the table will be replicated. If FALSE, the table will be sharded according to the shard key specified in the given type_id , or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values: TRUE FALSE The default value is FALSE. FOREIGN_KEYS: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'. FOREIGN_SHARD_KEY: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'. PARTITION_TYPE: Partitioning scheme to use. Supported values: RANGE: Use range partitioning. INTERVAL: Use interval partitioning. LIST: Use list partitioning. HASH: Use hash partitioning. SERIES: Use series partitioning. PARTITION_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION_DEFINITIONS. PARTITION_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats. IS_AUTOMATIC_PARTITION: If TRUE, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values: TRUE FALSE The default value is FALSE. TTL: Sets the TTL of the table specified in table_name . CHUNK_SIZE: Indicates the number of records per chunk to be used for this table. CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this table. CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this table. IS_RESULT_TABLE: Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data-handling, and it will not be retained if the server is restarted. Supported values: TRUE FALSE The default value is FALSE. STRATEGY_DEFINITION: The tier strategy for the table and its columns. COMPRESSION_CODEC: The default compression codec for this table's columns. LOAD_VECTORS_POLICY: Set startup data loading scheme for the table. Supported values: ALWAYS: Load as much vector data as possible into memory before accepting requests. LAZY: Load the necessary vector data at start, and load the remainder lazily. ON_DEMAND: Load vector data as requests use it. SYSTEM: Load vector data using the system-configured default. The default value is SYSTEM. BUILD_PK_INDEX_POLICY: Set startup primary-key index generation scheme for the table. Supported values: ALWAYS: Generate as much primary key index data as possible before accepting requests. LAZY: Generate the necessary primary key index data at start, and load the remainder lazily. ON_DEMAND: Generate primary key index data as requests use it. SYSTEM: Generate primary key index data using the system-configured default. The default value is SYSTEM. The default value is an empty Dictionary.

Definition at line 1145 of file CreateTable.cs.

◆ CreateTableRequest() [3/4]

kinetica.CreateTableRequest.CreateTableRequest ( )

inline

Constructs a CreateTableRequest object with default parameters.

Definition at line 762 of file CreateTable.cs.

◆ CreateTableRequest() [4/4]

kinetica.CreateTableRequest.CreateTableRequest	(	string	table_name,
		string	type_id,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateTableRequest object with the specified parameters.

Parameters

table_name	Name of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. Error for requests with existing table of the same name and type ID may be suppressed by using the NO_ERROR_IF_EXISTS option.
type_id	The type for the table, specified as either an existing table's numerical type ID (as returned by Kinetica.createType) or a type definition (as described above).
options	Optional parameters. NO_ERROR_IF_EXISTS: If TRUE, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values: TRUE FALSE The default value is FALSE. CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of table_name . If IS_RESULT_TABLE is TRUE, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_TABLE_NAME. Supported values: TRUE FALSE The default value is FALSE. COLLECTION_NAME: [DEPRECATED–please specify the containing schema as part of table_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created table. If the schema is non-existent, it will be automatically created. IS_COLLECTION: [DEPRECATED–please use Kinetica.createSchema to create a schema instead] Indicates whether to create a schema instead of a table. Supported values: TRUE FALSE The default value is FALSE. IS_REPLICATED: Affects the distribution scheme for the table's data. If TRUE and the given type has no explicit shard key defined, the table will be replicated. If FALSE, the table will be sharded according to the shard key specified in the given type_id , or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values: TRUE FALSE The default value is FALSE. FOREIGN_KEYS: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'. FOREIGN_SHARD_KEY: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'. PARTITION_TYPE: Partitioning scheme to use. Supported values: RANGE: Use range partitioning. INTERVAL: Use interval partitioning. LIST: Use list partitioning. HASH: Use hash partitioning. SERIES: Use series partitioning. PARTITION_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION_DEFINITIONS. PARTITION_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats. IS_AUTOMATIC_PARTITION: If TRUE, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values: TRUE FALSE The default value is FALSE. TTL: Sets the TTL of the table specified in table_name . CHUNK_SIZE: Indicates the number of records per chunk to be used for this table. CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this table. CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this table. IS_RESULT_TABLE: Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data-handling, and it will not be retained if the server is restarted. Supported values: TRUE FALSE The default value is FALSE. STRATEGY_DEFINITION: The tier strategy for the table and its columns. COMPRESSION_CODEC: The default compression codec for this table's columns. LOAD_VECTORS_POLICY: Set startup data loading scheme for the table. Supported values: ALWAYS: Load as much vector data as possible into memory before accepting requests. LAZY: Load the necessary vector data at start, and load the remainder lazily. ON_DEMAND: Load vector data as requests use it. SYSTEM: Load vector data using the system-configured default. The default value is SYSTEM. BUILD_PK_INDEX_POLICY: Set startup primary-key index generation scheme for the table. Supported values: ALWAYS: Generate as much primary key index data as possible before accepting requests. LAZY: Generate the necessary primary key index data at start, and load the remainder lazily. ON_DEMAND: Generate primary key index data as requests use it. SYSTEM: Generate primary key index data using the system-configured default. The default value is SYSTEM. The default value is an empty Dictionary.

Definition at line 1145 of file CreateTable.cs.

Property Documentation

◆ options

IDictionary< string, string > kinetica.CreateTableRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

NO_ERROR_IF_EXISTS: If TRUE, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values:
- TRUE
- FALSE
The default value is FALSE.
CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of table_name. If IS_RESULT_TABLE is TRUE, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_TABLE_NAME. Supported values:
- TRUE
- FALSE
The default value is FALSE.
COLLECTION_NAME: [DEPRECATED–please specify the containing schema as part of table_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created table. If the schema is non-existent, it will be automatically created.
IS_COLLECTION: [DEPRECATED–please use Kinetica.createSchema to create a schema instead] Indicates whether to create a schema instead of a table. Supported values:
- TRUE
- FALSE
The default value is FALSE.
IS_REPLICATED: Affects the distribution scheme for the table's data. If TRUE and the given type has no explicit shard key defined, the table will be replicated. If FALSE, the table will be sharded according to the shard key specified in the given type_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values:
- TRUE
- FALSE
The default value is FALSE.
FOREIGN_KEYS: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
FOREIGN_SHARD_KEY: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
PARTITION_TYPE: Partitioning scheme to use. Supported values:
- RANGE: Use range partitioning.
- INTERVAL: Use interval partitioning.
- LIST: Use list partitioning.
- HASH: Use hash partitioning.
- SERIES: Use series partitioning.
PARTITION_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION_DEFINITIONS.
PARTITION_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
IS_AUTOMATIC_PARTITION: If TRUE, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values:
- TRUE
- FALSE
The default value is FALSE.
TTL: Sets the TTL of the table specified in table_name.
CHUNK_SIZE: Indicates the number of records per chunk to be used for this table.
CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this table.
CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this table.
IS_RESULT_TABLE: Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data-handling, and it will not be retained if the server is restarted. Supported values:
- TRUE
- FALSE
The default value is FALSE.
STRATEGY_DEFINITION: The tier strategy for the table and its columns.
COMPRESSION_CODEC: The default compression codec for this table's columns.
LOAD_VECTORS_POLICY: Set startup data loading scheme for the table. Supported values:
- ALWAYS: Load as much vector data as possible into memory before accepting requests.
- LAZY: Load the necessary vector data at start, and load the remainder lazily.
- ON_DEMAND: Load vector data as requests use it.
- SYSTEM: Load vector data using the system-configured default.
The default value is SYSTEM.
BUILD_PK_INDEX_POLICY: Set startup primary-key index generation scheme for the table. Supported values:
- ALWAYS: Generate as much primary key index data as possible before accepting requests.
- LAZY: Generate the necessary primary key index data at start, and load the remainder lazily.
- ON_DEMAND: Generate primary key index data as requests use it.
- SYSTEM: Generate primary key index data using the system-configured default.
The default value is SYSTEM.

The default value is an empty Dictionary.

Definition at line 758 of file CreateTable.cs.

◆ table_name

string kinetica.CreateTableRequest.table_name

getset

Name of the table to be created, in [schema_name.

]table_name format, using standard name resolution rules and meeting table naming criteria.

Error for requests with existing table of the same name and type ID may be suppressed by using the NO_ERROR_IF_EXISTS option.

Definition at line 387 of file CreateTable.cs.

◆ type_id

string kinetica.CreateTableRequest.type_id

getset

The type for the table, specified as either an existing table's numerical type ID (as returned by Kinetica.createType) or a type definition (as described above).

Definition at line 393 of file CreateTable.cs.

The documentation for this class was generated from the following file:

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/CreateTable.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateTableRequest() [1/4]

◆ CreateTableRequest() [2/4]

◆ CreateTableRequest() [3/4]

◆ CreateTableRequest() [4/4]

Property Documentation

◆ options

◆ table_name

◆ type_id