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: Sets whether homogeneous tables are allowed in the given collection. This action is only valid if tableName is a collection. The value must be either 'true' or 'false'.
• CREATE_INDEX: Creates an index on the column name specified in value. If this column is already indexed, an error will be returned.
• DELETE_INDEX: Deletes an existing index on the column name specified in value. If this column does not have indexing turned on, an error will be returned.
• MOVE_TO_COLLECTION: Moves a table into a collection value.
• PROTECTED: Sets whether the given tableName should be protected or not. The value must be either 'true' or 'false'.
• RENAME_TABLE: Renames a table, view or collection to value. Has the same naming restrictions as tables.
• TTL: Sets the TTL of the table, view, or collection 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.
• SET_COLUMN_COMPRESSION: Modifies the compression setting on the column specified in value.
• DELETE_COLUMN: Deletes the column specified in value from the table specified in tableName.
• CREATE_FOREIGN_KEY: Creates a foreign key using the format 'source_column references target_table(primary_key_column) [ as ]'.
• DELETE_FOREIGN_KEY: Deletes a foreign key. The value should be the specified when creating the key or the complete string used to define it.
• 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'.

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	ALLOW_HOMOGENEOUS_TABLES Sets whether homogeneous tables are allowed in the given collection.
static String	CHANGE_COLUMN Changes type and properties of the column specified in value.
static String	CREATE_FOREIGN_KEY Creates a foreign key using the format 'source_column references target_table(primary_key_column) [ as ]'.
static String	CREATE_INDEX Creates an index 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 an existing index on the column name specified in value.
static String	MOVE_TO_COLLECTION Moves a table into a collection value.
static String	PROTECTED Sets whether the given tableName should be protected or not.
static String	RENAME_TABLE Renames a table, view or collection to value.
static String	SET_COLUMN_COMPRESSION Modifies the compression setting on the column specified in value.
static String	SET_GLOBAL_ACCESS_MODE Sets the global access mode (i.e.
static String	TTL Sets the TTL of the table, view, or collection 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

ALLOW_HOMOGENEOUS_TABLES

public static final String ALLOW_HOMOGENEOUS_TABLES

Sets whether homogeneous tables are allowed in the given collection. This action is only valid if tableName is a collection. The value must be either 'true' or 'false'.

See Also:

Constant Field Values

CREATE_INDEX

public static final String CREATE_INDEX

Creates an index on the column name specified in value. If this column is already indexed, an error will be returned.

See Also:

Constant Field Values

DELETE_INDEX

public static final String DELETE_INDEX

Deletes an existing index on the column name specified in value. If this column does not have indexing turned on, an error will be returned.

See Also:

Constant Field Values

MOVE_TO_COLLECTION

public static final String MOVE_TO_COLLECTION

Moves a table into a collection value.

See Also:

Constant Field Values

PROTECTED

public static final String PROTECTED

Sets whether the given tableName should be protected or not. The value must be either 'true' or 'false'.

See Also:

Constant Field Values

RENAME_TABLE

public static final String RENAME_TABLE

Renames a table, view or collection to value. Has the same naming restrictions as tables.

See Also:

Constant Field Values

TTL

public static final String TTL

Sets the TTL of the table, view, or collection 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.

See Also:

Constant Field Values

SET_COLUMN_COMPRESSION

public static final String SET_COLUMN_COMPRESSION

Modifies the compression setting on the column specified in value.

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 using the format 'source_column references target_table(primary_key_column) [ as ]'.

See Also:

Constant Field Values

DELETE_FOREIGN_KEY

public static final String DELETE_FOREIGN_KEY

Deletes a foreign key. The value should be the specified when creating the key or the complete string used to define it.

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