AlterTableRequest.Options (Kinetica Java API 7.0.19.0 API)

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

Enclosing class:

AlterTableRequest
```
public static final class AlterTableRequest.Options
extends Object
```
Optional parameters.
- ACTION
- COLUMN_NAME
- TABLE_NAME
- COLUMN_DEFAULT_VALUE: When adding a column, set a default value for existing records. For nullable columns, the default value will be null, regardless of data type.
- COLUMN_PROPERTIES: When adding or changing a column, set the column properties (strings, separated by a comma: data, store_only, text_search, char8, int8 etc).
- COLUMN_TYPE: When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).
- COMPRESSION_TYPE: When setting column compression (set_column_compression for action), compression type to use: none (to use no compression) or a valid compression type. Supported values:
  The default value is SNAPPY.
- COPY_VALUES_FROM_COLUMN: Deprecated. Please use add_column_expression instead.
- RENAME_COLUMN: When changing a column, specify new column name.
- VALIDATE_CHANGE_COLUMN: When changing a column, validate the change before applying it. If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. Supported values:
  - TRUE: true
  - FALSE: false
  The default value is TRUE.
- UPDATE_LAST_ACCESS_TIME: Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table's TTL. Supported values:
  - TRUE: Reset the expiration countdown timer to the table's configured TTL.
  - FALSE: Don't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed.
  The default value is TRUE.
- ADD_COLUMN_EXPRESSION: When adding a column, an optional expression to use for the new column's values. Any valid expression may be used, including one containing references to existing columns in the same table.
- STRATEGY_DEFINITION: Optional parameter for specifying the tier strategy for the table and its columns when action is set_strategy_definition, replacing the existing tier strategy in its entirety. See tier strategy usage for format and tier strategy examples for examples. This option will be ignored if value is also specified.
- INDEX_TYPE: Type of index to create, when action is create_index, or to delete, when action is delete_index. Supported values:
  - COLUMN: Create or delete a column (attribute) index.
  - CHUNK_SKIP: Create or delete a chunk skip index.
  The default value is COLUMN.
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`	`ACTION`
`static String`	`ADD_COLUMN_EXPRESSION` When adding a column, an optional expression to use for the new column's values.
`static String`	`CHUNK_SKIP` Create or delete a chunk skip index.
`static String`	`COLUMN` Create or delete a column (attribute) index.
`static String`	`COLUMN_DEFAULT_VALUE` When adding a column, set a default value for existing records.
`static String`	`COLUMN_NAME`
`static String`	`COLUMN_PROPERTIES` When adding or changing a column, set the column properties (strings, separated by a comma: data, store_only, text_search, char8, int8 etc).
`static String`	`COLUMN_TYPE` When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).
`static String`	`COMPRESSION_TYPE` When setting column compression (`set_column_compression` for `action`), compression type to use: `none` (to use no compression) or a valid compression type.
`static String`	`COPY_VALUES_FROM_COLUMN` Deprecated.
`static String`	`FALSE` Don't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed.
`static String`	`INDEX_TYPE` Type of index to create, when `action` is `create_index`, or to delete, when `action` is `delete_index`.
`static String`	`LZ4`
`static String`	`LZ4HC`
`static String`	`NONE`
`static String`	`RENAME_COLUMN` When changing a column, specify new column name.
`static String`	`SNAPPY`
`static String`	`STRATEGY_DEFINITION` Optional parameter for specifying the tier strategy for the table and its columns when `action` is `set_strategy_definition`, replacing the existing tier strategy in its entirety.
`static String`	`TABLE_NAME`
`static String`	`TRUE` Reset the expiration countdown timer to the table's configured TTL.
`static String`	`UPDATE_LAST_ACCESS_TIME` Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table's TTL.
`static String`	`VALIDATE_CHANGE_COLUMN` When changing a column, validate the change before applying it.

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

- Field Detail
  - ACTION
```
public static final String ACTION
```
    See Also:
    
    Constant Field Values
  - COLUMN_NAME
```
public static final String COLUMN_NAME
```
    See Also:
    
    Constant Field Values
  - TABLE_NAME
```
public static final String TABLE_NAME
```
    See Also:
    
    Constant Field Values
  - COLUMN_DEFAULT_VALUE
```
public static final String COLUMN_DEFAULT_VALUE
```
    When adding a column, set a default value for existing records. For nullable columns, the default value will be null, regardless of data type.
    
    See Also:
    
    Constant Field Values
  - COLUMN_PROPERTIES
```
public static final String COLUMN_PROPERTIES
```
    When adding or changing a column, set the column properties (strings, separated by a comma: data, store_only, text_search, char8, int8 etc).
    
    See Also:
    
    Constant Field Values
  - COLUMN_TYPE
```
public static final String COLUMN_TYPE
```
    When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).
    
    See Also:
    
    Constant Field Values
  - COMPRESSION_TYPE
```
public static final String COMPRESSION_TYPE
```
    When setting column compression (set_column_compression for action), compression type to use: none (to use no compression) or a valid compression type. Supported values:
    The default value is SNAPPY.
    See Also:
    
    Constant Field Values
  - NONE
```
public static final String NONE
```
    See Also:
    
    Constant Field Values
  - SNAPPY
```
public static final String SNAPPY
```
    See Also:
    
    Constant Field Values
  - LZ4
```
public static final String LZ4
```
    See Also:
    
    Constant Field Values
  - LZ4HC
```
public static final String LZ4HC
```
    See Also:
    
    Constant Field Values
  - COPY_VALUES_FROM_COLUMN
```
public static final String COPY_VALUES_FROM_COLUMN
```
    Deprecated. Please use add_column_expression instead.
    
    See Also:
    
    Constant Field Values
  - RENAME_COLUMN
```
public static final String RENAME_COLUMN
```
    When changing a column, specify new column name.
    
    See Also:
    
    Constant Field Values
  - VALIDATE_CHANGE_COLUMN
```
public static final String VALIDATE_CHANGE_COLUMN
```
    When changing a column, validate the change before applying it. If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. Supported values:
    - TRUE: true
    - FALSE: false
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    Reset the expiration countdown timer to the table's configured TTL.
    
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    Don't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed.
    
    See Also:
    
    Constant Field Values
  - UPDATE_LAST_ACCESS_TIME
```
public static final String UPDATE_LAST_ACCESS_TIME
```
    Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table's TTL. Supported values:
    - TRUE: Reset the expiration countdown timer to the table's configured TTL.
    - FALSE: Don't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed.
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - ADD_COLUMN_EXPRESSION
```
public static final String ADD_COLUMN_EXPRESSION
```
    When adding a column, an optional expression to use for the new column's values. Any valid expression may be used, including one containing references to existing columns in the same table.
    
    See Also:
    
    Constant Field Values
  - STRATEGY_DEFINITION
```
public static final String STRATEGY_DEFINITION
```
    Optional parameter for specifying the tier strategy for the table and its columns when action is set_strategy_definition, replacing the existing tier strategy in its entirety. See tier strategy usage for format and tier strategy examples for examples. This option will be ignored if value is also specified.
    
    See Also:
    
    Constant Field Values
  - INDEX_TYPE
```
public static final String INDEX_TYPE
```
    Type of index to create, when action is create_index, or to delete, when action is delete_index. Supported values:
    - COLUMN: Create or delete a column (attribute) index.
    - CHUNK_SKIP: Create or delete a chunk skip index.
    The default value is COLUMN.
    See Also:
    
    Constant Field Values
  - COLUMN
```
public static final String COLUMN
```
    Create or delete a column (attribute) index.
    
    See Also:
    
    Constant Field Values
  - CHUNK_SKIP
```
public static final String CHUNK_SKIP
```
    Create or delete a chunk skip index.
    
    See Also:
    
    Constant Field Values

Class AlterTableRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTION

COLUMN_NAME

TABLE_NAME

COLUMN_DEFAULT_VALUE

COLUMN_PROPERTIES

COLUMN_TYPE

COMPRESSION_TYPE

NONE

SNAPPY

LZ4

LZ4HC

COPY_VALUES_FROM_COLUMN

RENAME_COLUMN

VALIDATE_CHANGE_COLUMN

TRUE

FALSE

UPDATE_LAST_ACCESS_TIME

ADD_COLUMN_EXPRESSION

STRATEGY_DEFINITION

INDEX_TYPE

COLUMN

CHUNK_SKIP