A set of input parameters for mergeRecords(const MergeRecordsRequest&) const. More...

#include <gpudb/protocol/merge_records.h>

Public Member Functions
	MergeRecordsRequest ()
	Constructs a MergeRecordsRequest object with default parameter values. 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

std::vector< std::string >	sourceTableNames

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

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

Detailed Description

A set of input parameters for mergeRecords(const MergeRecordsRequest&) const.

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 32 of file merge_records.h.

Constructor & Destructor Documentation

◆ MergeRecordsRequest() [1/2]

gpudb::MergeRecordsRequest::MergeRecordsRequest ( )

inline

Constructs a MergeRecordsRequest object with default parameter values.

Definition at line 39 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 new result table name for the records to be merged. Must NOT be an existing table.
[in]	sourceTableNames_	The list of source table names to get the records from. 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. gpudb::merge_records_collection_name: Name of a collection which is to contain the newly created merged table specified by tableName. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created merged table will be a top-level table. gpudb::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. gpudb::merge_records_true gpudb::merge_records_false The default value is gpudb::merge_records_false. gpudb::merge_records_ttl: Sets the TTL of the merged table specified in tableName. gpudb::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. gpudb::merge_records_true gpudb::merge_records_false The default value is gpudb::merge_records_true. gpudb::merge_records_chunk_size: Indicates the chunk size to be used for the merged table specified in tableName. gpudb::merge_records_view_id: view this result table is part of. The default value is ''.

Definition at line 122 of file merge_records.h.

Member Data Documentation

◆ fieldMaps

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

Definition at line 132 of file merge_records.h.

◆ options

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

Definition at line 133 of file merge_records.h.

◆ sourceTableNames

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

Definition at line 131 of file merge_records.h.

◆ tableName

std::string gpudb::MergeRecordsRequest::tableName

Definition at line 130 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