Type alias ClusterRebalanceOptions

ClusterRebalanceOptions: {
    databasesExcluded?: string[];
    excludeSystemCollections?: boolean;
    leaderChanges?: boolean;
    maximumNumberOfMoves?: number;
    moveFollowers?: boolean;
    moveLeaders?: boolean;
    piFactor?: number;
}

Options for rebalancing the cluster.

Type declaration

  • Optional databasesExcluded?: string[]

    A list of database names to exclude from the analysis.

    Default: []

  • Optional excludeSystemCollections?: boolean

    Ignore system collections in the rebalance plan.

    Default: false

  • Optional leaderChanges?: boolean

    Allow leader changes without moving data.

    Default: true

  • Optional maximumNumberOfMoves?: number

    Maximum number of moves to be computed.

    Default: 1000

  • Optional moveFollowers?: boolean

    Allow moving followers.

    Default: false

  • Optional moveLeaders?: boolean

    Allow moving leaders.

    Default: false

  • Optional piFactor?: number

    Default: 256**6