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

#include <gpudb/protocol/admin_remove_host.h>

Public Member Functions
	AdminRemoveHostRequest ()
	Constructs an AdminRemoveHostRequest object with default parameters. More...

	AdminRemoveHostRequest (const std::string &host_, const std::map< std::string, std::string > &options_)
	Constructs an AdminRemoveHostRequest object with the specified parameters. More...

Public Attributes
std::string	host
	Identifies the host this applies to. More...

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

Detailed Description

A set of parameters for GPUdb::adminRemoveHost.

Removes a host from an existing cluster. If the host to be removed has any ranks running on it, the ranks must be removed using GPUdb::adminRemoveRanks or manually switched over to a new host using GPUdb::adminSwitchover prior to host removal. If the host to be removed has the graph server or SQL planner running on it, these must be manually switched over to a new host using GPUdb::adminSwitchover.

Definition at line 27 of file admin_remove_host.h.

Constructor & Destructor Documentation

◆ AdminRemoveHostRequest() [1/2]

gpudb::AdminRemoveHostRequest::AdminRemoveHostRequest ( )

inline

Constructs an AdminRemoveHostRequest object with default parameters.

Definition at line 32 of file admin_remove_host.h.

◆ AdminRemoveHostRequest() [2/2]

gpudb::AdminRemoveHostRequest::AdminRemoveHostRequest	(	const std::string &	host_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an AdminRemoveHostRequest object with the specified parameters.

Parameters

[in]	host_	Identifies the host this applies to. Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf
[in]	options_	Optional parameters. admin_remove_host_dry_run: If set to true, only validation checks will be performed. No host is removed. Supported values: admin_remove_host_true admin_remove_host_false The default value is admin_remove_host_false. The default value is an empty map.

Definition at line 67 of file admin_remove_host.h.

Member Data Documentation

◆ host

std::string gpudb::AdminRemoveHostRequest::host

Identifies the host this applies to.

Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf

Definition at line 78 of file admin_remove_host.h.

◆ options

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

Optional parameters.

admin_remove_host_dry_run: If set to true, only validation checks will be performed. No host is removed. Supported values:
- admin_remove_host_true
- admin_remove_host_false
The default value is admin_remove_host_false.

The default value is an empty map.

Definition at line 99 of file admin_remove_host.h.

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

gpudb/protocol/admin_remove_host.h

Public Member Functions