com.gpudb.protocol

Class AlterTableRequest.Action

java.lang.Object

com.gpudb.protocol.AlterTableRequest.Action

Enclosing class:

AlterTableRequest

public static final class AlterTableRequest.Action
extends Object

Modification operation to be applied Supported values:

• ALLOW_HOMOGENEOUS_TABLES: No longer supported; action will be ignored.
• CREATE_INDEX: Creates a column (attribute) index, chunk skip index, or geospatial 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.
• DELETE_INDEX: Deletes a column (attribute) index, chunk skip index, or geospatial 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.
• MOVE_TO_COLLECTION: [DEPRECATED--please use move_to_schema and use GPUdb.createSchema(CreateSchemaRequest) 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.
• 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.
• PROTECTED: No longer used. Previously set whether the given tableName should be protected or not. The value would have been either 'true' or 'false'.
• RENAME_TABLE: Renames a table or view within its current schema to value. Has the same naming restrictions as tables.
• TTL: Sets the time-to-live in minutes of the table or view specified in tableName.
• 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.
• 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.
• SET_COLUMN_COMPRESSION: No longer supported; action will be ignored.
• DELETE_COLUMN: Deletes the column specified in value from the table specified in tableName.
• 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]'.
• 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.
• ADD_PARTITION: Adds the partition specified in value, to either a range-partitioned or manual list-partitioned table.
• 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.
• DELETE_PARTITION: Deletes the partition specified in value (and all of its data) from either a range-partitioned or manual list-partitioned table.
• 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'.
• 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.
• 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'.
• 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.
• 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'.
• 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.
• SET_REFRESH_SPAN: Sets the future time-offset(in seconds) for the view refresh to stop.
• SET_REFRESH_EXECUTE_AS: Sets the user name to refresh this materialized view to the value specified in value.
• REMOVE_TEXT_SEARCH_ATTRIBUTES: Removes text search attribute from all columns.
• 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.
• 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.
• CANCEL_DATASOURCE_SUBSCRIPTION: Permanently unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure.
• PAUSE_DATASOURCE_SUBSCRIPTION: Temporarily unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure.
• RESUME_DATASOURCE_SUBSCRIPTION: Resubscribe to a paused data source subscription. The data source can be Kafka / S3 / Azure.
• CHANGE_OWNER: Change the owner resource group of the table.

A set of string constants for the parameter action.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD_COLUMN Adds the column specified in value to the table specified in tableName.
static String	ADD_PARTITION Adds the partition specified in value, to either a	static String	ALLOW_HOMOGENEOUS_TABLES No longer supported; action will be ignored.
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	static String	CREATE_INDEX Creates a	static String	DELETE_COLUMN Deletes the column specified in value from the table specified in tableName.
static String	DELETE_FOREIGN_KEY Deletes a	static String	DELETE_INDEX Deletes a	static String	DELETE_PARTITION Deletes the partition specified in value (and all of its data) from either a	static String	MOVE_TO_COLLECTION [DEPRECATED--please use move_to_schema and use GPUdb.createSchema(CreateSchemaRequest) 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	static String	REMOVE_PARTITION Removes the partition specified in value (and relocates all of its data to the default partition) from either a	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	static String	RENAME_TABLE Renames a table or view within its current schema to value.
static String	RESUME_DATASOURCE_SUBSCRIPTION Resubscribe to a paused data source subscription.
static String	SET_COLUMN_COMPRESSION No longer supported; action will be ignored.
static String	SET_GLOBAL_ACCESS_MODE Sets the global access mode (i.e. locking) for the table specified in tableName.
static String	SET_REFRESH_EXECUTE_AS Sets the user name to refresh this	static String	SET_REFRESH_METHOD For a	static String	SET_REFRESH_PERIOD Sets the time interval in seconds at which to refresh this	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	static String	SET_REFRESH_STOP_TIME Sets the time to stop periodic refreshes of this	static String	SET_STRATEGY_DEFINITION Sets the	static String	TTL Sets the Method Summary Methods inherited from class java.lang.Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait Field Detail ALLOW_HOMOGENEOUS_TABLES public static final String ALLOW_HOMOGENEOUS_TABLES No longer supported; action will be ignored. See Also: Constant Field Values CREATE_INDEX public static final String CREATE_INDEX Creates a column (attribute) index, chunk skip index, or geospatial 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 DELETE_INDEX public static final String DELETE_INDEX Deletes a column (attribute) index, chunk skip index, or geospatial 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(CreateSchemaRequest) 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 within its current schema 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_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 SET_COLUMN_COMPRESSION public static final String SET_COLUMN_COMPRESSION No longer supported; action will be ignored. 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 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 Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method Copyright © 2024. All rights reserved.