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 making up the union. 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 union. 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>).
Performs a union (concatenation) of one or more existing tables or views, the results of which are stored in a new table. It is equivalent to the SQL UNION ALL operator. Non-charN 'string' and 'bytes' column types cannot be included in a union, neither can columns with the property 'store_only'. Though not explicitly unions, intersect and except are also available from this endpoint.
Definition at line 28 of file CreateUnion.cs.
Constructor & Destructor Documentation
◆ CreateUnionRequest() [1/2]
|
inline |
Constructs a CreateUnionRequest object with default parameters.
Definition at line 446 of file CreateUnion.cs.
◆ CreateUnionRequest() [2/2]
|
inline |
Constructs a CreateUnionRequest object with the specified parameters.
- Parameters
-
table_name Name of the table to be created. Has the same naming restrictions as tables. table_names The list of table names making up the union. Must contain the names of one or more existing tables. input_column_names The list of columns from each of the corresponding input tables. output_column_names The list of names of the columns to be stored in the union. options 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'.
- 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.
Definition at line 586 of file CreateUnion.cs.
Property Documentation
◆ input_column_names
|
getset |
The list of columns from each of the corresponding input tables.
Definition at line 312 of file CreateUnion.cs.
◆ options
|
getset |
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'.
- 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.
Definition at line 441 of file CreateUnion.cs.
◆ output_column_names
|
getset |
The list of names of the columns to be stored in the union.
Definition at line 316 of file CreateUnion.cs.
◆ table_name
|
getset |
Name of the table to be created.
Has the same naming restrictions as tables.
Definition at line 304 of file CreateUnion.cs.
◆ table_names
|
getset |
The list of table names making up the union.
Must contain the names of one or more existing tables.
Definition at line 308 of file CreateUnion.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/CreateUnion.cs
