Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.CreateUnionRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string CREATE_TEMP_TABLE = "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. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string COLLECTION_NAME = "collection_name"
 [DEPRECATED–please specify the containing schema for the projection as part of table_name and use Kinetica.createSchema(string,IDictionary{string, string}) to create the schema if non-existent] Name of the schema for the output table. More...
 
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 number of records per chunk to be used for this output 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 output table specified in table_name. More...
 
const string PERSIST = "persist"
 If true, then the output table specified in table_name will be persisted and will not expire unless a ttl is specified. More...
 
const string VIEW_ID = "view_id"
 ID of view of which this output table is a member. More...
 
const string FORCE_REPLICATED = "force_replicated"
 If true, then the output table specified in table_name will be replicated even if the source tables are not. More...
 
const string STRATEGY_DEFINITION = "strategy_definition"
 The tier strategy for the table and its columns. More...
 

Detailed Description

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 . 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 and use /create/schema 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: 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 number of records per 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 .
  • TTL: Sets the TTL of the output table specified in .
  • PERSIST: If true, then the output table specified in 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 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.

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

Definition at line 238 of file CreateUnion.cs.

Member Data Documentation

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

Indicates the number of records per chunk to be used for this output table.

Definition at line 386 of file CreateUnion.cs.

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

[DEPRECATED–please specify the containing schema for the projection as part of table_name and use Kinetica.createSchema(string,IDictionary{string, string}) 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 ''.

Definition at line 272 of file CreateUnion.cs.

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

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

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

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

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

Definition at line 262 of file CreateUnion.cs.

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

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

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 371 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.

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

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

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

Definition at line 416 of file CreateUnion.cs.

const string kinetica.CreateUnionRequest.Options.STRATEGY_DEFINITION = "strategy_definition"

The tier strategy for the table and its columns.

Definition at line 443 of file CreateUnion.cs.

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

Definition at line 261 of file CreateUnion.cs.

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

Sets the TTL of the output table specified in table_name.

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

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

Retains all rows from the specified tables.

Definition at line 344 of file CreateUnion.cs.

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

Retains all unique rows from the specified tables.

Definition at line 352 of file CreateUnion.cs.

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

ID of view of which this output table is a member.

The default value is ''.

Definition at line 420 of file CreateUnion.cs.


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