Version:

/merge/records

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/merge/records

Create a new empty result table (specified by input parameter table_name), and insert all records from source tables (specified by input parameter source_table_names) based on the field mapping information (specified by input parameter field_maps).

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

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

Input Parameter Description

Name Type Description
table_name string The new result table name for the records to be merged. Must NOT be an existing table.
source_table_names array of strings The list of source table names to get the records from. Must be existing table names.
field_maps array of maps of string to strings Contains a list of source/target column mappings, one mapping for each source table listed in input parameter source_table_names being merged into the target table specified by input parameter table_name. 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.
options map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys) Parameter Description
collection_name Name of a collection which is to contain the newly created merged table specified by input parameter table_name. 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.
is_replicated

Indicates the distribution scheme for the data of the merged table specified in input parameter table_name. If true, the table will be replicated. If false, the table will be randomly sharded. The supported values are:

  • true
  • false
ttl Sets the TTL of the merged table specified in input parameter table_name.
persist

If true, then the table specified in input parameter table_name 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. The supported values are:

  • true
  • false
chunk_size Indicates the chunk size to be used for the merged table specified in input parameter table_name.
view_id view this result table is part of. The default value is ''.

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name Type Description
status String 'OK' or 'ERROR'
message String Empty if success or an error message
data_type String 'merge_records_request' or 'none' in case of an error
data String Empty string
data_str JSON or String

This embedded JSON represents the result of the /merge/records endpoint:

Name Type Description
table_name string  
info map of string to strings Additional information.

Empty string in case of an error.