gpudb::CreateJoinTableRequest Struct Reference

A set of input parameters for createJoinTable(const CreateJoinTableRequest&) const. More...

#include <gpudb/protocol/create_join_table.h>

Public Member Functions
	CreateJoinTableRequest ()
	Constructs a CreateJoinTableRequest object with default parameter values. More...
	CreateJoinTableRequest (const std::string &joinTableName, const std::vector< std::string > &tableNames, const std::vector< std::string > &aliases, const std::string &expression, const std::vector< std::string > &expressions, const std::map< std::string, std::string > &options)
	Constructs a CreateJoinTableRequest object with the specified parameters. More...

Public Attributes
std::string	joinTableName
std::vector< std::string >	tableNames
std::vector< std::string >	aliases
std::string	expression
std::vector< std::string >	expressions
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for createJoinTable(const CreateJoinTableRequest&) const.

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

Definition at line 20 of file create_join_table.h.

Constructor & Destructor Documentation

gpudb::CreateJoinTableRequest::CreateJoinTableRequest ( )

inline

Constructs a CreateJoinTableRequest object with default parameter values.

Definition at line 27 of file create_join_table.h.

gpudb::CreateJoinTableRequest::CreateJoinTableRequest ( const std::string &  joinTableName, const std::vector< std::string > &  tableNames, const std::vector< std::string > &  aliases, const std::string &  expression, 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. Must not be the name of a currently existing GPUdb table or join table. Cannot be an empty string.
[in]	tableNames	The list of table names making up the joined set. Corresponds to a SQL statement FROM clause
[in]	aliases	The list of aliases for each of the corresponding tables.
[in]	expression	An optional expression GPUdb uses to combine and filter the joined set. Corresponds to a SQL statement WHERE clause. For details see: expressions. Default value is an empty string.
[in]	expressions	An optional list of expressions GPUdb uses to combine and filter the joined set. Corresponds to a SQL statement WHERE clause. For details see: expressions. Default value is an empty std::vector.
[in]	options	Optional parameters. collection_name: Name of a collection in GPUdb to which the join table is to be assigned as a child table. If empty, then the join table will be a top level table. max_query_dimensions: The maximum number of tables in a joined table that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate optimize_lookups: Use the applied filters to precalculate the lookup table to get data from the primary key sets refresh_method: Method by which the join table can be refreshed when underlying member tables have changed. Values: 'manual', 'on_query', 'on_insert'. refresh: Do a manual refresh of the join table if it exists - throws an error otherwise Values: 'no_refresh', 'refresh', 'full_refresh'. Default value is an empty std::map.

Definition at line 89 of file create_join_table.h.

Member Data Documentation

std::vector<std::string> gpudb::CreateJoinTableRequest::aliases

Definition at line 101 of file create_join_table.h.

std::string gpudb::CreateJoinTableRequest::expression

Definition at line 102 of file create_join_table.h.

std::vector<std::string> gpudb::CreateJoinTableRequest::expressions

Definition at line 103 of file create_join_table.h.

std::string gpudb::CreateJoinTableRequest::joinTableName

Definition at line 99 of file create_join_table.h.

std::map<std::string, std::string> gpudb::CreateJoinTableRequest::options

Definition at line 104 of file create_join_table.h.

std::vector<std::string> gpudb::CreateJoinTableRequest::tableNames

Definition at line 100 of file create_join_table.h.

---

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

• gpudb/protocol/create_join_table.h