​

Method Details

• ​

  getClassSchema

  public static org.apache.avro.Schema getClassSchema()

  This method supports the Avro framework and is not intended to be called directly by the user.

  Returns:

  The schema for the class.

• ​

  getTableName

  public String getTableName()

  Table on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view.

  Returns:

  The current value of tableName.

• ​

  setTableName

  public AlterTableRequest setTableName(String tableName)

  Table on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view.

  Parameters:

  tableName - The new value for tableName.

  Returns:

  this to mimic the builder pattern.

• ​

  getAction

  public String getAction()

  Modification operation to be applied. Supported values:

  • 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.
  • REFRESH_INDEX: Refreshes an index identified by INDEX_TYPE, on the column name specified in value. Currently applicable only to CAGRA indices.
  • 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.
  • 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.
  • 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 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_COMMENT: Adds the comment specified in value to the table specified in tableName. Use COLUMN_NAME to set the comment for a column.
  • 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.
  • DELETE_COLUMN: Deletes the column specified in value from the table specified in tableName.
  • SET_DEFAULT: Sets or replaces the default value expression for the column specified in value. The new default is taken from ADD_COLUMN_EXPRESSION. Existing properties on the column are preserved.
  • DELETE_DEFAULT: Removes the default value expression from the column specified in value. Other column properties are preserved.
  • 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 / GCS.
  • DROP_DATASOURCE_SUBSCRIPTION: Permanently delete a cancelled data source subscription.
  • PAUSE_DATASOURCE_SUBSCRIPTION: Temporarily unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure / GCS.
  • RESUME_DATASOURCE_SUBSCRIPTION: Resubscribe to a paused data source subscription. The data source can be Kafka / S3 / Azure / GCS.
  • CHANGE_OWNER: Change the owner resource group of the table.
  • 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.
  • 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.
  • 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.

  Returns:

  The current value of action.

• ​

  setAction

  public AlterTableRequest setAction(String action)

  Modification operation to be applied. Supported values:

  • 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.
  • REFRESH_INDEX: Refreshes an index identified by INDEX_TYPE, on the column name specified in value. Currently applicable only to CAGRA indices.
  • 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.
  • 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.
  • 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 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_COMMENT: Adds the comment specified in value to the table specified in tableName. Use COLUMN_NAME to set the comment for a column.
  • 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.
  • DELETE_COLUMN: Deletes the column specified in value from the table specified in tableName.
  • SET_DEFAULT: Sets or replaces the default value expression for the column specified in value. The new default is taken from ADD_COLUMN_EXPRESSION. Existing properties on the column are preserved.
  • DELETE_DEFAULT: Removes the default value expression from the column specified in value. Other column properties are preserved.
  • 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 / GCS.
  • DROP_DATASOURCE_SUBSCRIPTION: Permanently delete a cancelled data source subscription.
  • PAUSE_DATASOURCE_SUBSCRIPTION: Temporarily unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure / GCS.
  • RESUME_DATASOURCE_SUBSCRIPTION: Resubscribe to a paused data source subscription. The data source can be Kafka / S3 / Azure / GCS.
  • CHANGE_OWNER: Change the owner resource group of the table.
  • 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.
  • 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.
  • 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.

  Parameters:

  action - The new value for action.

  Returns:

  this to mimic the builder pattern.

• ​

  getValue

  public String getValue()

  The value of the modification, depending on action. For example, if action is ADD_COLUMN, this would be the column name; while the column’s definition would be covered by the COLUMN_TYPE, COLUMN_PROPERTIES, COLUMN_DEFAULT_VALUE, and ADD_COLUMN_EXPRESSION in options. If action is TTL, it would be the number of minutes for the new TTL. If action is REFRESH, this field would be blank.

  Returns:

  The current value of value.

• ​

  setValue

  public AlterTableRequest setValue(String value)

  The value of the modification, depending on action. For example, if action is ADD_COLUMN, this would be the column name; while the column’s definition would be covered by the COLUMN_TYPE, COLUMN_PROPERTIES, COLUMN_DEFAULT_VALUE, and ADD_COLUMN_EXPRESSION in options. If action is TTL, it would be the number of minutes for the new TTL. If action is REFRESH, this field would be blank.

  Parameters:

  value - The new value for value.

  Returns:

  this to mimic the builder pattern.

• ​

  getOptions

  public Map<String,String> getOptions()

  Optional parameters.

  • ACTION
  • COLUMN_NAME
  • TABLE_NAME
  • 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.
  • COLUMN_PROPERTIES: When adding or changing a column, set the column properties (strings, separated by a comma: data, text_search, char8, int8 etc).
  • COLUMN_TYPE: When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).
  • COPY_VALUES_FROM_COLUMN: [DEPRECATED] Please use ADD_COLUMN_EXPRESSION instead.
  • RENAME_COLUMN: When changing a column, specify new column name.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • INDEX_OPTIONS: Options to use when creating an index, in the format “key: value [, key: value [, …]]”. Valid options vary by index type.

  The default value is an empty Map.

  Returns:

  The current value of options.

• ​

  setOptions

  public AlterTableRequest setOptions(Map<String,String> options)

  Optional parameters.

  • ACTION
  • COLUMN_NAME
  • TABLE_NAME
  • 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.
  • COLUMN_PROPERTIES: When adding or changing a column, set the column properties (strings, separated by a comma: data, text_search, char8, int8 etc).
  • COLUMN_TYPE: When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).
  • COPY_VALUES_FROM_COLUMN: [DEPRECATED] Please use ADD_COLUMN_EXPRESSION instead.
  • RENAME_COLUMN: When changing a column, specify new column name.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • INDEX_OPTIONS: Options to use when creating an index, in the format “key: value [, key: value [, …]]”. Valid options vary by index type.

  The default value is an empty Map.

  Parameters:

  options - The new value for options.

  Returns:

  this to mimic the builder pattern.

• ​

  getSchema

  public org.apache.avro.Schema getSchema()

  This method supports the Avro framework and is not intended to be called directly by the user.

  Specified by:

  getSchema in interface org.apache.avro.generic.GenericContainer

  Returns:

  The schema object describing this class.

• ​

  get

  public Object get(int index)

  This method supports the Avro framework and is not intended to be called directly by the user.

  Specified by:

  get in interface org.apache.avro.generic.IndexedRecord

  Parameters:

  index - the position of the field to get

  Returns:

  value of the field with the given index.

  Throws:

  IndexOutOfBoundsException

• ​

  put

  public void put(int index, Object value)

  This method supports the Avro framework and is not intended to be called directly by the user.

  Specified by:

  put in interface org.apache.avro.generic.IndexedRecord

  Parameters:

  index - the position of the field to set

  value - the value to set

  Throws:

  IndexOutOfBoundsException

• ​

  equals

  public boolean equals(Object obj)

  Overrides:

  equals in class Object

• ​

  toString

  public String toString()

  Overrides:

  toString in class Object

• ​

  hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object