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

Inheritance diagram for kinetica.CreateUnionRequest:

Collaboration diagram for kinetica.CreateUnionRequest:

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

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

	CreateUnionRequest (string table_name, IList< string > table_names, IList< IList< string >> input_column_names, IList< string > output_column_names, IDictionary< string, string > options=null)
	Constructs a CreateUnionRequest object with the specified parameters. More...

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

	CreateUnionRequest (string table_name, IList< string > table_names, IList< IList< string >> input_column_names, IList< string > output_column_names, IDictionary< string, string > options=null)
	Constructs a CreateUnionRequest 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...

IList< string >	table_names = new List<string>() `[get, set]`
	The list of table names to merge, in [schema_name. More...

IList< IList< string > >	input_column_names = new List<IList<string>>() `[get, set]`
	The list of columns from each of the corresponding input tables. More...

IList< string >	output_column_names = new List<string>() `[get, set]`
	The list of names of the columns to be stored in the output table. 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.createUnion.

Merges data from one or more tables with comparable data types into a new table.

The following merges are supported:

UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.

INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.

EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.

MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.

Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.

Definition at line 40 of file CreateUnion.cs.

Constructor & Destructor Documentation

◆ CreateUnionRequest() [1/4]

kinetica.CreateUnionRequest.CreateUnionRequest ( )

inline

Constructs a CreateUnionRequest object with default parameters.

Definition at line 491 of file CreateUnion.cs.

◆ CreateUnionRequest() [2/4]

kinetica.CreateUnionRequest.CreateUnionRequest	(	string	table_name,
		IList< string >	table_names,
		IList< IList< string >>	input_column_names,
		IList< string >	output_column_names,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateUnionRequest 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.
table_names	The list of table names to merge, in [schema_name.]table_name format, using standard name resolution rules. Must contain the names of one or more existing tables.
input_column_names	The list of columns from each of the corresponding input tables.
output_column_names	The list of names of the columns to be stored in the output table.
options	Optional parameters. 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 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. COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the projection as part of 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 ''. MODE: 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. LONG_HASH: When true use 128 bit hash for union-distinct, except, except_all, intersect and intersect_all modes. Otherwise use 64 bit hash. CHUNK_SIZE: Indicates the number of records per chunk to be used for this output table. CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this output table. CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this output table. CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in output_column_names . TTL: Sets the TTL of the output table specified in table_name . PERSIST: If TRUE, then the output table specified in 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. VIEW_ID: ID of view of which this output table is a member. The default value is ''. FORCE_REPLICATED: If TRUE, then the output table specified in table_name will be replicated even if the source tables are not. 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. NO_COUNT: Return a count of 0 for the union table response to avoid the cost of counting; optimization needed for many chunk virtual_union's. The default value is 'false'. The default value is an empty Dictionary.

Definition at line 726 of file CreateUnion.cs.

◆ CreateUnionRequest() [3/4]

kinetica.CreateUnionRequest.CreateUnionRequest ( )

inline

Constructs a CreateUnionRequest object with default parameters.

Definition at line 491 of file CreateUnion.cs.

◆ CreateUnionRequest() [4/4]

kinetica.CreateUnionRequest.CreateUnionRequest	(	string	table_name,
		IList< string >	table_names,
		IList< IList< string >>	input_column_names,
		IList< string >	output_column_names,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateUnionRequest 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.
table_names	The list of table names to merge, in [schema_name.]table_name format, using standard name resolution rules. Must contain the names of one or more existing tables.
input_column_names	The list of columns from each of the corresponding input tables.
output_column_names	The list of names of the columns to be stored in the output table.
options	Optional parameters. 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 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. COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the projection as part of 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 ''. MODE: 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. LONG_HASH: When true use 128 bit hash for union-distinct, except, except_all, intersect and intersect_all modes. Otherwise use 64 bit hash. CHUNK_SIZE: Indicates the number of records per chunk to be used for this output table. CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this output table. CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this output table. CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in output_column_names . TTL: Sets the TTL of the output table specified in table_name . PERSIST: If TRUE, then the output table specified in 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. VIEW_ID: ID of view of which this output table is a member. The default value is ''. FORCE_REPLICATED: If TRUE, then the output table specified in table_name will be replicated even if the source tables are not. 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. NO_COUNT: Return a count of 0 for the union table response to avoid the cost of counting; optimization needed for many chunk virtual_union's. The default value is 'false'. The default value is an empty Dictionary.

Definition at line 726 of file CreateUnion.cs.

Property Documentation

◆ input_column_names

IList< IList< string > > kinetica.CreateUnionRequest.input_column_names = new List<IList<string>>()

getset

The list of columns from each of the corresponding input tables.

Definition at line 267 of file CreateUnion.cs.

◆ options

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

getset

Optional parameters.

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 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.
COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the projection as part of 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 ''.
MODE: 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.
LONG_HASH: When true use 128 bit hash for union-distinct, except, except_all, intersect and intersect_all modes. Otherwise use 64 bit hash.
CHUNK_SIZE: Indicates the number of records per chunk to be used for this output table.
CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this output table.
CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this output table.
CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in output_column_names.
TTL: Sets the TTL of the output table specified in table_name.
PERSIST: If TRUE, then the output table specified in 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.
VIEW_ID: ID of view of which this output table is a member. The default value is ''.
FORCE_REPLICATED: If TRUE, then the output table specified in table_name will be replicated even if the source tables are not. 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.
NO_COUNT: Return a count of 0 for the union table response to avoid the cost of counting; optimization needed for many chunk virtual_union's. The default value is 'false'.

The default value is an empty Dictionary.

Definition at line 487 of file CreateUnion.cs.

◆ output_column_names

IList< string > kinetica.CreateUnionRequest.output_column_names = new List<string>()

getset

The list of names of the columns to be stored in the output table.

Definition at line 271 of file CreateUnion.cs.

◆ table_name

string kinetica.CreateUnionRequest.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.

Definition at line 255 of file CreateUnion.cs.

◆ table_names

IList< string > kinetica.CreateUnionRequest.table_names = new List<string>()

getset

The list of table names to merge, in [schema_name.

]table_name format, using standard name resolution rules.

Must contain the names of one or more existing tables.

Definition at line 263 of file CreateUnion.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/CreateUnion.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateUnionRequest() [1/4]

◆ CreateUnionRequest() [2/4]

◆ CreateUnionRequest() [3/4]

◆ CreateUnionRequest() [4/4]

Property Documentation

◆ input_column_names

◆ options

◆ output_column_names

◆ table_name

◆ table_names