gpudb::ClearTableRequest Struct Reference

A set of input parameters for clearTable(const ClearTableRequest&) 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 clearTable(const ClearTableRequest&) const.

Clears (drops) one or all tables in the GPUdb 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 GPUdb table. Empty string clears all available tables in GPUdb. Default value is an empty string.
[in]	authorization	No longer used. User can pass an empty string. Default value is an empty string.
[in]	options	Optional parameters. Default value is an empty std::map.

Definition at line 47 of file clear_table.h.

Member Data Documentation

std::string gpudb::ClearTableRequest::authorization

Definition at line 55 of file clear_table.h.

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

Definition at line 56 of file clear_table.h.

std::string gpudb::ClearTableRequest::tableName

Definition at line 54 of file clear_table.h.

---

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

• gpudb/protocol/clear_table.h