Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 TTL = "ttl"
 Sets the TTL of the table specified in <member name="table_name">. More...
 
const string PERSIST = "persist"
 If true then the union will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). 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. Values: true, 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. Values: union_all, union, union_distinct, except, intersect, merge_views.
  • ttl Sets the TTL of the table specified in . The value must be the desired TTL in minutes.
  • persist If true then the union will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations). If false then the union will be a read-only, memory-only temporary table. Values: true, false.


A set of string constants for the parameter <member name="options">.

Definition at line 71 of file CreateUnion.cs.

Member Data Documentation

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 78 of file CreateUnion.cs.

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 108 of file CreateUnion.cs.

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

Definition at line 85 of file CreateUnion.cs.

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 112 of file CreateUnion.cs.

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.

Values: true, false.

Definition at line 83 of file CreateUnion.cs.

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.

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 121 of file CreateUnion.cs.

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. Values: union_all, union, union_distinct, except, intersect, merge_views.

Definition at line 92 of file CreateUnion.cs.

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

If true then the union will be persisted as a regular table (it will not be automatically cleared unless a ttl is provided, and the table data can be modified in subsequent operations).

If false then the union will be a read-only, memory-only temporary table. Values: true, false.

Definition at line 134 of file CreateUnion.cs.

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

Definition at line 84 of file CreateUnion.cs.

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

Sets the TTL of the table specified in <member name="table_name">.

The value must be the desired TTL in minutes.

Definition at line 126 of file CreateUnion.cs.

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

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

Definition at line 99 of file CreateUnion.cs.

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

Retains all rows from the specified tables.

Definition at line 95 of file CreateUnion.cs.

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

Retains all unique rows from the specified tables.

Definition at line 103 of file CreateUnion.cs.


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