Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.AdminRebalanceRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string REBALANCE_SHARDED_DATA = "rebalance_sharded_data"
 If true, sharded data will be rebalanced approximately equally across the cluster. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string REBALANCE_UNSHARDED_DATA = "rebalance_unsharded_data"
 If true, unsharded data (data without primary keys and without shard keys) will be rebalanced approximately equally across the cluster. More...
 
const string TABLE_WHITELIST = "table_whitelist"
 Comma-separated list of unsharded table names to rebalance. More...
 
const string TABLE_BLACKLIST = "table_blacklist"
 Comma-separated list of unsharded table names to not rebalance. More...
 
const string AGGRESSIVENESS = "aggressiveness"
 Influences how much data to send per rebalance round. More...
 
const string COMPACT_AFTER_REBALANCE = "compact_after_rebalance"
 Perform compaction of deleted records once the rebalance completes, to reclaim memory and disk space. More...
 
const string COMPACT_ONLY = "compact_only"
 Only perform compaction, do not rebalance. More...
 
const string REPAIR_INCORRECTLY_SHARDED_DATA = "repair_incorrectly_sharded_data"
 Scans for any data sharded incorrectly and re-routes the correct location. More...
 

Detailed Description

Optional parameters.

  • 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. Supported values: The default value is TRUE.
  • 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. Supported values: The default value is TRUE.
  • 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.
  • 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.
  • 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'.
  • 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. Supported values: The default value is TRUE.
  • COMPACT_ONLY: Only perform compaction, do not rebalance. Default is false. Supported values: The default value is FALSE.
  • 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. Supported values: The default value is FALSE.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 170 of file AdminRebalance.cs.

Member Data Documentation

const string kinetica.AdminRebalanceRequest.Options.AGGRESSIVENESS = "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'.

Definition at line 234 of file AdminRebalance.cs.

const string kinetica.AdminRebalanceRequest.Options.COMPACT_AFTER_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. Supported values:

The default value is TRUE.

Definition at line 253 of file AdminRebalance.cs.

const string kinetica.AdminRebalanceRequest.Options.COMPACT_ONLY = "compact_only"

Only perform compaction, do not rebalance.

Default is false. Supported values:

The default value is FALSE.

Definition at line 270 of file AdminRebalance.cs.

const string kinetica.AdminRebalanceRequest.Options.FALSE = "false"

Definition at line 192 of file AdminRebalance.cs.

const string kinetica.AdminRebalanceRequest.Options.REBALANCE_SHARDED_DATA = "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. Supported values:

The default value is TRUE.

Definition at line 190 of file AdminRebalance.cs.

const string kinetica.AdminRebalanceRequest.Options.REBALANCE_UNSHARDED_DATA = "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. Supported values:

The default value is TRUE.

Definition at line 212 of file AdminRebalance.cs.

const string kinetica.AdminRebalanceRequest.Options.REPAIR_INCORRECTLY_SHARDED_DATA = "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. Supported values:

The default value is FALSE.

Definition at line 292 of file AdminRebalance.cs.

const string kinetica.AdminRebalanceRequest.Options.TABLE_BLACKLIST = "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.

Definition at line 226 of file AdminRebalance.cs.

const string kinetica.AdminRebalanceRequest.Options.TABLE_WHITELIST = "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.

Definition at line 219 of file AdminRebalance.cs.

const string kinetica.AdminRebalanceRequest.Options.TRUE = "true"

Definition at line 191 of file AdminRebalance.cs.

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