index.rst

Citus Documentation

Welcome to the documentation for Citus 10.1! Citus is an open source extension to PostgreSQL that transforms Postgres into a distributed database. To scale out Postgres horizontally, Citus employs distributed tables, reference tables, and a distributed SQL query engine. The query engine parallelizes SQL queries across multiple servers in a database cluster to deliver dramatically improved query response times, even for data-intensive applications.

Getting Started

Learn the Citus architecture, install locally, and follow some ten-minute tutorials.

Use Cases

See how Citus allows multi-tenant applications to scale with minimal database changes.

Migrating to Citus

Move from plain PostgreSQL to Citus, and discover data modeling techniques for distributed systems.

Managed Service

Explore our secure, scalable, highly available database-as-a-service.

API / Reference

Get the most out of Citus by learning its functions and configuration.

Help and Support

See the frequently asked questions, and contact us. This is the page to get unstuck.

.. toctree::
   :caption: Get Started
   :hidden:

   get_started/what_is_citus.rst
   get_started/tutorials.rst

.. toctree::
   :caption: Install
   :hidden:

   installation/single_node.rst
   installation/multi_node.rst
   installation/citus_cloud.rst

.. toctree::
   :caption: Use-Case Guides
   :hidden:

   use_cases/multi_tenant.rst
   use_cases/realtime_analytics.rst
   use_cases/timeseries.rst

.. toctree::
   :caption: Architecture
   :hidden:

   get_started/concepts.rst

.. toctree::
   :caption: Develop
   :hidden:

   develop/app_type.rst
   sharding/data_modeling.rst
   develop/migration.rst
   develop/reference.rst
   develop/api.rst
   develop/integrations.rst

.. toctree::
   :caption: Administer
   :hidden:

   admin_guide/cluster_management.rst
   admin_guide/table_management.rst
   admin_guide/upgrading_citus.rst

.. toctree::
   :caption: Troubleshoot
   :hidden:

   performance/performance_tuning.rst
   admin_guide/diagnostic_queries.rst
   reference/common_errors.rst

.. toctree::
   :caption: FAQ
   :hidden:

   faq/faq.rst

.. toctree::
   :caption: Citus Cloud
   :hidden:

   cloud/getting_started.rst
   cloud/manage.rst
   cloud/additional.rst
   cloud/support.rst

.. toctree::
   :caption: Articles
   :hidden:

   articles/index.rst