Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Classes | Public Member Functions | Properties | List of all members
kinetica.CreateUnionRequest Class Reference

A set of parameters for Kinetica.createUnion(string,IList{string},IList{IList{string}},IList{string},IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.CreateUnionRequest:
+ Collaboration diagram for kinetica.CreateUnionRequest:

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

 CreateUnionRequest ()
 Constructs a CreateUnionRequest object with default parameters. More...
 
 CreateUnionRequest (string table_name, IList< string > table_names, IList< IList< string >> input_column_names, IList< string > output_column_names, IDictionary< string, string > options=null)
 Constructs a CreateUnionRequest object with the specified parameters. More...
 
- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 

Properties

string table_name [get, set]
 Name of the table to be created. More...
 
IList< string > table_names [get, set]
 The list of table names to merge. More...
 
IList< IList< string > > input_column_names = new List<string>() [get, set]
 The list of columns from each of the corresponding input tables. More...
 
IList< string > output_column_names = new List<IList<string>>() [get, set]
 The list of names of the columns to be stored in the output table. More...
 
IDictionary< string, string > options = new List<string>() [get, set]
 Optional parameters. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

Additional Inherited Members

- Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema SchemaFromType (System.Type t, KineticaType ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType. More...
 

Detailed Description

A set of parameters for Kinetica.createUnion(string,IList{string},IList{IList{string}},IList{string},IDictionary{string, string}).


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.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.

Definition at line 48 of file CreateUnion.cs.

Constructor & Destructor Documentation

kinetica.CreateUnionRequest.CreateUnionRequest ( )
inline

Constructs a CreateUnionRequest object with default parameters.

Definition at line 632 of file CreateUnion.cs.

kinetica.CreateUnionRequest.CreateUnionRequest ( string  table_name,
IList< string >  table_names,
IList< IList< string >>  input_column_names,
IList< string >  output_column_names,
IDictionary< string, string >  options = null 
)
inline

Constructs a CreateUnionRequest object with the specified parameters.

Parameters
table_nameName of the table to be created. Has the same naming restrictions as tables.
table_namesThe list of table names to merge. 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.
  • 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: No longer used. See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. Supported values: 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 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.
The default value is an empty Dictionary.

Definition at line 824 of file CreateUnion.cs.

Property Documentation

IList<IList<string> > kinetica.CreateUnionRequest.input_column_names = new List<string>()
getset

The list of columns from each of the corresponding input tables.

Definition at line 444 of file CreateUnion.cs.

IDictionary<string, string> kinetica.CreateUnionRequest.options = new List<string>()
getset

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: No longer used. See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. Supported values: 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 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.

The default value is an empty Dictionary.

Definition at line 627 of file CreateUnion.cs.

IList<string> kinetica.CreateUnionRequest.output_column_names = new List<IList<string>>()
getset

The list of names of the columns to be stored in the output table.

Definition at line 448 of file CreateUnion.cs.

string kinetica.CreateUnionRequest.table_name
getset

Name of the table to be created.

Has the same naming restrictions as tables.

Definition at line 436 of file CreateUnion.cs.

IList<string> kinetica.CreateUnionRequest.table_names
getset

The list of table names to merge.

Must contain the names of one or more existing tables.

Definition at line 440 of file CreateUnion.cs.

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