AggregateUnpivotRequest.Options (Kinetica Java API 6.2.4.0 API)

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

Enclosing class:

AggregateUnpivotRequest
```
public static final class AggregateUnpivotRequest.Options
extends Object
```
Optional parameters.
- COLLECTION_NAME: Name of a collection which is to contain the table specified in result_table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table.
- RESULT_TABLE: The name of the table used to store the results. Has the same naming restrictions as tables. If present, no results are returned in the response.
- RESULT_TABLE_PERSIST: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result 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.
- EXPRESSION: Filter expression to apply to the table prior to unpivot processing.
- ORDER_BY: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in input table. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
- CHUNK_SIZE: Indicates the chunk size to be used for the result table. Must be used in combination with the result_table option.
- LIMIT: The number of records to keep. The default value is ''.
- TTL: Sets the TTL of the table specified in result_table.
- VIEW_ID: view this result table is part of. The default value is ''.
- MATERIALIZE_ON_GPU: If true then the output columns will be cached on the GPU. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the table specified in result_table. The columns specified must be present in output column names. If any alias is given for any column name, the alias must be used, rather than the original column name.
- RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. 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 chunk size to be used for the result table.
`static String`	`COLLECTION_NAME` Name of a collection which is to contain the table specified in `result_table`.
`static String`	`CREATE_INDEXES` Comma-separated list of columns on which to create indexes on the table specified in `result_table`.
`static String`	`EXPRESSION` Filter expression to apply to the table prior to unpivot processing.
`static String`	`FALSE`
`static String`	`LIMIT` The number of records to keep.
`static String`	`MATERIALIZE_ON_GPU` If `true` then the output columns will be cached on the GPU.
`static String`	`ORDER_BY` Comma-separated list of the columns to be sorted by; e.g.
`static String`	`RESULT_TABLE` The name of the table used to store the results.
`static String`	`RESULT_TABLE_FORCE_REPLICATED` Force the result table to be replicated (ignores any sharding).
`static String`	`RESULT_TABLE_PERSIST` If `true`, then the result table specified in `result_table` will be persisted and will not expire unless a `ttl` is specified.
`static String`	`TRUE`
`static String`	`TTL` Sets the TTL of the table specified in `result_table`.
`static String`	`VIEW_ID` view this result table is part of.

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 table specified in result_table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table.
    
    See Also:
    
    Constant Field Values
  - RESULT_TABLE
```
public static final String RESULT_TABLE
```
    The name of the table used to store the results. Has the same naming restrictions as tables. If present, no results are returned in the response.
    
    See Also:
    
    Constant Field Values
  - RESULT_TABLE_PERSIST
```
public static final String RESULT_TABLE_PERSIST
```
    If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result 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
  - TRUE
```
public static final String TRUE
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    See Also:
    
    Constant Field Values
  - EXPRESSION
```
public static final String EXPRESSION
```
    Filter expression to apply to the table prior to unpivot processing.
    
    See Also:
    
    Constant Field Values
  - ORDER_BY
```
public static final String ORDER_BY
```
    Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in input table. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
    
    See Also:
    
    Constant Field Values
  - CHUNK_SIZE
```
public static final String CHUNK_SIZE
```
    Indicates the chunk size to be used for the result table. Must be used in combination with the result_table option.
    
    See Also:
    
    Constant Field Values
  - LIMIT
```
public static final String LIMIT
```
    The number of records to keep. The default value is ''.
    
    See Also:
    
    Constant Field Values
  - TTL
```
public static final String TTL
```
    Sets the TTL of the table specified in result_table.
    
    See Also:
    
    Constant Field Values
  - VIEW_ID
```
public static final String VIEW_ID
```
    view this result table is part of. The default value is ''.
    
    See Also:
    
    Constant Field Values
  - MATERIALIZE_ON_GPU
```
public static final String MATERIALIZE_ON_GPU
```
    If true then the output columns will be cached on the GPU. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    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 table specified in result_table. The columns specified must be present in output column names. If any alias is given for any column name, the alias must be used, rather than the original column name.
    
    See Also:
    
    Constant Field Values
  - RESULT_TABLE_FORCE_REPLICATED
```
public static final String RESULT_TABLE_FORCE_REPLICATED
```
    Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values

Class AggregateUnpivotRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COLLECTION_NAME

RESULT_TABLE

RESULT_TABLE_PERSIST

TRUE

FALSE

EXPRESSION

ORDER_BY

CHUNK_SIZE

LIMIT

TTL

VIEW_ID

MATERIALIZE_ON_GPU

CREATE_INDEXES

RESULT_TABLE_FORCE_REPLICATED