GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::AdminAddRanksResponse Struct Reference

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

#include <gpudb/protocol/admin_add_ranks.h>

Public Member Functions

 AdminAddRanksResponse ()
 Constructs an AdminAddRanksResponse object with default parameter values. More...
 

Public Attributes

std::vector< int32_t > addedRanks
 
std::vector< std::string > results
 
std::map< std::string,
std::string > 
info
 

Detailed Description

A set of output 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 187 of file admin_add_ranks.h.

Constructor & Destructor Documentation

gpudb::AdminAddRanksResponse::AdminAddRanksResponse ( )
inline

Constructs an AdminAddRanksResponse object with default parameter values.

Definition at line 194 of file admin_add_ranks.h.

Member Data Documentation

std::vector<int32_t> gpudb::AdminAddRanksResponse::addedRanks

Definition at line 201 of file admin_add_ranks.h.

std::map<std::string, std::string> gpudb::AdminAddRanksResponse::info

Definition at line 203 of file admin_add_ranks.h.

std::vector<std::string> gpudb::AdminAddRanksResponse::results

Definition at line 202 of file admin_add_ranks.h.


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