kinetica.AdminRebalanceRequest Class Reference
A set of parameters for Kinetica.adminRebalance. More...
Inheritance diagram for kinetica.AdminRebalanceRequest:
Collaboration diagram for kinetica.AdminRebalanceRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. 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 = new Dictionary<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.adminRebalance.
Rebalance the data in the cluster so that all nodes contain an equal number of records approximately and/or rebalance the shards to be equally distributed (as much as possible) across all the ranks.
The database must be offline for this operation, see Kinetica.adminOffline
* If Kinetica.adminRebalance is invoked after a change is made to the cluster, e.g., a host was added or removed, sharded data will be evenly redistributed across the cluster by number of shards per rank while unsharded data will be redistributed across the cluster by data size per rank
* If Kinetica.adminRebalance is invoked at some point when unsharded data (a.k.a. randomly-sharded) in the cluster is unevenly distributed over time, sharded data will not move while unsharded data will be redistributed across the cluster by data size per rank
NOTE: Replicated data will not move as a result of this call
This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via Kinetica.createJob.
Definition at line 41 of file AdminRebalance.cs.
Constructor & Destructor Documentation
◆ AdminRebalanceRequest() [1/2]
|
inline |
Constructs an AdminRebalanceRequest object with default parameters.
Definition at line 321 of file AdminRebalance.cs.
◆ AdminRebalanceRequest() [2/2]
|
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 clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values: The default value is TRUE.
- REBALANCE_UNSHARDED_DATA: If TRUE, unsharded data (a.k.a. randomly-sharded) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values: The default value is TRUE.
- TABLE_INCLUDES: Comma-separated list of unsharded table names to rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with TABLE_EXCLUDES. This parameter is ignored if REBALANCE_UNSHARDED_DATA is FALSE.
- TABLE_EXCLUDES: Comma-separated list of unsharded table names to not rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with TABLE_INCLUDES. This parameter is ignored if REBALANCE_UNSHARDED_DATA is FALSE.
- AGGRESSIVENESS: Influences how much data is moved at a time during rebalance. A higher AGGRESSIVENESS will complete the rebalance faster. A lower AGGRESSIVENESS will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'.
- 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: The default value is TRUE.
- COMPACT_ONLY: If set to TRUE, ignore rebalance options and attempt to perform compaction of deleted records to reclaim memory and disk space without rebalancing first. Supported values: The default value is FALSE.
- REPAIR_INCORRECTLY_SHARDED_DATA: Scans for any data sharded incorrectly and re-routes the data to the correct location. Only necessary if Kinetica.adminVerifyDb reports an error in sharding alignment. 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. If this option is set to TRUE, the time necessary to rebalance and the memory used by the rebalance may increase. Supported values: The default value is FALSE.
Definition at line 481 of file AdminRebalance.cs.
Property Documentation
◆ options
|
getset |
Optional parameters.
- REBALANCE_SHARDED_DATA: If TRUE, sharded data will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values: The default value is TRUE.
- REBALANCE_UNSHARDED_DATA: If TRUE, unsharded data (a.k.a. randomly-sharded) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values: The default value is TRUE.
- TABLE_INCLUDES: Comma-separated list of unsharded table names to rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with TABLE_EXCLUDES. This parameter is ignored if REBALANCE_UNSHARDED_DATA is FALSE.
- TABLE_EXCLUDES: Comma-separated list of unsharded table names to not rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with TABLE_INCLUDES. This parameter is ignored if REBALANCE_UNSHARDED_DATA is FALSE.
- AGGRESSIVENESS: Influences how much data is moved at a time during rebalance. A higher AGGRESSIVENESS will complete the rebalance faster. A lower AGGRESSIVENESS will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'.
- 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: The default value is TRUE.
- COMPACT_ONLY: If set to TRUE, ignore rebalance options and attempt to perform compaction of deleted records to reclaim memory and disk space without rebalancing first. Supported values: The default value is FALSE.
- REPAIR_INCORRECTLY_SHARDED_DATA: Scans for any data sharded incorrectly and re-routes the data to the correct location. Only necessary if Kinetica.adminVerifyDb reports an error in sharding alignment. 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. If this option is set to TRUE, the time necessary to rebalance and the memory used by the rebalance may increase. Supported values: The default value is FALSE.
The default value is an empty Dictionary.
Definition at line 317 of file AdminRebalance.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/AdminRebalance.cs
