Skip to content

Documentation Error on citus_rebalance_start #1074

Description

Actual Behavior

The documentation has misleading information regarding the argument set of citus_rebalance_start, i.e., it lists the arguments threshold, drain_only and rebalance_strategy as opposed to the actual argument set rebalance_strategy, drain_only and shard_transfer_mode, in the given order.

Desired Behavior

We should copy over the documentation regarding shard_transfer_mode from d1ff979, if the functionality has not changed, to the arguments of citus_rebalance_start and remove the non-existing threshold from the docs.

I can create a PR if desired.

/cc Joe Nelson (@begriffs), Joe Nelson (@jonels-msft).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions