CreateProjectionRequest.Options (Kinetica Java API 7.0.19.0 API)

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

Enclosing class:

CreateProjectionRequest
```
public static final class CreateProjectionRequest.Options
extends Object
```
Optional parameters.
- COLLECTION_NAME: Name of a collection to which the projection is to be assigned as a child. If the collection provided is non-existent, the collection will be automatically created. If empty, then the projection will be at the top level. The default value is ''.
- EXPRESSION: An optional filter expression to be applied to the source table prior to the projection. The default value is ''.
- IS_REPLICATED: If true then the projection will be replicated even if the source table is not. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- LIMIT: The number of records to keep. The default value is ''.
- 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 columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. 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.
- CHUNK_SIZE: Indicates the number of records per chunk to be used for this projection.
- CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the projection. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name.
- TTL: Sets the TTL of the projection specified in projectionName.
- SHARD_KEY: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
- PERSIST: If true, then the projection specified in projectionName will be persisted and will not expire unless a ttl is specified. If false, then the projection will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- PRESERVE_DICT_ENCODING: If true, then columns that were dict encoded in the source table will be dict encoded in the projection. Supported values:
  - TRUE
  - FALSE
  The default value is TRUE.
- RETAIN_PARTITIONS: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- VIEW_ID: ID of view of which this projection is a member. The default value is ''.
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 projection.
`static String`	`COLLECTION_NAME` Name of a collection to which the projection is to be assigned as a child.
`static String`	`CREATE_INDEXES` Comma-separated list of columns on which to create indexes on the projection.
`static String`	`EXPRESSION` An optional filter expression to be applied to the source table prior to the projection.
`static String`	`FALSE`
`static String`	`IS_REPLICATED` If `true` then the projection will be replicated even if the source table is not.
`static String`	`LIMIT` The number of records to keep.
`static String`	`MATERIALIZE_ON_GPU` No longer used.
`static String`	`ORDER_BY` Comma-separated list of the columns to be sorted by; e.g.
`static String`	`PERSIST` If `true`, then the projection specified in `projectionName` will be persisted and will not expire unless a `ttl` is specified.
`static String`	`PRESERVE_DICT_ENCODING` If `true`, then columns that were dict encoded in the source table will be dict encoded in the projection.
`static String`	`RETAIN_PARTITIONS` Determines whether the created projection will retain the partitioning scheme from the source table.
`static String`	`SHARD_KEY` Comma-separated list of the columns to be sharded on; e.g.
`static String`	`TRUE`
`static String`	`TTL` Sets the TTL of the projection specified in `projectionName`.
`static String`	`VIEW_ID` ID of view of which this projection 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 to which the projection is to be assigned as a child. If the collection provided is non-existent, the collection will be automatically created. If empty, then the projection will be at the top level. The default value is ''.
    
    See Also:
    
    Constant Field Values
  - EXPRESSION
```
public static final String EXPRESSION
```
    An optional filter expression to be applied to the source table prior to the projection. The default value is ''.
    
    See Also:
    
    Constant Field Values
  - IS_REPLICATED
```
public static final String IS_REPLICATED
```
    If true then the projection will be replicated even if the source table is not. 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
  - LIMIT
```
public static final String LIMIT
```
    The number of records to keep. The default value is ''.
    
    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 columnNames. 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
  - 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
  - CHUNK_SIZE
```
public static final String CHUNK_SIZE
```
    Indicates the number of records per chunk to be used for this projection.
    
    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 projection. The columns specified must be present in columnNames. 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
  - TTL
```
public static final String TTL
```
    Sets the TTL of the projection specified in projectionName.
    
    See Also:
    
    Constant Field Values
  - SHARD_KEY
```
public static final String SHARD_KEY
```
    Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in columnNames. 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
  - PERSIST
```
public static final String PERSIST
```
    If true, then the projection specified in projectionName will be persisted and will not expire unless a ttl is specified. If false, then the projection 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
  - PRESERVE_DICT_ENCODING
```
public static final String PRESERVE_DICT_ENCODING
```
    If true, then columns that were dict encoded in the source table will be dict encoded in the projection. Supported values:
    - TRUE
    - FALSE
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - RETAIN_PARTITIONS
```
public static final String RETAIN_PARTITIONS
```
    Determines whether the created projection will retain the partitioning scheme from the source table. 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 projection is a member. The default value is ''.
    
    See Also:
    
    Constant Field Values

Class CreateProjectionRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COLLECTION_NAME

EXPRESSION

IS_REPLICATED

TRUE

FALSE

LIMIT

ORDER_BY

MATERIALIZE_ON_GPU

CHUNK_SIZE

CREATE_INDEXES

TTL

SHARD_KEY

PERSIST

PRESERVE_DICT_ENCODING

RETAIN_PARTITIONS

VIEW_ID