> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.CreateJoinTableRequest > kinetica.CreateJoinTableRequest — Kinetica C# API

A set of parameters for Kinetica.createJoinTable. More...

Inheritance diagram for kinetica.CreateJoinTableRequest:
Collaboration diagram for kinetica.CreateJoinTableRequest:

Classes
struct   Options
  A set of string constants for the parameter CreateJoinTableRequest.options. More...
 

Public Member Functions
  CreateJoinTableRequest ()
  Constructs a CreateJoinTableRequest object with default parameters.
 
  CreateJoinTableRequest (string join\_table\_name, IList\< string > table\_names, IList\< string > column\_names, IList\< string > expressions=null, IDictionary\< string, string > options=null)
  Constructs a CreateJoinTableRequest object with the specified parameters.
 
  CreateJoinTableRequest ()
  Constructs a CreateJoinTableRequest object with default parameters.
 
  CreateJoinTableRequest (string join\_table\_name, IList\< string > table\_names, IList\< string > column\_names, IList\< string > expressions=null, IDictionary\< string, string > options=null)
  Constructs a CreateJoinTableRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  join\_table\_name \[get, set]
  Name of the join table to be created, in \[schema\_name.
 
IList\< string >  table\_names = new List\() \[get, set]
  The list of table names composing the join, each in \[schema\_name.
 
IList\< string >  column\_names = new List\() \[get, set]
  List of member table columns or column expressions to be included in the join.
 
IList\< string >  expressions = new List\() \[get, set]
  An optional list of expressions to combine and filter the joined tables.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

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.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.createJoinTable.

Creates a table that is the result of a SQL JOIN.

For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.

Definition at line 19 of file CreateJoinTable.cs.

Constructor & Destructor Documentation

◆ CreateJoinTableRequest() \[1/4]

kinetica.CreateJoinTableRequest.CreateJoinTableRequest ( )
inline

Constructs a CreateJoinTableRequest object with default parameters.

Definition at line 328 of file CreateJoinTable.cs.

◆ CreateJoinTableRequest() \[2/4]

kinetica.CreateJoinTableRequest.CreateJoinTableRequest ( string join\_table\_name,
IList\< string > table\_names,
IList\< string > column\_names,
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, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria.
table\_names The list of table names composing the join, each in \[schema\_name.]table\_name format, using standard name resolution rules. 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 composing 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. The default value is an empty List.
options 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 join\_table\_name . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_JOIN\_TABLE\_NAME. Supported values: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the join as part of join\_table\_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema for the join. If the schema is non-existent, it will be automatically created. The default value is ''.
  • MAX\_QUERY\_DIMENSIONS: No longer used.
  • STRATEGY\_DEFINITION: The tier strategy for the table and its columns.
  • TTL: Sets the TTL of the join table specified in join\_table\_name .
  • VIEW\_ID: View this projection is part of. The default value is ''.
  • NO\_COUNT: Return a count of 0 for the join table for logging and for Kinetica.showTable; optimization needed for large overlapped equi-join stencils. The default value is 'false'.
  • CHUNK\_SIZE: Maximum number of records per joined-chunk for this table. Defaults to the gpudb.conf file chunk size.
  • ENABLE\_VIRTUAL\_CHUNKING: Collect chunks with accumulated size less than chunk\_size into a single chunk. The default value is 'false'.
  • MAX\_VIRTUAL\_CHUNK\_SIZE: Maximum number of records per virtual-chunk. When set, enables virtual chunking. Defaults to chunk\_size if virtual chunking otherwise enabled.
  • MIN\_VIRTUAL\_CHUNK\_SIZE: Minimum number of records per virtual-chunk. When set, enables virtual chunking. Defaults to chunk\_size if virtual chunking otherwise enabled.
  • ENABLE\_SPARSE\_VIRTUAL\_CHUNKING: Materialize virtual chunks with only non-deleted values. The default value is 'false'.
  • ENABLE\_EQUI\_JOIN\_LAZY\_RESULT\_STORE: Allow using the lazy result store to cache computation of one side of a multichunk equi-join. Reduces computation but also reduces parallelism to the number of chunks on the other side of the equi-join.
  • ENABLE\_PREDICATE\_EQUI\_JOIN\_LAZY\_RESULT\_STORE: Allow using the lazy result store to cache computation of one side of a multichunk predicate-equi-join. Reduces computation but also reduces parallelism to the number of chunks on the other side of the equi-join.
  • ENABLE\_PK\_EQUI\_JOIN: Use equi-join to do primary key joins rather than using primary key index.
The default value is an empty Dictionary.

Definition at line 504 of file CreateJoinTable.cs.

◆ CreateJoinTableRequest() \[3/4]

kinetica.CreateJoinTableRequest.CreateJoinTableRequest ( )
inline

Constructs a CreateJoinTableRequest object with default parameters.

Definition at line 328 of file CreateJoinTable.cs.

◆ CreateJoinTableRequest() \[4/4]

kinetica.CreateJoinTableRequest.CreateJoinTableRequest ( string join\_table\_name,
IList\< string > table\_names,
IList\< string > column\_names,
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, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria.
table\_names The list of table names composing the join, each in \[schema\_name.]table\_name format, using standard name resolution rules. 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 composing 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. The default value is an empty List.
options 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 join\_table\_name . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_JOIN\_TABLE\_NAME. Supported values: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the join as part of join\_table\_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema for the join. If the schema is non-existent, it will be automatically created. The default value is ''.
  • MAX\_QUERY\_DIMENSIONS: No longer used.
  • STRATEGY\_DEFINITION: The tier strategy for the table and its columns.
  • TTL: Sets the TTL of the join table specified in join\_table\_name .
  • VIEW\_ID: View this projection is part of. The default value is ''.
  • NO\_COUNT: Return a count of 0 for the join table for logging and for Kinetica.showTable; optimization needed for large overlapped equi-join stencils. The default value is 'false'.
  • CHUNK\_SIZE: Maximum number of records per joined-chunk for this table. Defaults to the gpudb.conf file chunk size.
  • ENABLE\_VIRTUAL\_CHUNKING: Collect chunks with accumulated size less than chunk\_size into a single chunk. The default value is 'false'.
  • MAX\_VIRTUAL\_CHUNK\_SIZE: Maximum number of records per virtual-chunk. When set, enables virtual chunking. Defaults to chunk\_size if virtual chunking otherwise enabled.
  • MIN\_VIRTUAL\_CHUNK\_SIZE: Minimum number of records per virtual-chunk. When set, enables virtual chunking. Defaults to chunk\_size if virtual chunking otherwise enabled.
  • ENABLE\_SPARSE\_VIRTUAL\_CHUNKING: Materialize virtual chunks with only non-deleted values. The default value is 'false'.
  • ENABLE\_EQUI\_JOIN\_LAZY\_RESULT\_STORE: Allow using the lazy result store to cache computation of one side of a multichunk equi-join. Reduces computation but also reduces parallelism to the number of chunks on the other side of the equi-join.
  • ENABLE\_PREDICATE\_EQUI\_JOIN\_LAZY\_RESULT\_STORE: Allow using the lazy result store to cache computation of one side of a multichunk predicate-equi-join. Reduces computation but also reduces parallelism to the number of chunks on the other side of the equi-join.
  • ENABLE\_PK\_EQUI\_JOIN: Use equi-join to do primary key joins rather than using primary key index.
The default value is an empty Dictionary.

Definition at line 504 of file CreateJoinTable.cs.

Property Documentation

◆ column\_names

IList\< string > kinetica.CreateJoinTableRequest.column\_names = new List\()
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 composing 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 167 of file CreateJoinTable.cs.

◆ expressions

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

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

Corresponds to a SQL statement WHERE clause. For details see: expressions. The default value is an empty List.

Definition at line 175 of file CreateJoinTable.cs.

◆ join\_table\_name

string kinetica.CreateJoinTableRequest.join\_table\_name
getset

Name of the join table to be created, in \[schema\_name.

]table\_name format, using standard name resolution rules and meeting table naming criteria.

Definition at line 147 of file CreateJoinTable.cs.

◆ options

IDictionary\< string, string > kinetica.CreateJoinTableRequest.options = new Dictionary\()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 324 of file CreateJoinTable.cs.

◆ table\_names

IList\< string > kinetica.CreateJoinTableRequest.table\_names = new List\()
getset

The list of table names composing the join, each in \[schema\_name.

]table\_name format, using standard name resolution rules.

Corresponds to a SQL statement FROM clause.

Definition at line 155 of file CreateJoinTable.cs.

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