Skip to main content
Package com.gpudb.protocol

​
Class ClearTablesRequest

java.lang.Object
com.gpudb.protocol.ClearTablesRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
public class ClearTablesRequest extends Object implements org.apache.avro.generic.IndexedRecord
A set of parameters for GPUdb.clearTables.

Clears (drops) tables in the database cluster. The operation is synchronous meaning that the tables will be cleared before the function returns. The response payload returns the status of the operation for each table requested.

  • ​
    Constructor Details

    • ​
      ClearTablesRequest

      public ClearTablesRequest()
      Constructs a ClearTablesRequest object with default parameters.

    • ​
      ClearTablesRequest

      public ClearTablesRequest(List<String> tableNames, Map<String,String> options)
      Constructs a ClearTablesRequest object with the specified parameters.
      Parameters:
      tableNames - Names of the tables to be cleared, in [schema_name.]table_name format, using standard name resolution rules. Must be existing tables. Empty list clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter ‘disable_clear_all’. The default value is an empty List.
      options - Optional parameters.
      • NO_ERROR_IF_NOT_EXISTS: If TRUE and if a table specified in tableNames does not exist no error is returned. If FALSE and if a table specified in tableNames does not exist then an error is returned. Supported values:The default value is FALSE.
      The default value is an empty Map.

  • ​
    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.

    • ​
      getTableNames

      public List<String> getTableNames()
      Names of the tables to be cleared, in [schema_name.]table_name format, using standard name resolution rules. Must be existing tables. Empty list clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter ‘disable_clear_all’. The default value is an empty List.
      Returns:
      The current value of tableNames.

    • ​
      setTableNames

      public ClearTablesRequest setTableNames(List<String> tableNames)
      Names of the tables to be cleared, in [schema_name.]table_name format, using standard name resolution rules. Must be existing tables. Empty list clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter ‘disable_clear_all’. The default value is an empty List.
      Parameters:
      tableNames - The new value for tableNames.
      Returns:
      this to mimic the builder pattern.

    • ​
      getOptions

      public Map<String,String> getOptions()
      Optional parameters.The default value is an empty Map.
      Returns:
      The current value of options.

    • ​
      setOptions

      public ClearTablesRequest setOptions(Map<String,String> options)
      Optional parameters.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