CockroachDB - the open source, cloud-native distributed SQL database.
Other
26205
716
3319


CockroachDB is a cloud-native distributed SQL database designed to build, scale, and manage modern, data-intensive applications.

What is CockroachDB?

CockroachDB is a distributed SQL database built on a transactional and strongly-consistent key-value store. It scales horizontally; survives disk, machine, rack, and even datacenter failures with minimal latency disruption and no manual intervention; supports strongly-consistent ACID transactions; and provides a familiar SQL API for structuring, manipulating, and querying data.

For more details, see our FAQ or architecture document.

Docs

For guidance on installation, development, deployment, and administration, see our User Documentation.

Starting with CockroachCloud

We can run CockroachDB for you, so you don't have to run your own cluster.

See our online documentation: Quickstart with CockroachCloud

Starting with CockroachDB

  1. Install CockroachDB: using a pre-built executable or build it from source.
  2. Start a local cluster and connect to it via the built-in SQL client.
  3. Learn more about CockroachDB SQL.
  4. Use a PostgreSQL-compatible driver or ORM to build an app with CockroachDB.
  5. Explore core features, such as data replication, automatic rebalancing, and fault tolerance and recovery.

Client Drivers

CockroachDB supports the PostgreSQL wire protocol, so you can use any available PostgreSQL client drivers to connect from various languages.

Deployment

  • CockroachCloud - Steps to create a free CockroachCloud cluster on your preferred Cloud platform.
  • Manual - Steps to deploy a CockroachDB cluster manually on multiple machines.
  • Cloud - Guides for deploying CockroachDB on various cloud platforms.
  • Orchestration - Guides for running CockroachDB with popular open-source orchestration systems.

Need Help?

Building from source

See our wiki for more details.

Contributing

We welcome your contributions! If you're looking for issues to work on, try looking at the good first issue list. We do our best to tag issues suitable for new external contributors with that label, so it's a great way to find something you can help with!

See our wiki for more details.

Engineering discussions take place on our public mailing list, cockroach-db@googlegroups.com. Also please join our Community Slack (there's a dedicated #contributors channel!) to ask questions, discuss your ideas, and connect with other contributors.

Design

For an in-depth discussion of the CockroachDB architecture, see our Architecture Guide. For the original design motivation, see our design doc.

Licensing

Current CockroachDB code is released under a combination of two licenses, the Business Source License (BSL) and the Cockroach Community License (CCL).

When contributing to a CockroachDB feature, you can find the relevant license in the comments at the top of each file.

For more information, see the Licensing FAQs.

Comparison with Other Databases

To see how key features of CockroachDB stack up against other databases, check out CockroachDB in Comparison.

See Also

Contributors

tbg
knz
petermattis
tamird
nvanbenschoten
RaduBerinde
andreimatei
yuzefovich
dt
bdarnell
jordanlewis
ajwerner
benesch
a-robinson
otan
mjibson
danhhz
vivekmenezes
spencerkimball
BramGruneir
mgartner
rafiss
irfansharif
rytaft
rickystewart
asubiotto
andy-kimball
erikgrinaker
couchand
koorosh
kkaneda
adityamaru
rohany
pbardea
miretskiy
postamar
mberhault
stevendanna
fqazi
RichardJCai
itsbilal
maryliag
arulajmani
jbowens
sumeerbhola
solongordon
aayushshah15
vladlos
DrewKimball
justinj
dhartunian
Azhng
nathanstilwell
spaskob
mrtracy
chengxiong-ruan
lgo
celiala
jayshrivastava
msbutler
andybons
aliher1911
thoszhang
cuongdo
pavelkalinnikov
xinhaoz
d4l3k
maxlang
ZhouXing19
rail
matthewtodd
michae2
richardwu
Xiang-Gu
jaylim-crl
ecwall
HonoreDB
cucaroach
nicktrav
ajstorm
sjbarag
ericharmeling
healthy-pod
AlexTalks
vilterp
jeffrey-xiao
bobvawter
lunevalex
kvoli
e-mbrown
craig[bot]
darinpp
msirek
yaojingguo
ajkr
adityamaru27
jlinder
THardy98
a6802739
renatolabs