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 options. More...

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

	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. More...

	CreateJoinTableRequest ()
	Constructs a CreateJoinTableRequest object with default parameters. More...

	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. 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...

	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, in [schema_name. More...

IList< string >	table_names = new List<string>() `[get, set]`
	The list of table names composing the join, each in [schema_name. 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 Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

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...

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.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 20 of file CreateJoinTable.cs.

Constructor & Destructor Documentation

◆ CreateJoinTableRequest() [1/4]

kinetica.CreateJoinTableRequest.CreateJoinTableRequest ( )

inline

Constructs a CreateJoinTableRequest object with default parameters.

Definition at line 327 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: TRUE FALSE 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. OPTIMIZE_LOOKUPS: Use more memory to speed up the joining of tables. Supported values: TRUE FALSE The default value is FALSE. 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_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 507 of file CreateJoinTable.cs.

◆ CreateJoinTableRequest() [3/4]

kinetica.CreateJoinTableRequest.CreateJoinTableRequest ( )

inline

Constructs a CreateJoinTableRequest object with default parameters.

Definition at line 340 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: TRUE FALSE 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. OPTIMIZE_LOOKUPS: Use more memory to speed up the joining of tables. Supported values: TRUE FALSE The default value is FALSE. 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 528 of file CreateJoinTable.cs.

Property Documentation

◆ column_names

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 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 164 of file CreateJoinTable.cs.

◆ expressions

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. The default value is an empty List.

Definition at line 172 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 144 of file CreateJoinTable.cs.

◆ options

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

getset

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:
- TRUE
- FALSE
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.
OPTIMIZE_LOOKUPS: Use more memory to speed up the joining of tables. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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_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.

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:
- TRUE
- FALSE
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.
OPTIMIZE_LOOKUPS: Use more memory to speed up the joining of tables. Supported values:
- TRUE
- FALSE
The default value is FALSE.
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 323 of file CreateJoinTable.cs.

◆ table_names

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

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 152 of file CreateJoinTable.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/CreateJoinTable.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateJoinTableRequest() [1/4]

◆ CreateJoinTableRequest() [2/4]

◆ CreateJoinTableRequest() [3/4]

◆ CreateJoinTableRequest() [4/4]

Property Documentation

◆ column_names

◆ expressions

◆ join_table_name

◆ options

◆ table_names