A set of parameters for GPUdb::createJoinTable. More...

#include \<gpudb/protocol/create\_join\_table.h>

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

	CreateJoinTableRequest (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\_)
	Constructs a CreateJoinTableRequest object with the specified parameters.

Public Attributes
std::string	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.

std::vector\< std::string >	tableNames
	The list of table names composing the join, each in \[ schema\_name.

std::vector\< std::string >	columnNames
	List of member table columns or column expressions to be included in the join.

std::vector\< std::string >	expressions
	An optional list of expressions to combine and filter the joined tables.

std::map\< std::string, std::string >	options
	Optional parameters.

Detailed Description

A set of parameters for GPUdb::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 23 of file create\_join\_table.h.

Constructor & Destructor Documentation

◆ CreateJoinTableRequest() \[1/2]

gpudb::CreateJoinTableRequest::CreateJoinTableRequest

(

)

inline

Constructs a CreateJoinTableRequest object with default parameters.

Definition at line 28 of file create\_join\_table.h.

◆ CreateJoinTableRequest() \[2/2]

gpudb::CreateJoinTableRequest::CreateJoinTableRequest	(	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\_ )

inline

Constructs a CreateJoinTableRequest object with the specified parameters.

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

Definition at line 203 of file create\_join\_table.h.

Member Data Documentation

◆ columnNames

std::vector\ gpudb::CreateJoinTableRequest::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.

Definition at line 241 of file create\_join\_table.h.

◆ expressions

std::vector\ gpudb::CreateJoinTableRequest::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.

Definition at line 249 of file create\_join\_table.h.

◆ joinTableName

std::string gpudb::CreateJoinTableRequest::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.

Definition at line 220 of file create\_join\_table.h.

◆ options

std::map\ gpudb::CreateJoinTableRequest::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 GPUdb::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 GPUdb::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.

Definition at line 343 of file create\_join\_table.h.

◆ tableNames

std::vector\ gpudb::CreateJoinTableRequest::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.

Definition at line 229 of file create\_join\_table.h.

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

gpudb/protocol/create\_join\_table.h

Public Member Functions

Public Attributes