gpudb::ClearTableRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/clear_table.h>

Public Member Functions
	ClearTableRequest ()
	Constructs a ClearTableRequest object with default parameter values. More...
	ClearTableRequest (const std::string &tableName_, const std::string &authorization_, const std::map< std::string, std::string > &options_)
	Constructs a ClearTableRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
std::string	authorization
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

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.

Definition at line 21 of file clear_table.h.

Constructor & Destructor Documentation

gpudb::ClearTableRequest::ClearTableRequest ( )

inline

Constructs a ClearTableRequest object with default parameter values.

Definition at line 27 of file clear_table.h.

gpudb::ClearTableRequest::ClearTableRequest ( const std::string &  tableName_, const std::string &  authorization_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a ClearTableRequest object with the specified parameters.

Parameters

[in]	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'.
[in]	authorization_	No longer used. User can pass an empty string.
[in]	options_	Optional parameters. gpudb::clear_table_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. gpudb::clear_table_true gpudb::clear_table_false The default value is gpudb::clear_table_false.

Definition at line 61 of file clear_table.h.

Member Data Documentation

std::string gpudb::ClearTableRequest::authorization

Definition at line 69 of file clear_table.h.

std::map<std::string, std::string> gpudb::ClearTableRequest::options

Definition at line 70 of file clear_table.h.

std::string gpudb::ClearTableRequest::tableName

Definition at line 68 of file clear_table.h.

---

The documentation for this struct was generated from the following file:

• gpudb/protocol/clear_table.h