Citus DocumentationΒΆ
Welcome to the documentation for Citus 6.1! Citus horizontally scales PostgreSQL across commodity servers using sharding and replication. Its query engine parallelizes incoming SQL queries across these servers to enable real-time responses on large datasets.
The documentation explains how you can install Citus and then provides instructions to design, build, query, and maintain your Citus cluster. It also includes a Reference section which provides quick information on several topics.
- Citus SQL Language Reference
- SQL Workarounds
- Citus Utility Function Reference
- Metadata Tables Reference
- Configuration Reference
- Node configuration
- Data Loading
- Planner Configuration
- Intermediate Data Transfer Format
- DDL
- Executor Configuration
- Append Distribution
- Frequently Asked Questions
- Can I create primary keys on distributed tables?
- How do I add nodes to an existing Citus cluster?
- How do I change the shard count for a hash partitioned table?
- How does Citus handle failure of a worker node?
- How does Citus handle failover of the coordinator node?
- How do I ingest the results of a query into a distributed table?
- Can I join distributed and non-distributed tables together in the same query?
- Are there any PostgreSQL features not supported by Citus?
- How do I choose the shard count when I hash-partition my data?
- How does citus support count(distinct) queries?
- In which situations are uniqueness constraints supported on distributed tables?
- Which shard contains data for a particular tenant?
- I forgot the distribution column of a table, how do I find it?
- Why does pg_relation_size report zero bytes for a distributed table?
- Can I run Citus on Heroku or Amazon RDS?
- Can I shard by schema on Citus for multi-tenant applications?
- How does cstore_fdw work with Citus?
- What happened to pg_shard?