Skip to main content
Package com.gpudb.protocol

​
Class ClearTableRequest

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

Clears (drops) one or all tables in the database cluster. The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.

  • ​
    Constructor Details

    • ​
      ClearTableRequest

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

    • ​
      ClearTableRequest

      public ClearTableRequest(String tableName, String authorization, Map<String,String> options)
      Constructs a ClearTableRequest object with the specified parameters.
      Parameters:
      tableName - Name of the table to be cleared, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. Empty string clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter ‘disable_clear_all’. The default value is ”.
      authorization - No longer used. User can pass an empty string. The default value is ”.
      options - Optional parameters.
      • NO_ERROR_IF_NOT_EXISTS: If TRUE and if the table specified in tableName does not exist no error is returned. If FALSE and if the table specified in tableName 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.

    • ​
      getTableName

      public String getTableName()
      Name of the table to be cleared, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. Empty string clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter ‘disable_clear_all’. The default value is ”.
      Returns:
      The current value of tableName.

    • ​
      setTableName

      public ClearTableRequest setTableName(String tableName)
      Name of the table to be cleared, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. Empty string clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter ‘disable_clear_all’. The default value is ”.
      Parameters:
      tableName - The new value for tableName.
      Returns:
      this to mimic the builder pattern.

    • ​
      getAuthorization

      public String getAuthorization()
      No longer used. User can pass an empty string. The default value is ”.
      Returns:
      The current value of authorization.

    • ​
      setAuthorization

      public ClearTableRequest setAuthorization(String authorization)
      No longer used. User can pass an empty string. The default value is ”.
      Parameters:
      authorization - The new value for authorization.
      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 ClearTableRequest 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