CreateProjectionRequest.Options (Kinetica Java API 7.1.10.4 API)

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

Enclosing class:

CreateProjectionRequest
```
public static final class CreateProjectionRequest.Options
extends Object
```
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 projectionName. 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_projection_name. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- COLLECTION_NAME: [DEPRECATED--please specify the containing schema for the projection as part of projectionName and use GPUdb.createSchema(CreateSchemaRequest) to create the schema if non-existent] Name of a schema for the projection. If the schema is non-existent, it will be automatically created. 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.
- OFFSET: The number of initial results to skip (this can be useful for paging through the results). The default value is '0'.
- LIMIT: The number of records to keep. The default value is '-9999'.
- 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 ''.
- 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.
- PARTITION_TYPE: Partitioning scheme to use. 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.
- VIEW_ID: ID of view of which this projection is a member. The default value is ''.
- STRATEGY_DEFINITION: The tier strategy for the table and its columns.
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` [DEPRECATED--please specify the containing schema for the projection as part of `projectionName` and use `GPUdb.createSchema(CreateSchemaRequest)` to create the schema if non-existent] Name of a schema for the projection.
`static String`	`CREATE_INDEXES` Comma-separated list of columns on which to create indexes on the projection.
`static String`	`CREATE_TEMP_TABLE` If `true`, a unique temporary table name will be generated in the sys_temp schema and used in place of `projectionName`.
`static String`	`EXPRESSION` An optional filter	`static String`	`FALSE`
`static String`	`HASH` Use	`static String`	`INTERVAL` Use	`static String`	`IS_AUTOMATIC_PARTITION` If `true`, a new partition will be created for values which don't fall into an existing partition.
`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`	`LIST` Use	`static String`	`OFFSET` The number of initial results to skip (this can be useful for paging through the results).
`static String`	`ORDER_BY` Comma-separated list of the columns to be sorted by; e.g.
`static String`	`PARTITION_DEFINITIONS` Comma-separated list of partition definitions, whose format depends on the choice of `partition_type`.
`static String`	`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`.
`static String`	`PARTITION_TYPE`	`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`	`RANGE` Use	`static String`	`RETAIN_PARTITIONS` Determines whether the created projection will retain the partitioning scheme from the source table.
`static String`	`SERIES` Use	`static String`	`SHARD_KEY` Comma-separated list of the columns to be sharded on; e.g.
`static String`	`STRATEGY_DEFINITION` The	`static String`	`TRUE`
`static String`	`TTL` Sets the	`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
  - CREATE_TEMP_TABLE
```
public static final String CREATE_TEMP_TABLE
```
    If true, a unique temporary table name will be generated in the sys_temp schema and used in place of projectionName. 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_projection_name. 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
  - COLLECTION_NAME
```
public static final String COLLECTION_NAME
```
    [DEPRECATED--please specify the containing schema for the projection as part of projectionName and use GPUdb.createSchema(CreateSchemaRequest) to create the schema if non-existent] Name of a schema for the projection. If the schema is non-existent, it will be automatically created. 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
  - OFFSET
```
public static final String OFFSET
```
    The number of initial results to skip (this can be useful for paging through the results). The default value is '0'.
    
    See Also:
    
    Constant Field Values
  - LIMIT
```
public static final String LIMIT
```
    The number of records to keep. The default value is '-9999'.
    
    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
  - 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
  - PARTITION_TYPE
```
public static final String PARTITION_TYPE
```
    Partitioning scheme to use. Supported values:
    - RANGE: Use range partitioning.
    - INTERVAL: Use interval partitioning.
    - LIST: Use list partitioning.
    - HASH: Use hash partitioning.
    - SERIES: Use series partitioning.
    See Also:
    
    Constant Field Values
  - RANGE
```
public static final String RANGE
```
    Use range partitioning.
    
    See Also:
    
    Constant Field Values
  - INTERVAL
```
public static final String INTERVAL
```
    Use interval partitioning.
    
    See Also:
    
    Constant Field Values
  - LIST
```
public static final String LIST
```
    Use list partitioning.
    
    See Also:
    
    Constant Field Values
  - HASH
```
public static final String HASH
```
    Use hash partitioning.
    
    See Also:
    
    Constant Field Values
  - SERIES
```
public static final String SERIES
```
    Use series partitioning.
    
    See Also:
    
    Constant Field Values
  - PARTITION_KEYS
```
public static final String 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.
    
    See Also:
    
    Constant Field Values
  - PARTITION_DEFINITIONS
```
public static final String 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.
    
    See Also:
    
    Constant Field Values
  - IS_AUTOMATIC_PARTITION
```
public static final String 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.
    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
  - STRATEGY_DEFINITION
```
public static final String STRATEGY_DEFINITION
```
    The tier strategy for the table and its columns.
    
    See Also:
    
    Constant Field Values

Class CreateProjectionRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATE_TEMP_TABLE

TRUE

FALSE

COLLECTION_NAME

EXPRESSION

IS_REPLICATED

OFFSET

LIMIT

ORDER_BY

CHUNK_SIZE

CREATE_INDEXES

TTL

SHARD_KEY

PERSIST

PRESERVE_DICT_ENCODING

RETAIN_PARTITIONS

PARTITION_TYPE

RANGE

INTERVAL

LIST

HASH

SERIES

PARTITION_KEYS

PARTITION_DEFINITIONS

IS_AUTOMATIC_PARTITION

VIEW_ID

STRATEGY_DEFINITION