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

Enclosing class:

AlterTableRequest
```
public static final class AlterTableRequest.Action
extends Object
```
A set of string constants for the AlterTableRequest parameter action.
Modification operation to be applied

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ADD_COLUMN`	Adds the column specified in `value` to the table specified in `tableName`.
`static String`	`ADD_COMMENT`	Adds the comment specified in `value` to the table specified in `tableName`.
`static String`	`ADD_PARTITION`	Adds the partition specified in `value`, to either a range-partitioned or manual list-partitioned table.
`static String`	`CANCEL_DATASOURCE_SUBSCRIPTION`	Permanently unsubscribe a data source that is loading continuously as a stream.
`static String`	`CHANGE_COLUMN`	Changes type and properties of the column specified in `value`.
`static String`	`CHANGE_OWNER`	Change the owner resource group of the table.
`static String`	`CREATE_FOREIGN_KEY`	Creates a foreign key specified in `value` using the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...])
`static String`	`CREATE_INDEX`	Creates a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified `INDEX_TYPE`), on the column name specified in `value`.
`static String`	`DELETE_COLUMN`	Deletes the column specified in `value` from the table specified in `tableName`.
`static String`	`DELETE_FOREIGN_KEY`	Deletes a foreign key.
`static String`	`DELETE_INDEX`	Deletes a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified `INDEX_TYPE`), on the column name specified in `value`.
`static String`	`DELETE_PARTITION`	Deletes the partition specified in `value` (and all of its data) from either a range-partitioned or manual list-partitioned table.
`static String`	`DROP_DATASOURCE_SUBSCRIPTION`	Permanently delete a cancelled data source subscription.
`static String`	`MOVE_TO_COLLECTION`	[DEPRECATED--please use `MOVE_TO_SCHEMA` and use `GPUdb.createSchema` to create the schema if non-existent] Moves a table or view into a schema named `value`.
`static String`	`MOVE_TO_SCHEMA`	Moves a table or view into a schema named `value`.
`static String`	`PAUSE_DATASOURCE_SUBSCRIPTION`	Temporarily unsubscribe a data source that is loading continuously as a stream.
`static String`	`PROTECTED`	No longer used.
`static String`	`REFRESH`	For a materialized view, replays all the table creation commands required to create the view.
`static String`	`REFRESH_INDEX`	Refreshes an index identified by `INDEX_TYPE`, on the column name specified in `value`.
`static String`	`REMOVE_PARTITION`	Removes the partition specified in `value` (and relocates all of its data to the default partition) from either a range-partitioned or manual list-partitioned table.
`static String`	`REMOVE_SHARD_KEYS`	Removes the shard key property from all columns, so that the table will be considered randomly sharded.
`static String`	`REMOVE_TEXT_SEARCH_ATTRIBUTES`	Removes text search attribute from all columns.
`static String`	`RENAME_TABLE`	Renames a table or view to `value`.
`static String`	`RESUME_DATASOURCE_SUBSCRIPTION`	Resubscribe to a paused data source subscription.
`static String`	`SET_BUILD_MATERIALIZED_VIEW_POLICY`	Set startup rebuilding scheme for the materialized view; see description of 'build_materialized_view_policy' in `GPUdb.createMaterializedView` for possible values for `value`
`static String`	`SET_BUILD_PK_INDEX_POLICY`	Set startup primary key generation scheme for the table; see description of 'build_pk_index_policy' in `GPUdb.createTable` for possible values for `value`
`static String`	`SET_GLOBAL_ACCESS_MODE`	Sets the global access mode (i.e. locking) for the table specified in `tableName`.
`static String`	`SET_LOAD_VECTORS_POLICY`	Set startup data loading scheme for the table; see description of 'load_vectors_policy' in `GPUdb.createTable` for possible values for `value`
`static String`	`SET_REFRESH_EXECUTE_AS`	Sets the user name to refresh this materialized view to the value specified in `value`.
`static String`	`SET_REFRESH_METHOD`	For a materialized view, sets the method by which the view is refreshed to the method specified in `value` - one of 'manual', 'periodic', or 'on_change'.
`static String`	`SET_REFRESH_PERIOD`	Sets the time interval in seconds at which to refresh this materialized view to the value specified in `value`.
`static String`	`SET_REFRESH_SPAN`	Sets the future time-offset(in seconds) for the view refresh to stop.
`static String`	`SET_REFRESH_START_TIME`	Sets the time to start periodic refreshes of this materialized view to the datetime string specified in `value` with format 'YYYY-MM-DD HH:MM:SS'.
`static String`	`SET_REFRESH_STOP_TIME`	Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in `value` with format 'YYYY-MM-DD HH:MM:SS'.
`static String`	`SET_STRATEGY_DEFINITION`	Sets the tier strategy for the table and its columns to the one specified in `value`, replacing the existing tier strategy in its entirety.
`static String`	`TTL`	Sets the time-to-live in minutes of the table or view 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
  - CREATE_INDEX
```
public static final String CREATE_INDEX
```
    Creates a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified INDEX_TYPE), on the column name specified in value. If this column already has the specified index, an error will be returned.
    
    See Also:
    
    Constant Field Values
  - REFRESH_INDEX
```
public static final String REFRESH_INDEX
```
    Refreshes an index identified by INDEX_TYPE, on the column name specified in value. Currently applicable only to CAGRA indices.
    
    See Also:
    
    Constant Field Values
  - DELETE_INDEX
```
public static final String DELETE_INDEX
```
    Deletes a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified INDEX_TYPE), on the column name specified in value. If this column does not have the specified index, an error will be returned.
    
    See Also:
    
    Constant Field Values
  - MOVE_TO_COLLECTION
```
public static final String MOVE_TO_COLLECTION
```
    [DEPRECATED--please use MOVE_TO_SCHEMA and use GPUdb.createSchema to create the schema if non-existent] Moves a table or view into a schema named value. If the schema provided is non-existent, it will be automatically created.
    
    See Also:
    
    Constant Field Values
  - MOVE_TO_SCHEMA
```
public static final String MOVE_TO_SCHEMA
```
    Moves a table or view into a schema named value. If the schema provided is nonexistent, an error will be thrown. If value is empty, then the table or view will be placed in the user's default schema.
    
    See Also:
    
    Constant Field Values
  - PROTECTED
```
public static final String PROTECTED
```
    No longer used. Previously set whether the given tableName should be protected or not. The value would have been either 'true' or 'false'.
    
    See Also:
    
    Constant Field Values
  - RENAME_TABLE
```
public static final String RENAME_TABLE
```
    Renames a table or view to value. Has the same naming restrictions as tables.
    
    See Also:
    
    Constant Field Values
  - TTL
```
public static final String TTL
```
    Sets the time-to-live in minutes of the table or view specified in tableName.
    
    See Also:
    
    Constant Field Values
  - ADD_COMMENT
```
public static final String ADD_COMMENT
```
    Adds the comment specified in value to the table specified in tableName. Use COLUMN_NAME to set the comment for a column.
    
    See Also:
    
    Constant Field Values
  - ADD_COLUMN
```
public static final String ADD_COLUMN
```
    Adds the column specified in value to the table specified in tableName. Use COLUMN_TYPE and COLUMN_PROPERTIES in options to set the column's type and properties, respectively.
    
    See Also:
    
    Constant Field Values
  - CHANGE_COLUMN
```
public static final String CHANGE_COLUMN
```
    Changes type and properties of the column specified in value. Use COLUMN_TYPE and COLUMN_PROPERTIES in options to set the column's type and properties, respectively. Note that primary key and/or shard key columns cannot be changed. All unchanging column properties must be listed for the change to take place, e.g., to add dictionary encoding to an existing 'char4' column, both 'char4' and 'dict' must be specified in the options map.
    
    See Also:
    
    Constant Field Values
  - DELETE_COLUMN
```
public static final String DELETE_COLUMN
```
    Deletes the column specified in value from the table specified in tableName.
    
    See Also:
    
    Constant Field Values
  - CREATE_FOREIGN_KEY
```
public static final String CREATE_FOREIGN_KEY
```
    Creates a foreign key specified in value using the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
    
    See Also:
    
    Constant Field Values
  - DELETE_FOREIGN_KEY
```
public static final String DELETE_FOREIGN_KEY
```
    Deletes a foreign key. The value should be the foreign_key_name specified when creating the key or the complete string used to define it.
    
    See Also:
    
    Constant Field Values
  - ADD_PARTITION
```
public static final String ADD_PARTITION
```
    Adds the partition specified in value, to either a range-partitioned or manual list-partitioned table.
    
    See Also:
    
    Constant Field Values
  - REMOVE_PARTITION
```
public static final String REMOVE_PARTITION
```
    Removes the partition specified in value (and relocates all of its data to the default partition) from either a range-partitioned or manual list-partitioned table.
    
    See Also:
    
    Constant Field Values
  - DELETE_PARTITION
```
public static final String DELETE_PARTITION
```
    Deletes the partition specified in value (and all of its data) from either a range-partitioned or manual list-partitioned table.
    
    See Also:
    
    Constant Field Values
  - SET_GLOBAL_ACCESS_MODE
```
public static final String SET_GLOBAL_ACCESS_MODE
```
    Sets the global access mode (i.e. locking) for the table specified in tableName. Specify the access mode in value. Valid modes are 'no_access', 'read_only', 'write_only' and 'read_write'.
    
    See Also:
    
    Constant Field Values
  - REFRESH
```
public static final String REFRESH
```
    For a materialized view, replays all the table creation commands required to create the view. For an external table, reloads all data in the table from its associated source files or data source.
    
    See Also:
    
    Constant Field Values
  - SET_REFRESH_METHOD
```
public static final String SET_REFRESH_METHOD
```
    For a materialized view, sets the method by which the view is refreshed to the method specified in value - one of 'manual', 'periodic', or 'on_change'. For an external table, sets the method by which the table is refreshed to the method specified in value - either 'manual' or 'on_start'.
    
    See Also:
    
    Constant Field Values
  - SET_REFRESH_START_TIME
```
public static final String SET_REFRESH_START_TIME
```
    Sets the time to start periodic refreshes of this materialized view to the datetime string specified in value with format 'YYYY-MM-DD HH:MM:SS'. Subsequent refreshes occur at the specified time + N * the refresh period.
    
    See Also:
    
    Constant Field Values
  - SET_REFRESH_STOP_TIME
```
public static final String SET_REFRESH_STOP_TIME
```
    Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in value with format 'YYYY-MM-DD HH:MM:SS'.
    
    See Also:
    
    Constant Field Values
  - SET_REFRESH_PERIOD
```
public static final String SET_REFRESH_PERIOD
```
    Sets the time interval in seconds at which to refresh this materialized view to the value specified in value. Also, sets the refresh method to periodic if not already set.
    
    See Also:
    
    Constant Field Values
  - SET_REFRESH_SPAN
```
public static final String SET_REFRESH_SPAN
```
    Sets the future time-offset(in seconds) for the view refresh to stop.
    
    See Also:
    
    Constant Field Values
  - SET_REFRESH_EXECUTE_AS
```
public static final String SET_REFRESH_EXECUTE_AS
```
    Sets the user name to refresh this materialized view to the value specified in value.
    
    See Also:
    
    Constant Field Values
  - REMOVE_TEXT_SEARCH_ATTRIBUTES
```
public static final String REMOVE_TEXT_SEARCH_ATTRIBUTES
```
    Removes text search attribute from all columns.
    
    See Also:
    
    Constant Field Values
  - REMOVE_SHARD_KEYS
```
public static final String REMOVE_SHARD_KEYS
```
    Removes the shard key property from all columns, so that the table will be considered randomly sharded. The data is not moved. The value is ignored.
    
    See Also:
    
    Constant Field Values
  - SET_STRATEGY_DEFINITION
```
public static final String SET_STRATEGY_DEFINITION
```
    Sets the tier strategy for the table and its columns to the one specified in value, replacing the existing tier strategy in its entirety.
    
    See Also:
    
    Constant Field Values
  - CANCEL_DATASOURCE_SUBSCRIPTION
```
public static final String CANCEL_DATASOURCE_SUBSCRIPTION
```
    Permanently unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure.
    
    See Also:
    
    Constant Field Values
  - DROP_DATASOURCE_SUBSCRIPTION
```
public static final String DROP_DATASOURCE_SUBSCRIPTION
```
    Permanently delete a cancelled data source subscription.
    
    See Also:
    
    Constant Field Values
  - PAUSE_DATASOURCE_SUBSCRIPTION
```
public static final String PAUSE_DATASOURCE_SUBSCRIPTION
```
    Temporarily unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure.
    
    See Also:
    
    Constant Field Values
  - RESUME_DATASOURCE_SUBSCRIPTION
```
public static final String RESUME_DATASOURCE_SUBSCRIPTION
```
    Resubscribe to a paused data source subscription. The data source can be Kafka / S3 / Azure.
    
    See Also:
    
    Constant Field Values
  - CHANGE_OWNER
```
public static final String CHANGE_OWNER
```
    Change the owner resource group of the table.
    
    See Also:
    
    Constant Field Values
  - SET_LOAD_VECTORS_POLICY
```
public static final String SET_LOAD_VECTORS_POLICY
```
    Set startup data loading scheme for the table; see description of 'load_vectors_policy' in GPUdb.createTable for possible values for value
    
    See Also:
    
    Constant Field Values
  - SET_BUILD_PK_INDEX_POLICY
```
public static final String SET_BUILD_PK_INDEX_POLICY
```
    Set startup primary key generation scheme for the table; see description of 'build_pk_index_policy' in GPUdb.createTable for possible values for value
    
    See Also:
    
    Constant Field Values
  - SET_BUILD_MATERIALIZED_VIEW_POLICY
```
public static final String SET_BUILD_MATERIALIZED_VIEW_POLICY
```
    Set startup rebuilding scheme for the materialized view; see description of 'build_materialized_view_policy' in GPUdb.createMaterializedView for possible values for value
    
    See Also:
    
    Constant Field Values

Class AlterTableRequest.Action

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATE_INDEX

REFRESH_INDEX

DELETE_INDEX

MOVE_TO_COLLECTION

MOVE_TO_SCHEMA

PROTECTED

RENAME_TABLE

TTL

ADD_COMMENT

ADD_COLUMN

CHANGE_COLUMN

DELETE_COLUMN

CREATE_FOREIGN_KEY

DELETE_FOREIGN_KEY

ADD_PARTITION

REMOVE_PARTITION

DELETE_PARTITION

SET_GLOBAL_ACCESS_MODE

REFRESH

SET_REFRESH_METHOD

SET_REFRESH_START_TIME

SET_REFRESH_STOP_TIME

SET_REFRESH_PERIOD

SET_REFRESH_SPAN

SET_REFRESH_EXECUTE_AS

REMOVE_TEXT_SEARCH_ATTRIBUTES

REMOVE_SHARD_KEYS

SET_STRATEGY_DEFINITION

CANCEL_DATASOURCE_SUBSCRIPTION

DROP_DATASOURCE_SUBSCRIPTION

PAUSE_DATASOURCE_SUBSCRIPTION

RESUME_DATASOURCE_SUBSCRIPTION

CHANGE_OWNER

SET_LOAD_VECTORS_POLICY

SET_BUILD_PK_INDEX_POLICY

SET_BUILD_MATERIALIZED_VIEW_POLICY