You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
craig[bot] c87535a050 Merge #49812 3 days ago
.github github: update bulk CODEOWNERS 4 weeks ago
build Merge #49593 5 days ago
c-deps roachpb: non-nullable field in error 5 days ago
cloud cloud: bump version to 20.1.1 1 week ago
docs Merge #49742 4 days ago
githooks build: disable required release justifications 2 months ago
licenses licenses: Update BSL change date for master/20.2 2 months ago
monitoring monitoring: add expiration alerts for optional certificates. 1 year ago
pkg Merge #49812 3 days ago
scripts scripts: add a plandiff script 1 month ago
vendor @ 9f418e59c0 vendor: bump Pebble to 4887c526300055e1c30635c53fd16b3fe9d9e132 5 days ago
.editorconfig opt: use 4 space indentation for .opt files 1 month ago
.gitattributes sql: clean up the `array` logic test 1 year ago
.gitignore c-deps/geos: add geos 2 months ago
.gitmodules c-deps/proj: bump PROJ to compile on more systems 5 days ago
.node-version build: upgrade to node 12 LTS 4 months ago
AUTHORS Merge #47502 #49807 4 days ago
CONTRIBUTING.md githooks: enhance the commit message recommendations 7 months ago
Gopkg.lock vendor: bump Pebble to 4887c526300055e1c30635c53fd16b3fe9d9e132 5 days ago
Gopkg.toml deps: switch over from raven-go to sentry-go 1 week ago
LICENSE licenses: Add BSL.txt 1 year ago
Makefile geo: remove geoproj dependency for now 5 days ago
README.md README: spruce up our README page 2 months ago

README.md


CockroachDB is a cloud-native SQL database for building global, scalable cloud services that survive disasters.

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.

Quickstart

  1. Install CockroachDB.
  2. Start a local cluster
    and talk 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

  • Test Deployments - Easiest way to test an insecure, multi-node CockroachDB cluster.
  • Production Deployments
    • 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?

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 discussion takes place on our public mailing list,
cockroach-db@googlegroups.com,
and feel free to join our Community Slack (there’s
a dedicated #contributors channel!) to ask questions, discuss your ideas, or
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
.

Comparison with Other Databases

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

See Also