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

#include <gpudb/protocol/admin_remove_ranks.h>

Public Member Functions
	AdminRemoveRanksRequest ()
	Constructs an AdminRemoveRanksRequest object with default parameters. 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
	Each array value designates one or more ranks to remove from the cluster. More...

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

Detailed Description

A set of parameters for GPUdb::adminRemoveRanks.

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 GPUdb::adminOffline

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 GPUdb::createJob.

Definition at line 37 of file admin_remove_ranks.h.

Constructor & Destructor Documentation

◆ AdminRemoveRanksRequest() [1/2]

gpudb::AdminRemoveRanksRequest::AdminRemoveRanksRequest ( )

inline

Constructs an AdminRemoveRanksRequest object with default parameters.

Definition at line 43 of file admin_remove_ranks.h.

◆ AdminRemoveRanksRequest() [2/2]

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 GPUdb::adminSwitchover). At least one worker rank must be left in the cluster after the operation.
[in]	options_	Optional parameters. 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. Supported values: admin_remove_ranks_true admin_remove_ranks_false The default value is admin_remove_ranks_true. 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. Supported values: admin_remove_ranks_true admin_remove_ranks_false The default value is admin_remove_ranks_true. 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'. The default value is an empty map.

Definition at line 136 of file admin_remove_ranks.h.

Member Data Documentation

◆ options

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

Optional parameters.

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. Supported values:
- admin_remove_ranks_true
- admin_remove_ranks_false
The default value is admin_remove_ranks_true.
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. Supported values:
- admin_remove_ranks_true
- admin_remove_ranks_false
The default value is admin_remove_ranks_true.
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'.

The default value is an empty map.

Definition at line 206 of file admin_remove_ranks.h.

◆ ranks

std::vector<std::string> gpudb::AdminRemoveRanksRequest::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 GPUdb::adminSwitchover). At least one worker rank must be left in the cluster after the operation.

Definition at line 153 of file admin_remove_ranks.h.

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

gpudb/protocol/admin_remove_ranks.h

Public Member Functions