kinetica.AdminRemoveRanksRequest Class Reference

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

Inheritance diagram for kinetica.AdminRemoveRanksRequest:

Collaboration diagram for kinetica.AdminRemoveRanksRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	AdminRemoveRanksRequest ()
	Constructs an AdminRemoveRanksRequest object with default parameters. More...
	AdminRemoveRanksRequest (IList< int > ranks, IDictionary< string, string > options=null)
	Constructs an AdminRemoveRanksRequest 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< int >	ranks [get, set]
	Rank numbers of the ranks to be removed from the cluster. More...
IDictionary< string, string >	options = new List<int>() [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.adminRemoveRanks(IList{int},IDictionary{string, string}).

Remove one or more ranks from the cluster. All data in the ranks to be removed is rebalanced to other ranks before the node is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the options.
Due to the rebalancing, this endpoint may take a long time to run, depending on the amount of data in the system. 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 29 of file AdminRemoveRanks.cs.

Constructor & Destructor Documentation

kinetica.AdminRemoveRanksRequest.AdminRemoveRanksRequest ( )

inline

Constructs an AdminRemoveRanksRequest object with default parameters.

Definition at line 212 of file AdminRemoveRanks.cs.

kinetica.AdminRemoveRanksRequest.AdminRemoveRanksRequest ( IList< int >  ranks, IDictionary< string, string >  options = null  )

inline

Constructs an AdminRemoveRanksRequest object with the specified parameters.

Parameters

ranks

Rank numbers of the ranks to be removed from the cluster.

options

Optional parameters. REBALANCE_SHARDED_DATA: When true, data with primary keys or shard keys will be rebalanced to other ranks prior to rank removal. Note that for big clusters, this data transfer could be time consuming and result in delayed query responses. Supported values: TRUE FALSE The default value is TRUE. REBALANCE_UNSHARDED_DATA: When true, unsharded data (data without primary keys and without shard keys) will be rebalanced to other ranks prior to rank removal. Note that for big clusters, this data transfer could be time consuming and result in delayed query responses. Supported values: TRUE FALSE The default value is TRUE. AGGRESSIVENESS: Influences how much data to send per rebalance round, during the rebalance portion of removing ranks. A higher aggressiveness setting will complete the rebalance faster. A lower aggressiveness setting will take longer, but allow for better interleaving between the rebalance and other queries. Allowed values are 1 through 10. The default value is '1'. The default value is an empty Dictionary.

Definition at line 277 of file AdminRemoveRanks.cs.

Property Documentation

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

getset

Optional parameters.

• REBALANCE_SHARDED_DATA: When true, data with primary keys or shard keys will be rebalanced to other ranks prior to rank removal. Note that for big clusters, this data transfer could be time consuming and result in delayed query responses. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• REBALANCE_UNSHARDED_DATA: When true, unsharded data (data without primary keys and without shard keys) will be rebalanced to other ranks prior to rank removal. Note that for big clusters, this data transfer could be time consuming and result in delayed query responses. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• AGGRESSIVENESS: Influences how much data to send per rebalance round, during the rebalance portion of removing ranks. A higher aggressiveness setting will complete the rebalance faster. A lower aggressiveness setting will take longer, but allow for better interleaving between the rebalance and other queries. Allowed values are 1 through 10. The default value is '1'.

The default value is an empty Dictionary.

Definition at line 207 of file AdminRemoveRanks.cs.

IList<int> kinetica.AdminRemoveRanksRequest.ranks

getset

Rank numbers of the ranks to be removed from the cluster.

Definition at line 148 of file AdminRemoveRanks.cs.

---

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

• Kinetica/Protocol/AdminRemoveRanks.cs