Crate

.. image:: docs/_static/crate-logo.svg :alt: CrateDB :target: https://cratedb.com

----

.. image:: https://github.com/crate/crate/actions/workflows/main.yml/badge.svg :target: https://github.com/crate/crate/actions?query=workflow%3A%22CrateDB+SQL%22

.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg :target: https://cratedb.com/docs/crate/reference/en/latest/

.. image:: https://img.shields.io/badge/container-docker-green.svg :target: https://hub.docker.com/_/crate/

|

Help us improve CrateDB by taking our User Survey! _

About =====

CrateDB is a distributed SQL database that makes it simple to store and analyze massive amounts of data in real-time.

CrateDB offers the benefits_ of an SQL database and the scalability and flexibility typically associated with NoSQL databases. Modest CrateDB clusters can ingest tens of thousands of records per second without breaking a sweat. You can run ad-hoc queries using standard SQL_. CrateDB's blazing-fast distributed query execution engine parallelizes query workloads across the whole cluster.

CrateDB is well suited to containerization_, can be scaled horizontally_ using ephemeral virtual machines (e.g., Kubernetes_, AWS_, and Azure_) with no shared state_. You can deploy and run CrateDB on any sort of network — from personal computers to multi-region hybrid clouds and the edge_.

Features ========

• Use standard SQL_ via the PostgreSQL wire protocol_ or an HTTP API_.

• Dynamic table schemas and queryable objects provide

document-oriented features in addition to the relational features of SQL.

• Support for time-series data, real-time full-text search, geospatial data

types and search capabilities.

• Horizontally scalable, highly available and fault-tolerant clusters that run

very well in virtualized and containerized environments.

• Extremely fast distributed query execution.

• Auto-partitioning, auto-sharding, and auto-replication.

• Self-healing and auto-rebalancing.

• User-defined functions_ (UDFs) can be used to extend the functionality of CrateDB.

Screenshots ===========

CrateDB provides an Admin UI_:

.. image:: crate-admin.gif :alt: Screenshots of the CrateDB Admin UI

Try CrateDB ===========

Run CrateDB via the official Docker Image_:

.. code-block:: console

sh$ docker run --publish 4200:4200 --publish 5432:5432 --env CRATE_HEAP_SIZE=1g crate '-Cdiscovery.type=single-node'

Or visit the installation documentation_ to see all the available download and install options.

Once you're up and running, head over to the introductory docs_. To interact with CrateDB, you can use the Admin UI sql console_ or the CrateDB shell_ CLI tool. Alternatively, review the list of recommended clients and tools_ that work with CrateDB.

For container-specific documentation, check out the CrateDB on Docker how-to guide_ or the CrateDB on Kubernetes how-to guide_.

Contributing ============