A set of parameters for /create/jointable. More...

Inheritance diagram for kinetica.CreateJoinTableRequest:

Collaboration diagram for kinetica.CreateJoinTableRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	CreateJoinTableRequest ()
	Constructs a CreateJoinTableRequest object with default parameters. More...

	CreateJoinTableRequest (string join_table_name, IList< string > table_names=null, IList< string > column_names=null, IList< string > expressions=null, IDictionary< string, string > options=null)
	Constructs a CreateJoinTableRequest 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	join_table_name `[get, set]`
	Name of the join table to be created. More...

IList< string >	table_names `[get, set]`
	The list of table names composing the join. More...

IList< string >	column_names = new List<string>() `[get, set]`
	List of member table columns or column expressions to be included in the join. More...

IList< string >	expressions = new List<string>() `[get, set]`
	An optional list of expressions to combine and filter the joined tables. 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/jointable.

Creates a table that is the result of a SQL JOIN. For details see: join concept documentation.

Definition at line 19 of file CreateJoinTable.cs.

Constructor & Destructor Documentation

kinetica.CreateJoinTableRequest.CreateJoinTableRequest ( )

inline

Constructs a CreateJoinTableRequest object with default parameters.

Definition at line 209 of file CreateJoinTable.cs.

kinetica.CreateJoinTableRequest.CreateJoinTableRequest	(	string	join_table_name,
		IList< string >	table_names = `null`,
		IList< string >	column_names = `null`,
		IList< string >	expressions = `null`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateJoinTableRequest object with the specified parameters.

Parameters

join_table_name	Name of the join table to be created. Has the same naming restrictions as tables.
table_names	The list of table names composing the join. Corresponds to a SQL statement FROM clause
column_names	List of member table columns or column expressions to be included in the join. Columns can be prefixed with 'table_id.column_name', where 'table_id' is the table name or alias. Columns can be aliased via the syntax 'column_name as alias'. Wild cards '' can be used to include all columns across member tables or 'table_id.' for all of a single table's columns. Columns and column expressions comprising the join must be uniquely named or aliased–therefore, the '*' wild card cannot be used if column names aren't unique across all tables.
expressions	An optional list of expressions to combine and filter the joined tables. Corresponds to a SQL statement WHERE clause. For details see: expressions.
options	Optional parameters. collection_name Name of a collection which is to contain the join. If the collection provided is non-existent, the collection will be automatically created. If empty, then the join will be at the top level. max_query_dimensions The maximum number of tables in a join that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate optimize_lookups Use more memory to speed up the joining of tables. Values: true, false. refresh_method Method by which the join can be refreshed when the data in underlying member tables have changed. Values: manual, on_query, on_insert. refresh Do a manual refresh of the join if it exists - throws an error otherwise Values: no_refresh, refresh, full_refresh. ttl Sets the TTL of the table specified in . The value must be the desired TTL in minutes.

Definition at line 278 of file CreateJoinTable.cs.

Property Documentation

IList<string> kinetica.CreateJoinTableRequest.column_names = new List<string>()

getset

List of member table columns or column expressions to be included in the join.

Columns can be prefixed with 'table_id.column_name', where 'table_id' is the table name or alias. Columns can be aliased via the syntax 'column_name as alias'. Wild cards '*' can be used to include all columns across member tables or 'table_id.*' for all of a single table's columns. Columns and column expressions comprising the join must be uniquely named or aliased–therefore, the '*' wild card cannot be used if column names aren't unique across all tables.

Definition at line 153 of file CreateJoinTable.cs.

IList<string> kinetica.CreateJoinTableRequest.expressions = new List<string>()

getset

An optional list of expressions to combine and filter the joined tables.

Corresponds to a SQL statement WHERE clause. For details see: expressions.

Definition at line 159 of file CreateJoinTable.cs.

string kinetica.CreateJoinTableRequest.join_table_name

getset

Name of the join table to be created.

Has the same naming restrictions as tables.

Definition at line 138 of file CreateJoinTable.cs.

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

getset

Optional parameters.

collection_name Name of a collection which is to contain the join. If the collection provided is non-existent, the collection will be automatically created. If empty, then the join will be at the top level.
max_query_dimensions The maximum number of tables in a join that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate
optimize_lookups Use more memory to speed up the joining of tables. Values: true, false.
refresh_method Method by which the join can be refreshed when the data in underlying member tables have changed. Values: manual, on_query, on_insert.
refresh Do a manual refresh of the join if it exists - throws an error otherwise Values: no_refresh, refresh, full_refresh.
ttl Sets the TTL of the table specified in . The value must be the desired TTL in minutes.

Definition at line 204 of file CreateJoinTable.cs.

IList<string> kinetica.CreateJoinTableRequest.table_names

getset

The list of table names composing the join.

Corresponds to a SQL statement FROM clause

Definition at line 142 of file CreateJoinTable.cs.

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

Kinetica/Protocol/CreateJoinTable.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation