Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Classes | Public Member Functions | Properties | List of all members
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]
 Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. More...
 
IList< IDictionary< string,
string > > 		config_params = new List<string>() [get, set]
 Array of maps containing configuration parameters to apply to the new ranks found in . 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 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(IDictionary{string, string}).
The database must be offline for this operation, see Kinetica.adminOffline(bool,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 48 of file AdminAddRanks.cs.

Constructor & Destructor Documentation

kinetica.AdminAddRanksRequest.AdminAddRanksRequest ( )
inline

Constructs an AdminAddRanksRequest object with default parameters.

Definition at line 176 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
hostsArray 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 /admin/add/host. 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, 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_paramsArray of maps containing configuration parameters to apply to the new ranks found in . 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 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 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 . This array must either be completely empty or have the same number of elements as the . An empty array will result in the new ranks being set with default parameters.
optionsOptional 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 249 of file AdminAddRanks.cs.

Property Documentation

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

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

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 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 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 . This array must either be completely empty or have the same number of elements as the . An empty array will result in the new ranks being set with default parameters.

Definition at line 146 of file AdminAddRanks.cs.

IList<string> kinetica.AdminAddRanksRequest.hosts
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 /admin/add/host. 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, 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 .

Definition at line 113 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: The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 171 of file AdminAddRanks.cs.

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