kinetica.CreateUnionRequest Class Reference

A set of parameters for /create/union. 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 /create/union.

Performs a union (concatenation) of one or more existing tables or views, the results of which are stored in a new view. 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 26 of file CreateUnion.cs.

Constructor & Destructor Documentation

kinetica.CreateUnionRequest.CreateUnionRequest ( )

inline

Constructs a CreateUnionRequest object with default parameters.

Definition at line 200 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_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. 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.

Definition at line 257 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 149 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 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.

Definition at line 195 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 union.

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

IList<string> kinetica.CreateUnionRequest.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 145 of file CreateUnion.cs.

---

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

• Kinetica/Protocol/CreateUnion.cs