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

Inheritance diagram for kinetica.AdminRebalanceRequest:

Collaboration diagram for kinetica.AdminRebalanceRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	AdminRebalanceRequest ()
	Constructs an AdminRebalanceRequest object with default parameters. More...

	AdminRebalanceRequest (IDictionary< string, string > options=null)
	Constructs an AdminRebalanceRequest 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
IDictionary< string, string >	options `[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.adminRebalance(IDictionary{string, string}).

Rebalance the cluster so that all the nodes contain approximately an equal number of records. The rebalance will also cause the shards to be equally distributed (as much as possible) across all the ranks.
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 26 of file AdminRebalance.cs.

Constructor & Destructor Documentation

kinetica.AdminRebalanceRequest.AdminRebalanceRequest ( )

inline

Constructs an AdminRebalanceRequest object with default parameters.

Definition at line 440 of file AdminRebalance.cs.

kinetica.AdminRebalanceRequest.AdminRebalanceRequest ( IDictionary< string, string > options = null )

inline

Constructs an AdminRebalanceRequest object with the specified parameters.

Parameters

options

Optional parameters.

REBALANCE_SHARDED_DATA: If true, sharded data will be rebalanced approximately equally across the cluster. 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: If true, unsharded data (data without primary keys and without shard keys) will be rebalanced approximately equally across the cluster. 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.
TABLE_WHITELIST: Comma-separated list of unsharded table names to rebalance. Not applicable to sharded tables because they are always balanced in accordance with their primary key or shard key. Cannot be used simultaneously with table_blacklist.
TABLE_BLACKLIST: Comma-separated list of unsharded table names to not rebalance. Not applicable to sharded tables because they are always balanced in accordance with their primary key or shard key. Cannot be used simultaneously with table_whitelist.
AGGRESSIVENESS: Influences how much data to send per rebalance round. 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'.
COMPACT_AFTER_REBALANCE: Perform compaction of deleted records once the rebalance completes, to reclaim memory and disk space. Default is true, unless repair_incorrectly_sharded_data is set to true. Supported values:
- TRUE
- FALSE
The default value is TRUE.
COMPACT_ONLY: Only perform compaction, do not rebalance. Default is false. Supported values:
- TRUE
- FALSE
The default value is FALSE.
REPAIR_INCORRECTLY_SHARDED_DATA: Scans for any data sharded incorrectly and re-routes the correct location. This can be done as part of a typical rebalance after expanding the cluster, or in a standalone fashion when it is believed that data is sharded incorrectly somewhere in the cluster. Compaction will not be performed by default when this is enabled. This option may also lengthen rebalance time, and increase the memory used by the rebalance. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 585 of file AdminRebalance.cs.

Property Documentation

IDictionary<string, string> kinetica.AdminRebalanceRequest.options

getset

Optional parameters.

REBALANCE_SHARDED_DATA: If true, sharded data will be rebalanced approximately equally across the cluster. 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: If true, unsharded data (data without primary keys and without shard keys) will be rebalanced approximately equally across the cluster. 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.
TABLE_WHITELIST: Comma-separated list of unsharded table names to rebalance. Not applicable to sharded tables because they are always balanced in accordance with their primary key or shard key. Cannot be used simultaneously with table_blacklist.
TABLE_BLACKLIST: Comma-separated list of unsharded table names to not rebalance. Not applicable to sharded tables because they are always balanced in accordance with their primary key or shard key. Cannot be used simultaneously with table_whitelist.
AGGRESSIVENESS: Influences how much data to send per rebalance round. 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'.
COMPACT_AFTER_REBALANCE: Perform compaction of deleted records once the rebalance completes, to reclaim memory and disk space. Default is true, unless repair_incorrectly_sharded_data is set to true. Supported values:
- TRUE
- FALSE
The default value is TRUE.
COMPACT_ONLY: Only perform compaction, do not rebalance. Default is false. Supported values:
- TRUE
- FALSE
The default value is FALSE.
REPAIR_INCORRECTLY_SHARDED_DATA: Scans for any data sharded incorrectly and re-routes the correct location. This can be done as part of a typical rebalance after expanding the cluster, or in a standalone fashion when it is believed that data is sharded incorrectly somewhere in the cluster. Compaction will not be performed by default when this is enabled. This option may also lengthen rebalance time, and increase the memory used by the rebalance. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 435 of file AdminRebalance.cs.

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

Kinetica/Protocol/AdminRebalance.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation