druid/README.md

106 lines
6.4 KiB
Markdown
Raw Normal View History

<!--
~ Licensed to the Apache Software Foundation (ASF) under one
~ or more contributor license agreements. See the NOTICE file
~ distributed with this work for additional information
~ regarding copyright ownership. The ASF licenses this file
~ to you under the Apache License, Version 2.0 (the
~ "License"); you may not use this file except in compliance
~ with the License. You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing,
~ software distributed under the License is distributed on an
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~ KIND, either express or implied. See the License for the
~ specific language governing permissions and limitations
~ under the License.
-->
[![Slack](https://img.shields.io/badge/slack-%23druid-72eff8?logo=slack)](https://s.apache.org/slack-invite)
[![Build Status](https://api.travis-ci.com/apache/druid.svg?branch=master)](https://travis-ci.com/apache/druid)
2019-12-20 23:56:53 -05:00
[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/apache/druid.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/apache/druid/context:java)
[![Coverage Status](https://img.shields.io/codecov/c/gh/apache/druid)](https://codecov.io/gh/apache/druid)
[![Docker](https://img.shields.io/badge/container-docker-blue.svg)](https://hub.docker.com/r/apache/druid)
[![Helm](https://img.shields.io/badge/helm-druid-5F90AB?logo=helm)](https://github.com/apache/druid/blob/master/helm/druid/README.md)
<!--- Following badges are disabled until they can be fixed: -->
<!--- [![Inspections Status](https://img.shields.io/teamcity/http/teamcity.jetbrains.com/s/OpenSourceProjects_Druid_Inspections.svg?label=TeamCity%20inspections)](https://teamcity.jetbrains.com/viewType.html?buildTypeId=OpenSourceProjects_Druid_Inspections) -->
2015-02-18 19:50:18 -05:00
---
[Website](https://druid.apache.org/) |
[Documentation](https://druid.apache.org/docs/latest/design/) |
[Developer Mailing List](https://lists.apache.org/list.html?dev@druid.apache.org) |
[User Mailing List](https://groups.google.com/forum/#!forum/druid-user) |
[Slack](https://s.apache.org/slack-invite) |
[Twitter](https://twitter.com/druidio) |
[Download](https://druid.apache.org/downloads.html)
---
## Apache Druid
2014-08-01 16:24:12 -04:00
2019-12-20 01:32:08 -05:00
Druid is a high performance real-time analytics database. Druid's main value add is to reduce time to insight and action.
2015-02-18 19:50:18 -05:00
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](https://druid.apache.org/docs/latest/design/architecture.html) explains the key concepts.
2014-08-01 16:24:12 -04:00
2019-09-29 22:32:39 -04:00
### Getting started
2015-02-18 19:50:18 -05:00
You can get started with Druid with our [local](https://druid.apache.org/docs/latest/tutorials/quickstart.html) or [Docker](http://druid.apache.org/docs/latest/tutorials/docker.html) quickstart.
2014-08-01 16:24:12 -04:00
2019-09-29 22:32:39 -04:00
Druid provides a rich set of APIs (via HTTP and [JDBC](https://druid.apache.org/docs/latest/querying/sql.html#jdbc)) for loading, managing, and querying your data.
You can also interact with Druid via the [built-in console](https://druid.apache.org/docs/latest/operations/druid-console.html) (shown below).
#### Load data
[![data loader Kafka](https://user-images.githubusercontent.com/177816/65819337-054eac80-e1d0-11e9-8842-97b92d8c6159.gif)](https://druid.apache.org/docs/latest/ingestion/index.html)
Load [streaming](https://druid.apache.org/docs/latest/ingestion/index.html#streaming) and [batch](https://druid.apache.org/docs/latest/ingestion/index.html#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](https://user-images.githubusercontent.com/177816/65819338-08499d00-e1d0-11e9-80fe-faee9e9468cb.gif)](https://druid.apache.org/docs/latest/ingestion/data-management.html)
2019-12-19 16:00:27 -05:00
Manage your cluster with ease. Get a view of your [datasources](https://druid.apache.org/docs/latest/design/architecture.html), [segments](https://druid.apache.org/docs/latest/design/segments.html), [ingestion tasks](https://druid.apache.org/docs/latest/ingestion/tasks.html), and [services](https://druid.apache.org/docs/latest/design/processes.html) from one convenient location. All powered by [SQL systems tables](https://druid.apache.org/docs/latest/querying/sql.html#metadata-tables), allowing you to see the underlying query for each view.
2019-09-29 22:32:39 -04:00
#### Issue queries
[![query view combo](https://user-images.githubusercontent.com/177816/65819341-0c75ba80-e1d0-11e9-9730-0f2d084defcc.gif)](https://druid.apache.org/docs/latest/querying/sql.html)
Use the built-in query workbench to prototype [DruidSQL](https://druid.apache.org/docs/latest/querying/sql.html) and [native](https://druid.apache.org/docs/latest/querying/querying.html) queries or connect one of the [many tools](https://druid.apache.org/libraries.html) that help you make the most out of Druid.
2014-08-01 16:24:12 -04:00
### Documentation
2015-02-18 19:50:18 -05:00
You can find the [documentation for the latest Druid release](https://druid.apache.org/docs/latest/) on
2019-08-22 12:50:55 -04:00
the [project website](https://druid.apache.org).
2015-02-18 19:50:18 -05:00
If you would like to contribute documentation, please do so under
2019-08-22 12:50:55 -04:00
`/docs` in this repository and submit a pull request.
2015-02-18 19:50:18 -05:00
### Community
Community support is available on the
2019-08-22 12:50:55 -04:00
[druid-user mailing list](https://groups.google.com/forum/#!forum/druid-user), which
is hosted at Google Groups.
Development discussions occur on [dev@druid.apache.org](https://lists.apache.org/list.html?dev@druid.apache.org), which
you can subscribe to by emailing [dev-subscribe@druid.apache.org](mailto:dev-subscribe@druid.apache.org).
2014-08-08 14:41:26 -04:00
2019-09-29 22:32:39 -04:00
Chat with Druid committers and users in real-time on the `#druid` channel in the Apache Slack team. Please use [this invitation link to join the ASF Slack](https://s.apache.org/slack-invite), and once joined, go into the `#druid` channel.
2019-08-08 12:15:27 -04:00
2019-09-29 22:32:39 -04:00
### Building from source
2019-03-18 17:16:21 -04:00
Please note that JDK 8 is required to build Druid.
For instructions on building Druid from source, see [docs/development/build.md](docs/development/build.md)
2016-04-13 14:33:31 -04:00
### Contributing
2019-08-22 12:50:55 -04:00
Please follow the [community guidelines](https://druid.apache.org/community/) for contributing.
For instructions on setting up IntelliJ [dev/intellij-setup.md](dev/intellij-setup.md)
2019-08-22 12:50:55 -04:00
### License
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)