About this project

CockroachDB is a cloud-native distributed SQL database for building, scaling, and managing data-intensive applications. It is built on a transactional and strongly-consistent key-value store. According to the README, 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 SQL API for structuring, manipulating, and querying data. The project supports the PostgreSQL wire protocol, so users can connect with PostgreSQL-compatible client drivers and ORMs. The README points to recommended drivers, example apps, and tutorials. Getting started options include installing a pre-built executable or building from source, starting a local cluster, using the built-in SQL client, learning CockroachDB SQL, and exploring features such as data replication, automatic rebalancing, and fault tolerance and recovery. Deployment documentation covers CockroachCloud, manual multi-machine deployment, cloud platforms, and orchestration systems. Community help is available through CockroachDB Community Slack, the CockroachDB Forum, Stack Overflow, and GitHub issues. Contributions are welcomed, with a good first issue list and wiki guidance. For architecture details, the README links to an Architecture Guide and an original design doc. It also links to a comparison page and tech talks, blog, and key design documents. Licensing note: releases on or after November 18, 2024 (v24.3 and later, plus certain patch fixes for v23.1.29+, v23.2.16+, v24.1.7+, and v24.2.5+) are published under the CockroachDB Software License (CSL); copyright belongs to The Cockroach Authors unless otherwise noted.