createJoinTable - Kinetica Docs

◆ createJoinTable() [1/4]

CreateJoinTableResponse gpudb::GPUdb::createJoinTable ( const CreateJoinTableRequest & request_ ) const

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.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

◆ createJoinTable() [2/4]

CreateJoinTableResponse & gpudb::GPUdb::createJoinTable	(	const CreateJoinTableRequest &	request_,
		CreateJoinTableResponse &	response_ ) const

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.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

◆ createJoinTable() [3/4]

CreateJoinTableResponse gpudb::GPUdb::createJoinTable	(	const std::string &	joinTableName,
		const std::vector< std::string > &	tableNames,
		const std::vector< std::string > &	columnNames,
		const std::vector< std::string > &	expressions,
		const std::map< std::string, std::string > &	options ) const

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.

Parameters

[in]	joinTableName	Name of the join table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.
[in]	tableNames	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.
[in]	columnNames	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.
[in]	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 vector.
[in]	options	Optional parameters. create_join_table_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of joinTableName. 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: create_join_table_true create_join_table_false The default value is create_join_table_false. create_join_table_collection_name: [DEPRECATED–please specify the containing schema for the join as part of joinTableName and use 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 ”. create_join_table_max_query_dimensions: No longer used. create_join_table_strategy_definition: The tier strategy for the table and its columns. create_join_table_ttl: Sets the TTL of the join table specified in joinTableName. create_join_table_view_id: View this projection is part of. The default value is ”. create_join_table_no_count: Return a count of 0 for the join table for logging and for showTable; optimization needed for large overlapped equi-join stencils. The default value is ‘false’. create_join_table_chunk_size: Maximum number of records per joined-chunk for this table. Defaults to the gpudb.conf file chunk size. create_join_table_enable_virtual_chunking: Collect chunks with accumulated size less than chunk_size into a single chunk. The default value is ‘false’. create_join_table_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. create_join_table_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. create_join_table_enable_sparse_virtual_chunking: Materialize virtual chunks with only non-deleted values. The default value is ‘false’. create_join_table_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. create_join_table_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. create_join_table_enable_pk_equi_join: Use equi-join to do primary key joins rather than using primary key index. The default value is an empty map.

Returns

Response object containing the result of the operation.

◆ createJoinTable() [4/4]

CreateJoinTableResponse & gpudb::GPUdb::createJoinTable	(	const std::string &	joinTableName,
		const std::vector< std::string > &	tableNames,
		const std::vector< std::string > &	columnNames,
		const std::vector< std::string > &	expressions,
		const std::map< std::string, std::string > &	options,
		CreateJoinTableResponse &	response_ ) const

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.

Parameters

[in]	joinTableName	Name of the join table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.
[in]	tableNames	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.
[in]	columnNames	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.
[in]	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 vector.
[in]	options	Optional parameters. create_join_table_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of joinTableName. 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: create_join_table_true create_join_table_false The default value is create_join_table_false. create_join_table_collection_name: [DEPRECATED–please specify the containing schema for the join as part of joinTableName and use 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 ”. create_join_table_max_query_dimensions: No longer used. create_join_table_strategy_definition: The tier strategy for the table and its columns. create_join_table_ttl: Sets the TTL of the join table specified in joinTableName. create_join_table_view_id: View this projection is part of. The default value is ”. create_join_table_no_count: Return a count of 0 for the join table for logging and for showTable; optimization needed for large overlapped equi-join stencils. The default value is ‘false’. create_join_table_chunk_size: Maximum number of records per joined-chunk for this table. Defaults to the gpudb.conf file chunk size. create_join_table_enable_virtual_chunking: Collect chunks with accumulated size less than chunk_size into a single chunk. The default value is ‘false’. create_join_table_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. create_join_table_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. create_join_table_enable_sparse_virtual_chunking: Materialize virtual chunks with only non-deleted values. The default value is ‘false’. create_join_table_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. create_join_table_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. create_join_table_enable_pk_equi_join: Use equi-join to do primary key joins rather than using primary key index. The default value is an empty map.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

​◆ createJoinTable() [1/4]

​◆ createJoinTable() [2/4]

​◆ createJoinTable() [3/4]

​◆ createJoinTable() [4/4]

◆ createJoinTable() [1/4]

◆ createJoinTable() [2/4]

◆ createJoinTable() [3/4]

◆ createJoinTable() [4/4]