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

#include <gpudb/protocol/admin_add_ranks.h>

Public Member Functions
	AdminAddRanksRequest ()
	Constructs an AdminAddRanksRequest object with default parameters. More...

	AdminAddRanksRequest (const std::vector< std::string > &hosts_, const std::vector< std::map< std::string, std::string > > &configParams_, const std::map< std::string, std::string > &options_)
	Constructs an AdminAddRanksRequest object with the specified parameters. More...

Public Attributes
std::vector< std::string >	hosts
	Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster. More...

std::vector< std::map< std::string, std::string > >	configParams
	Array of maps containing configuration parameters to apply to the new ranks found in hosts. More...

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

Detailed Description

A set of parameters for GPUdb::adminAddRanks.

Add one or more ranks to an existing Kinetica cluster. The new ranks will not contain any data initially (other than replicated tables) and will not be assigned any shards. To rebalance data and shards across the cluster, use GPUdb::adminRebalance.

The database must be offline for this operation, see GPUdb::adminOffline

For example, if attempting to add three new ranks (two ranks on host 172.123.45.67 and one rank on host 172.123.45.68) to a Kinetica cluster with additional configuration parameters:

hosts would be an array including 172.123.45.67 in the first two indices (signifying two ranks being added to host 172.123.45.67) and 172.123.45.68 in the last index (signifying one rank being added to host 172.123.45.67)
configParams would be an array of maps, with each map corresponding to the ranks being added in hosts. The key of each map would be the configuration parameter name and the value would be the parameter's value, e.g. '{"rank.gpu":"1"}'

This endpoint's processing includes copying all replicated table data to the new rank(s) and therefore could take a long time. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via GPUdb::createJob.

Definition at line 46 of file admin_add_ranks.h.

Constructor & Destructor Documentation

◆ AdminAddRanksRequest() [1/2]

gpudb::AdminAddRanksRequest::AdminAddRanksRequest ( )

inline

Constructs an AdminAddRanksRequest object with default parameters.

Definition at line 51 of file admin_add_ranks.h.

◆ AdminAddRanksRequest() [2/2]

gpudb::AdminAddRanksRequest::AdminAddRanksRequest	(	const std::vector< std::string > &	hosts_,
		const std::vector< std::map< std::string, std::string > > &	configParams_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an AdminAddRanksRequest object with the specified parameters.

Parameters

[in]	hosts_	Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster. The hosts must already be in the cluster. If needed beforehand, to add a new host to the cluster use GPUdb::adminAddHost. Include the same entry as many times as there are ranks to add to the cluster, e.g., if two ranks on host 172.123.45.67 should be added, hosts_ could look like '["172.123.45.67", "172.123.45.67"]'. All ranks will be added simultaneously, i.e. they're not added in the order of this array. Each entry in this array corresponds to the entry at the same index in the configParams_.
[in]	configParams_	Array of maps containing configuration parameters to apply to the new ranks found in hosts_. For example, '{"rank.gpu":"2", "tier.ram.rank.limit":"10000000000"}'. Currently, the available parameters are rank-specific parameters in the Network, Hardware, Text Search, and RAM Tiered Storage sections in the gpudb.conf file, with the key exception of the 'rankN.host' settings in the Network section that will be determined by hosts_ instead. Though many of these configuration parameters typically are affixed with 'rankN' in the gpudb.conf file (where N is the rank number), the 'N' should be omitted in configParams_ as the new rank number(s) are not allocated until the ranks have been added to the cluster. Each entry in this array corresponds to the entry at the same index in the hosts_. This array must either be completely empty or have the same number of elements as the hosts_. An empty configParams_ array will result in the new ranks being set with default parameters.
[in]	options_	Optional parameters. admin_add_ranks_dry_run: If true, only validation checks will be performed. No ranks are added. Supported values: admin_add_ranks_true admin_add_ranks_false The default value is admin_add_ranks_false. The default value is an empty map.

Definition at line 134 of file admin_add_ranks.h.

Member Data Documentation

◆ configParams

std::vector<std::map<std::string, std::string> > gpudb::AdminAddRanksRequest::configParams

Array of maps containing configuration parameters to apply to the new ranks found in hosts.

For example, '{"rank.gpu":"2", "tier.ram.rank.limit":"10000000000"}'. Currently, the available parameters are rank-specific parameters in the Network, Hardware, Text Search, and RAM Tiered Storage sections in the gpudb.conf file, with the key exception of the 'rankN.host' settings in the Network section that will be determined by hosts instead. Though many of these configuration parameters typically are affixed with 'rankN' in the gpudb.conf file (where N is the rank number), the 'N' should be omitted in configParams as the new rank number(s) are not allocated until the ranks have been added to the cluster. Each entry in this array corresponds to the entry at the same index in the hosts. This array must either be completely empty or have the same number of elements as the hosts. An empty configParams array will result in the new ranks being set with default parameters.

Definition at line 182 of file admin_add_ranks.h.

◆ hosts

std::vector<std::string> gpudb::AdminAddRanksRequest::hosts

Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster.

The hosts must already be in the cluster. If needed beforehand, to add a new host to the cluster use GPUdb::adminAddHost. Include the same entry as many times as there are ranks to add to the cluster, e.g., if two ranks on host 172.123.45.67 should be added, hosts could look like '["172.123.45.67", "172.123.45.67"]'. All ranks will be added simultaneously, i.e. they're not added in the order of this array. Each entry in this array corresponds to the entry at the same index in the configParams.

Definition at line 156 of file admin_add_ranks.h.

◆ options

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

Optional parameters.

admin_add_ranks_dry_run: If true, only validation checks will be performed. No ranks are added. Supported values:
- admin_add_ranks_true
- admin_add_ranks_false
The default value is admin_add_ranks_false.

The default value is an empty map.

Definition at line 203 of file admin_add_ranks.h.

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

gpudb/protocol/admin_add_ranks.h

Public Member Functions

Public Attributes