adminRemoveRanks

AdminRemoveRanksResponse gpudb::GPUdb::adminRemoveRanks ( const AdminRemoveRanksRequest & request_ ) const

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.

Attention

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

AdminRemoveRanksResponse & gpudb::GPUdb::adminRemoveRanks	(	const AdminRemoveRanksRequest &	request_,
		AdminRemoveRanksResponse &	response_ ) const

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.

Attention

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

AdminRemoveRanksResponse gpudb::GPUdb::adminRemoveRanks	(	const std::vector< std::string > &	ranks,
		const std::map< std::string, std::string > &	options ) const

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.

Attention

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

Parameters

[in]	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 adminSwitchover). At least one worker rank must be left in the cluster after the operation.
[in]	options	Optional parameters. admin_remove_ranks_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: admin_remove_ranks_true admin_remove_ranks_false The default value is admin_remove_ranks_true. admin_remove_ranks_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: admin_remove_ranks_true admin_remove_ranks_false The default value is admin_remove_ranks_true. admin_remove_ranks_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 map.

Returns

Response object containing the result of the operation.

AdminRemoveRanksResponse & gpudb::GPUdb::adminRemoveRanks	(	const std::vector< std::string > &	ranks,
		const std::map< std::string, std::string > &	options,
		AdminRemoveRanksResponse &	response_ ) const

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.

Attention

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

Parameters

[in]	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 adminSwitchover). At least one worker rank must be left in the cluster after the operation.
[in]	options	Optional parameters. admin_remove_ranks_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: admin_remove_ranks_true admin_remove_ranks_false The default value is admin_remove_ranks_true. admin_remove_ranks_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: admin_remove_ranks_true admin_remove_ranks_false The default value is admin_remove_ranks_true. admin_remove_ranks_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 map.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

API

◆ adminRemoveRanks() [1/4]

◆ adminRemoveRanks() [2/4]

◆ adminRemoveRanks() [3/4]

◆ adminRemoveRanks() [4/4]

​◆ adminRemoveRanks() [1/4]

​◆ adminRemoveRanks() [2/4]

​◆ adminRemoveRanks() [3/4]

​◆ adminRemoveRanks() [4/4]

◆ adminRemoveRanks() [1/4]

◆ adminRemoveRanks() [2/4]

◆ adminRemoveRanks() [3/4]

◆ adminRemoveRanks() [4/4]