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< std::string > &ranks_, const std::map< std::string, std::string > &options_)
	Constructs an AdminRemoveRanksRequest object with the specified parameters. More...

Public Attributes
std::vector< std::string >	ranks
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

Remove one or more ranks from an existing Kinetica cluster. All data will be rebalanced to other ranks before the rank(s) is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the options, in which case the corresponding sharded data and/or unsharded data (a.k.a. randomly-sharded) will be deleted.

The database must be offline for this operation, see const

This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via const.

Definition at line 38 of file admin_remove_ranks.h.

Constructor & Destructor Documentation

gpudb::AdminRemoveRanksRequest::AdminRemoveRanksRequest ( )

inline

Constructs an AdminRemoveRanksRequest object with default parameter values.

Definition at line 45 of file admin_remove_ranks.h.

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

inline

Constructs an AdminRemoveRanksRequest object with the specified parameters.

Parameters

[in]	ranks_	Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using /admin/switchover). At least one worker rank must be left in the cluster after the operation.
[in]	options_	Optional parameters. gpudb::admin_remove_ranks_rebalance_sharded_data: If true, sharded data will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, 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: If true, unsharded data (a.k.a. randomly-sharded) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, 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 is moved at a time during rebalance. A higher aggressiveness will complete the rebalance faster. A lower aggressiveness will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'.

Definition at line 112 of file admin_remove_ranks.h.

Member Data Documentation

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

Definition at line 119 of file admin_remove_ranks.h.

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

Definition at line 118 of file admin_remove_ranks.h.

---

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

• gpudb/protocol/admin_remove_ranks.h