​

Field Details

• ​

  TYPE_ID

  public static final String TYPE_ID

  ID of a currently registered type. The default value is ”.

  See Also:

  • Constant Field Values

• ​

  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

• ​

  IS_REPLICATED

  public static final String IS_REPLICATED

  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 TYPE_ID, 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.
  • 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

• ​

  TTL

  public static final String TTL

  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

  Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data-handling, 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 Also:

  • Constant Field Values

• ​

  COMPRESSION_CODEC

  public static final String COMPRESSION_CODEC

  The default compression codec for this table’s columns.

  See Also:

  • Constant Field Values