A set of parameters for GPUdb::adminSwitchover. More…
#include <gpudb/protocol/admin_switchover.h>
Public Member Functions | |
| AdminSwitchoverRequest () | |
| Constructs an AdminSwitchoverRequest object with default parameters. | |
| AdminSwitchoverRequest (const std::vector< std::string > &processes_, const std::vector< std::string > &destinations_, const std::map< std::string, std::string > &options_) | |
| Constructs an AdminSwitchoverRequest object with the specified parameters. | |
Public Attributes | |
| std::vector< std::string > | processes |
| Indicates the process identifier to switch over to another host. | |
| std::vector< std::string > | destinations |
| Indicates to which host to switch over each corresponding process given in processes. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::adminSwitchover.
Manually switch over one or more processes to another host. Individual ranks or entire hosts may be moved to another host.
Definition at line 19 of file admin_switchover.h.
Constructor & Destructor Documentation
◆ AdminSwitchoverRequest() [1/2]
| inline |
Constructs an AdminSwitchoverRequest object with default parameters.
Definition at line 24 of file admin_switchover.h.
◆ AdminSwitchoverRequest() [2/2]
| inline |
Constructs an AdminSwitchoverRequest object with the specified parameters.
| [in] | processes_ | Indicates the process identifier to switch over to another host. Options are ‘hostN’ and ‘rankN’ where ‘N’ corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., ‘host[N].address’ or ‘rank[N].host’. If ‘hostN’ is provided, all processes on that host will be moved to another host. Each entry in this array will be switched over to the corresponding host entry at the same index in destinations_. |
| [in] | destinations_ | Indicates to which host to switch over each corresponding process given in processes_. Each index must be specified as ‘hostN’ where ‘N’ corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., ‘host[N].address’. Each entry in this array will receive the corresponding process entry at the same index in processes_. |
| [in] | options_ | Optional parameters.
|
Definition at line 81 of file admin_switchover.h.
Member Data Documentation
◆ destinations
| std::vector<std::string> gpudb::AdminSwitchoverRequest::destinations |
Indicates to which host to switch over each corresponding process given in processes.
Each index must be specified as ‘hostN’ where ‘N’ corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., ‘host[N].address’. Each entry in this array will receive the corresponding process entry at the same index in processes.
Definition at line 110 of file admin_switchover.h.
◆ options
| std::map<std::string, std::string> gpudb::AdminSwitchoverRequest::options |
Optional parameters.
- admin_switchover_dry_run: If set to true, only validation checks will be performed. Nothing is switched over. Supported values:The default value is admin_switchover_false.
The default value is an empty map.
Definition at line 131 of file admin_switchover.h.
◆ processes
| std::vector<std::string> gpudb::AdminSwitchoverRequest::processes |
Indicates the process identifier to switch over to another host.
Options are ‘hostN’ and ‘rankN’ where ‘N’ corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., ‘host[N].address’ or ‘rank[N].host’. If ‘hostN’ is provided, all processes on that host will be moved to another host. Each entry in this array will be switched over to the corresponding host entry at the same index in destinations.
Definition at line 99 of file admin_switchover.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/admin_switchover.h