CreateTableRequest.Options (Kinetica Java API 7.0.19.0 API)

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

Enclosing class:

CreateTableRequest
```
public static final class CreateTableRequest.Options
extends Object
```
Optional parameters.
- NO_ERROR_IF_EXISTS: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- COLLECTION_NAME: Name of a collection which is to contain the newly created table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created table will be a top-level table.
- IS_COLLECTION: Indicates whether the new table to be created will be a collection. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- DISALLOW_HOMOGENEOUS_TABLES: No longer supported; value will be ignored. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- IS_REPLICATED: For a table, affects the distribution scheme for the table's data. If true and the given type has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given typeId, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- FOREIGN_KEYS: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
- FOREIGN_SHARD_KEY: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
- PARTITION_TYPE: Partitioning scheme to use. Supported values:
  - RANGE: Use range partitioning.
  - INTERVAL: Use interval partitioning.
  - LIST: Use list partitioning.
  - HASH: Use hash 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, or hash 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.
- TTL: For a table, sets the TTL of the table specified in tableName.
- CHUNK_SIZE: Indicates the number of records per chunk to be used for this table.
- IS_RESULT_TABLE: For a table, indicates whether the table is an in-memory table. A result table cannot contain store_only, text_search, or string columns (charN columns are acceptable), and it will not be retained if the server is restarted. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- STRATEGY_DEFINITION: The tier strategy for the table and its columns. See tier strategy usage for format and tier strategy examples for examples.
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 table.
`static String`	`COLLECTION_NAME` Name of a collection which is to contain the newly created table.
`static String`	`DISALLOW_HOMOGENEOUS_TABLES` No longer supported; value will be ignored.
`static String`	`FALSE`
`static String`	`FOREIGN_KEYS` Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
`static String`	`FOREIGN_SHARD_KEY` Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
`static String`	`HASH` Use hash partitioning.
`static String`	`INTERVAL` Use interval partitioning.
`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_COLLECTION` Indicates whether the new table to be created will be a collection.
`static String`	`IS_REPLICATED` For a table, affects the distribution scheme for the table's data.
`static String`	`IS_RESULT_TABLE` For a table, indicates whether the table is an in-memory table.
`static String`	`LIST` Use list partitioning.
`static String`	`NO_ERROR_IF_EXISTS` If `true`, prevents an error from occurring if the table already exists and is of the given type.
`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` Partitioning scheme to use.
`static String`	`RANGE` Use range partitioning.
`static String`	`STRATEGY_DEFINITION` The tier strategy for the table and its columns.
`static String`	`TRUE`
`static String`	`TTL` For a table, sets the TTL of the table specified in `tableName`.

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

- Field Detail
  - NO_ERROR_IF_EXISTS
```
public static final String NO_ERROR_IF_EXISTS
```
    If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. 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
```
    Name of a collection which is to contain the newly created table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created table will be a top-level table.
    
    See Also:
    
    Constant Field Values
  - IS_COLLECTION
```
public static final String IS_COLLECTION
```
    Indicates whether the new table to be created will be a collection. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - DISALLOW_HOMOGENEOUS_TABLES
```
public static final String DISALLOW_HOMOGENEOUS_TABLES
```
    No longer supported; value will be ignored. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - IS_REPLICATED
```
public static final String IS_REPLICATED
```
    For a table, affects the distribution scheme for the table's data. If true and the given type has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given typeId, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - FOREIGN_KEYS
```
public static final String FOREIGN_KEYS
```
    Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
    
    See Also:
    
    Constant Field Values
  - FOREIGN_SHARD_KEY
```
public static final String FOREIGN_SHARD_KEY
```
    Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
    
    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.
    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
  - 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, or hash 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
  - TTL
```
public static final String TTL
```
    For a table, sets the TTL of the table specified in tableName.
    
    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 table.
    
    See Also:
    
    Constant Field Values
  - IS_RESULT_TABLE
```
public static final String IS_RESULT_TABLE
```
    For a table, indicates whether the table is an in-memory table. A result table cannot contain store_only, text_search, or string columns (charN columns are acceptable), and it will not be retained if the server is restarted. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - STRATEGY_DEFINITION
```
public static final String STRATEGY_DEFINITION
```
    The tier strategy for the table and its columns. See tier strategy usage for format and tier strategy examples for examples.
    
    See Also:
    
    Constant Field Values

Class CreateTableRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_ERROR_IF_EXISTS

TRUE

FALSE

COLLECTION_NAME

IS_COLLECTION

DISALLOW_HOMOGENEOUS_TABLES

IS_REPLICATED

FOREIGN_KEYS

FOREIGN_SHARD_KEY

PARTITION_TYPE

RANGE

INTERVAL

LIST

HASH

PARTITION_KEYS

PARTITION_DEFINITIONS

IS_AUTOMATIC_PARTITION

TTL

CHUNK_SIZE

IS_RESULT_TABLE

STRATEGY_DEFINITION