druid README

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

Coverage Status Docker Helm

Workflow Status
⚙️ CodeQL Config codeql-config
🔍 CodeQL codeql
🕒 Cron Job ITS cron-job-its
🏷️ Labeler labeler
🛠️ Static Checks static-checks
🧪 Unit and Integration Tests Unified unit-and-integration-tests-unified

Website Twitter Download Get Started Documentation Community Build Contribute License


Apache Druid

Druid is a high performance real-time analytics database. Druid's main value add is to reduce time to insight and action.

Druid is designed for workflows where fast queries and ingest really matter. Druid excels at powering UIs, running operational (ad-hoc) queries, or handling high concurrency. Consider Druid as an open source alternative to data warehouses for a variety of use cases. The design documentation explains the key concepts.

Getting started

You can get started with Druid with our local or Docker quickstart. For Kubernetes deployments, the druid-operator is maintained in a separate repository.

Druid provides a rich set of APIs (via HTTP and JDBC) for loading, managing, and querying your data. You can also interact with Druid via the built-in web console (shown below).

Load data

data loader Kafka

Load streaming and batch data using a point-and-click wizard to guide you through ingestion setup. Monitor one off tasks and ingestion supervisors.

Manage the cluster

management

Manage your cluster with ease. Get a view of your datasources, segments, ingestion tasks, and services from one convenient location. All powered by SQL systems tables, allowing you to see the underlying query for each view.

Issue queries

query view combo

Use the built-in query workbench to prototype DruidSQL and native queries or connect one of the many tools that help you make the most out of Druid.

Documentation

See the latest documentation for the documentation for the current official release. If you need information on a previous release, you can browse previous releases documentation.

Make documentation and tutorials updates in /docs using Markdown or extended Markdown (MDX). Then, open a pull request.

To build the site locally, you need Node 22 or higher and to install Docusaurus 3 with npm|yarn install in the website directory. Then you can run npm|yarn start to launch a local dev preview of the docs.

If you're looking to update non-doc pages like Use Cases, those files are in the druid-website-src repo.

For more information, see the README in the ./website directory.

Community

Visit the official project community page to read about getting involved in contributing to Apache Druid, and how we help one another use and operate Druid.

Check out the official community page for details of how to join the community Slack channels.

Find articles written by community members and a calendar of upcoming events on the project site - contribute your own events and articles by submitting a PR in the apache/druid-website-src repository.

Building from source

Please note that JDK 25 is required to build Druid.

See the latest build guide for instructions on building Apache Druid from source.

Contributing

Please follow the community guidelines for contributing.

For instructions on setting up IntelliJ dev/intellij-setup.md

License

Apache License, Version 2.0

druid (apache/druid)

Searching Database…

14.1K ·GitHub
What is this?Apache Druid is a high-performance real-time analytics database built to reduce the time between data arriving and being queryable, so dashboards and ad-hoc queries stay fast even under high concurrency.
Is this a library I embed, or a standalone database I run?It's a standalone distributed database server that you deploy and query, not a library you import into an app; you interact with it over HTTP/JDBC APIs or the built-in web console.
How do I get Druid running?Use the local quickstart or the Docker quickstart to spin up a single-node Druid cluster and start loading data.
Does Druid have built-in Kubernetes support?Not directly in this repo — Kubernetes deployments are handled by the druid-operator, which lives in a separate repository rather than being bundled with Druid itself.
What platforms does Druid run on?Druid runs as a self-hosted server on Linux, and can be started locally or via the provided Docker quickstart.
How do I actually query data in Druid?You use the built-in query workbench to write DruidSQL or native JSON queries, or connect an external BI/SQL tool that supports Druid.
What can I do from the web console?Load streaming and batch data through a point-and-click wizard, monitor ingestion tasks and supervisors, and view datasources, segments and services, all backed by SQL system tables.
Why use Druid instead of a traditional data warehouse?Druid is optimized for fast ingest and fast queries, which makes it a good fit for powering UIs, ad-hoc operational queries, and high-concurrency workloads where a typical data warehouse is too slow.
What are similar projects?trino, doris, starrocks, ClickHouse, oceanbase, tidb, questdb, timescaledb
Creator
apache
Size
426.1 MB
Stars
14.1K
Age
13y
Commits · 90 Days