GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::AdminRemoveRanksRequest Struct Reference

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

#include <gpudb/protocol/admin_remove_ranks.h>

Public Member Functions

 AdminRemoveRanksRequest ()
 Constructs an AdminRemoveRanksRequest object with default parameter values. More...
 
 AdminRemoveRanksRequest (const std::vector< int32_t > &ranks_, const std::map< std::string, std::string > &options_)
 Constructs an AdminRemoveRanksRequest object with the specified parameters. More...
 

Public Attributes

std::vector< int32_t > ranks
 
std::map< std::string,
std::string > 
options
 

Detailed Description

A set of input parameters for const.

Remove one or more ranks from the cluster. All data in the ranks to be removed is rebalanced to other ranks before the node is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the options.

Due to the rebalancing, this endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via const.

Definition at line 26 of file admin_remove_ranks.h.

Constructor & Destructor Documentation

gpudb::AdminRemoveRanksRequest::AdminRemoveRanksRequest ( )
inline

Constructs an AdminRemoveRanksRequest object with default parameter values.

Definition at line 33 of file admin_remove_ranks.h.

gpudb::AdminRemoveRanksRequest::AdminRemoveRanksRequest ( const std::vector< int32_t > &  ranks_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs an AdminRemoveRanksRequest object with the specified parameters.

Parameters
[in]ranks_Rank numbers of the ranks to be removed from the cluster.
[in]options_Optional parameters.

Definition at line 87 of file admin_remove_ranks.h.

Member Data Documentation

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

Definition at line 94 of file admin_remove_ranks.h.

std::vector<int32_t> gpudb::AdminRemoveRanksRequest::ranks

Definition at line 93 of file admin_remove_ranks.h.


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