A set of parameters for GPUdb::clearTable. More...

#include <gpudb/protocol/clear_table.h>

Public Member Functions
	ClearTableRequest ()
	Constructs a ClearTableRequest object with default parameters. 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
	Name of the table to be cleared, in [ schema_name. ]table_name format, using standard name resolution rules. More...

std::string	authorization
	No longer used. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

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.

Definition at line 20 of file clear_table.h.

Constructor & Destructor Documentation

◆ ClearTableRequest() [1/2]

gpudb::ClearTableRequest::ClearTableRequest ( )

inline

Constructs a ClearTableRequest object with default parameters.

Definition at line 25 of file clear_table.h.

◆ ClearTableRequest() [2/2]

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

Definition at line 72 of file clear_table.h.

Member Data Documentation

◆ authorization

std::string gpudb::ClearTableRequest::authorization

No longer used.

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

Definition at line 94 of file clear_table.h.

◆ options

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

Optional parameters.

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. Supported values:
- clear_table_true
- clear_table_false
The default value is clear_table_false.

The default value is an empty map.

Definition at line 115 of file clear_table.h.

◆ tableName

std::string gpudb::ClearTableRequest::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 ''.

Definition at line 88 of file clear_table.h.

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

gpudb/protocol/clear_table.h

Public Member Functions

Public Attributes