README
¶
CockroachDB is a cloud-native SQL database for building global, scalable cloud services that survive disasters.
/statusIcon.svg)
- What is CockroachDB?
- Docs
- Quickstart
- Client Drivers
- Deployment
- Need Help?
- Contributing
- Design
- Comparison with Other Databases
- See Also
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 and original design document.
Status
CockroachDB is production-ready. See our 1.1 milestone for a list of features planned or in development.
Docs
For guidance on installation, development, deployment, and administration, see our User Documentation.
Quickstart
-
Start a local cluster and talk to it via the built-in SQL client.
-
Use a PostgreSQL-compatible driver or ORM to build an app with CockroachDB.
-
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.
-
For recommended drivers that we've tested, see Install Client Drivers.
-
For tutorials using these drivers, as well as supported ORMs, see Build an App with CockroachDB.
Deployment
-
Manual Deployment - Steps to deploy a CockroachDB cluster manually on multiple machines.
-
Cloud Deployment - Guides for deploying CockroachDB on various cloud platforms.
-
Orchestration - Guides for running CockroachDB with popular open-source orchestration systems.
Need Help?
-
Troubleshooting documentation - Learn how to troubleshoot common errors, cluster and node setup, and SQL query behavior, and how to use debug and error logs.
-
CockroachDB Forum and Stack Overflow - Ask questions, find answers, and help other users.
-
Join us on Gitter - This is the most immediate way to connect with CockroachDB engineers.
-
For filing bugs, suggesting improvements, or requesting new features, help us out by opening an issue.
Contributing
We're an open source project and welcome contributions.
-
See CONTRIBUTING.md to get your local environment set up.
-
Take a look at our open issues, in particular those with the helpwanted label.
-
Review our style guide and follow our code reviews to learn about our style and conventions.
-
Make your changes according to our code review workflow.
Design
This is an overview. For an in-depth discussion of the design and architecture, see the full design doc.
For another quick design overview, see the CockroachDB tech talk slides.
Design Goals
CockroachDB is a distributed SQL database built on top of a transactional and consistent key:value store.
The primary design goals are support for ACID transactions, horizontal scalability and survivability, hence the name.
It aims to tolerate disk, machine, rack, and even datacenter failures with minimal latency disruption and no manual intervention.
CockroachDB nodes are symmetric; a design goal is homogeneous deployment (one binary) with minimal configuration.
How it Works in a Nutshell
CockroachDB implements a single, monolithic sorted map from key to value where both keys and values are byte strings (not unicode).
The map is composed of one or more ranges and each range is backed by data stored in RocksDB (a variant of LevelDB), and is replicated to a total of three or more CockroachDB servers. This enables CockroachDB to scale linearly — theoretically up to 4 exabytes (4E) of logical data.
Ranges are defined by start and end keys. Ranges are merged and split
to maintain total byte size within a globally configurable min/max
size interval. Range sizes default to target 64M in order to
facilitate quick splits and merges and to distribute load at hotspots
within a key range. Range replicas are intended to be located in
disparate datacenters for survivability (e.g. { US-East, US-West, Japan }, { Ireland, US-East, US-West} , { Ireland, US-East, US-West, Japan, Australia }).
Single mutations to ranges are mediated via an instance of a distributed consensus algorithm to ensure consistency. We’ve chosen to use the Raft consensus algorithm. All consensus state is also stored in RocksDB.
A single logical mutation may affect multiple key/value pairs. Logical mutations have ACID transactional semantics. If all keys affected by a logical mutation fall within the same range, atomicity and consistency are guaranteed by Raft; this is the fast commit path. Otherwise, a non-locking distributed commit protocol is employed between affected ranges.
CockroachDB provides snapshot isolation (SI) and serializable snapshot isolation (SSI) semantics, allowing externally consistent, lock-free reads and writes--both from an historical snapshot timestamp and from the current wall clock time. SI provides lock-free reads and writes but still allows write skew. SSI eliminates write skew, but introduces a performance hit in the case of a contentious system. SSI is the default isolation; clients must consciously decide to trade correctness for performance. CockroachDB implements a limited form of linearalizability, providing ordering for any observer or chain of observers.
Similar to Spanner directories, CockroachDB allows configuration of arbitrary zones of data. This allows replication factor, storage device type, and/or datacenter location to be chosen to optimize performance and/or availability. Unlike Spanner, zones are monolithic and don’t allow movement of fine grained data on the level of entity groups.
Comparison with Other Databases
To see how key features of CockroachDB stack up against other databases, visit the CockroachDB in Comparison page on our website.
See Also
- Tech Talks by CockroachDB founders and engineers
- The CockroachDB User documentation
- The CockroachDB Blog
- Key Design documents:
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
acceptance/cluster
Package cluster is a generated protocol buffer package.
|
Package cluster is a generated protocol buffer package. |
|
acceptance/localcluster/tc
Package tc contains utility methods for using the Linux tc (traffic control) command to mess with the network links between cockroach nodes running on the local machine.
|
Package tc contains utility methods for using the Linux tc (traffic control) command to mess with the network links between cockroach nodes running on the local machine. |
|
build
Package build is a generated protocol buffer package.
|
Package build is a generated protocol buffer package. |
|
ccl/sqlccl
Package sqlccl is a generated protocol buffer package.
|
Package sqlccl is a generated protocol buffer package. |
|
ccl/utilccl/licenseccl
Package licenseccl is a generated protocol buffer package.
|
Package licenseccl is a generated protocol buffer package. |
|
cmd/allocsim
command
|
|
|
cmd/benchmark
command
|
|
|
cmd/cockroach-oss
command
|
|
|
cmd/docgen
command
|
|
|
cmd/generate-binary
command
This connects to a postgres server and crafts postgres-protocol message to encode its arguments into postgres' binary encoding.
|
This connects to a postgres server and crafts postgres-protocol message to encode its arguments into postgres' binary encoding. |
|
cmd/github-post
command
|
|
|
cmd/github-pull-request-make
command
This utility detects new tests added in a given pull request, and runs them under stress in our CI infrastructure.
|
This utility detects new tests added in a given pull request, and runs them under stress in our CI infrastructure. |
|
cmd/gossipsim
command
Package simulation provides tools meant to visualize or test aspects of a Cockroach cluster on a single host.
|
Package simulation provides tools meant to visualize or test aspects of a Cockroach cluster on a single host. |
|
cmd/metacheck
command
|
|
|
cmd/protoc-gen-gogoroach
command
|
|
|
cmd/publish-artifacts
command
|
|
|
cmd/returncheck
command
|
|
|
cmd/teamcity-trigger
command
|
|
|
cmd/urlcheck
command
|
|
|
cmd/zerosum
command
|
|
|
config
Package config is a generated protocol buffer package.
|
Package config is a generated protocol buffer package. |
|
gossip
Package gossip implements a protocol for sharing information between Cockroach nodes using an ad-hoc, peer-to-peer network.
|
Package gossip implements a protocol for sharing information between Cockroach nodes using an ad-hoc, peer-to-peer network. |
|
internal/client
Package client and its KV API have been deprecated for external usage.
|
Package client and its KV API have been deprecated for external usage. |
|
internal/rsg/yacc
Package yacc parses .y files.
|
Package yacc parses .y files. |
|
kv
Package kv provides a key-value API to an underlying cockroach datastore.
|
Package kv provides a key-value API to an underlying cockroach datastore. |
|
roachpb
Package roachpb is a generated protocol buffer package.
|
Package roachpb is a generated protocol buffer package. |
|
rpc
Package rpc is a generated protocol buffer package.
|
Package rpc is a generated protocol buffer package. |
|
security/securitytest
Package securitytest embeds the TLS test certificates.
|
Package securitytest embeds the TLS test certificates. |
|
server
Package server implements the Cockroach storage node.
|
Package server implements the Cockroach storage node. |
|
server/diagnosticspb
Package diagnosticspb is a generated protocol buffer package.
|
Package diagnosticspb is a generated protocol buffer package. |
|
server/serverpb
Package serverpb is a generated protocol buffer package.
|
Package serverpb is a generated protocol buffer package. |
|
server/status
Package status is a generated protocol buffer package.
|
Package status is a generated protocol buffer package. |
|
settings
Package settings provides a central registry of runtime editable settings and accompanying helper functions for retrieving their current values.
|
Package settings provides a central registry of runtime editable settings and accompanying helper functions for retrieving their current values. |
|
settings/cluster
Package cluster is a generated protocol buffer package.
|
Package cluster is a generated protocol buffer package. |
|
sql
Package sql provides the user-facing API for access to a Cockroach datastore.
|
Package sql provides the user-facing API for access to a Cockroach datastore. |
|
sql/distsqlrun
Package distsqlrun is a generated protocol buffer package.
|
Package distsqlrun is a generated protocol buffer package. |
|
sql/ir/irgen
command
|
|
|
sql/jobs
Package jobs is a generated protocol buffer package.
|
Package jobs is a generated protocol buffer package. |
|
sql/pgbench/cmd/pgbenchsetup
command
|
|
|
sql/pgwire/pgerror
Package pgerror is a generated protocol buffer package.
|
Package pgerror is a generated protocol buffer package. |
|
sql/sqlbase
Package sqlbase is a generated protocol buffer package.
|
Package sqlbase is a generated protocol buffer package. |
|
storage
Package storage is a generated protocol buffer package.
|
Package storage is a generated protocol buffer package. |
|
storage/engine
Package engine provides low-level storage.
|
Package engine provides low-level storage. |
|
storage/engine/enginepb
Package enginepb is a generated protocol buffer package.
|
Package enginepb is a generated protocol buffer package. |
|
storage/storagebase
Package storagebase is a generated protocol buffer package.
|
Package storagebase is a generated protocol buffer package. |
|
ts
Package ts provides a basic time series datastore on top of the underlying CockroachDB key/value datastore.
|
Package ts provides a basic time series datastore on top of the underlying CockroachDB key/value datastore. |
|
ts/tspb
Package tspb is a generated protocol buffer package.
|
Package tspb is a generated protocol buffer package. |
|
ui
Package ui embeds into the Cockroach certain data such as web html and stylesheets.
|
Package ui embeds into the Cockroach certain data such as web html and stylesheets. |
|
util
Package util is a generated protocol buffer package.
|
Package util is a generated protocol buffer package. |
|
util/hlc
Package hlc implements the Hybrid Logical Clock outlined in "Logical Physical Clocks and Consistent Snapshots in Globally Distributed Databases", available online at http://www.cse.buffalo.edu/tech-reports/2014-04.pdf.
|
Package hlc implements the Hybrid Logical Clock outlined in "Logical Physical Clocks and Consistent Snapshots in Globally Distributed Databases", available online at http://www.cse.buffalo.edu/tech-reports/2014-04.pdf. |
|
util/interval
Package interval provides two implementations for an interval tree.
|
Package interval provides two implementations for an interval tree. |
|
util/leaktest
Package leaktest provides tools to detect leaked goroutines in tests.
|
Package leaktest provides tools to detect leaked goroutines in tests. |
|
util/log
Package log implements logging analogous to the Google-internal C++ INFO/ERROR/V setup.
|
Package log implements logging analogous to the Google-internal C++ INFO/ERROR/V setup. |
|
util/metric
Package metric provides server metrics (a.k.a.
|
Package metric provides server metrics (a.k.a. |
|
util/sdnotify
Package sdnotify implements both sides of the systemd readiness protocol.
|
Package sdnotify implements both sides of the systemd readiness protocol. |
|
util/syncutil/singleflight
Package singleflight provides a duplicate function call suppression mechanism.
|
Package singleflight provides a duplicate function call suppression mechanism. |
|
util/tracing
Package tracing is a generated protocol buffer package.
|
Package tracing is a generated protocol buffer package. |
|
acceptance/compose/gss/psql
module
|