​

Field Details

• ​

  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 literal default value for existing records. For nullable columns, the default value will be null, regardless of data type. Also persisted as the column’s default for future inserts that omit the column.

  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, 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

• ​

  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 (or not). Supported values:

  • TRUE: Validate all values. A value too large (or too long) for the new type will prevent any change.
  • FALSE: When a value is too large or long, it will be truncated.

  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 or setting a new default with action set to SET_DEFAULT, the new default expression (GPUdb-syntax) for the column. Any valid expression may be used, including one containing references to existing columns in the same table. Persisted as the column’s default for future inserts that omit the column; for add_column, also used to backfill existing rows.

  See Also:

  • Constant Field Values

• ​

  ADD_COLUMN_EXPRESSION_SQL

  public static final String ADD_COLUMN_EXPRESSION_SQL

  Optional SQL-syntax form of ADD_COLUMN_EXPRESSION, used only when the SQL syntax differs from the GPUdb syntax. Persisted alongside the GPUdb form so SHOW CREATE TABLE / information_schema can reproduce the original SQL.

  See Also:

  • Constant Field Values

• ​

  STRATEGY_DEFINITION

  public static final String STRATEGY_DEFINITION

  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 Also:

  • Constant Field Values

• ​

  INDEX_TYPE

  public static final String INDEX_TYPE

  Type of index to create, when action is CREATE_INDEX; to refresh, when action is REFRESH_INDEX; or to delete, when action is DELETE_INDEX. Supported values:

  • COLUMN: Create or delete a column (attribute) index.
  • LOW_CARDINALITY: Create a low-cardinality column (attribute) index.
  • CHUNK_SKIP: Create or delete a chunk skip index.
  • GEOSPATIAL: Create or delete a geospatial index.
  • CAGRA: Create or delete a CAGRA index on a vector column.
  • HNSW: Create or delete an HNSW index on a vector column.

  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

• ​

  LOW_CARDINALITY

  public static final String LOW_CARDINALITY

  Create a low-cardinality 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

• ​

  GEOSPATIAL

  public static final String GEOSPATIAL

  Create or delete a geospatial index.

  See Also:

  • Constant Field Values

• ​

  CAGRA

  public static final String CAGRA

  Create or delete a CAGRA index on a vector column.

  See Also:

  • Constant Field Values

• ​

  HNSW

  public static final String HNSW

  Create or delete an HNSW index on a vector column.

  See Also:

  • Constant Field Values

• ​

  INDEX_OPTIONS

  public static final String INDEX_OPTIONS

  Options to use when creating an index, in the format “key: value [, key: value [, …]]”. Valid options vary by index type.

  See Also:

  • Constant Field Values