​

Method Details

• ​

  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()

  Name of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.

  Returns:

  The current value of tableName.

• ​

  setTableName

  public CreateUnionRequest setTableName(String tableName)

  Name of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.

  Parameters:

  tableName - The new value for tableName.

  Returns:

  this to mimic the builder pattern.

• ​

  getTableNames

  public List<String> getTableNames()

  The list of table names to merge, in [schema_name.]table_name format, using standard name resolution rules. Must contain the names of one or more existing tables.

  Returns:

  The current value of tableNames.

• ​

  setTableNames

  public CreateUnionRequest setTableNames(List<String> tableNames)

  The list of table names to merge, in [schema_name.]table_name format, using standard name resolution rules. Must contain the names of one or more existing tables.

  Parameters:

  tableNames - The new value for tableNames.

  Returns:

  this to mimic the builder pattern.

• ​

  getInputColumnNames

  public List<List<String>> getInputColumnNames()

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

  Returns:

  The current value of inputColumnNames.

• ​

  setInputColumnNames

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

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

  Parameters:

  inputColumnNames - The new value for inputColumnNames.

  Returns:

  this to mimic the builder pattern.

• ​

  getOutputColumnNames

  public List<String> getOutputColumnNames()

  The list of names of the columns to be stored in the output table.

  Returns:

  The current value of outputColumnNames.

• ​

  setOutputColumnNames

  public CreateUnionRequest setOutputColumnNames(List<String> outputColumnNames)

  The list of names of the columns to be stored in the output table.

  Parameters:

  outputColumnNames - The new value for outputColumnNames.

  Returns:

  this to mimic the builder pattern.

• ​

  getOptions

  public Map<String,String> getOptions()

  Optional parameters.

  • 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 (or unspecified), 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:
    • TRUE
    • FALSE
    The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED—please specify the containing schema for the projection as part of tableName and use GPUdb.createSchema to create the schema if non-existent] Name of the schema for the output table. If the schema provided is non-existent, it will be automatically created. The default value is ”.
  • MODE: The mode describes what rows of the tables being unioned will be retained. 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).
    • EXCEPT_ALL: Retains all rows(including duplicates) 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).
    • INTERSECT_ALL: Retains all rows(including duplicates) that appear in both of the specified tables (only works on 2 tables).
    The default value is UNION_ALL.
  • CHUNK_SIZE: Indicates the number of records per chunk to be used for this output table.
  • CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this output table.
  • CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this output table.
  • CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in outputColumnNames.
  • PARTITION_TYPE: Partitioning scheme to use for the output table. Supported values:
    • RANGE: Use range partitioning.
    • INTERVAL: Use interval partitioning.
    • LIST: Use list partitioning.
    • HASH: Use hash partitioning.
    • SERIES: Use series partitioning.
  • PARTITION_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION_DEFINITIONS.
  • PARTITION_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
  • IS_AUTOMATIC_PARTITION: If TRUE, a new partition will be created for values which don’t fall into an existing partition. Currently only supported for list partitions. Supported values:
    • TRUE
    • FALSE
    The default value is FALSE.
  • TTL: Sets the TTL of the output table specified in tableName.
  • PERSIST: If TRUE, then the output table specified in tableName will be persisted and will not expire unless a TTL is specified. If FALSE, then the output table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values:
    • TRUE
    • FALSE
    The default value is FALSE.
  • VIEW_ID: ID of view of which this output table is a member. The default value is ”.
  • FORCE_REPLICATED: If TRUE, then the output table specified in tableName will be replicated even if the source tables are not. Supported values:
    • TRUE
    • FALSE
    The default value is FALSE.
  • STRATEGY_DEFINITION: The tier strategy for the table and its columns.
  • COMPRESSION_CODEC: The default compression codec for this table’s columns.
  • NO_COUNT: Return a count of 0 for the union table response to avoid the cost of counting; optimization needed for many chunk virtual unions. The default value is ‘false’.

  The default value is an empty Map.

  Returns:

  The current value of options.

• ​

  setOptions

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

  Optional parameters.

  • 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 (or unspecified), 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:
    • TRUE
    • FALSE
    The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED—please specify the containing schema for the projection as part of tableName and use GPUdb.createSchema to create the schema if non-existent] Name of the schema for the output table. If the schema provided is non-existent, it will be automatically created. The default value is ”.
  • MODE: The mode describes what rows of the tables being unioned will be retained. 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).
    • EXCEPT_ALL: Retains all rows(including duplicates) 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).
    • INTERSECT_ALL: Retains all rows(including duplicates) that appear in both of the specified tables (only works on 2 tables).
    The default value is UNION_ALL.
  • CHUNK_SIZE: Indicates the number of records per chunk to be used for this output table.
  • CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this output table.
  • CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this output table.
  • CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in outputColumnNames.
  • PARTITION_TYPE: Partitioning scheme to use for the output table. Supported values:
    • RANGE: Use range partitioning.
    • INTERVAL: Use interval partitioning.
    • LIST: Use list partitioning.
    • HASH: Use hash partitioning.
    • SERIES: Use series partitioning.
  • PARTITION_KEYS: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by PARTITION_DEFINITIONS.
  • PARTITION_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
  • IS_AUTOMATIC_PARTITION: If TRUE, a new partition will be created for values which don’t fall into an existing partition. Currently only supported for list partitions. Supported values:
    • TRUE
    • FALSE
    The default value is FALSE.
  • TTL: Sets the TTL of the output table specified in tableName.
  • PERSIST: If TRUE, then the output table specified in tableName will be persisted and will not expire unless a TTL is specified. If FALSE, then the output table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values:
    • TRUE
    • FALSE
    The default value is FALSE.
  • VIEW_ID: ID of view of which this output table is a member. The default value is ”.
  • FORCE_REPLICATED: If TRUE, then the output table specified in tableName will be replicated even if the source tables are not. Supported values:
    • TRUE
    • FALSE
    The default value is FALSE.
  • STRATEGY_DEFINITION: The tier strategy for the table and its columns.
  • COMPRESSION_CODEC: The default compression codec for this table’s columns.
  • NO_COUNT: Return a count of 0 for the union table response to avoid the cost of counting; optimization needed for many chunk virtual unions. The default value is ‘false’.

  The default value is an empty Map.

  Parameters:

  options - The new value for options.

  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