kinetica.AdminAddRanksRequest Class Reference

A set of parameters for Kinetica.adminAddRanks(IList{string},IList{IDictionary{string, string}},IDictionary{string, string}). More...

Inheritance diagram for kinetica.AdminAddRanksRequest:

Collaboration diagram for kinetica.AdminAddRanksRequest:

Classes
struct	Options
	Optional parameters. More...

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

Properties
IList< string >	hosts [get, set]
	The IP address of each rank being added to the cluster. More...
IList< IDictionary< string, string > >	config_params = new List<string>() [get, set]
	Configuration parameters to apply to the new ranks, e.g., which GPU to use. More...
IDictionary< string, string >	options = new List<IDictionary<string, string>>() [get, set]
	Optional parameters. More...
Properties inherited from kinetica.KineticaData
Schema	Schema [get]
	Avro Schema for this class More...

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

Detailed Description

A set of parameters for Kinetica.adminAddRanks(IList{string},IList{IDictionary{string, string}},IDictionary{string, string}).

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 Kinetica.adminRebalance(IDictionary{string, string}).
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)
  
• config_params 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 Kinetica.createJob(string,string,byte[],string,IDictionary{string, string}).

Definition at line 44 of file AdminAddRanks.cs.

Constructor & Destructor Documentation

kinetica.AdminAddRanksRequest.AdminAddRanksRequest ( )

inline

Constructs an AdminAddRanksRequest object with default parameters.

Definition at line 141 of file AdminAddRanks.cs.

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	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 .
config_params	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 . 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.
options	Optional parameters. DRY_RUN: If true, only validation checks will be performed. No ranks are added. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 185 of file AdminAddRanks.cs.

Property Documentation

IList<IDictionary<string, string> > kinetica.AdminAddRanksRequest.config_params = new List<string>()

getset

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

Definition at line 111 of file AdminAddRanks.cs.

IList<string> kinetica.AdminAddRanksRequest.hosts

getset

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 .

Definition at line 100 of file AdminAddRanks.cs.

IDictionary<string, string> kinetica.AdminAddRanksRequest.options = new List<IDictionary<string, string>>()

getset

Optional parameters.

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

The default value is an empty Dictionary.

Definition at line 136 of file AdminAddRanks.cs.

---

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

• Kinetica/Protocol/AdminAddRanks.cs