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

#include <gpudb/protocol/merge_records.h>

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

	MergeRecordsRequest (const std::string &tableName_, const std::vector< std::string > &sourceTableNames_, const std::vector< std::map< std::string, std::string > > &fieldMaps_, const std::map< std::string, std::string > &options_)
	Constructs a MergeRecordsRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
	The name of the new result table for the records to be merged into, in [ schema_name. ]table_name format, using standard name resolution rules and meeting table naming criteria. More...

std::vector< std::string >	sourceTableNames
	The list of names of source tables to get the records from, each in [ schema_name. ]table_name format, using standard name resolution rules. More...

std::vector< std::map< std::string, std::string > >	fieldMaps
	Contains a list of source/target column mappings, one mapping for each source table listed in sourceTableNames being merged into the target table specified by tableName. More...

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

Detailed Description

A set of parameters for GPUdb::mergeRecords.

Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).

For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.

The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.

Definition at line 33 of file merge_records.h.

Constructor & Destructor Documentation

◆ MergeRecordsRequest() [1/2]

gpudb::MergeRecordsRequest::MergeRecordsRequest ( )

inline

Constructs a MergeRecordsRequest object with default parameters.

Definition at line 38 of file merge_records.h.

◆ MergeRecordsRequest() [2/2]

gpudb::MergeRecordsRequest::MergeRecordsRequest	(	const std::string &	tableName_,
		const std::vector< std::string > &	sourceTableNames_,
		const std::vector< std::map< std::string, std::string > > &	fieldMaps_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a MergeRecordsRequest object with the specified parameters.

Parameters

[in]	tableName_	The name of the new result table for the records to be merged into, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. Must NOT be an existing table.
[in]	sourceTableNames_	The list of names of source tables to get the records from, each in [schema_name.]table_name format, using standard name resolution rules. Must be existing table names.
[in]	fieldMaps_	Contains a list of source/target column mappings, one mapping for each source table listed in sourceTableNames_ being merged into the target table specified by tableName_. Each mapping contains the target column names (as keys) that the data in the mapped source columns or column expressions (as values) will be merged into. All of the source columns being merged into a given target column must match in type, as that type will determine the type of the new target column.
[in]	options_	Optional parameters. merge_records_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, 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: merge_records_true merge_records_false The default value is merge_records_false. merge_records_collection_name: [DEPRECATED–please specify the containing schema for the merged table as part of tableName_ and use GPUdb::createSchema to create the schema if non-existent] Name of a schema for the newly created merged table specified by tableName_. merge_records_is_replicated: Indicates the distribution scheme for the data of the merged table specified in tableName_. If true, the table will be replicated. If false, the table will be randomly sharded. Supported values: merge_records_true merge_records_false The default value is merge_records_false. merge_records_ttl: Sets the TTL of the merged table specified in tableName_. merge_records_persist: If true, then the table specified in tableName_ will be persisted and will not expire unless a ttl is specified. If false, then the table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: merge_records_true merge_records_false The default value is merge_records_true. merge_records_chunk_size: Indicates the number of records per chunk to be used for the merged table specified in tableName_. merge_records_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for the merged table specified in tableName_. merge_records_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for the merged table specified in tableName_. merge_records_view_id: view this result table is part of. The default value is ''. The default value is an empty map.

Definition at line 195 of file merge_records.h.

Member Data Documentation

◆ fieldMaps

std::vector<std::map<std::string, std::string> > gpudb::MergeRecordsRequest::fieldMaps

Contains a list of source/target column mappings, one mapping for each source table listed in sourceTableNames being merged into the target table specified by tableName.

Each mapping contains the target column names (as keys) that the data in the mapped source columns or column expressions (as values) will be merged into. All of the source columns being merged into a given target column must match in type, as that type will determine the type of the new target column.

Definition at line 234 of file merge_records.h.

◆ options

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

Optional parameters.

merge_records_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, 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:
- merge_records_true
- merge_records_false
The default value is merge_records_false.
merge_records_collection_name: [DEPRECATED–please specify the containing schema for the merged table as part of tableName and use GPUdb::createSchema to create the schema if non-existent] Name of a schema for the newly created merged table specified by tableName.
merge_records_is_replicated: Indicates the distribution scheme for the data of the merged table specified in tableName. If true, the table will be replicated. If false, the table will be randomly sharded. Supported values:
- merge_records_true
- merge_records_false
The default value is merge_records_false.
merge_records_ttl: Sets the TTL of the merged table specified in tableName.
merge_records_persist: If true, then the table specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
- merge_records_true
- merge_records_false
The default value is merge_records_true.
merge_records_chunk_size: Indicates the number of records per chunk to be used for the merged table specified in tableName.
merge_records_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for the merged table specified in tableName.
merge_records_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for the merged table specified in tableName.
merge_records_view_id: view this result table is part of. The default value is ''.

The default value is an empty map.

Definition at line 320 of file merge_records.h.

◆ sourceTableNames

std::vector<std::string> gpudb::MergeRecordsRequest::sourceTableNames

The list of names of source tables to get the records from, each in [ schema_name. ]table_name format, using standard name resolution rules.

Must be existing table names.

Definition at line 221 of file merge_records.h.

◆ tableName

std::string gpudb::MergeRecordsRequest::tableName

The name of the new result table for the records to be merged into, in [ schema_name. ]table_name format, using standard name resolution rules and meeting table naming criteria.

Must NOT be an existing table.

Definition at line 212 of file merge_records.h.

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

gpudb/protocol/merge_records.h

Public Member Functions

Public Attributes