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. gpudb::admin_remove_ranks_rebalance_sharded_data: When true, data with primary keys or shard keys will be rebalanced to other ranks prior to rank removal. Note that for big clusters, this data transfer could be time consuming and result in delayed query responses. gpudb::admin_remove_ranks_true gpudb::admin_remove_ranks_false The default value is gpudb::admin_remove_ranks_true. gpudb::admin_remove_ranks_rebalance_unsharded_data: When true, unsharded data (data without primary keys and without shard keys) will be rebalanced to other ranks prior to rank removal. Note that for big clusters, this data transfer could be time consuming and result in delayed query responses. gpudb::admin_remove_ranks_true gpudb::admin_remove_ranks_false The default value is gpudb::admin_remove_ranks_true. gpudb::admin_remove_ranks_aggressiveness: Influences how much data to send per rebalance round, during the rebalance portion of removing ranks. A higher aggressiveness setting will complete the rebalance faster. A lower aggressiveness setting will take longer, but allow for better interleaving between the rebalance and other queries. Allowed values are 1 through 10. The default value is '1'.

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:

• gpudb/protocol/admin_remove_ranks.h