cockroach README

The project's README from github.com/cockroachdb/cockroach. As one markdown file: README.md.

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 product overview, 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

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, [email protected]. 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

All versions released on or after November 18, 2024 (specifically, major version series v24.3 and later, and patch fixes for v23.1.29+, v23.2.16+, v24.1.7+, and v24.2.5+) are published under the CockroachDB Software License (CSL). Source code in a given file is licensed under the CSL and the copyright belongs to The Cockroach Authors unless otherwise noted in the file or in a LICENSE or README file located in the same or a parent directory of the file.

Comparison with Other Databases

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

See Also

cockroach (cockroachdb/cockroach)

Searching Database…

32.6K ·GitHub
Cockroach
这是什么？CockroachDB 是一个分布式 SQL 数据库，构建在支持事务且强一致性的键值存储之上，旨在实现高可用、水平扩展，并能在硬件故障时无需人工干预即可持续运行。
这是我自己运行的数据库服务器，还是托管的云服务？两者都可以：你可以在自己的机器上自行部署 CockroachDB 集群，也可以使用 CockroachCloud，这是由公司运营的托管版本。
如何让集群运行起来？可以从预编译的可执行文件安装 CockroachDB，也可以从源代码构建；然后启动本地集群，并使用内置的 SQL 客户端连接。
连接它是否需要专门的客户端库？不需要专门的驱动程序：CockroachDB 支持 PostgreSQL 网络协议，因此任何现有的 PostgreSQL 客户端驱动或 ORM 都可以直接使用。
它是否仍然完全开源？现在已不完全开源：2024年11月18日及之后发布的版本（v24.3+ 以及部分补丁版本）改用 CockroachDB 软件许可证（CSL），而不再采用传统的开源许可证。
它在故障情况下如何保持一致性？CockroachDB 底层使用支持事务且强一致性的分布式键值存储，即使节点发生故障或数据重新平衡，也能提供可序列化的 ACID 事务。
我能把它部署到云编排工具上吗？可以。除了托管的 CockroachCloud 选项外，README 还列出了手动多机部署、主流云平台以及流行的开源编排系统的相关指南。
What are similar projects?yugabyte-db, oceanbase, citus, typeorm, mysql-server, vitess, rqlite, shardingsphere
Which topics is it in?cockroachdb, scalable, sqlserver, relational-database, distributed-database, high-availability, nosql, cloud-native, enterprise, sql, distributed-systems, postgresql
Creator
cockroachdb
Size
2.6 GB
Stars
32.6K
Updated
CommitSep 23
Age
12y
Commits · 90 Days