A set of parameters for Kinetica.adminRemoveRanks. More...
Inheritance diagram for kinetica.AdminRemoveRanksRequest:
Collaboration diagram for kinetica.AdminRemoveRanksRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| AdminRemoveRanksRequest () | |
| Constructs an AdminRemoveRanksRequest object with default parameters. More... | |
| AdminRemoveRanksRequest (IList< string > 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< string > | ranks = new List<string>() [get, set] |
| Each array value designates one or more ranks to remove from the cluster. More... | |
| 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.adminRemoveRanks.
Remove one or more ranks from an existing Kinetica cluster. All data will be rebalanced to other ranks before the rank(s) is removed unless the REBALANCE_SHARDED_DATA or REBALANCE_UNSHARDED_DATA parameters are set to FALSE in the options, in which case the corresponding sharded data and/or unsharded data (a.k.a. randomly-sharded) will be deleted.
The database must be offline for this operation, see Kinetica.adminOffline
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 33 of file AdminRemoveRanks.cs.
Constructor & Destructor Documentation
◆ AdminRemoveRanksRequest() [1/2]
|
inline |
Constructs an AdminRemoveRanksRequest object with default parameters.
Definition at line 168 of file AdminRemoveRanks.cs.
◆ AdminRemoveRanksRequest() [2/2]
|
inline |
Constructs an AdminRemoveRanksRequest object with the specified parameters.
- Parameters
-
ranks Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using Kinetica.adminSwitchover). At least one worker rank must be left in the cluster after the operation. 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.
- 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'.
Definition at line 247 of file AdminRemoveRanks.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.
- 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'.
The default value is an empty Dictionary.
Definition at line 164 of file AdminRemoveRanks.cs.
◆ ranks
|
getset |
Each array value designates one or more ranks to remove from the cluster.
Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using Kinetica.adminSwitchover). At least one worker rank must be left in the cluster after the operation.
Definition at line 98 of file AdminRemoveRanks.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/AdminRemoveRanks.cs
