Distributed PostgreSQL as an extension
 
 
 
 
 
 
Go to file
Craig Kerstiens dfa547dbc1 updating citus cloud link to point to sign up 2017-01-24 09:09:06 +01:00
src Add Regression Tests For Querying MX Tables from Workers 2017-01-24 10:36:59 +03:00
.codecov.yml Bump target to 87.5% 2016-12-09 14:06:35 -07:00
.gitattributes Support PostgreSQL 9.6 2016-10-18 16:23:55 -06:00
.gitignore Initial commit of Citus 5.0 2016-02-11 04:05:32 +02:00
.travis.yml Add comment for otherwise opaque secure value 2016-12-06 11:30:22 -07:00
CHANGELOG.md Add 6.0.1 CHANGELOG entry 2016-11-29 08:05:36 -08:00
CONTRIBUTING.md Proper indentation for code blocks in lists 2016-03-30 15:40:53 -07:00
LICENSE Add AGPL-3.0 in LICENSE file 2016-03-23 17:04:58 -06:00
Makefile Remove csql, \stage is no longer needed 2016-08-26 10:41:59 +03:00
Makefile.global.in Identify build and source directory of postgres we're compiling against. 2016-10-27 00:31:41 -07:00
README.md updating citus cloud link to point to sign up 2017-01-24 09:09:06 +01:00
autogen.sh Changed product name to citus 2016-02-15 16:04:31 +02:00
configure Enable instrumentation of coverage 2016-12-06 11:30:22 -07:00
configure.in Enable instrumentation of coverage 2016-12-06 11:30:22 -07:00
github-banner.png Readme for 5.0 2016-03-18 13:32:13 -07:00
prep_buildtree Changed product name to citus 2016-02-15 16:04:31 +02:00

README.md

Citus Banner

Build Status Slack Status Latest Docs

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 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 and join the mailing list to stay on top of the latest developments.

Getting started with Citus

The fastest way to get up and running is to create a Citus Cloud account. You can also setup a local Citus cluster with Docker.

Citus Cloud

Citus Cloud runs on top of AWS as a fully managed database as a service and has development plans available for getting started. You can provision a Citus Cloud account at https://console.citusdata.com and get started with just a few clicks.

Local Citus Cluster

If you're looking to get started locally, you can follow the following steps to get up and running.

  • Install docker-compose: Mac | Linux

  • (Mac only) connect to Docker VM

    eval $(docker-machine env default)
    
  • Pull and start the docker images

    wget https://raw.githubusercontent.com/citusdata/docker/master/docker-compose.yml
    docker-compose -p citus up -d
    
  • Connect to the master database

    docker exec -it citus_master psql -U postgres -d postgres
    
  • Follow the first tutorial instructions

  • To shut the cluster down, run

    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.
Twitter Follow @citusdata for general updates and PostgreSQL scaling tips.
Training and Support See our support page for training and dedicated support options.

Contributing

Citus is built on and of open source. We welcome your contributions, and have added a helpwanted label to issues which are accessible to new contributors. The CONTRIBUTING.md file explains how to get started developing the Citus extension itself and our code quality guidelines.

Who is Using Citus?

Citus is deployed in production by many customers, ranging from technology start-ups to large enterprises. Here are some examples:

  • CloudFlare uses Citus to provide real-time analytics on 100 TBs of data from over 4 million customer websites. Case Study
  • MixRank uses Citus to efficiently collect and analyze vast amounts of data to allow inside B2B sales teams to find new customers. Case Study
  • Neustar builds and maintains scalable ad-tech infrastructure that counts billions of events per day using Citus and HyperLogLog.
  • Agari uses Citus to secure more than 85 percent of U.S. consumer emails on two 6-8 TB clusters. Case Study
  • Heap uses Citus to run dynamic funnel, segmentation, and cohort queries across billions of users and tens of billions of events. Watch Video

Copyright © 20122017 Citus Data, Inc.