admin_remove_ranks
- admin_remove_ranks(
ranks: string[],
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<AdminRemoveRanksResponse>Parameters
- ranks: string[]
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
admin_switchover). At least one worker rank must be left in the cluster after the operation. Optionaloptions: Record<string, string>Optional parameters.
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<AdminRemoveRanksResponse>
Promise<Types.AdminRemoveRanksResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:2315
- ranks: string[]
admin_remove_ranks_request
- admin_remove_ranks_request(
request: AdminRemoveRanksRequest,
callback?: GPUdbCallback,
): Promise<AdminRemoveRanksResponse>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
admin_offlineThis 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
create_job.Note: This method should be used for on-premise deployments only.
Parameters
- request: AdminRemoveRanksRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<AdminRemoveRanksResponse>
Promise<Types.AdminRemoveRanksResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:2280
- request: AdminRemoveRanksRequest
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
admin_offlineThis 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
create_job.Note: This method should be used for on-premise deployments only.