Kinetica C# API  Version 7.1.10.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 (a.k.a. More...
 
const string TABLE_INCLUDES = "table_includes"
 Comma-separated list of unsharded table names to rebalance. More...
 
const string TABLE_EXCLUDES = "table_excludes"
 Comma-separated list of unsharded table names to not rebalance. More...
 
const string AGGRESSIVENESS = "aggressiveness"
 Influences how much data is moved at a time during rebalance. 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"
 If set to true, ignore rebalance options and attempt to perform compaction of deleted records to reclaim memory and disk space without rebalancing first. More...
 
const string REPAIR_INCORRECTLY_SHARDED_DATA = "repair_incorrectly_sharded_data"
 Scans for any data sharded incorrectly and re-routes the data to 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 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.
  • TABLE_INCLUDES: Comma-separated list of unsharded table names to rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with table_excludes. This parameter is ignored if rebalance_unsharded_data is false.
  • TABLE_EXCLUDES: Comma-separated list of unsharded table names to not rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with table_includes. This parameter is ignored if rebalance_unsharded_data is false.
  • 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'.
  • 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: If set to true, ignore rebalance options and attempt to perform compaction of deleted records to reclaim memory and disk space without rebalancing first. Supported values: The default value is FALSE.
  • REPAIR_INCORRECTLY_SHARDED_DATA: Scans for any data sharded incorrectly and re-routes the data to the correct location. Only necessary if /admin/verifydb reports an error in sharding alignment. 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. If this option is set to true, the time necessary to rebalance and the memory used by the rebalance may increase. 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 201 of file AdminRebalance.cs.

Member Data Documentation

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

Definition at line 269 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 288 of file AdminRebalance.cs.

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

If set to true, ignore rebalance options and attempt to perform compaction of deleted records to reclaim memory and disk space without rebalancing first.

Supported values:

The default value is FALSE.

Definition at line 306 of file AdminRebalance.cs.

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

Definition at line 225 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 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.

Definition at line 223 of file AdminRebalance.cs.

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

Definition at line 247 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 data to the correct location.

Only necessary if Kinetica.adminVerifyDb(IDictionary{string, string}) reports an error in sharding alignment. 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. If this option is set to true, the time necessary to rebalance and the memory used by the rebalance may increase. Supported values:

The default value is FALSE.

Definition at line 331 of file AdminRebalance.cs.

const string kinetica.AdminRebalanceRequest.Options.TABLE_EXCLUDES = "table_excludes"

Comma-separated list of unsharded table names to not rebalance.

Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with table_includes. This parameter is ignored if rebalance_unsharded_data is false.

Definition at line 261 of file AdminRebalance.cs.

const string kinetica.AdminRebalanceRequest.Options.TABLE_INCLUDES = "table_includes"

Comma-separated list of unsharded table names to rebalance.

Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with table_excludes. This parameter is ignored if rebalance_unsharded_data is false.

Definition at line 254 of file AdminRebalance.cs.

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

Definition at line 224 of file AdminRebalance.cs.

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