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.IndexedRecordA 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.
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA set of string constants for theClearTablesRequestparameteroptions.Method Summary
Modifier and TypeMethodDescriptionbooleanget(int index) This method supports the Avro framework and is not intended to be called directly by the user.static org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.Optional parameters.org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.Names of the tables to be cleared, in [schema_name.]table_name format, using standard name resolution rules.inthashCode()voidThis method supports the Avro framework and is not intended to be called directly by the user.setOptions(Map<String, String> options) Optional parameters.setTableNames(List<String> tableNames) Names of the tables to be cleared, in [schema_name.]table_name format, using standard name resolution rules.toString()
Constructor Details
ClearTablesRequest
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 prevented by default via system configuration parameter disable_clear_all. The default value is an emptyList.options- Optional parameters.NO_ERROR_IF_NOT_EXISTS: IfTRUEand if a table specified intableNamesdoes not exist no error is returned. IfFALSEand if a table specified intableNamesdoes not exist then an error is returned. Supported values:The default value isFALSE.
Map.
Method Details
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 prevented by default via system configuration parameter disable_clear_all. The default value is an emptyList.Returns:The current value oftableNames.setTableNames
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 prevented by default via system configuration parameter disable_clear_all. The default value is an emptyList.Parameters:tableNames- The new value fortableNames.Returns:thisto mimic the builder pattern.getOptions
Optional parameters.NO_ERROR_IF_NOT_EXISTS: IfTRUEand if a table specified intableNamesdoes not exist no error is returned. IfFALSEand if a table specified intableNamesdoes not exist then an error is returned. Supported values:The default value isFALSE.
Map.Returns:The current value ofoptions.setOptions
Optional parameters.NO_ERROR_IF_NOT_EXISTS: IfTRUEand if a table specified intableNamesdoes not exist no error is returned. IfFALSEand if a table specified intableNamesdoes not exist then an error is returned. Supported values:The default value isFALSE.
Map.Parameters:options- The new value foroptions.Returns:thisto mimic the builder pattern.