Skip to main content

​
◆ adminRemoveRanks() [1/2]

AdminRemoveRanksResponse kinetica.Kinetica.adminRemoveRanks (AdminRemoveRanksRequestrequest_)
 inline

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 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 createJob.

This method should be used for on-premise deployments only.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 1951 of file KineticaFunctions.cs.

​
◆ adminRemoveRanks() [2/2]

AdminRemoveRanksResponse kinetica.Kinetica.adminRemoveRanks (IList< string >ranks,
IDictionary< string, string >options = null )
 inline

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 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 createJob.

This method should be used for on-premise deployments only.

Parameters
ranksEach 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 adminSwitchover). At least one worker rank must be left in the cluster after the operation.
optionsOptional 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.
Returns
Response object containing the result of the operation.

Definition at line 2105 of file KineticaFunctions.cs.

​
◆ AdminRemoveRanksAsync() [1/2]

async System.Threading.Tasks.Task< AdminRemoveRanksResponse > kinetica.Kinetica.AdminRemoveRanksAsync (AdminRemoveRanksRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Remove one or more ranks from an existing Kinetica cluster.

(async)

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 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 createJob.

This method should be used for on-premise deployments only.

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 1987 of file KineticaFunctions.cs.

​
◆ AdminRemoveRanksAsync() [2/2]

async System.Threading.Tasks.Task< AdminRemoveRanksResponse > kinetica.Kinetica.AdminRemoveRanksAsync (IList< string >ranks,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Remove one or more ranks from an existing Kinetica cluster.

(async)

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 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 createJob.

This method should be used for on-premise deployments only.

Parameters
ranksEach 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 adminSwitchover). At least one worker rank must be left in the cluster after the operation.
optionsOptional 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.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 2223 of file KineticaFunctions.cs.