com.gpudb.protocol

Class MergeRecordsRequest

java.lang.Object

com.gpudb.protocol.MergeRecordsRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class MergeRecordsRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.mergeRecords(MergeRecordsRequest).

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MergeRecordsRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
MergeRecordsRequest() Constructs a MergeRecordsRequest object with default parameters.
MergeRecordsRequest(String tableName, List<String> sourceTableNames, List<Map<String,String>> fieldMaps, Map<String,String> options) Constructs a MergeRecordsRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
List<Map<String,String>>	getFieldMaps()
Map<String,String>	getOptions()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
List<String>	getSourceTableNames()
String	getTableName()
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
MergeRecordsRequest	setFieldMaps(List<Map<String,String>> fieldMaps)
MergeRecordsRequest	setOptions(Map<String,String> options)
MergeRecordsRequest	setSourceTableNames(List<String> sourceTableNames)
MergeRecordsRequest	setTableName(String tableName)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MergeRecordsRequest

public MergeRecordsRequest()

Constructs a MergeRecordsRequest object with default parameters.

MergeRecordsRequest

public MergeRecordsRequest(String tableName,
                           List<String> sourceTableNames,
                           List<Map<String,String>> fieldMaps,
                           Map<String,String> options)

Constructs a MergeRecordsRequest object with the specified parameters.

Parameters:

tableName - The new result table name for the records to be merged. Must NOT be an existing table.

sourceTableNames - The list of source table names to get the records from. Must be existing table names.

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.

options - Optional parameters.

• 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.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• TTL: Sets the TTL of the merged table specified in tableName.
• 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:
  • TRUE
  • FALSE
  The default value is TRUE.
• CHUNK_SIZE: Indicates the number of records per chunk to be used for the merged table specified in tableName.
• VIEW_ID: view this result table is part of. The default value is ''.

The default value is an empty Map.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

the schema for the class.

getTableName

public String getTableName()

Returns:

The new result table name for the records to be merged. Must NOT be an existing table.

setTableName

public MergeRecordsRequest setTableName(String tableName)

Parameters:

tableName - The new result table name for the records to be merged. Must NOT be an existing table.

Returns:

this to mimic the builder pattern.

getSourceTableNames

public List<String> getSourceTableNames()

Returns:

The list of source table names to get the records from. Must be existing table names.

setSourceTableNames

public MergeRecordsRequest setSourceTableNames(List<String> sourceTableNames)

Parameters:

sourceTableNames - The list of source table names to get the records from. Must be existing table names.

Returns:

this to mimic the builder pattern.

getFieldMaps

public List<Map<String,String>> getFieldMaps()

Returns:

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.

setFieldMaps

public MergeRecordsRequest setFieldMaps(List<Map<String,String>> fieldMaps)

Parameters:

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.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• 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.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• TTL: Sets the TTL of the merged table specified in tableName.
• 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:
  • TRUE
  • FALSE
  The default value is TRUE.
• CHUNK_SIZE: Indicates the number of records per chunk to be used for the merged table specified in tableName.
• VIEW_ID: view this result table is part of. The default value is ''.

The default value is an empty Map.

setOptions

public MergeRecordsRequest setOptions(Map<String,String> options)

Parameters:

options - Optional parameters.

• 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.
• 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:
  • TRUE
  • FALSE
  The default value is FALSE.
• TTL: Sets the TTL of the merged table specified in tableName.
• 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:
  • TRUE
  • FALSE
  The default value is TRUE.
• CHUNK_SIZE: Indicates the number of records per chunk to be used for the merged table specified in tableName.
• VIEW_ID: view this result table is part of. The default value is ''.

The default value is an empty Map.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

the schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object