Package com.gpudb.protocol
Class AlterTableRequest.Options
- java.lang.Object
-
- com.gpudb.protocol.AlterTableRequest.Options
-
- Enclosing class:
- AlterTableRequest
public static final class AlterTableRequest.Options extends Object
-
-
Field Summary
Fields Modifier and Type Field Description static StringACTIONstatic StringADD_COLUMN_EXPRESSIONWhen adding a column, an optional expression to use for the new column's values.static StringCAGRACreate or delete a CAGRA index on a vector columnstatic StringCHUNK_SKIPCreate or delete a chunk skip index.static StringCOLUMNCreate or delete a column (attribute) index.static StringCOLUMN_DEFAULT_VALUEWhen adding a column, set a default value for existing records.static StringCOLUMN_NAMEstatic StringCOLUMN_PROPERTIESWhen adding or changing a column, set the column properties (strings, separated by a comma: data, text_search, char8, int8 etc).static StringCOLUMN_TYPEWhen adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).static StringCOPY_VALUES_FROM_COLUMN[DEPRECATED--please useADD_COLUMN_EXPRESSIONinstead.]static StringFALSEDon't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed.static StringGEOSPATIALCreate or delete a geospatial indexstatic StringHNSWCreate or delete an HNSW index on a vector columnstatic StringINDEX_OPTIONSOptions to use when creating an index, in the format "key: value [, key: value [, ...]]".static StringINDEX_TYPEType of index to create, whenactionisCREATE_INDEX; to refresh, whenactionisREFRESH_INDEX; or to delete, whenactionisDELETE_INDEX.static StringLOW_CARDINALITYCreate a low-cardinality column (attribute) index.static StringRENAME_COLUMNWhen changing a column, specify new column name.static StringSTRATEGY_DEFINITIONOptional parameter for specifying the tier strategy for the table and its columns whenactionisSET_STRATEGY_DEFINITION, replacing the existing tier strategy in its entirety.static StringTABLE_NAMEstatic StringTRUEReset the expiration countdown timer to the table's configured TTL.static StringUPDATE_LAST_ACCESS_TIMEIndicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table's TTL.static StringVALIDATE_CHANGE_COLUMNWhen changing a column, validate the change before applying it (or not).
-
-
-
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, 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 useADD_COLUMN_EXPRESSIONinstead.]- 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.
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.
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 whenactionisSET_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, whenactionisCREATE_INDEX; to refresh, whenactionisREFRESH_INDEX; or to delete, whenactionisDELETE_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 indexCAGRA: Create or delete a CAGRA index on a vector columnHNSW: Create or delete an HNSW index on a vector column
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
-
-