GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
gpudb::AdminAddRanksRequest Struct Reference

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

#include <gpudb/protocol/admin_add_ranks.h>

Public Member Functions

 AdminAddRanksRequest ()
 Constructs an AdminAddRanksRequest object with default parameter values. 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
 
std::vector< std::map
< std::string, std::string > > 		configParams
 
std::map< std::string,
std::string > 		options
 

Detailed Description

A set of input parameters for const.

Add one or more new ranks to the Kinetica cluster. The new ranks will not contain any data initially, other than replicated tables, and not be assigned any shards. To rebalance data across the cluster, which includes shifting some shard key assignments to newly added ranks, see const.

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 const.

Definition at line 42 of file admin_add_ranks.h.

Constructor & Destructor Documentation

gpudb::AdminAddRanksRequest::AdminAddRanksRequest ( )
inline

Constructs an AdminAddRanksRequest object with default parameter values.

Definition at line 49 of file admin_add_ranks.h.

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_The IP address of each rank being added to the cluster. Insert one entry per rank, even if they are on the same host. The order of the hosts in the array only matters as it relates to the configParams.
[in]configParams_Configuration parameters to apply to the new ranks, e.g., which GPU to use. Configuration parameters that start with 'rankN.', where N is the rank number, should omit the N, as the new rank number(s) are not allocated until the ranks are created. Each entry in this array corresponds to the entry at the same array index in the hosts. This array must either be completely empty or have the same number of elements as the hosts array. An empty array will result in the new ranks being set only with default parameters.
[in]options_Optional parameters.

Definition at line 93 of file admin_add_ranks.h.

Member Data Documentation

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

Definition at line 101 of file admin_add_ranks.h.

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

Definition at line 100 of file admin_add_ranks.h.

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

Definition at line 102 of file admin_add_ranks.h.

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