Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Error on citus_rebalance_start #1074

Open
aytekinar opened this issue Feb 20, 2023 · 1 comment
Open

Documentation Error on citus_rebalance_start #1074

aytekinar opened this issue Feb 20, 2023 · 1 comment

Comments

@aytekinar
Copy link
Member

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 @begriffs, @jonels-msft.

@ivyazmitinov
Copy link

I would also add that description of the block_writes shard transfer mode is incorrect: it states

Use COPY (blocking writes) for tables lacking primary key or replica identity.

While in reality it uses COPY and blocks writes for all tables in question, as can be seen here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants