Permalink
Newer
Older
100644 125 lines (82 sloc) 6.52 KB
1
![CockroachDB](docs/media/cockroach_db.png?raw=true "CockroachDB logo")
2
=======================================================================
Feb 6, 2014
3
4
CockroachDB is a cloud-native SQL database for building global, scalable cloud services that survive disasters.
6
[![TeamCity CI](https://teamcity.cockroachdb.com/guestAuth/app/rest/builds/buildType:(id:Cockroach_UnitTests)/statusIcon.svg)](https://teamcity.cockroachdb.com/viewLog.html?buildTypeId=Cockroach_UnitTests&buildId=lastFinished&guest=1)
7
[![GoDoc](https://godoc.org/github.com/cockroachdb/cockroach?status.svg)](https://godoc.org/github.com/cockroachdb/cockroach)
8
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cockroachdb/cockroach?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
Apr 23, 2015
9
10
- [What is CockroachDB?](#what-is-cockroachdb)
May 12, 2016
11
- [Docs](#docs)
12
- [Quickstart](#quickstart)
13
- [Client Drivers](#client-drivers)
Mar 23, 2016
14
- [Deployment](#deployment)
15
- [Need Help?](#need-help)
16
- [Contributing](#contributing)
Mar 23, 2016
17
- [Design](#design)
18
- [Comparison with Other Databases](#comparison-with-other-databases)
19
- [See Also](#see-also)
21
## What is CockroachDB?
Sep 8, 2015
22
23
CockroachDB is a distributed SQL database built on a transactional and
24
strongly-consistent key-value store. It **scales** horizontally;
25
**survives** disk, machine, rack, and even datacenter failures with
26
minimal latency disruption and no manual intervention; supports
27
**strongly-consistent** ACID transactions; and provides a familiar
28
**SQL** API for structuring, manipulating, and querying data.
Jun 3, 2014
29
Jan 17, 2018
30
For more details, see our [FAQ](https://cockroachlabs.com/docs/stable/frequently-asked-questions.html) or [architecture document](
31
https://www.cockroachlabs.com/docs/stable/architecture/overview.html).
32
33
Here’s a quick explainer video:
34
35
<a href='https://www.youtube.com/watch?v=VgXiMcbGwzQ'> <img src='docs/media/explainer-video-preview.png' width='50%'> </a>
36
37
38
## Status
39
40
CockroachDB is production-ready. See our
Jan 17, 2018
41
[Roadmap](https://github.com/cockroachdb/cockroach/wiki/Roadmap) for a list of features planned or in development.
May 12, 2016
43
## Docs
44
45
For guidance on installation, development, deployment, and administration, see our [User Documentation](https://cockroachlabs.com/docs/stable/).
May 12, 2016
46
47
## Quickstart
49
1. [Install CockroachDB](https://www.cockroachlabs.com/docs/stable/install-cockroachdb.html).
51
1. [Start a local cluster](https://www.cockroachlabs.com/docs/stable/start-a-local-cluster.html)
52
and talk to it via the [built-in SQL client](https://www.cockroachlabs.com/docs/stable/use-the-built-in-sql-client.html).
54
1. [Learn more about CockroachDB SQL](https://www.cockroachlabs.com/docs/stable/learn-cockroachdb-sql.html).
Jun 2, 2017
56
1. Use a PostgreSQL-compatible driver or ORM to
57
[build an app with CockroachDB](https://www.cockroachlabs.com/docs/stable/build-an-app-with-cockroachdb.html).
59
1. [Explore core features](https://www.cockroachlabs.com/docs/stable/demo-data-replication.html),
Jun 2, 2017
60
such as data replication, automatic rebalancing, and fault tolerance and recovery.
Mar 23, 2016
61
62
## Client Drivers
64
CockroachDB supports the PostgreSQL wire protocol, so you can use any available PostgreSQL client drivers to connect from various languages.
66
- For recommended drivers that we've tested, see [Install Client Drivers](https://www.cockroachlabs.com/docs/stable/install-client-drivers.html).
68
- For tutorials using these drivers, as well as supported ORMs, see [Build an App with CockroachDB](https://www.cockroachlabs.com/docs/stable/build-an-app-with-cockroachdb.html).
Mar 23, 2016
70
## Deployment
Jan 17, 2018
72
- [Test Deployment](https://www.cockroachlabs.com/docs/stable/deploy-a-test-cluster.html) - Easiest way to test an insecure, multi-node CockroachDB cluster.
73
- Production Deployments
74
- [Manual](https://www.cockroachlabs.com/docs/stable/manual-deployment.html) - Steps to deploy a CockroachDB cluster manually on multiple machines.
75
- [Cloud](https://www.cockroachlabs.com/docs/stable/cloud-deployment.html) - Guides for deploying CockroachDB on various cloud platforms.
76
- [Orchestration](https://www.cockroachlabs.com/docs/stable/orchestration.html) - Guides for running CockroachDB with popular open-source orchestration systems.
80
- [Troubleshooting documentation](https://www.cockroachlabs.com/docs/stable/troubleshooting-overview.html) -
Jun 2, 2017
81
Learn how to troubleshoot common errors, cluster and node setup, and SQL query behavior,
82
and how to use debug and error logs.
Jun 2, 2017
84
- [CockroachDB Forum](https://forum.cockroachlabs.com/) and
85
[Stack Overflow](https://stackoverflow.com/questions/tagged/cockroachdb) - Ask questions,
86
find answers, and help other users.
Jun 2, 2017
88
- [Join us on Gitter](https://gitter.im/cockroachdb/cockroach) - This is the most immediate
89
way to connect with CockroachDB engineers.
90
91
- For filing bugs, suggesting improvements, or requesting new features, help us out by
92
[opening an issue](https://github.com/cockroachdb/cockroach/issues/new).
94
## Contributing
Jan 17, 2018
96
We're an open source project and welcome contributions. See our [Contributing Guide](https://www.cockroachlabs.com/docs/stable/contribute-to-cockroachdb.html) for more details.
98
Engineering discussion takes place on our public mailing list,
99
[cockroach-db@googlegroups.com](https://groups.google.com/forum/#!forum/cockroach-db).
100
May 19, 2014
101
Mar 5, 2015
103
Jan 17, 2018
104
For an in-depth discussion of the CockroachDB architecture, see our [Architecture Guide](https://www.cockroachlabs.com/docs/stable/architecture/overview.html).
Jan 17, 2018
106
For the original design motivation, see our [design doc](https://github.com/cockroachdb/cockroach/blob/master/docs/design.md).
109
## Comparison with Other Databases
111
To see how key features of CockroachDB stack up against other databases,
112
visit the [CockroachDB in Comparison](https://www.cockroachlabs.com/docs/stable/cockroachdb-in-comparison.html) page on our website.
116
- [Tech Talks](https://www.cockroachlabs.com/community/tech-talks/) by CockroachDB founders and engineers
117
- [The CockroachDB User documentation](https://cockroachlabs.com/docs/stable/)
118
- [The CockroachDB Blog](https://www.cockroachlabs.com/blog/)
119
- Key Design documents:
120
- [Serializable, Lockless, Distributed: Isolation in CockroachDB](https://www.cockroachlabs.com/blog/serializable-lockless-distributed-isolation-cockroachdb/)
121
- [Consensus, Made Thrive](https://www.cockroachlabs.com/blog/consensus-made-thrive/)
122
- [Trust, But Verify: How CockroachDB Checks Replication](https://www.cockroachlabs.com/blog/trust-but-verify-cockroachdb-checks-replication/)
123
- [Living Without Atomic Clocks](https://www.cockroachlabs.com/blog/living-without-atomic-clocks/)
124
- [The CockroachDB Architecture Document](https://github.com/cockroachdb/cockroach/blob/master/docs/design.md)