![Citus Banner](/github-banner.png) [![Build Status](https://travis-ci.org/citusdata/citus.svg?branch=master)](https://travis-ci.org/citusdata/citus) [![Slack Status](http://slack.citusdata.com/badge.svg)](https://slack.citusdata.com) [![Latest Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://docs.citusdata.com/en/v5.2/index.html) ### What is Citus? * **Open-source** PostgreSQL extension (not a fork) * **Scalable** across multiple hosts through sharding and replication * **Distributed** engine for query parallelization * **Highly available** in the face of host failures 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. Citus extends the underlying database rather than forking it, which gives developers and enterprises the power and familiarity of a traditional relational database. As an extension, Citus supports new PostgreSQL releases, allowing users to benefit from new features while maintaining compatibility with existing PostgreSQL tools. Note that Citus supports many (but not all) SQL commands; see the [FAQ][faq] for more details. Common Use-Cases: * Powering real-time analytic dashboards * Exploratory queries on events as they happen * Large dataset archival and reporting * Session analytics (funnels, segmentation, and cohorts) To learn more, visit [citusdata.com](https://www.citusdata.com) and join the [mailing list](https://groups.google.com/forum/#!forum/citus-users) to stay on top of the latest developments. ### Quickstart #### Local Citus Cluster * Install docker-compose: [Mac][mac_install] | [Linux][linux_install] * (Mac only) connect to Docker VM ```bash eval $(docker-machine env default) ``` * Pull and start the docker images ```bash wget https://raw.githubusercontent.com/citusdata/docker/master/docker-compose.yml docker-compose -p citus up -d ``` * Connect to the master database ```bash docker exec -it citus_master psql -U postgres -d postgres ``` * Follow the [first tutorial][tutorial] instructions * To shut the cluster down, run ```bash docker-compose -p citus down ``` ### Talk to Contributors and Learn More
Documentation | Try the Citus
tutorials for a hands-on introduction or the documentation for a more comprehensive reference. |
Google Groups | The Citus Google Group is our place for detailed questions and discussions. |
Slack | Chat with us in our community Slack channel. |
Github Issues | We track specific bug reports and feature requests on our project issues. |
Follow @citusdata for general updates and PostgreSQL scaling tips. | |
Training and Support | See our support page for training and dedicated support options. |