Kinetica C# API  Version 6.1.0.0
Public Attributes | List of all members
kinetica.CreateUnionRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string COLLECTION_NAME = "collection_name"
 Name of a collection which is to contain the union. More...
 
const string MATERIALIZE_ON_GPU = "materialize_on_gpu"
 If 'true' then the columns of the union will be cached on the GPU. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string MODE = "mode"
 If 'merge_views' then this operation will merge (i.e. More...
 
const string UNION_ALL = "union_all"
 Retains all rows from the specified tables. More...
 
const string UNION = "union"
 Retains all unique rows from the specified tables (synonym for 'union_distinct'). More...
 
const string UNION_DISTINCT = "union_distinct"
 Retains all unique rows from the specified tables. More...
 
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). More...
 
const string INTERSECT = "intersect"
 Retains all unique rows that appear in both of the specified tables (only works on 2 tables). More...
 
const string MERGE_VIEWS = "merge_views"
 Merge two or more views (or views of views) of the same base data set into a new view. More...
 
const string CHUNK_SIZE = "chunk_size"
 Indicates the chunk size to be used for this table. More...
 
const string TTL = "ttl"
 Sets the TTL of the table specified in table_name. More...
 
const string PERSIST = "persist"
 If true, then the union specified in table_name will be persisted and will not expire unless a ttl is specified. More...
 

Detailed Description

Optional parameters.

  • COLLECTION_NAME: Name of a collection which is to contain the union. If the collection provided is non-existent, the collection will be automatically created. If empty, then the union will be a top-level table.
  • MATERIALIZE_ON_GPU: If 'true' then the columns of the union will be cached on the GPU. Supported values: The default value is FALSE.
  • MODE: If 'merge_views' then this operation will merge (i.e. union) the provided views. All 'table_names' must be views from the same underlying base table. 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).
    • INTERSECT: Retains all unique rows that appear in both of the specified tables (only works on 2 tables).
    • MERGE_VIEWS: Merge two or more views (or views of views) of the same base data set into a new view. If this mode is selected AND must be empty. The resulting view would match the results of a SQL OR operation, e.g., if filter 1 creates a view using the expression 'x = 10' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 10 OR x <= 10'.
    The default value is UNION_ALL.
  • CHUNK_SIZE: Indicates the chunk size to be used for this table.
  • TTL: Sets the TTL of the table specified in .
  • PERSIST: If true, then the union specified in will be persisted and will not expire unless a ttl is specified. If false, then the union will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is FALSE.


A set of string constants for the parameter options.

Definition at line 156 of file CreateUnion.cs.

Member Data Documentation

◆ CHUNK_SIZE

const string kinetica.CreateUnionRequest.Options.CHUNK_SIZE = "chunk_size"

Indicates the chunk size to be used for this table.

Definition at line 272 of file CreateUnion.cs.

◆ COLLECTION_NAME

const string kinetica.CreateUnionRequest.Options.COLLECTION_NAME = "collection_name"

Name of a collection which is to contain the union.

If the collection provided is non-existent, the collection will be automatically created. If empty, then the union will be a top-level table.

Definition at line 163 of file CreateUnion.cs.

◆ EXCEPT

const string kinetica.CreateUnionRequest.Options.EXCEPT = "except"

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

Definition at line 253 of file CreateUnion.cs.

◆ FALSE

const string kinetica.CreateUnionRequest.Options.FALSE = "false"

Definition at line 182 of file CreateUnion.cs.

◆ INTERSECT

const string kinetica.CreateUnionRequest.Options.INTERSECT = "intersect"

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

Definition at line 257 of file CreateUnion.cs.

◆ MATERIALIZE_ON_GPU

const string kinetica.CreateUnionRequest.Options.MATERIALIZE_ON_GPU = "materialize_on_gpu"

If 'true' then the columns of the union will be cached on the GPU.

Supported values:

The default value is FALSE.

Definition at line 180 of file CreateUnion.cs.

◆ MERGE_VIEWS

const string kinetica.CreateUnionRequest.Options.MERGE_VIEWS = "merge_views"

Merge two or more views (or views of views) of the same base data set into a new view.

If this mode is selected input_column_names AND output_column_names must be empty. The resulting view would match the results of a SQL OR operation, e.g., if filter 1 creates a view using the expression 'x = 10' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 10 OR x <= 10'.

Definition at line 268 of file CreateUnion.cs.

◆ MODE

const string kinetica.CreateUnionRequest.Options.MODE = "mode"

If 'merge_views' then this operation will merge (i.e.

union) the provided views. All 'table_names' must be views from the same underlying base table. 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).
  • INTERSECT: Retains all unique rows that appear in both of the specified tables (only works on 2 tables).
  • MERGE_VIEWS: Merge two or more views (or views of views) of the same base data set into a new view. If this mode is selected input_column_names AND output_column_names must be empty. The resulting view would match the results of a SQL OR operation, e.g., if filter 1 creates a view using the expression 'x = 10' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 10 OR x <= 10'.

The default value is UNION_ALL.

Definition at line 237 of file CreateUnion.cs.

◆ PERSIST

const string kinetica.CreateUnionRequest.Options.PERSIST = "persist"

If true, then the union specified in table_name will be persisted and will not expire unless a ttl is specified.

If false, then the union will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:

The default value is FALSE.

Definition at line 297 of file CreateUnion.cs.

◆ TRUE

const string kinetica.CreateUnionRequest.Options.TRUE = "true"

Definition at line 181 of file CreateUnion.cs.

◆ TTL

const string kinetica.CreateUnionRequest.Options.TTL = "ttl"

Sets the TTL of the table specified in table_name.

Definition at line 277 of file CreateUnion.cs.

◆ UNION

const string kinetica.CreateUnionRequest.Options.UNION = "union"

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

Definition at line 244 of file CreateUnion.cs.

◆ UNION_ALL

const string kinetica.CreateUnionRequest.Options.UNION_ALL = "union_all"

Retains all rows from the specified tables.

Definition at line 240 of file CreateUnion.cs.

◆ UNION_DISTINCT

const string kinetica.CreateUnionRequest.Options.UNION_DISTINCT = "union_distinct"

Retains all unique rows from the specified tables.

Definition at line 248 of file CreateUnion.cs.

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