gpudb::AdminRebalanceRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/admin_rebalance.h>

Public Member Functions
	AdminRebalanceRequest ()
	Constructs an AdminRebalanceRequest object with default parameter values. More...
	AdminRebalanceRequest (const std::map< std::string, std::string > &options_)
	Constructs an AdminRebalanceRequest object with the specified parameters. More...

Public Attributes
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

Rebalance the cluster so that all the nodes contain approximately an equal number of records. The rebalance will also cause the shards to be equally distributed (as much as possible) across all the ranks.

This endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via const.

Definition at line 25 of file admin_rebalance.h.

Constructor & Destructor Documentation

gpudb::AdminRebalanceRequest::AdminRebalanceRequest ( )

inline

Constructs an AdminRebalanceRequest object with default parameter values.

Definition at line 32 of file admin_rebalance.h.

gpudb::AdminRebalanceRequest::AdminRebalanceRequest ( const std::map< std::string, std::string > &  options_ )

inline

Constructs an AdminRebalanceRequest object with the specified parameters.

Parameters

[in]

options_

Optional parameters. gpudb::admin_rebalance_rebalance_sharded_data: If true, sharded data will be rebalanced approximately equally across the cluster. Note that for big clusters, this data transfer could be time consuming and result in delayed query responses. gpudb::admin_rebalance_true gpudb::admin_rebalance_false The default value is gpudb::admin_rebalance_true. gpudb::admin_rebalance_rebalance_unsharded_data: If true, unsharded data (data without primary keys and without shard keys) will be rebalanced approximately equally across the cluster. Note that for big clusters, this data transfer could be time consuming and result in delayed query responses. gpudb::admin_rebalance_true gpudb::admin_rebalance_false The default value is gpudb::admin_rebalance_true. gpudb::admin_rebalance_table_whitelist: Comma-separated list of unsharded table names to rebalance. Not applicable to sharded tables because they are always balanced in accordance with their primary key or shard key. Cannot be used simultaneously with table_blacklist. gpudb::admin_rebalance_table_blacklist: Comma-separated list of unsharded table names to not rebalance. Not applicable to sharded tables because they are always balanced in accordance with their primary key or shard key. Cannot be used simultaneously with table_whitelist. gpudb::admin_rebalance_aggressiveness: Influences how much data to send per rebalance round. A higher aggressiveness setting will complete the rebalance faster. A lower aggressiveness setting will take longer, but allow for better interleaving between the rebalance and other queries. Allowed values are 1 through 10. The default value is '1'. gpudb::admin_rebalance_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. gpudb::admin_rebalance_true gpudb::admin_rebalance_false The default value is gpudb::admin_rebalance_true. gpudb::admin_rebalance_compact_only: Only perform compaction, do not rebalance. Default is false. gpudb::admin_rebalance_true gpudb::admin_rebalance_false The default value is gpudb::admin_rebalance_false. gpudb::admin_rebalance_repair_incorrectly_sharded_data: Scans for any data sharded incorrectly and re-routes the correct location. 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. This option may also lengthen rebalance time, and increase the memory used by the rebalance. gpudb::admin_rebalance_true gpudb::admin_rebalance_false The default value is gpudb::admin_rebalance_false.

Definition at line 138 of file admin_rebalance.h.

Member Data Documentation

std::map<std::string, std::string> gpudb::AdminRebalanceRequest::options

Definition at line 143 of file admin_rebalance.h.

---

The documentation for this struct was generated from the following file:

• gpudb/protocol/admin_rebalance.h