> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.AdminAddRanksRequest > kinetica.AdminAddRanksRequest — Kinetica C# API

A set of parameters for Kinetica.adminAddRanks. More...

Inheritance diagram for kinetica.AdminAddRanksRequest:
Collaboration diagram for kinetica.AdminAddRanksRequest:

Classes
struct   Options
  A set of string constants for the parameter AdminAddRanksRequest.options. More...
 

Public Member Functions
  AdminAddRanksRequest ()
  Constructs an AdminAddRanksRequest object with default parameters.
 
  AdminAddRanksRequest (IList\< string > hosts, IList\< IDictionary\< string, string > > config\_params, IDictionary\< string, string > options=null)
  Constructs an AdminAddRanksRequest object with the specified parameters.
 
  AdminAddRanksRequest ()
  Constructs an AdminAddRanksRequest object with default parameters.
 
  AdminAddRanksRequest (IList\< string > hosts, IList\< IDictionary\< string, string > > config\_params, IDictionary\< string, string > options=null)
  Constructs an AdminAddRanksRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
IList\< string >  hosts = new List\() \[get, set]
  Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g.
 
IList\< IDictionary\< string, string > >  config\_params = new List\>() \[get, set]
  Array of maps containing configuration parameters to apply to the new ranks found in AdminAddRanksRequest.hosts.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

Additional Inherited Members
 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.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 Kinetica.adminRebalance.

The database must be offline for this operation, see Kinetica.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:

\* AdminAddRanksRequest.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)

\* AdminAddRanksRequest.config\_params would be an array of maps, with each map corresponding to the ranks being added in AdminAddRanksRequest.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 Kinetica.createJob.

Definition at line 39 of file AdminAddRanks.cs.

Constructor & Destructor Documentation

◆ AdminAddRanksRequest() \[1/4]

kinetica.AdminAddRanksRequest.AdminAddRanksRequest ( )
inline

Constructs an AdminAddRanksRequest object with default parameters.

Definition at line 150 of file AdminAddRanks.cs.

◆ AdminAddRanksRequest() \[2/4]

kinetica.AdminAddRanksRequest.AdminAddRanksRequest ( IList\< string > hosts,
IList\< IDictionary\< string, string > > config\_params,
IDictionary\< string, string > options = null )
inline

Constructs an AdminAddRanksRequest object with the specified parameters.

Parameters
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 Kinetica.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 config\_params .
config\_params 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 config\_params 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 config\_params array will result in the new ranks being set with default parameters.
options Optional parameters.
  • DRY\_RUN: If TRUE, only validation checks will be performed. No ranks are added. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 218 of file AdminAddRanks.cs.

◆ AdminAddRanksRequest() \[3/4]

kinetica.AdminAddRanksRequest.AdminAddRanksRequest ( )
inline

Constructs an AdminAddRanksRequest object with default parameters.

Definition at line 150 of file AdminAddRanks.cs.

◆ AdminAddRanksRequest() \[4/4]

kinetica.AdminAddRanksRequest.AdminAddRanksRequest ( IList\< string > hosts,
IList\< IDictionary\< string, string > > config\_params,
IDictionary\< string, string > options = null )
inline

Constructs an AdminAddRanksRequest object with the specified parameters.

Parameters
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 Kinetica.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 config\_params .
config\_params 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 config\_params 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 config\_params array will result in the new ranks being set with default parameters.
options Optional parameters.
  • DRY\_RUN: If TRUE, only validation checks will be performed. No ranks are added. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 218 of file AdminAddRanks.cs.

Property Documentation

◆ config\_params

IList\< IDictionary\< string, string > > kinetica.AdminAddRanksRequest.config\_params = new List\>()
getset

Array of maps containing configuration parameters to apply to the new ranks found in AdminAddRanksRequest.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 AdminAddRanksRequest.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 AdminAddRanksRequest.config\_params 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 AdminAddRanksRequest.hosts. This array must either be completely empty or have the same number of elements as the AdminAddRanksRequest.hosts. An empty AdminAddRanksRequest.config\_params array will result in the new ranks being set with default parameters.

Definition at line 116 of file AdminAddRanks.cs.

◆ hosts

IList\< string > kinetica.AdminAddRanksRequest.hosts = new List\()
getset

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 Kinetica.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, AdminAddRanksRequest.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 AdminAddRanksRequest.config\_params.

Definition at line 89 of file AdminAddRanks.cs.

◆ options

IDictionary\< string, string > kinetica.AdminAddRanksRequest.options = new Dictionary\()
getset

Optional parameters.

  • DRY\_RUN: If TRUE, only validation checks will be performed. No ranks are added. Supported values: The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 146 of file AdminAddRanks.cs.

The documentation for this class was generated from the following files: