A set of parameters for GPUdb::createUnion. More…
#include <gpudb/protocol/create_union.h>
Public Member Functions | |
| CreateUnionRequest () | |
| Constructs a CreateUnionRequest object with default parameters. | |
| CreateUnionRequest (const std::string &tableName_, const std::vector< std::string > &tableNames_, const std::vector< std::vector< std::string > > &inputColumnNames_, const std::vector< std::string > &outputColumnNames_, const std::map< std::string, std::string > &options_) | |
| Constructs a CreateUnionRequest object with the specified parameters. | |
Public Attributes | |
| std::string | tableName |
| Name of the 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 to merge, in [ schema_name. ]table_name format, using standard name resolution rules. | |
| std::vector< std::vector< std::string > > | inputColumnNames |
| The list of columns from each of the corresponding input tables. | |
| std::vector< std::string > | outputColumnNames |
| The list of names of the columns to be stored in the output table. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::createUnion.
Merges data from one or more tables with comparable data types into a new table.
The following merges are supported:
UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
Definition at line 38 of file create_union.h.
Constructor & Destructor Documentation
◆ CreateUnionRequest() [1/2]
| inline |
Constructs a CreateUnionRequest object with default parameters.
Definition at line 43 of file create_union.h.
◆ CreateUnionRequest() [2/2]
| inline |
Constructs a CreateUnionRequest object with the specified parameters.
Parameters
| [in] | tableName_ | Name of the 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 to merge, in [schema_name.]table_name format, using standard name resolution rules. Must contain the names of one or more existing tables. |
| [in] | inputColumnNames_ | The list of columns from each of the corresponding input tables. |
| [in] | outputColumnNames_ | The list of names of the columns to be stored in the output table. |
| [in] | options_ | Optional parameters.
|
Definition at line 349 of file create_union.h.
Member Data Documentation
◆ inputColumnNames
| std::vector<std::vector<std::string> > gpudb::CreateUnionRequest::inputColumnNames |
The list of columns from each of the corresponding input tables.
Definition at line 380 of file create_union.h.
◆ options
| std::map<std::string, std::string> gpudb::CreateUnionRequest::options |
Optional parameters.
- create_union_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of tableName. If persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_table_name. Supported values:The default value is create_union_false.
- create_union_collection_name: [DEPRECATED–please specify the containing schema for the projection as part of tableName and use GPUdb::createSchema to create the schema if non-existent] Name of the schema for the output table. If the schema provided is non-existent, it will be automatically created. The default value is ”.
- create_union_mode: The mode describes what rows of the tables being unioned will be retained. Supported values:
- create_union_union_all: Retains all rows from the specified tables.
- create_union_union: Retains all unique rows from the specified tables (synonym for union_distinct).
- create_union_union_distinct: Retains all unique rows from the specified tables.
- create_union_except: Retains all unique rows from the first table that do not appear in the second table (only works on 2 tables).
- create_union_except_all: Retains all rows(including duplicates) from the first table that do not appear in the second table (only works on 2 tables).
- create_union_intersect: Retains all unique rows that appear in both of the specified tables (only works on 2 tables).
- create_union_intersect_all: Retains all rows(including duplicates) that appear in both of the specified tables (only works on 2 tables).
- create_union_chunk_size: Indicates the number of records per chunk to be used for this output table.
- create_union_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this output table.
- create_union_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this output table.
- create_union_create_indexes: Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in outputColumnNames.
- create_union_partition_type: Partitioning scheme to use for the output table. Supported values:
- create_union_partition_keys: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
- create_union_partition_definitions: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
- create_union_is_automatic_partition: If true, a new partition will be created for values which don’t fall into an existing partition. Currently only supported for list partitions. Supported values:The default value is create_union_false.
- create_union_ttl: Sets the TTL of the output table specified in tableName.
- create_union_persist: If true, then the output table specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the output table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:The default value is create_union_false.
- create_union_view_id: ID of view of which this output table is a member. The default value is ”.
- create_union_force_replicated: If true, then the output table specified in tableName will be replicated even if the source tables are not. Supported values:The default value is create_union_false.
- create_union_strategy_definition: The tier strategy for the table and its columns.
- create_union_compression_codec: The default compression codec for this table’s columns.
- create_union_no_count: Return a count of 0 for the union table response to avoid the cost of counting; optimization needed for many chunk virtual unions. The default value is ‘false’.
The default value is an empty map.
Definition at line 580 of file create_union.h.
◆ outputColumnNames
| std::vector<std::string> gpudb::CreateUnionRequest::outputColumnNames |
The list of names of the columns to be stored in the output table.
Definition at line 385 of file create_union.h.
◆ tableName
| std::string gpudb::CreateUnionRequest::tableName |
Name of the table to be created, in [ schema_name. ]table_name format, using standard name resolution rules and meeting table naming criteria.
Definition at line 366 of file create_union.h.
◆ tableNames
| std::vector<std::string> gpudb::CreateUnionRequest::tableNames |
The list of table names to merge, in [ schema_name. ]table_name format, using standard name resolution rules.
Must contain the names of one or more existing tables.
Definition at line 375 of file create_union.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/create_union.h