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 > &columnNames_, 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 >	columnNames
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 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 parameter values.

Definition at line 30 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. Has the same naming restrictions as tables.
[in]	tableNames_	The list of table names composing the join. 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.
[in]	options_	Optional parameters. gpudb::create_join_table_collection_name: Name of a collection which is to contain the join. If the collection provided is non-existent, the collection will be automatically created. If empty, then the join will be at the top level. The default value is ''. gpudb::create_join_table_max_query_dimensions: The maximum number of tables in a join that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate gpudb::create_join_table_optimize_lookups: Use more memory to speed up the joining of tables. gpudb::create_join_table_true gpudb::create_join_table_false The default value is gpudb::create_join_table_false. gpudb::create_join_table_refresh_method: Method by which the join can be refreshed when the data in underlying member tables have changed. gpudb::create_join_table_manual: refresh only occurs when manually requested by calling this endpoint with refresh option set to refresh or full_refresh gpudb::create_join_table_on_query: incrementally refresh (refresh just those records added) whenever a new query is issued and new data is inserted into the base table. A full refresh of all the records occurs when a new query is issued and there have been inserts to any non-base-tables since the last query. TTL will be set to not expire; any ttl specified will be ignored. gpudb::create_join_table_on_insert: incrementally refresh (refresh just those records added) whenever new data is inserted into a base table. A full refresh of all the records occurs when a new query is issued and there have been inserts to any non-base-tables since the last query. TTL will be set to not expire; any ttl specified will be ignored. The default value is gpudb::create_join_table_manual. gpudb::create_join_table_refresh: Do a manual refresh of the join if it exists - throws an error otherwise gpudb::create_join_table_no_refresh: don't refresh gpudb::create_join_table_refresh: incrementally refresh (refresh just those records added) if new data has been inserted into the base table. A full refresh of all the records occurs if there have been inserts to any non-base-tables since the last refresh gpudb::create_join_table_full_refresh: always refresh even if no new records have been added. Only refresh method guaranteed to do a full refresh (refresh all the records) if a delete or update has occurred since the last refresh. The default value is gpudb::create_join_table_no_refresh. gpudb::create_join_table_ttl: Sets the TTL of the join table specified in joinTableName. Ignored if refresh_method is either on_insert or on_query. gpudb::create_join_table_view_id: view this projection is part of. The default value is ''. gpudb::create_join_table_no_count: return a count of 0 for the join table for logging and for show_table. optimization needed for large overlapped equi-join stencils. The default value is 'false'. gpudb::create_join_table_chunk_size: Maximum size of a joined-chunk for this table. Defaults to the gpudb.conf file chunk size gpudb::create_join_table_allow_right_primary_key_join: When true allows right joins from a key to a primary key to be done as primary key joins. Such a join table cannot be joined to other join tables. When false the right join shall be done as an equi-join. The default value is 'false'.

Definition at line 176 of file create_join_table.h.

Member Data Documentation

columnNames

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

Definition at line 187 of file create_join_table.h.

expressions

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

Definition at line 188 of file create_join_table.h.

joinTableName

std::string gpudb::CreateJoinTableRequest::joinTableName

Definition at line 185 of file create_join_table.h.

options

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

Definition at line 189 of file create_join_table.h.

tableNames

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

Definition at line 186 of file create_join_table.h.

---

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

• gpudb/protocol/create_join_table.h