github.com/cockroachdb/cockroach@v20.2.0-alpha.1+incompatible/README.md (about)

     1  <p align="center">
     2    <img src='docs/media/cockroach_db.png?raw=true' width='70%'>
     3  </p>
     4  
     5  ---
     6  
     7  CockroachDB is a cloud-native SQL database for building global, scalable cloud services that survive disasters.
     8  
     9  - [What is CockroachDB?](#what-is-cockroachdb)
    10  - [Docs](#docs)
    11  - [Quickstart](#quickstart)
    12  - [Client Drivers](#client-drivers)
    13  - [Deployment](#deployment)
    14  - [Need Help?](#need-help)
    15  - [Contributing](#contributing)
    16  - [Design](#design)
    17  - [Comparison with Other Databases](#comparison-with-other-databases)
    18  - [See Also](#see-also)
    19  
    20  ## What is CockroachDB?
    21  
    22  CockroachDB is a distributed SQL database built on a transactional and
    23  strongly-consistent key-value store. It **scales** horizontally;
    24  **survives** disk, machine, rack, and even datacenter failures with
    25  minimal latency disruption and no manual intervention; supports
    26  **strongly-consistent** ACID transactions; and provides a familiar
    27  **SQL** API for structuring, manipulating, and querying data.
    28  
    29  For more details, see our [FAQ](https://cockroachlabs.com/docs/stable/frequently-asked-questions.html) or [architecture document](
    30  https://www.cockroachlabs.com/docs/stable/architecture/overview.html).
    31  
    32  <p align="center">
    33    <a href='https://www.youtube.com/watch?v=VgXiMcbGwzQ'> <img src='docs/media/explainer-video-preview.png' width='70%'> </a>
    34  </p>
    35  
    36  ## Docs
    37  
    38  For guidance on installation, development, deployment, and administration, see our [User Documentation](https://cockroachlabs.com/docs/stable/).
    39  
    40  ## Quickstart
    41  
    42  1. [Install CockroachDB](https://www.cockroachlabs.com/docs/stable/install-cockroachdb.html).
    43  2. [Start a local cluster](https://www.cockroachlabs.com/docs/stable/start-a-local-cluster.html)
    44     and talk to it via the [built-in SQL client](https://www.cockroachlabs.com/docs/stable/use-the-built-in-sql-client.html).
    45  3. [Learn more about CockroachDB SQL](https://www.cockroachlabs.com/docs/stable/learn-cockroachdb-sql.html).
    46  4. Use a PostgreSQL-compatible driver or ORM to
    47     [build an app with CockroachDB](https://www.cockroachlabs.com/docs/stable/build-an-app-with-cockroachdb.html).
    48  5. [Explore core features](https://www.cockroachlabs.com/docs/stable/demo-data-replication.html),
    49     such as data replication, automatic rebalancing, and fault tolerance and recovery.
    50  
    51  ## Client Drivers
    52  
    53  CockroachDB supports the PostgreSQL wire protocol, so you can use any available PostgreSQL client drivers to connect from various languages.
    54  
    55  - For recommended drivers that we've tested, see [Install Client Drivers](https://www.cockroachlabs.com/docs/stable/install-client-drivers.html).
    56  - For tutorials using these drivers, as well as supported ORMs, see [Build an App with CockroachDB](https://www.cockroachlabs.com/docs/stable/build-an-app-with-cockroachdb.html).
    57  
    58  ## Deployment
    59  
    60  - [Test Deployments](https://www.cockroachlabs.com/docs/stable/deploy-a-test-cluster.html) - Easiest way to test an insecure, multi-node CockroachDB cluster.
    61  - Production Deployments
    62      - [Manual](https://www.cockroachlabs.com/docs/stable/manual-deployment.html) - Steps to deploy a CockroachDB cluster manually on multiple machines.
    63      - [Cloud](https://www.cockroachlabs.com/docs/stable/cloud-deployment.html) - Guides for deploying CockroachDB on various cloud platforms.
    64      - [Orchestration](https://www.cockroachlabs.com/docs/stable/orchestration.html) - Guides for running CockroachDB with popular open-source orchestration systems.
    65  
    66  ## Need Help?
    67  
    68  - [CockroachDB Community Slack](https://cockroa.ch/slack) - Join our slack to
    69    connect with our engineers and other users running CockroachDB.
    70  - [CockroachDB Forum](https://forum.cockroachlabs.com/) and
    71    [Stack Overflow](https://stackoverflow.com/questions/tagged/cockroachdb) - Ask questions,
    72    find answers, and help other users.
    73  - [Troubleshooting documentation](https://www.cockroachlabs.com/docs/stable/troubleshooting-overview.html) -
    74    Learn how to troubleshoot common errors, cluster setup, and SQL query behavior.
    75  - For filing bugs, suggesting improvements, or requesting new features, help us out by
    76    [opening an issue](https://github.com/cockroachdb/cockroach/issues/new).
    77  
    78  ## Contributing
    79  
    80  We welcome your contributions! If you're looking for issues to work on, try
    81  looking at the [good first issue](https://github.com/cockroachdb/cockroach/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
    82  list. We do our best to tag issues suitable for new external contributors with
    83  that label, so it's a great way to find something you can help with! See our
    84  [Wiki](https://wiki.crdb.io/wiki/spaces/CRDB/pages/73204033/Contributing+to+CockroachDB)
    85  for more details. 
    86  
    87  Engineering discussion takes place on our public mailing list,
    88  [cockroach-db@googlegroups.com](https://groups.google.com/forum/#!forum/cockroach-db),
    89  and feel free to join our [Community Slack](https://cockroa.ch/slack) (there's
    90  a dedicated #contributors channel!) to ask questions, discuss your ideas, or
    91  connect with other contributors.
    92  
    93  ## Design
    94  
    95  For an in-depth discussion of the CockroachDB architecture, see our
    96  [Architecture
    97  Guide](https://www.cockroachlabs.com/docs/stable/architecture/overview.html).
    98  For the original design motivation, see our [design
    99  doc](https://github.com/cockroachdb/cockroach/blob/master/docs/design.md).
   100  
   101  ## Comparison with Other Databases
   102  
   103  To see how key features of CockroachDB stack up against other databases,
   104  check out [CockroachDB in Comparison](https://www.cockroachlabs.com/docs/stable/cockroachdb-in-comparison.html).
   105  
   106  ## See Also
   107  
   108  - [Tech Talks](https://www.cockroachlabs.com/community/tech-talks/) (by CockroachDB founders and engineers)
   109  - [CockroachDB User Documentation](https://cockroachlabs.com/docs/stable/)
   110  - [The CockroachDB Blog](https://www.cockroachlabs.com/blog/)
   111  - Key design documents
   112    - [Serializable, Lockless, Distributed: Isolation in CockroachDB](https://www.cockroachlabs.com/blog/serializable-lockless-distributed-isolation-cockroachdb/)
   113    - [Consensus, Made Thrive](https://www.cockroachlabs.com/blog/consensus-made-thrive/)
   114    - [Trust, But Verify: How CockroachDB Checks Replication](https://www.cockroachlabs.com/blog/trust-but-verify-cockroachdb-checks-replication/)
   115    - [Living Without Atomic Clocks](https://www.cockroachlabs.com/blog/living-without-atomic-clocks/)
   116    - [The CockroachDB Architecture Document](https://github.com/cockroachdb/cockroach/blob/master/docs/design.md)