kinetica.CreateUnionRequest.Options

A set of string constants for the parameter CreateUnionRequest.options. More…

Static Public Attributes
const string	CREATE_TEMP_TABLE = “create_temp_table”
	If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of CreateUnionRequest.table_name.

const string	TRUE = “true”
	A boolean constant for the CreateUnionRequest.Options options.

const string	FALSE = “false”
	A boolean constant for the CreateUnionRequest.Options options.

const string	COLLECTION_NAME = “collection_name”
	[DEPRECATED–please specify the containing schema for the projection as part of CreateUnionRequest.table_name and use Kinetica.createSchema to create the schema if non-existent] Name of the schema for the output table.

const string	MODE = “mode”
	The mode describes what rows of the tables being unioned will be retained.

const string	UNION_ALL = “union_all”
	Retains all rows from the specified tables.

const string	UNION = “union”
	Retains all unique rows from the specified tables (synonym for UNION_DISTINCT).

const string	UNION_DISTINCT = “union_distinct”
	Retains all unique rows from the specified tables.

const string	EXCEPT = “except”
	Retains all unique rows from the first table that do not appear in the second table (only works on 2 tables).

const string	EXCEPT_ALL = “except_all”
	Retains all rows(including duplicates) from the first table that do not appear in the second table (only works on 2 tables).

const string	INTERSECT = “intersect”
	Retains all unique rows that appear in both of the specified tables (only works on 2 tables).

const string	INTERSECT_ALL = “intersect_all”
	Retains all rows(including duplicates) that appear in both of the specified tables (only works on 2 tables).

const string	CHUNK_SIZE = “chunk_size”
	Indicates the number of records per chunk to be used for this output table.

const string	CHUNK_COLUMN_MAX_MEMORY = “chunk_column_max_memory”
	Indicates the target maximum data size for each column in a chunk to be used for this output table.

const string	CHUNK_MAX_MEMORY = “chunk_max_memory”
	Indicates the target maximum data size for all columns in a chunk to be used for this output table.

const string	CREATE_INDEXES = “create_indexes”
	Comma-separated list of columns on which to create indexes on the output table.

const string	PARTITION_TYPE = “partition_type”
	Partitioning scheme to use for the output table.

const string	RANGE = “RANGE”
	Use range partitioning.

const string	INTERVAL = “INTERVAL”
	Use interval partitioning.

const string	LIST = “LIST”
	Use list partitioning.

const string	HASH = “HASH”
	Use hash partitioning.

const string	SERIES = “SERIES”
	Use series partitioning.

const string	PARTITION_KEYS = “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.

const string	PARTITION_DEFINITIONS = “partition_definitions”
	Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE.

const string	IS_AUTOMATIC_PARTITION = “is_automatic_partition”
	If TRUE, a new partition will be created for values which don’t fall into an existing partition.

const string	TTL = “ttl”
	Sets the TTL of the output table specified in CreateUnionRequest.table_name.

const string	PERSIST = “persist”
	If TRUE, then the output table specified in CreateUnionRequest.table_name will be persisted and will not expire unless a TTL is specified.

const string	VIEW_ID = “view_id”
	ID of view of which this output table is a member.

const string	FORCE_REPLICATED = “force_replicated”
	If TRUE, then the output table specified in CreateUnionRequest.table_name will be replicated even if the source tables are not.

const string	STRATEGY_DEFINITION = “strategy_definition”
	The tier strategy for the table and its columns.

const string	COMPRESSION_CODEC = “compression_codec”
	The default compression codec for this table’s columns.

const string	NO_COUNT = “no_count”
	Return a count of 0 for the union table response to avoid the cost of counting; optimization needed for many chunk virtual unions.

Detailed Description

A set of string constants for the parameter CreateUnionRequest.options.

Optional parameters.

Definition at line 36 of file CreateUnion.cs.

Member Data Documentation

◆ CHUNK_COLUMN_MAX_MEMORY

const string kinetica.CreateUnionRequest.Options.CHUNK_COLUMN_MAX_MEMORY = “chunk_column_max_memory”

static

Indicates the target maximum data size for each column in a chunk to be used for this output table.

Definition at line 183 of file CreateUnion.cs.

◆ CHUNK_MAX_MEMORY

const string kinetica.CreateUnionRequest.Options.CHUNK_MAX_MEMORY = “chunk_max_memory”

static

Indicates the target maximum data size for all columns in a chunk to be used for this output table.

Definition at line 187 of file CreateUnion.cs.

◆ CHUNK_SIZE

const string kinetica.CreateUnionRequest.Options.CHUNK_SIZE = “chunk_size”

static

Indicates the number of records per chunk to be used for this output table.

Definition at line 179 of file CreateUnion.cs.

◆ COLLECTION_NAME

const string kinetica.CreateUnionRequest.Options.COLLECTION_NAME = “collection_name”

static

[DEPRECATED–please specify the containing schema for the projection as part of CreateUnionRequest.table_name and use Kinetica.createSchema to create the schema if non-existent] Name of the schema for the output table.

If the schema provided is non-existent, it will be automatically created. The default value is ”.

Definition at line 81 of file CreateUnion.cs.

◆ COMPRESSION_CODEC

const string kinetica.CreateUnionRequest.Options.COMPRESSION_CODEC = “compression_codec”

static

The default compression codec for this table’s columns.

Definition at line 378 of file CreateUnion.cs.

◆ CREATE_INDEXES

const string kinetica.CreateUnionRequest.Options.CREATE_INDEXES = “create_indexes”

static

Comma-separated list of columns on which to create indexes on the output table.

The columns specified must be present in CreateUnionRequest.output_column_names.

Definition at line 193 of file CreateUnion.cs.

◆ CREATE_TEMP_TABLE

const string kinetica.CreateUnionRequest.Options.CREATE_TEMP_TABLE = “create_temp_table”

static

If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of CreateUnionRequest.table_name.

If PERSIST is FALSE (or unspecified), 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.

Definition at line 63 of file CreateUnion.cs.

◆ EXCEPT

const string kinetica.CreateUnionRequest.Options.EXCEPT = “except”

static

Retains all unique rows from the first table that do not appear in the second table (only works on 2 tables).

Definition at line 162 of file CreateUnion.cs.

◆ EXCEPT_ALL

const string kinetica.CreateUnionRequest.Options.EXCEPT_ALL = “except_all”

static

Retains all rows(including duplicates) from the first table that do not appear in the second table (only works on 2 tables).

Definition at line 167 of file CreateUnion.cs.

◆ FALSE

const string kinetica.CreateUnionRequest.Options.FALSE = “false”

static

A boolean constant for the CreateUnionRequest.Options options.

Definition at line 71 of file CreateUnion.cs.

◆ FORCE_REPLICATED

const string kinetica.CreateUnionRequest.Options.FORCE_REPLICATED = “force_replicated”

static

If TRUE, then the output table specified in CreateUnionRequest.table_name will be replicated even if the source tables are not.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 367 of file CreateUnion.cs.

◆ HASH

const string kinetica.CreateUnionRequest.Options.HASH = “HASH”

static

Use hash partitioning.

Definition at line 258 of file CreateUnion.cs.

◆ INTERSECT

const string kinetica.CreateUnionRequest.Options.INTERSECT = “intersect”

static

Retains all unique rows that appear in both of the specified tables (only works on 2 tables).

Definition at line 171 of file CreateUnion.cs.

◆ INTERSECT_ALL

const string kinetica.CreateUnionRequest.Options.INTERSECT_ALL = “intersect_all”

static

Retains all rows(including duplicates) that appear in both of the specified tables (only works on 2 tables).

Definition at line 175 of file CreateUnion.cs.

◆ INTERVAL

const string kinetica.CreateUnionRequest.Options.INTERVAL = “INTERVAL”

static

Use interval partitioning.

Definition at line 248 of file CreateUnion.cs.

◆ IS_AUTOMATIC_PARTITION

const string kinetica.CreateUnionRequest.Options.IS_AUTOMATIC_PARTITION = “is_automatic_partition”

static

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.

Definition at line 310 of file CreateUnion.cs.

◆ LIST

const string kinetica.CreateUnionRequest.Options.LIST = “LIST”

static

Use list partitioning.

Definition at line 253 of file CreateUnion.cs.

◆ MODE

const string kinetica.CreateUnionRequest.Options.MODE = “mode”

static

The mode describes what rows of the tables being unioned will be retained.

Supported values:

UNION_ALL: Retains all rows from the specified tables.
UNION: Retains all unique rows from the specified tables (synonym for UNION_DISTINCT).
UNION_DISTINCT: Retains all unique rows from the specified tables.
EXCEPT: Retains all unique rows from the first table that do not appear in the second table (only works on 2 tables).
EXCEPT_ALL: Retains all rows(including duplicates) from the first table that do not appear in the second table (only works on 2 tables).
INTERSECT: Retains all unique rows that appear in both of the specified tables (only works on 2 tables).
INTERSECT_ALL: Retains all rows(including duplicates) that appear in both of the specified tables (only works on 2 tables).

The default value is UNION_ALL.

Definition at line 145 of file CreateUnion.cs.

◆ NO_COUNT

const string kinetica.CreateUnionRequest.Options.NO_COUNT = “no_count”

static

Return a count of 0 for the union table response to avoid the cost of counting; optimization needed for many chunk virtual unions.

The default value is ‘false’.

Definition at line 384 of file CreateUnion.cs.

◆ PARTITION_DEFINITIONS

const string kinetica.CreateUnionRequest.Options.PARTITION_DEFINITIONS = “partition_definitions”

static

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.

Definition at line 288 of file CreateUnion.cs.

◆ PARTITION_KEYS

const string kinetica.CreateUnionRequest.Options.PARTITION_KEYS = “partition_keys”

static

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.

Definition at line 270 of file CreateUnion.cs.

◆ PARTITION_TYPE

const string kinetica.CreateUnionRequest.Options.PARTITION_TYPE = “partition_type”

static

Partitioning scheme to use for the output table.

Supported values:

Definition at line 238 of file CreateUnion.cs.

◆ PERSIST

const string kinetica.CreateUnionRequest.Options.PERSIST = “persist”

static

If TRUE, then the output table specified in CreateUnionRequest.table_name will be persisted and will not expire unless a TTL is specified.

If FALSE, then the output table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 342 of file CreateUnion.cs.

◆ RANGE

const string kinetica.CreateUnionRequest.Options.RANGE = “RANGE”

static

Use range partitioning.

Definition at line 243 of file CreateUnion.cs.

◆ SERIES

const string kinetica.CreateUnionRequest.Options.SERIES = “SERIES”

static

Use series partitioning.

Definition at line 263 of file CreateUnion.cs.

◆ STRATEGY_DEFINITION

const string kinetica.CreateUnionRequest.Options.STRATEGY_DEFINITION = “strategy_definition”

static

The tier strategy for the table and its columns.

Definition at line 372 of file CreateUnion.cs.

◆ TRUE

const string kinetica.CreateUnionRequest.Options.TRUE = “true”

static

A boolean constant for the CreateUnionRequest.Options options.

Definition at line 67 of file CreateUnion.cs.

◆ TTL

const string kinetica.CreateUnionRequest.Options.TTL = “ttl”

static

Sets the TTL of the output table specified in CreateUnionRequest.table_name.

Definition at line 315 of file CreateUnion.cs.

◆ UNION

const string kinetica.CreateUnionRequest.Options.UNION = “union”

static

Retains all unique rows from the specified tables (synonym for UNION_DISTINCT).

Definition at line 154 of file CreateUnion.cs.

◆ UNION_ALL

const string kinetica.CreateUnionRequest.Options.UNION_ALL = “union_all”

static

Retains all rows from the specified tables.

Definition at line 148 of file CreateUnion.cs.

◆ UNION_DISTINCT

const string kinetica.CreateUnionRequest.Options.UNION_DISTINCT = “union_distinct”

static

Retains all unique rows from the specified tables.

Definition at line 158 of file CreateUnion.cs.

◆ VIEW_ID

const string kinetica.CreateUnionRequest.Options.VIEW_ID = “view_id”

static

ID of view of which this output table is a member.

The default value is ”.

Definition at line 347 of file CreateUnion.cs.

The documentation for this struct was generated from the following files:

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

​ Static Public Attributes

​Detailed Description

​Member Data Documentation

​◆ CHUNK_COLUMN_MAX_MEMORY

​◆ CHUNK_MAX_MEMORY

​◆ CHUNK_SIZE

​◆ COLLECTION_NAME

​◆ COMPRESSION_CODEC

​◆ CREATE_INDEXES

​◆ CREATE_TEMP_TABLE

​◆ EXCEPT

​◆ EXCEPT_ALL

​◆ FALSE

​◆ FORCE_REPLICATED

​◆ HASH

​◆ INTERSECT

​◆ INTERSECT_ALL

​◆ INTERVAL

​◆ IS_AUTOMATIC_PARTITION

​◆ LIST

​◆ MODE

​◆ NO_COUNT

​◆ PARTITION_DEFINITIONS

​◆ PARTITION_KEYS

​◆ PARTITION_TYPE

​◆ PERSIST

​◆ RANGE

​◆ SERIES

​◆ STRATEGY_DEFINITION

​◆ TRUE

​◆ TTL

​◆ UNION

​◆ UNION_ALL

​◆ UNION_DISTINCT

​◆ VIEW_ID

Static Public Attributes

Detailed Description

Member Data Documentation

◆ CHUNK_COLUMN_MAX_MEMORY

◆ CHUNK_MAX_MEMORY

◆ CHUNK_SIZE

◆ COLLECTION_NAME

◆ COMPRESSION_CODEC

◆ CREATE_INDEXES

◆ CREATE_TEMP_TABLE

◆ EXCEPT

◆ EXCEPT_ALL

◆ FALSE

◆ FORCE_REPLICATED

◆ HASH

◆ INTERSECT

◆ INTERSECT_ALL

◆ INTERVAL

◆ IS_AUTOMATIC_PARTITION

◆ LIST

◆ MODE

◆ NO_COUNT

◆ PARTITION_DEFINITIONS

◆ PARTITION_KEYS

◆ PARTITION_TYPE

◆ PERSIST

◆ RANGE

◆ SERIES

◆ STRATEGY_DEFINITION

◆ TRUE

◆ TTL

◆ UNION

◆ UNION_ALL

◆ UNION_DISTINCT

◆ VIEW_ID