citusdata / citusdata/citus

Document create_distributed_table_concurrently()

Open
#8,116 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
C
Stars
12.8k
Forks
794
Avg merge
2d 14h
Merged PRs (30d)
31

Description

Currently, the documentation for the Citus API only includes create_distributed_table() and not create_distributed_table_concurrently[0]. The function in question is only documented in the README[1] and in a blog post[2].

We should document the function in the Citus API docs for better discoverability.

[0]: https://docs.citusdata.com/en/v13.0/develop/api_udf.html#create-distributed-table
[1]: https://github.com/citusdata/citus?tab=readme-ov-file#distributing-tables-without-interrupting-the-application
[2]: https://www.citusdata.com/blog/2022/09/19/citus-11-1-shards-postgres-tables-without-interruption/

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.