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(ClearTableRequest).

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClearTableRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
ClearTableRequest() Constructs a ClearTableRequest object with default parameters.
ClearTableRequest(String tableName, String authorization, Map<String,String> options) Constructs a ClearTableRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
String	getAuthorization()
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
Map<String,String>	getOptions()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getTableName()
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
ClearTableRequest	setAuthorization(String authorization)
ClearTableRequest	setOptions(Map<String,String> options)
ClearTableRequest	setTableName(String tableName)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

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. 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:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Method Detail

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()

Returns:

Name of the table to be cleared. 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 ''.

setTableName

public ClearTableRequest setTableName(String tableName)

Parameters:

tableName - Name of the table to be cleared. 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:

this to mimic the builder pattern.

getAuthorization

public String getAuthorization()

Returns:

No longer used. User can pass an empty string. The default value is ''.

setAuthorization

public ClearTableRequest setAuthorization(String authorization)

Parameters:

authorization - No longer used. User can pass an empty string. The default value is ''.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

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:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

setOptions

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

Parameters:

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:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

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