external
/
citus
mirror of https://github.com/citusdata/citus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md to include use cases 

Updated to the README.md to reflect newer product features.

* Include references to the multi-tenant use case
* Minor update to tutorial link to include 6.0
* Minor update to Contributing guidelines (we haven't used #helpwanted tags over the past year)
* Minor update to remove link to support & training
pull/1178/head
Ozgun Erdogan 2017-01-27 16:36:33 -08:00 committed by GitHub
parent 6843ad8e91
commit 80e241e5c8
1 changed files with 22 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -7,28 +7,28 @@
### What is Citus? ### What is Citus?
* **Open-source** PostgreSQL extension (not a fork) * **Open-source** PostgreSQL extension (not a fork)
* **Scalable** across multiple hosts through sharding and replication * **Scalable** across multiple machines through sharding and replication
* **Distributed** engine for query parallelization * **Distributed** engine for query parallelization
* **Highly available** in the face of host failures * **Database** designed to scale multi-tenant applications
Citus horizontally scales PostgreSQL across commodity servers using Citus is a distributed database that scales across commodity servers using transparent
sharding and replication. Its query engine parallelizes incoming sharding and replication. Citus extends the underlying database rather than forking it,
SQL queries across these servers to enable real-time responses on giving developers and enterprises the power and familiarity of a relational database. As
large datasets. an extension, Citus supports new PostgreSQL releases, and allows you to benefit from new
features while maintaining compatibility with existing PostgreSQL tools.
Citus extends the underlying database rather than forking it, which Citus serves many use cases. Two common ones are:
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: 1. [Multi-tenant database](https://www.citusdata.com/blog/2016/10/03/designing-your-saas-database-for-high-scalability):
* Powering real-time analytic dashboards Most B2B applications already have the notion of a tenant /
* Exploratory queries on events as they happen customer / account built into their data model. Citus allows you to scale out your
* Large dataset archival and reporting transactional relational database to 100K+ tenants with minimal changes to your
* Session analytics (funnels, segmentation, and cohorts) application.
2. [Real-time analytics](https://www.citusdata.com/blog/2017/01/27/getting-started-with-github-events-data):
Citus enables ingesting large volumes of data and running
analytical queries on that data in human real-time. Example applications include analytic
dashboards with subsecond response times and exploratory queries on unfolding events.
To learn more, visit [citusdata.com](https://www.citusdata.com) and join To learn more, visit [citusdata.com](https://www.citusdata.com) and join
the [mailing list](https://groups.google.com/forum/#!forum/citus-users) to the [mailing list](https://groups.google.com/forum/#!forum/citus-users) to
@ -78,8 +78,8 @@ If you're looking to get started locally, you can follow the following steps to
<tr> <tr>
<td>Documentation</td> <td>Documentation</td>
<td>Try the <a <td>Try the <a
href="https://docs.citusdata.com/en/v5.2/tutorials/tut-hash-distribution.html">Citus href="https://docs.citusdata.com/en/v6.0/tutorials/tut-hash-distribution.html">Citus
tutorials</a> for a hands-on introduction or <br/>the <a tutorial</a> for a hands-on introduction or <br/>the <a
href="https://docs.citusdata.com">documentation</a> for href="https://docs.citusdata.com">documentation</a> for
a more comprehensive reference.</td> a more comprehensive reference.</td>
</tr> </tr>
@ -105,21 +105,12 @@ If you're looking to get started locally, you can follow the following steps to
<td>Follow <a href="https://twitter.com/citusdata">@citusdata</a> <td>Follow <a href="https://twitter.com/citusdata">@citusdata</a>
for general updates and PostgreSQL scaling tips.</td> for general updates and PostgreSQL scaling tips.</td>
</tr> </tr>
<tr>
<td>Training and Support</td>
<td>See our <a
href="https://www.citusdata.com/support">support
page</a> for training and dedicated support options.</td>
</tr>
</table> </table>
### Contributing ### Contributing
Citus is built on and of open source. We welcome your contributions, Citus is built on and of open source, and we welcome your contributions.
and have added a The [CONTRIBUTING.md](CONTRIBUTING.md) file explains how to get started
[helpwanted](https://github.com/citusdata/citus/labels/helpwanted) label
to issues which are accessible to new contributors. The
[CONTRIBUTING.md](CONTRIBUTING.md) file explains how to get started
developing the Citus extension itself and our code quality guidelines. developing the Citus extension itself and our code quality guidelines.
### Who is Using Citus? ### Who is Using Citus?