CreateUnionRequest.Options (Kinetica Java API 7.0.19.0 API)

java.lang.Object
- com.gpudb.protocol.CreateUnionRequest.Options

Enclosing class:

CreateUnionRequest
```
public static final class CreateUnionRequest.Options
extends Object
```
Optional parameters.
- COLLECTION_NAME: Name of a collection which is to contain the output table. If the collection provided is non-existent, the collection will be automatically created. If empty, the output table will be a top-level table. The default value is ''.
- MATERIALIZE_ON_GPU: No longer used. See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- MODE: If merge_views, then this operation will merge the provided views. All tableNames 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).
  - 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).
  - 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 = 20' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 20 OR x <= 10'.
  The default value is UNION_ALL.
- CHUNK_SIZE: Indicates the number of records per 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.
- 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.
The default value is an empty Map. A set of string constants for the parameter options.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CHUNK_SIZE` Indicates the number of records per chunk to be used for this output table.
`static String`	`COLLECTION_NAME` Name of a collection which is to contain the output table.
`static String`	`CREATE_INDEXES` Comma-separated list of columns on which to create indexes on the output table.
`static String`	`EXCEPT` Retains all unique rows from the first table that do not appear in the second table (only works on 2 tables).
`static String`	`EXCEPT_ALL` Retains all rows(including duplicates) from the first table that do not appear in the second table (only works on 2 tables).
`static String`	`FALSE`
`static String`	`FORCE_REPLICATED` If `true`, then the output table specified in `tableName` will be replicated even if the source tables are not.
`static String`	`INTERSECT` Retains all unique rows that appear in both of the specified tables (only works on 2 tables).
`static String`	`INTERSECT_ALL` Retains all rows(including duplicates) that appear in both of the specified tables (only works on 2 tables).
`static String`	`MATERIALIZE_ON_GPU` No longer used.
`static String`	`MERGE_VIEWS` Merge two or more views (or views of views) of the same base data set into a new view.
`static String`	`MODE` If `merge_views`, then this operation will merge the provided views.
`static String`	`PERSIST` If `true`, then the output table specified in `tableName` will be persisted and will not expire unless a `ttl` is specified.
`static String`	`TRUE`
`static String`	`TTL` Sets the TTL of the output table specified in `tableName`.
`static String`	`UNION` Retains all unique rows from the specified tables (synonym for `union_distinct`).
`static String`	`UNION_ALL` Retains all rows from the specified tables.
`static String`	`UNION_DISTINCT` Retains all unique rows from the specified tables.
`static String`	`VIEW_ID` ID of view of which this output table is a member.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COLLECTION_NAME
```
public static final String COLLECTION_NAME
```
    Name of a collection which is to contain the output table. If the collection provided is non-existent, the collection will be automatically created. If empty, the output table will be a top-level table. The default value is ''.
    
    See Also:
    
    Constant Field Values
  - MATERIALIZE_ON_GPU
```
public static final String MATERIALIZE_ON_GPU
```
    No longer used. See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    See Also:
    
    Constant Field Values
  - MODE
```
public static final String MODE
```
    If merge_views, then this operation will merge the provided views. All tableNames 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).
    - 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).
    - 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 = 20' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 20 OR x <= 10'.
    The default value is UNION_ALL.
    See Also:
    
    Constant Field Values
  - UNION_ALL
```
public static final String UNION_ALL
```
    Retains all rows from the specified tables.
    
    See Also:
    
    Constant Field Values
  - UNION
```
public static final String UNION
```
    Retains all unique rows from the specified tables (synonym for union_distinct).
    
    See Also:
    
    Constant Field Values
  - UNION_DISTINCT
```
public static final String UNION_DISTINCT
```
    Retains all unique rows from the specified tables.
    
    See Also:
    
    Constant Field Values
  - EXCEPT
```
public static final String EXCEPT
```
    Retains all unique rows from the first table that do not appear in the second table (only works on 2 tables).
    
    See Also:
    
    Constant Field Values
  - EXCEPT_ALL
```
public static final String EXCEPT_ALL
```
    Retains all rows(including duplicates) from the first table that do not appear in the second table (only works on 2 tables).
    
    See Also:
    
    Constant Field Values
  - INTERSECT
```
public static final String INTERSECT
```
    Retains all unique rows that appear in both of the specified tables (only works on 2 tables).
    
    See Also:
    
    Constant Field Values
  - INTERSECT_ALL
```
public static final String INTERSECT_ALL
```
    Retains all rows(including duplicates) that appear in both of the specified tables (only works on 2 tables).
    
    See Also:
    
    Constant Field Values
  - MERGE_VIEWS
```
public static final String 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 = 20' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 20 OR x <= 10'.
    
    See Also:
    
    Constant Field Values
  - CHUNK_SIZE
```
public static final String CHUNK_SIZE
```
    Indicates the number of records per chunk to be used for this output table.
    
    See Also:
    
    Constant Field Values
  - CREATE_INDEXES
```
public static final String CREATE_INDEXES
```
    Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in outputColumnNames.
    
    See Also:
    
    Constant Field Values
  - TTL
```
public static final String TTL
```
    Sets the TTL of the output table specified in tableName.
    
    See Also:
    
    Constant Field Values
  - PERSIST
```
public static final String 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.
    See Also:
    
    Constant Field Values
  - VIEW_ID
```
public static final String VIEW_ID
```
    ID of view of which this output table is a member. The default value is ''.
    
    See Also:
    
    Constant Field Values
  - FORCE_REPLICATED
```
public static final String 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.
    See Also:
    
    Constant Field Values

Class CreateUnionRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COLLECTION_NAME

MATERIALIZE_ON_GPU

TRUE

FALSE

MODE

UNION_ALL

UNION

UNION_DISTINCT

EXCEPT

EXCEPT_ALL

INTERSECT

INTERSECT_ALL

MERGE_VIEWS

CHUNK_SIZE

CREATE_INDEXES

TTL

PERSIST

VIEW_ID

FORCE_REPLICATED