Skip to main content

​
◆ createUnion() [1/2]

CreateUnionResponse kinetica.Kinetica.createUnion (CreateUnionRequestrequest_)
 inline

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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 29899 of file KineticaFunctions.cs.

​
◆ createUnion() [2/2]

CreateUnionResponse kinetica.Kinetica.createUnion (stringtable_name,
IList< string >table_names,
IList< IList< string > >input_column_names,
IList< string >output_column_names,
IDictionary< string, string >options = null )
 inline

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.

Parameters
table_nameName of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.
table_namesThe 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_namesThe list of columns from each of the corresponding input tables.
output_column_namesThe list of names of the columns to be stored in the output table.
optionsOptional 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:The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the projection as part of table_name and use 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.
  • 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 .
  • PARTITION_TYPE: Partitioning scheme to use for the output table. Supported values:
  • 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:The default value is FALSE.
  • 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: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: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 unions. The default value is ‘false’.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 30323 of file KineticaFunctions.cs.

​
◆ CreateUnionAsync() [1/2]

async System.Threading.Tasks.Task< CreateUnionResponse > kinetica.Kinetica.CreateUnionAsync (CreateUnionRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

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

(async)

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.

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 29931 of file KineticaFunctions.cs.

​
◆ CreateUnionAsync() [2/2]

async System.Threading.Tasks.Task< CreateUnionResponse > kinetica.Kinetica.CreateUnionAsync (stringtable_name,
IList< string >table_names,
IList< IList< string > >input_column_names,
IList< string >output_column_names,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

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

(async)

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.

Parameters
table_nameName of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.
table_namesThe 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_namesThe list of columns from each of the corresponding input tables.
output_column_namesThe list of names of the columns to be stored in the output table.
optionsOptional 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:The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the projection as part of table_name and use 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.
  • 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 .
  • PARTITION_TYPE: Partitioning scheme to use for the output table. Supported values:
  • 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:The default value is FALSE.
  • 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: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: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 unions. The default value is ‘false’.
The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 30720 of file KineticaFunctions.cs.