com.gpudb.protocol

Class CreateUnionRequest

java.lang.Object

com.gpudb.protocol.CreateUnionRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.createUnion(CreateUnionRequest).

Performs a union (concatenation) of one or more existing tables or views, the results of which are stored in a new table. It is equivalent to the SQL UNION ALL operator. Non-charN 'string' and 'bytes' column types cannot be included in a union, neither can columns with the property 'store_only'. Though not explicitly unions, intersect and except are also available from this endpoint.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CreateUnionRequest() Constructs a CreateUnionRequest object with default parameters.
CreateUnionRequest(String tableName, List<String> tableNames, List<List<String>> inputColumnNames, List<String> outputColumnNames, Map<String,String> options) Constructs a CreateUnionRequest object with the specified parameters.

Method Summary

Methods

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<List<String>>	getInputColumnNames()
Map<String,String>	getOptions()
List<String>	getOutputColumnNames()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getTableName()
List<String>	getTableNames()
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.
CreateUnionRequest	setInputColumnNames(List<List<String>> inputColumnNames)
CreateUnionRequest	setOptions(Map<String,String> options)
CreateUnionRequest	setOutputColumnNames(List<String> outputColumnNames)
CreateUnionRequest	setTableName(String tableName)
CreateUnionRequest	setTableNames(List<String> tableNames)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateUnionRequest

public CreateUnionRequest()

Constructs a CreateUnionRequest object with default parameters.

CreateUnionRequest

public CreateUnionRequest(String tableName,
                  List<String> tableNames,
                  List<List<String>> inputColumnNames,
                  List<String> outputColumnNames,
                  Map<String,String> options)

Constructs a CreateUnionRequest object with the specified parameters.

Parameters:

tableName - Name of the table to be created. Has the same naming restrictions as tables.

tableNames - The list of table names making up the union. Must contain the names of one or more existing tables.

inputColumnNames - The list of columns from each of the corresponding input tables.

outputColumnNames - The list of names of the columns to be stored in the union.

options - Optional parameters.

• COLLECTION_NAME: Name of a collection which is to contain the union. If the collection provided is non-existent, the collection will be automatically created. If empty, then the union will be a top-level table.
• MATERIALIZE_ON_GPU: If 'true' then the columns of the union will be cached on the GPU. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• MODE: If 'merge_views' then this operation will merge (i.e. union) the provided views. All 'table_names' must be views from the same underlying base table. Supported values:
  • UNION_ALL: Retains all rows from the specified tables.
  • UNION: Retains all unique rows from the specified tables (synonym for 'union_distinct').
  • UNION_DISTINCT: Retains all unique rows from the specified tables.
  • EXCEPT: Retains all unique rows from the first table that do not appear in the second table (only works on 2 tables).
  • INTERSECT: Retains all unique rows that appear in both of the specified tables (only works on 2 tables).
  • MERGE_VIEWS: Merge two or more views (or views of views) of the same base data set into a new view. If this mode is selected inputColumnNames AND outputColumnNames must be empty. The resulting view would match the results of a SQL OR operation, e.g., if filter 1 creates a view using the expression 'x = 10' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 10 OR x <= 10'.
  The default value is UNION_ALL.
• CHUNK_SIZE: Indicates the chunk size to be used for this table.
• TTL: Sets the TTL of the table specified in tableName.
• PERSIST: If true, then the union specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the union will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

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:

Name of the table to be created. Has the same naming restrictions as tables.

setTableName

public CreateUnionRequest setTableName(String tableName)

Parameters:

tableName - Name of the table to be created. Has the same naming restrictions as tables.

Returns:

this to mimic the builder pattern.

getTableNames

public List<String> getTableNames()

Returns:

The list of table names making up the union. Must contain the names of one or more existing tables.

setTableNames

public CreateUnionRequest setTableNames(List<String> tableNames)

Parameters:

tableNames - The list of table names making up the union. Must contain the names of one or more existing tables.

Returns:

this to mimic the builder pattern.

getInputColumnNames

public List<List<String>> getInputColumnNames()

Returns:

The list of columns from each of the corresponding input tables.

setInputColumnNames

public CreateUnionRequest setInputColumnNames(List<List<String>> inputColumnNames)

Parameters:

inputColumnNames - The list of columns from each of the corresponding input tables.

Returns:

this to mimic the builder pattern.

getOutputColumnNames

public List<String> getOutputColumnNames()

Returns:

The list of names of the columns to be stored in the union.

setOutputColumnNames

public CreateUnionRequest setOutputColumnNames(List<String> outputColumnNames)

Parameters:

outputColumnNames - The list of names of the columns to be stored in the union.

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 union. If the collection provided is non-existent, the collection will be automatically created. If empty, then the union will be a top-level table.
• MATERIALIZE_ON_GPU: If 'true' then the columns of the union will be cached on the GPU. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• MODE: If 'merge_views' then this operation will merge (i.e. union) the provided views. All 'table_names' must be views from the same underlying base table. Supported values:
  • UNION_ALL: Retains all rows from the specified tables.
  • UNION: Retains all unique rows from the specified tables (synonym for 'union_distinct').
  • UNION_DISTINCT: Retains all unique rows from the specified tables.
  • EXCEPT: Retains all unique rows from the first table that do not appear in the second table (only works on 2 tables).
  • INTERSECT: Retains all unique rows that appear in both of the specified tables (only works on 2 tables).
  • MERGE_VIEWS: Merge two or more views (or views of views) of the same base data set into a new view. If this mode is selected inputColumnNames AND outputColumnNames must be empty. The resulting view would match the results of a SQL OR operation, e.g., if filter 1 creates a view using the expression 'x = 10' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 10 OR x <= 10'.
  The default value is UNION_ALL.
• CHUNK_SIZE: Indicates the chunk size to be used for this table.
• TTL: Sets the TTL of the table specified in tableName.
• PERSIST: If true, then the union specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the union will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

setOptions

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

Parameters:

options - Optional parameters.

• COLLECTION_NAME: Name of a collection which is to contain the union. If the collection provided is non-existent, the collection will be automatically created. If empty, then the union will be a top-level table.
• MATERIALIZE_ON_GPU: If 'true' then the columns of the union will be cached on the GPU. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• MODE: If 'merge_views' then this operation will merge (i.e. union) the provided views. All 'table_names' must be views from the same underlying base table. Supported values:
  • UNION_ALL: Retains all rows from the specified tables.
  • UNION: Retains all unique rows from the specified tables (synonym for 'union_distinct').
  • UNION_DISTINCT: Retains all unique rows from the specified tables.
  • EXCEPT: Retains all unique rows from the first table that do not appear in the second table (only works on 2 tables).
  • INTERSECT: Retains all unique rows that appear in both of the specified tables (only works on 2 tables).
  • MERGE_VIEWS: Merge two or more views (or views of views) of the same base data set into a new view. If this mode is selected inputColumnNames AND outputColumnNames must be empty. The resulting view would match the results of a SQL OR operation, e.g., if filter 1 creates a view using the expression 'x = 10' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 10 OR x <= 10'.
  The default value is UNION_ALL.
• CHUNK_SIZE: Indicates the chunk size to be used for this table.
• TTL: Sets the TTL of the table specified in tableName.
• PERSIST: If true, then the union specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the union will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

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