Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api-reference/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ sidebar_label: Overview
-->


This topic is an index to the Apache Druid API documentation.
This topic is an index to the Apache® Druid API documentation.

## HTTP APIs
* [Druid SQL queries](./sql-api.md) to submit SQL queries using the Druid SQL API.
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/automatic-compaction-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import TabItem from '@theme/TabItem';
~ under the License.
-->

This topic describes the status and configuration API endpoints for [automatic compaction using Coordinator duties](../data-management/automatic-compaction.md#auto-compaction-using-coordinator-duties) in Apache Druid. You can configure automatic compaction in the Druid web console or API.
This topic describes the status and configuration API endpoints for [automatic compaction using Coordinator duties](../data-management/automatic-compaction.md#auto-compaction-using-coordinator-duties) in Apache® Druid. You can configure automatic compaction in the Druid web console or API.

:::info[Experimental]

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/data-management-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ sidebar_label: Data management
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

This topic describes the data management API endpoints for Apache Druid.
This topic describes the data management API endpoints for Apache® Druid.
This includes information on how to mark segments as used or unused and delete them from Druid.

In this topic, `http://ROUTER_IP:ROUTER_PORT` is a placeholder for your Router service address and port.
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/dynamic-configuration-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import TabItem from '@theme/TabItem';
~ under the License.
-->

This document describes the API endpoints to retrieve and manage dynamic configurations for the [Coordinator](../design/coordinator.md) and [Overlord](../design/overlord.md) in Apache Druid.
This document describes the API endpoints to retrieve and manage dynamic configurations for the [Coordinator](../design/coordinator.md) and [Overlord](../design/overlord.md) in Apache® Druid.

In this topic, `http://ROUTER_IP:ROUTER_PORT` is a placeholder for your Router service address and port.
Replace it with the information for your deployment.
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/json-querying-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import TabItem from '@theme/TabItem';
~ under the License.
-->

This topic describes the API endpoints to submit JSON-based [native queries](../querying/querying.md) to Apache Druid.
This topic describes the API endpoints to submit JSON-based [native queries](../querying/querying.md) to Apache® Druid.

In this topic, `http://SERVICE_IP:SERVICE_PORT` is a placeholder for the server address of deployment and the service port. For example, on the quickstart configuration, replace `http://ROUTER_IP:ROUTER_PORT` with `http://localhost:8888`.

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/legacy-metadata-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ sidebar_label: Legacy metadata
~ under the License.
-->

This document describes the legacy API endpoints to retrieve datasource metadata from Apache Druid. Use the [SQL metadata tables](../querying/sql-metadata-tables.md) to retrieve datasource metadata instead.
This document describes the legacy API endpoints to retrieve datasource metadata from Apache® Druid. Use the [SQL metadata tables](../querying/sql-metadata-tables.md) to retrieve datasource metadata instead.

## Segment loading

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/lookups-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ sidebar_label: Lookups
~ under the License.
-->

This document describes the API endpoints to configure, update, retrieve, and manage lookups for Apache Druid.
This document describes the API endpoints to configure, update, retrieve, and manage lookups for Apache® Druid.

## Configure lookups

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/retention-rules-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import TabItem from '@theme/TabItem';
~ under the License.
-->

This topic describes the API endpoints for managing retention rules in Apache Druid. You can configure retention rules in the Druid web console or API.
This topic describes the API endpoints for managing retention rules in Apache® Druid. You can configure retention rules in the Druid web console or API.

Druid uses retention rules to determine what data is retained in the cluster. Druid supports load, drop, and broadcast rules. For more information, see [Using rules to drop and retain data](../operations/rule-configuration.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/service-status-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import TabItem from '@theme/TabItem';
-->


This document describes the API endpoints to retrieve service status, cluster information for Apache Druid.
This document describes the API endpoints to retrieve service status, cluster information for Apache® Druid.

In this document, `http://SERVICE_IP:SERVICE_PORT` is a placeholder for the server address of deployment and the service port. For example, on the quickstart configuration, replace `http://ROUTER_IP:ROUTER_PORT` with `http://localhost:8888`.

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/sql-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import TabItem from '@theme/TabItem';
-->

:::info
Apache Druid supports two query languages: Druid SQL and [native queries](../querying/querying.md).
Apache® Druid supports two query languages: Druid SQL and [native queries](../querying/querying.md).
This document describes the SQL language.
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/sql-jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ sidebar_label: SQL JDBC driver
-->

:::info
Apache Druid supports two query languages: Druid SQL and [native queries](../querying/querying.md).
Apache® Druid supports two query languages: Druid SQL and [native queries](../querying/querying.md).
This document describes the SQL language.
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/supervisor-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ import TabItem from '@theme/TabItem';
~ under the License.
-->

This topic describes the API endpoints to manage and monitor supervisors for Apache Druid.
The topic uses the Apache Kafka term offset to refer to the identifier for records in a partition. If you are using Amazon Kinesis, the equivalent is sequence number.
This topic describes the API endpoints to manage and monitor supervisors for Apache® Druid.
The topic uses the Apache Kafka® term offset to refer to the identifier for records in a partition. If you are using Amazon Kinesis, the equivalent is sequence number.

In this topic, `http://ROUTER_IP:ROUTER_PORT` is a placeholder for your Router service address and port. Replace it with the information for your deployment. For example, use `http://localhost:8888` for quickstart deployments.

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/tasks-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import TabItem from '@theme/TabItem';
~ under the License.
-->

This document describes the API endpoints for task retrieval, submission, and deletion for Apache Druid. Tasks are individual jobs performed by Druid to complete operations such as ingestion, querying, and compaction.
This document describes the API endpoints for task retrieval, submission, and deletion for Apache® Druid. Tasks are individual jobs performed by Druid to complete operations such as ingestion, querying, and compaction.

In this topic, `http://ROUTER_IP:ROUTER_PORT` is a placeholder for the Router service address and port. For example, on the quickstart configuration, use `http://localhost:8888`.

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Core extensions are maintained by Druid committers.
|druid-hdfs-storage|HDFS deep storage.|[link](../development/extensions-core/hdfs.md)|
|druid-histogram|Approximate histograms and quantiles aggregator. Deprecated, please use the [DataSketches quantiles aggregator](../development/extensions-core/datasketches-quantiles.md) from the `druid-datasketches` extension instead.|[link](../development/extensions-core/approximate-histograms.md)|
|druid-kafka-extraction-namespace|Apache Kafka-based namespaced lookup. Requires namespace lookup extension.|[link](../querying/kafka-extraction-namespace.md)|
|druid-kafka-indexing-service|Supervised exactly-once Apache Kafka ingestion for the indexing service.|[link](../ingestion/kafka-ingestion.md)|
|druid-kafka-indexing-service|Supervised exactly-once Apache Kafka® ingestion for the indexing service.|[link](../ingestion/kafka-ingestion.md)|
|druid-kinesis-indexing-service|Supervised exactly-once Kinesis ingestion for the indexing service.|[link](../ingestion/kinesis-ingestion.md)|
|druid-kerberos|Kerberos authentication for druid processes.|[link](../development/extensions-core/druid-kerberos.md)|
|druid-lookups-cached-global|A module for [lookups](../querying/lookups.md) providing a jvm-global eager caching for lookups. It provides JDBC and URI implementations for fetching lookup data.|[link](../querying/lookups-cached-global.md)|
Expand Down
2 changes: 1 addition & 1 deletion docs/data-management/automatic-compaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ title: "Automatic compaction"
~ under the License.
-->

In Apache Druid, compaction is a special type of ingestion task that reads data from a Druid datasource and writes it back into the same datasource. A common use case for this is to [optimally size segments](../operations/segment-optimization.md) after ingestion to improve query performance. Automatic compaction, or auto-compaction, refers to the system for automatic execution of compaction tasks issued by Druid itself. In addition to auto-compaction, you can perform [manual compaction](./manual-compaction.md) using the Overlord APIs.
In Apache® Druid, compaction is a special type of ingestion task that reads data from a Druid datasource and writes it back into the same datasource. A common use case for this is to [optimally size segments](../operations/segment-optimization.md) after ingestion to improve query performance. Automatic compaction, or auto-compaction, refers to the system for automatic execution of compaction tasks issued by Druid itself. In addition to auto-compaction, you can perform [manual compaction](./manual-compaction.md) using the Overlord APIs.

:::info
Auto-compaction skips datasources that have a segment granularity of `ALL`.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-management/compaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ description: "Defines compaction and automatic compaction (auto-compaction or au
~ under the License.
-->

Query performance in Apache Druid depends on optimally sized segments. Compaction is one strategy you can use to optimize segment size for your Druid database. Compaction tasks read an existing set of segments for a given time interval and combine the data into a new "compacted" set of segments. In some cases the compacted segments are larger, but there are fewer of them. In other cases the compacted segments may be smaller. Compaction tends to increase performance because optimized segments require less per-segment processing and less memory overhead for ingestion and for querying paths.
Query performance in Apache® Druid depends on optimally sized segments. Compaction is one strategy you can use to optimize segment size for your Druid database. Compaction tasks read an existing set of segments for a given time interval and combine the data into a new "compacted" set of segments. In some cases the compacted segments are larger, but there are fewer of them. In other cases the compacted segments may be smaller. Compaction tends to increase performance because optimized segments require less per-segment processing and less memory overhead for ingestion and for querying paths.

## Compaction guidelines

Expand Down
2 changes: 1 addition & 1 deletion docs/data-management/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ title: "Data deletion"

## Delete data for a time range manually

Apache Druid stores data [partitioned by time chunk](../design/storage.md) and supports
Apache® Druid stores data [partitioned by time chunk](../design/storage.md) and supports
deleting data for time chunks by dropping segments. This is a fast, metadata-only operation.

Deletion by time range happens in two steps:
Expand Down
2 changes: 1 addition & 1 deletion docs/data-management/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ sidebar_label: "Overview"
~ under the License.
-->

Apache Druid stores data [partitioned by time chunk](../design/storage.md) in immutable
Apache® Druid stores data [partitioned by time chunk](../design/storage.md) in immutable
files called [segments](../design/segments.md). Data management operations involving replacing, or deleting,
these segments include:

Expand Down
2 changes: 1 addition & 1 deletion docs/data-management/manual-compaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ title: "Manual compaction"
~ under the License.
-->

In Apache Druid, compaction is a special type of ingestion task that reads data from a Druid datasource and writes it back into the same datasource. A common use case for this is to [optimally size segments](../operations/segment-optimization.md) after ingestion to improve query performance.
In Apache® Druid, compaction is a special type of ingestion task that reads data from a Druid datasource and writes it back into the same datasource. A common use case for this is to [optimally size segments](../operations/segment-optimization.md) after ingestion to improve query performance.

You can perform manual compaction where you submit a one-time compaction task for a specific interval. Generally, you don't need to do this if you use [automatic compaction](./automatic-compaction.md), which is recommended for most workloads.

Expand Down
2 changes: 1 addition & 1 deletion docs/data-management/schema-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ title: "Schema changes"

## For new data

Apache Druid allows you to provide a new schema for new data without the need to update the schema of any existing data.
Apache® Druid allows you to provide a new schema for new data without the need to update the schema of any existing data.
It is sufficient to update your supervisor spec, if using [streaming ingestion](../ingestion/index.md#streaming), or to
provide the new schema the next time you do a [batch ingestion](../ingestion/index.md#batch). This is made possible by
the fact that each [segment](../design/segments.md), at the time it is created, stores a
Expand Down
2 changes: 1 addition & 1 deletion docs/data-management/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ title: "Data updates"

## Overwrite

Apache Druid stores data [partitioned by time chunk](../design/storage.md) and supports
Apache® Druid stores data [partitioned by time chunk](../design/storage.md) and supports
overwriting existing data using time ranges. Data outside the replacement time range is not touched. Overwriting of
existing data is done using the same mechanisms as [batch ingestion](../ingestion/index.md#batch).

Expand Down
2 changes: 1 addition & 1 deletion docs/design/broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The Broker service routes queries in a distributed cluster setup. It discovers d

## Configuration

For Apache Druid Broker service configuration, see [Broker Configuration](../configuration/index.md#broker).
For Apache® Druid Broker service configuration, see [Broker Configuration](../configuration/index.md#broker).

For basic tuning guidance for the Broker service, see [Basic cluster tuning](../operations/basic-cluster-tuning.md#broker).

Expand Down
2 changes: 1 addition & 1 deletion docs/design/coordinator.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ service loads the segment and begins servicing it.

## Configuration

For Apache Druid Coordinator service configuration, see [Coordinator configuration](../configuration/index.md#coordinator).
For Apache® Druid Coordinator service configuration, see [Coordinator configuration](../configuration/index.md#coordinator).

For basic tuning guidance for the Coordinator service, see [Basic cluster tuning](../operations/basic-cluster-tuning.md#coordinator).

Expand Down
2 changes: 1 addition & 1 deletion docs/design/deep-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ title: "Deep storage"
-->


Deep storage is where segments are stored. It is a storage mechanism that Apache Druid does not provide. This deep storage infrastructure defines the level of durability of your data. As long as Druid processes can see this storage infrastructure and get at the segments stored on it, you will not lose data no matter how many Druid nodes you lose. If segments disappear from this storage layer, then you will lose whatever data those segments represented.
Deep storage is where segments are stored. It is a storage mechanism that Apache® Druid does not provide. This deep storage infrastructure defines the level of durability of your data. As long as Druid processes can see this storage infrastructure and get at the segments stored on it, you will not lose data no matter how many Druid nodes you lose. If segments disappear from this storage layer, then you will lose whatever data those segments represented.

In addition to being the backing store for segments, you can use [query from deep storage](#querying-from-deep-storage) and run queries against segments stored primarily in deep storage. The [load rules](../operations/rule-configuration.md#load-rules) you configure determine whether segments exist primarily in deep storage or in a combination of deep storage and Historical processes.

Expand Down
2 changes: 1 addition & 1 deletion docs/design/historical.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Historical services cache data segments on local disk and serve queries from tha

## Configuration

For Apache Druid Historical service configuration, see [Historical configuration](../configuration/index.md#historical).
For Apache® Druid Historical service configuration, see [Historical configuration](../configuration/index.md#historical).

For basic tuning guidance for the Historical service, see [Basic cluster tuning](../operations/basic-cluster-tuning.md#historical).

Expand Down
2 changes: 1 addition & 1 deletion docs/design/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ title: "Introduction to Apache Druid"
~ under the License.
-->

Apache Druid is a real-time analytics database designed for fast slice-and-dice analytics ("[OLAP](http://en.wikipedia.org/wiki/Online_analytical_processing)" queries) on large data sets. Most often, Druid powers use cases where real-time ingestion, fast query performance, and high uptime are important.
Apache® Druid is a real-time analytics database designed for fast slice-and-dice analytics ("[OLAP](http://en.wikipedia.org/wiki/Online_analytical_processing)" queries) on large data sets. Most often, Druid powers use cases where real-time ingestion, fast query performance, and high uptime are important.

Druid is commonly used as the database backend for GUIs of analytical applications, or for highly-concurrent APIs that need fast aggregations. Druid works best with event-oriented data.

Expand Down
2 changes: 1 addition & 1 deletion docs/design/indexer.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ sidebar_label: "Indexer"
The Indexer is an optional and experimental feature. If you're primarily performing batch ingestion, we recommend you use either the MiddleManager and Peon task execution system or [MiddleManager-less ingestion using Kubernetes](../development/extensions-core/k8s-jobs.md). If you're primarily doing streaming ingestion, you may want to try either [MiddleManager-less ingestion using Kubernetes](../development/extensions-core/k8s-jobs.md) or the Indexer service.
:::

The Apache Druid Indexer service is an alternative to the Middle Manager + Peon task execution system. Instead of forking a separate JVM process per-task, the Indexer runs tasks as separate threads within a single JVM process.
The Apache® Druid Indexer service is an alternative to the Middle Manager + Peon task execution system. Instead of forking a separate JVM process per-task, the Indexer runs tasks as separate threads within a single JVM process.

The Indexer is designed to be easier to configure and deploy compared to the Middle Manager + Peon system and to better enable resource sharing across tasks.

Expand Down
2 changes: 1 addition & 1 deletion docs/design/indexing-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ title: "Indexing Service"
-->


The Apache Druid indexing service is a highly-available, distributed service that runs indexing related tasks.
The Apache® Druid indexing service is a highly-available, distributed service that runs indexing related tasks.

Indexing [tasks](../ingestion/tasks.md) are responsible for creating and [killing](../ingestion/tasks.md#kill) Druid [segments](../design/segments.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/design/metadata-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ title: "Metadata storage"
-->


Apache Druid relies on an external dependency for metadata storage.
Apache® Druid relies on an external dependency for metadata storage.
Druid uses the metadata store to house various metadata about the system, but not to store the actual data.
The metadata store retains all metadata essential for a Druid cluster to work.

Expand Down
2 changes: 1 addition & 1 deletion docs/design/middlemanager.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Druid uses separate JVMs for tasks to isolate resources and logs. Each Peon is c

## Configuration

For Apache Druid Middle Manager service configuration, see [Middle Manager and Peons](../configuration/index.md#middle-manager-and-peon).
For Apache® Druid Middle Manager service configuration, see [Middle Manager and Peons](../configuration/index.md#middle-manager-and-peon).

For basic tuning guidance for the Middle Manager service, see [Basic cluster tuning](../operations/basic-cluster-tuning.md#middle-manager).

Expand Down
Loading
Loading