Optional parameters. More...

Public Attributes
const string	COLLECTION_NAME = "collection_name"
	Name of a collection which is to contain the output table. More...

const string	MATERIALIZE_ON_GPU = "materialize_on_gpu"
	If true, then the columns of the output table 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 the provided views. 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	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). 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	INTERSECT_ALL = "intersect_all"
	Retains all rows(including duplicates) 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	CREATE_INDEXES = "create_indexes"
	Comma-separated list of columns on which to create indexes on the output 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 table specified in table_name will be persisted and will not expire unless a ttl is specified. More...

const string	VIEW_ID = "view_id"
	view the output table will be a part of. More...

const string	FORCE_REPLICATED = "force_replicated"
	If true, then the table specified in table_name will be replicated even if the source tables are not. More...

Detailed Description

Optional parameters.

COLLECTION_NAME: Name of a collection which is to contain the output table. If the collection provided is non-existent, the collection will be automatically created. If empty, the output table will be a top-level table. The default value is ''.
MATERIALIZE_ON_GPU: If true, then the columns of the output table will be cached on the GPU. Supported values:
- TRUE
- FALSE
The default value is FALSE.
MODE: If merge_views, then this operation will merge the provided views. All 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).
- 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).
- 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 = 20' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 20 OR x <= 10'.
The default value is UNION_ALL.
CHUNK_SIZE: Indicates the chunk size to be used for this table.
CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in .
TTL: Sets the TTL of the table specified in .
PERSIST: If true, then the table specified in will be persisted and will not expire unless a ttl is specified. If false, then the 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: view the output table will be a part of. The default value is ''.
FORCE_REPLICATED: If true, then the table specified in will be replicated even if the source tables are not. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary. A set of string constants for the parameter options.

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

◆ COLLECTION_NAME

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

Name of a collection which is to contain the output table.

If the collection provided is non-existent, the collection will be automatically created. If empty, the output table will be a top-level table. The default value is ''.

Definition at line 233 of file CreateUnion.cs.

◆ CREATE_INDEXES

const string kinetica.CreateUnionRequest.Options.CREATE_INDEXES = "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.

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

◆ EXCEPT_ALL

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

Definition at line 342 of file CreateUnion.cs.

◆ FALSE

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

Definition at line 252 of file CreateUnion.cs.

◆ FORCE_REPLICATED

const string kinetica.CreateUnionRequest.Options.FORCE_REPLICATED = "force_replicated"

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

Supported values:

TRUE
FALSE

The default value is FALSE.

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

◆ INTERSECT_ALL

const string kinetica.CreateUnionRequest.Options.INTERSECT_ALL = "intersect_all"

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

Definition at line 351 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 output table will be cached on the GPU.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 250 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 = 20' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 20 OR x <= 10'.

Definition at line 362 of file CreateUnion.cs.

◆ MODE

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

If merge_views, then this operation will merge 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).
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).
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 = 20' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 20 OR x <= 10'.

The default value is UNION_ALL.

Definition at line 321 of file CreateUnion.cs.

◆ PERSIST

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

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

If false, then the 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 396 of file CreateUnion.cs.

◆ TRUE

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

Definition at line 251 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 376 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 328 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 324 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 332 of file CreateUnion.cs.

◆ VIEW_ID

const string kinetica.CreateUnionRequest.Options.VIEW_ID = "view_id"

view the output table will be a part of.

The default value is ''.

Definition at line 400 of file CreateUnion.cs.

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

Kinetica/Protocol/CreateUnion.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ CHUNK_SIZE

◆ COLLECTION_NAME

◆ CREATE_INDEXES

◆ EXCEPT

◆ EXCEPT_ALL

◆ FALSE

◆ FORCE_REPLICATED

◆ INTERSECT

◆ INTERSECT_ALL

◆ MATERIALIZE_ON_GPU

◆ MERGE_VIEWS

◆ MODE

◆ PERSIST

◆ TRUE

◆ TTL

◆ UNION

◆ UNION_ALL

◆ UNION_DISTINCT

◆ VIEW_ID