From 1bd3feee2ba265a7ddfb18e0f44eb22ff3940a78 Mon Sep 17 00:00:00 2001 From: avaamsel Date: Wed, 24 Jun 2026 14:04:59 -0700 Subject: [PATCH 01/11] docs: updated isolation.level description --- docs/ingestion/kafka-ingestion.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/ingestion/kafka-ingestion.md b/docs/ingestion/kafka-ingestion.md index 5854d5820764..928d8aa3ff88 100644 --- a/docs/ingestion/kafka-ingestion.md +++ b/docs/ingestion/kafka-ingestion.md @@ -156,9 +156,7 @@ Consumer properties control how a supervisor reads and processes event messages You must include `bootstrap.servers` in consumer properties with a list of Kafka brokers in the format `:,:,...`. In some cases, you may need to retrieve consumer properties at runtime. For example, when `bootstrap.servers` is unknown or not static. -The `isolation.level` property in `consumerProperties` determines how Druid reads messages written transactionally. -With `read_committed`, which is the default in Druid, only committed transactions are read. -If you use older versions of Kafka without transaction support, or you want to read even aborted transactions, set `isolation.level` to `read_uncommitted`. +The `isolation.level` property determines how Druid handles transactional Kafka messages. Although standard Kafka consumers default to `read_uncommitted`, Druid's ingestion engine defaults `read_committed`. This ensures that only finalized data is indexed and aborted transactions are ignored. If you need to use legacy Kafka brokers or don’t want Druid to consume only committed transactions, explicitly set `isolation.level` to `read_uncommitted`. Note that using `read_uncommitted` removes Druid's offset gap check, which requires the message source to ensure the message offsets are continuous. If your Kafka cluster enables consumer group ACLs, you can set `group.id` in `consumerProperties` to override the default auto generated group ID. From ad41d9532b8c6c155eb341137d1d4ead51077b46 Mon Sep 17 00:00:00 2001 From: avaamsel Date: Wed, 24 Jun 2026 14:10:20 -0700 Subject: [PATCH 02/11] added yarn serve to scripts --- website/package.json | 1 + 1 file changed, 1 insertion(+) diff --git a/website/package.json b/website/package.json index 5ff9dfdf86ba..0733ccbb9b6a 100644 --- a/website/package.json +++ b/website/package.json @@ -3,6 +3,7 @@ "scripts": { "start": "docusaurus start", "build": "docusaurus build", + "serve": "docusaurus serve", "compile-scss": "sass scss/custom.scss > static/css/custom.css", "link-lint": "node script/link-lint.js", "spellcheck": "mdspell --en-us --ignore-numbers --report '../docs/**/*.md' || (./script/notify-spellcheck-issues && false)", From b84173360e65db12d092c3622224415337bc2261 Mon Sep 17 00:00:00 2001 From: ava nunes Date: Fri, 26 Jun 2026 10:56:17 -0700 Subject: [PATCH 03/11] Update docs/ingestion/kafka-ingestion.md Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com> --- docs/ingestion/kafka-ingestion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ingestion/kafka-ingestion.md b/docs/ingestion/kafka-ingestion.md index 928d8aa3ff88..1d8127a767ce 100644 --- a/docs/ingestion/kafka-ingestion.md +++ b/docs/ingestion/kafka-ingestion.md @@ -156,7 +156,7 @@ Consumer properties control how a supervisor reads and processes event messages You must include `bootstrap.servers` in consumer properties with a list of Kafka brokers in the format `:,:,...`. In some cases, you may need to retrieve consumer properties at runtime. For example, when `bootstrap.servers` is unknown or not static. -The `isolation.level` property determines how Druid handles transactional Kafka messages. Although standard Kafka consumers default to `read_uncommitted`, Druid's ingestion engine defaults `read_committed`. This ensures that only finalized data is indexed and aborted transactions are ignored. If you need to use legacy Kafka brokers or don’t want Druid to consume only committed transactions, explicitly set `isolation.level` to `read_uncommitted`. Note that using `read_uncommitted` removes Druid's offset gap check, which requires the message source to ensure the message offsets are continuous. +The `isolation.level` property determines how Druid handles transactional Kafka messages. Although standard Kafka consumers default to `read_uncommitted`, Druid's ingestion engine defaults to `read_committed`. This ensures that only finalized data is indexed and aborted transactions are ignored. If you need to use legacy Kafka brokers or don’t want Druid to consume only committed transactions, explicitly set `isolation.level` to `read_uncommitted`. Note that using `read_uncommitted` removes Druid's offset gap check, which requires the message source to ensure the message offsets are continuous. If your Kafka cluster enables consumer group ACLs, you can set `group.id` in `consumerProperties` to override the default auto generated group ID. From ce83ca40c7594d1d199d42b89ae98caff9d75062 Mon Sep 17 00:00:00 2001 From: avaamsel Date: Mon, 29 Jun 2026 15:16:44 -0700 Subject: [PATCH 04/11] docs: updated all commands referencing bin/post-index-task --- docs/ingestion/native-batch.md | 2 +- docs/tutorials/tutorial-batch.md | 8 ++++---- docs/tutorials/tutorial-compaction.md | 14 ++++++++++---- docs/tutorials/tutorial-delete-data.md | 6 ++++-- docs/tutorials/tutorial-ingestion-spec.md | 4 +++- docs/tutorials/tutorial-retention.md | 6 ++++-- 6 files changed, 26 insertions(+), 14 deletions(-) diff --git a/docs/ingestion/native-batch.md b/docs/ingestion/native-batch.md index 986d7e977975..96ab037b2126 100644 --- a/docs/ingestion/native-batch.md +++ b/docs/ingestion/native-batch.md @@ -46,7 +46,7 @@ For related information on batch indexing, see: To run either kind of JSON-based batch indexing task, you can: - Use the **Load Data** UI in the web console to define and submit an ingestion spec. -- Define an ingestion spec in JSON based upon the [examples](#parallel-indexing-example) and reference topics for batch indexing. Then POST the ingestion spec to the [Tasks API endpoint](../api-reference/tasks-api.md), `/druid/indexer/v1/task`, the Overlord service. Alternatively, you can use the indexing script included with Druid at `bin/post-index-task`. +- Define an ingestion spec in JSON based upon the [examples](#parallel-indexing-example) and reference topics for batch indexing. Then POST the ingestion spec to the [Tasks API endpoint](../api-reference/tasks-api.md), `/druid/indexer/v1/task`, the Overlord service. ## Parallel task indexing diff --git a/docs/tutorials/tutorial-batch.md b/docs/tutorials/tutorial-batch.md index e8b729b04a46..765f91d104d3 100644 --- a/docs/tutorials/tutorial-batch.md +++ b/docs/tutorials/tutorial-batch.md @@ -118,14 +118,14 @@ Once the spec is submitted, wait a few moments for the data to load, after which ## Loading data with a spec (via command line) -For convenience, the Druid package includes a batch ingestion helper script at `bin/post-index-task`. - -This script will POST an ingestion task to the Druid Overlord and poll Druid until the data is available for querying. +To load data with a spec, you need to POST an ingestion task to the Druid Overlord and poll Druid until the data is available for querying. Run the following command from Druid package root: ```bash -bin/post-index-task --file quickstart/tutorial/wikipedia-index.json --url http://localhost:8081 +curl -X POST http://localhost:8081/druid/indexer/v1/task \ + -H "Content-Type: application/json" \ + -d @quickstart/tutorial/wikipedia-index.json ``` You should see output like the following: diff --git a/docs/tutorials/tutorial-compaction.md b/docs/tutorials/tutorial-compaction.md index c4a918897ab0..7f8c4cc9bb0e 100644 --- a/docs/tutorials/tutorial-compaction.md +++ b/docs/tutorials/tutorial-compaction.md @@ -45,10 +45,12 @@ This tutorial uses the Wikipedia edits sample data included with the Druid distr To load the initial data, you use an ingestion spec that loads batch data with segment granularity of `HOUR` and creates between one and three segments per hour. You can review the ingestion spec at `quickstart/tutorial/compaction-init-index.json`. -Submit the spec as follows to create a datasource called `compaction-tutorial`: +Submit the spec as follows to the Druid Overlord API to create a datasource called `compaction-tutorial`: ```bash -bin/post-index-task --file quickstart/tutorial/compaction-init-index.json --url http://localhost:8081 +curl -X POST http://localhost:8081/druid/indexer/v1/task \ + -H "Content-Type: application/json" \ + -d @quickstart/tutorial/compaction-init-index.json ``` :::info @@ -106,7 +108,9 @@ This datasource only has 39,244 rows. 39,244 is below the default limit of 5,000 Submit the compaction task now: ```bash -bin/post-index-task --file quickstart/tutorial/compaction-keep-granularity.json --url http://localhost:8081 +curl -X POST http://localhost:8081/druid/indexer/v1/task \ + -H "Content-Type: application/json" \ + -d @quickstart/tutorial/compaction-keep-granularity.json ``` After the task finishes, refresh the [segments view](http://localhost:8888/unified-console.html#segments). @@ -172,7 +176,9 @@ Note that `segmentGranularity` is set to `DAY` in this compaction task spec. Submit this task now: ```bash -bin/post-index-task --file quickstart/tutorial/compaction-day-granularity.json --url http://localhost:8081 +curl -X POST http://localhost:8081/druid/indexer/v1/task \ + -H "Content-Type: application/json" \ + -d @quickstart/tutorial/compaction-day-granularity.json ``` It takes some time before the Coordinator marks the old input segments as unused, so you may see an intermediate state with 25 total segments. Eventually, only one DAY granularity segment remains: diff --git a/docs/tutorials/tutorial-delete-data.md b/docs/tutorials/tutorial-delete-data.md index 93173470c4ca..9c176c9cb9a4 100644 --- a/docs/tutorials/tutorial-delete-data.md +++ b/docs/tutorials/tutorial-delete-data.md @@ -34,10 +34,12 @@ This tutorial requires the following: In this tutorial, we will use the Wikipedia edits data, with an indexing spec that creates hourly segments. This spec is located at `quickstart/tutorial/deletion-index.json`, and it creates a datasource called `deletion-tutorial`. -Let's load this initial data: +Let's load this initial data by calling the Druid Overlord API: ```bash -bin/post-index-task --file quickstart/tutorial/deletion-index.json --url http://localhost:8081 +curl -X POST http://localhost:8081/druid/indexer/v1/task \ + -H "Content-Type: application/json" \ + -d @quickstart/tutorial/deletion-index.json ``` When the load finishes, open [http://localhost:8888/unified-console.md#datasources](http://localhost:8888/unified-console.html#datasources) in a browser. diff --git a/docs/tutorials/tutorial-ingestion-spec.md b/docs/tutorials/tutorial-ingestion-spec.md index 67324cb19ebf..d26fcc73bc2b 100644 --- a/docs/tutorials/tutorial-ingestion-spec.md +++ b/docs/tutorials/tutorial-ingestion-spec.md @@ -583,7 +583,9 @@ We've finished defining the ingestion spec, it should now look like the followin From the `apache-druid-{{DRUIDVERSION}}` package root, run the following command: ```bash -bin/post-index-task --file quickstart/ingestion-tutorial-index.json --url http://localhost:8081 +curl -X POST http://localhost:8081/druid/indexer/v1/task \ + -H "Content-Type: application/json" \ + -d @quickstart/tutorial/ingestion-tutorial-index.json ``` After the script completes, we will query the data. diff --git a/docs/tutorials/tutorial-retention.md b/docs/tutorials/tutorial-retention.md index 6beca6255b66..2e6381bfe7d0 100644 --- a/docs/tutorials/tutorial-retention.md +++ b/docs/tutorials/tutorial-retention.md @@ -35,10 +35,12 @@ It will also be helpful to have finished [Load a file](../tutorials/tutorial-bat For this tutorial, we'll be using the Wikipedia edits sample data, with an ingestion task spec that will create a separate segment for each hour in the input data. -The ingestion spec can be found at `quickstart/tutorial/retention-index.json`. Let's submit that spec, which will create a datasource called `retention-tutorial`: +The ingestion spec can be found at `quickstart/tutorial/retention-index.json`. Let's submit that spec by calling Druid Overlord, which will create a datasource called `retention-tutorial`: ```bash -bin/post-index-task --file quickstart/tutorial/retention-index.json --url http://localhost:8081 +curl -X POST http://localhost:8081/druid/indexer/v1/task \ + -H "Content-Type: application/json" \ + -d @quickstart/tutorial/retention-index.json ``` After the ingestion completes, go to [http://localhost:8888/unified-console.html#datasources](http://localhost:8888/unified-console.html#datasources) in a browser to access the web console's datasource view. From 10621a7d43b4b8d3d44f6011ff4a0859fc57089c Mon Sep 17 00:00:00 2001 From: avaamsel Date: Thu, 2 Jul 2026 14:04:05 -0700 Subject: [PATCH 05/11] first wave of adding trademarks to docs --- docs/api-reference/api-reference.md | 2 +- docs/api-reference/automatic-compaction-api.md | 2 +- docs/api-reference/data-management-api.md | 2 +- docs/api-reference/dynamic-configuration-api.md | 2 +- docs/api-reference/json-querying-api.md | 2 +- docs/api-reference/legacy-metadata-api.md | 2 +- docs/api-reference/lookups-api.md | 2 +- docs/api-reference/retention-rules-api.md | 2 +- docs/api-reference/service-status-api.md | 2 +- docs/api-reference/sql-api.md | 2 +- docs/api-reference/sql-jdbc.md | 2 +- docs/api-reference/supervisor-api.md | 4 ++-- docs/api-reference/tasks-api.md | 2 +- docs/data-management/automatic-compaction.md | 2 +- docs/data-management/compaction.md | 2 +- docs/data-management/delete.md | 2 +- docs/data-management/index.md | 2 +- docs/data-management/manual-compaction.md | 2 +- docs/data-management/schema-changes.md | 2 +- docs/data-management/update.md | 2 +- 20 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/api-reference/api-reference.md b/docs/api-reference/api-reference.md index dd4a4ab638b9..d8fc86ee2a70 100644 --- a/docs/api-reference/api-reference.md +++ b/docs/api-reference/api-reference.md @@ -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. diff --git a/docs/api-reference/automatic-compaction-api.md b/docs/api-reference/automatic-compaction-api.md index 4f2ce3d62afd..5b052c99e87c 100644 --- a/docs/api-reference/automatic-compaction-api.md +++ b/docs/api-reference/automatic-compaction-api.md @@ -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] diff --git a/docs/api-reference/data-management-api.md b/docs/api-reference/data-management-api.md index fe37c6a81422..53f90b1c77e6 100644 --- a/docs/api-reference/data-management-api.md +++ b/docs/api-reference/data-management-api.md @@ -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. diff --git a/docs/api-reference/dynamic-configuration-api.md b/docs/api-reference/dynamic-configuration-api.md index 7805d7287c4e..fefbc22c3133 100644 --- a/docs/api-reference/dynamic-configuration-api.md +++ b/docs/api-reference/dynamic-configuration-api.md @@ -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. diff --git a/docs/api-reference/json-querying-api.md b/docs/api-reference/json-querying-api.md index 5d03ec8b316b..26eb9c7e94a9 100644 --- a/docs/api-reference/json-querying-api.md +++ b/docs/api-reference/json-querying-api.md @@ -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`. diff --git a/docs/api-reference/legacy-metadata-api.md b/docs/api-reference/legacy-metadata-api.md index d22be18a7ec9..b7114b84d959 100644 --- a/docs/api-reference/legacy-metadata-api.md +++ b/docs/api-reference/legacy-metadata-api.md @@ -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 diff --git a/docs/api-reference/lookups-api.md b/docs/api-reference/lookups-api.md index 4a122917b536..270699a5704f 100644 --- a/docs/api-reference/lookups-api.md +++ b/docs/api-reference/lookups-api.md @@ -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 diff --git a/docs/api-reference/retention-rules-api.md b/docs/api-reference/retention-rules-api.md index c21e546abd2a..979fb213a7dc 100644 --- a/docs/api-reference/retention-rules-api.md +++ b/docs/api-reference/retention-rules-api.md @@ -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). diff --git a/docs/api-reference/service-status-api.md b/docs/api-reference/service-status-api.md index 1c192162d5d0..1a712603281e 100644 --- a/docs/api-reference/service-status-api.md +++ b/docs/api-reference/service-status-api.md @@ -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`. diff --git a/docs/api-reference/sql-api.md b/docs/api-reference/sql-api.md index 37b79e83c3b0..b9f037740549 100644 --- a/docs/api-reference/sql-api.md +++ b/docs/api-reference/sql-api.md @@ -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. ::: diff --git a/docs/api-reference/sql-jdbc.md b/docs/api-reference/sql-jdbc.md index affe9ea738b5..771ee24e451b 100644 --- a/docs/api-reference/sql-jdbc.md +++ b/docs/api-reference/sql-jdbc.md @@ -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. ::: diff --git a/docs/api-reference/supervisor-api.md b/docs/api-reference/supervisor-api.md index 8f9c5c36dc5c..48dbd1d47c08 100644 --- a/docs/api-reference/supervisor-api.md +++ b/docs/api-reference/supervisor-api.md @@ -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. diff --git a/docs/api-reference/tasks-api.md b/docs/api-reference/tasks-api.md index 6eaa00d7f463..cf7257f3ee7a 100644 --- a/docs/api-reference/tasks-api.md +++ b/docs/api-reference/tasks-api.md @@ -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`. diff --git a/docs/data-management/automatic-compaction.md b/docs/data-management/automatic-compaction.md index e455319d924a..221888e3ba8f 100644 --- a/docs/data-management/automatic-compaction.md +++ b/docs/data-management/automatic-compaction.md @@ -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`. diff --git a/docs/data-management/compaction.md b/docs/data-management/compaction.md index 3c31c7ef57e4..487958d86131 100644 --- a/docs/data-management/compaction.md +++ b/docs/data-management/compaction.md @@ -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 diff --git a/docs/data-management/delete.md b/docs/data-management/delete.md index db87e3768d9e..cf571566edec 100644 --- a/docs/data-management/delete.md +++ b/docs/data-management/delete.md @@ -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: diff --git a/docs/data-management/index.md b/docs/data-management/index.md index 0e0e09ac8902..4b6e5de6ec8d 100644 --- a/docs/data-management/index.md +++ b/docs/data-management/index.md @@ -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: diff --git a/docs/data-management/manual-compaction.md b/docs/data-management/manual-compaction.md index 4c13d4b40f24..15b6f5da24d5 100644 --- a/docs/data-management/manual-compaction.md +++ b/docs/data-management/manual-compaction.md @@ -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. diff --git a/docs/data-management/schema-changes.md b/docs/data-management/schema-changes.md index 0771da3ce2c4..f8e175c2d8d9 100644 --- a/docs/data-management/schema-changes.md +++ b/docs/data-management/schema-changes.md @@ -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 diff --git a/docs/data-management/update.md b/docs/data-management/update.md index a8c75a5d3492..85423046afab 100644 --- a/docs/data-management/update.md +++ b/docs/data-management/update.md @@ -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). From 4e75cba59df79f285602d66f8bf44ffcdc6770e1 Mon Sep 17 00:00:00 2001 From: avaamsel Date: Thu, 2 Jul 2026 14:15:01 -0700 Subject: [PATCH 06/11] added trademarks to design and ingestion sections in docs --- docs/design/broker.md | 2 +- docs/design/coordinator.md | 2 +- docs/design/deep-storage.md | 2 +- docs/design/historical.md | 2 +- docs/design/index.md | 2 +- docs/design/indexer.md | 2 +- docs/design/indexing-service.md | 2 +- docs/design/metadata-storage.md | 2 +- docs/design/middlemanager.md | 2 +- docs/design/overlord.md | 2 +- docs/design/peons.md | 2 +- docs/design/router.md | 2 +- docs/design/segments.md | 2 +- docs/design/zookeeper.md | 2 +- docs/ingestion/data-formats.md | 2 +- docs/ingestion/hadoop.md | 2 +- docs/ingestion/index.md | 2 +- docs/ingestion/ingestion-spec.md | 2 +- docs/ingestion/input-sources.md | 2 +- docs/ingestion/kafka-ingestion.md | 2 +- docs/ingestion/kinesis-ingestion.md | 2 +- docs/ingestion/native-batch.md | 2 +- docs/ingestion/standalone-realtime.md | 2 +- docs/ingestion/streaming.md | 4 ++-- docs/ingestion/supervisor.md | 4 ++-- docs/ingestion/tranquility.md | 2 +- docs/multi-stage-query/reference.md | 2 +- docs/release-info/migr-ansi-sql-null.md | 2 +- docs/release-info/migr-front-coded-dict.md | 2 +- docs/release-info/migration-guide.md | 2 +- 30 files changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/design/broker.md b/docs/design/broker.md index 800000925e52..ffd8b9801f09 100644 --- a/docs/design/broker.md +++ b/docs/design/broker.md @@ -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). diff --git a/docs/design/coordinator.md b/docs/design/coordinator.md index f2d735000cf9..7801fd1fe1cb 100644 --- a/docs/design/coordinator.md +++ b/docs/design/coordinator.md @@ -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). diff --git a/docs/design/deep-storage.md b/docs/design/deep-storage.md index 0674f324292c..b5c7412b77a2 100644 --- a/docs/design/deep-storage.md +++ b/docs/design/deep-storage.md @@ -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. diff --git a/docs/design/historical.md b/docs/design/historical.md index 9bf5935f95ea..4ddbaa9d4091 100644 --- a/docs/design/historical.md +++ b/docs/design/historical.md @@ -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). diff --git a/docs/design/index.md b/docs/design/index.md index 4d4655a9b1b3..96f9051f0be1 100644 --- a/docs/design/index.md +++ b/docs/design/index.md @@ -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. diff --git a/docs/design/indexer.md b/docs/design/indexer.md index 4b695b290b9d..96d4997bffc3 100644 --- a/docs/design/indexer.md +++ b/docs/design/indexer.md @@ -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. diff --git a/docs/design/indexing-service.md b/docs/design/indexing-service.md index d7dde33ecdf4..ae191374c8eb 100644 --- a/docs/design/indexing-service.md +++ b/docs/design/indexing-service.md @@ -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). diff --git a/docs/design/metadata-storage.md b/docs/design/metadata-storage.md index 8071753f3e07..90bcc1bbf618 100644 --- a/docs/design/metadata-storage.md +++ b/docs/design/metadata-storage.md @@ -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. diff --git a/docs/design/middlemanager.md b/docs/design/middlemanager.md index 9037b56a6e75..05ff2abab441 100644 --- a/docs/design/middlemanager.md +++ b/docs/design/middlemanager.md @@ -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). diff --git a/docs/design/overlord.md b/docs/design/overlord.md index d8458e750a95..fb3c0aded43a 100644 --- a/docs/design/overlord.md +++ b/docs/design/overlord.md @@ -31,7 +31,7 @@ This mode is recommended if you intend to use the indexing service as the single ## Configuration -For Apache Druid Overlord service configuration, see [Overlord Configuration](../configuration/index.md#overlord). +For Apache® Druid Overlord service configuration, see [Overlord Configuration](../configuration/index.md#overlord). For basic tuning guidance for the Overlord service, see [Basic cluster tuning](../operations/basic-cluster-tuning.md#overlord). diff --git a/docs/design/peons.md b/docs/design/peons.md index b31bd8ec1a81..3a029856ff42 100644 --- a/docs/design/peons.md +++ b/docs/design/peons.md @@ -27,7 +27,7 @@ The Peon service is a task execution engine spawned by the Middle Manager. Each ## Configuration -For Apache Druid Peon configuration, see [Peon Query Configuration](../configuration/index.md#peon-query-configuration) and [Additional Peon Configuration](../configuration/index.md#additional-peon-configuration). +For Apache® Druid Peon configuration, see [Peon Query Configuration](../configuration/index.md#peon-query-configuration) and [Additional Peon Configuration](../configuration/index.md#additional-peon-configuration). For basic tuning guidance for Middle Manager tasks, see [Basic cluster tuning](../operations/basic-cluster-tuning.md#task-configurations). diff --git a/docs/design/router.md b/docs/design/router.md index ffe9358e488b..15ec0495af32 100644 --- a/docs/design/router.md +++ b/docs/design/router.md @@ -31,7 +31,7 @@ In addition to query routing, the Router also runs the [web console](../operatio ## Configuration -For Apache Druid Router service configuration, see [Router configuration](../configuration/index.md#router). +For Apache® Druid Router service configuration, see [Router configuration](../configuration/index.md#router). For basic tuning guidance for the Router service, see [Basic cluster tuning](../operations/basic-cluster-tuning.md#router). diff --git a/docs/design/segments.md b/docs/design/segments.md index 7bf9c1b88622..f69bc666d660 100644 --- a/docs/design/segments.md +++ b/docs/design/segments.md @@ -23,7 +23,7 @@ title: "Segments" --> -Apache Druid stores its data and indexes in *segment files* partitioned by time. Druid creates a segment for each segment interval that contains data. If an interval is empty—that is, containing no rows—no segment exists for that time interval. Druid may create multiple segments for the same interval if you ingest data for that period via different ingestion jobs. [Compaction](../data-management/compaction.md) is the Druid process that attempts to combine these segments into a single segment per interval for optimal performance. +Apache® Druid stores its data and indexes in *segment files* partitioned by time. Druid creates a segment for each segment interval that contains data. If an interval is empty—that is, containing no rows—no segment exists for that time interval. Druid may create multiple segments for the same interval if you ingest data for that period via different ingestion jobs. [Compaction](../data-management/compaction.md) is the Druid process that attempts to combine these segments into a single segment per interval for optimal performance. The time interval is configurable in the `segmentGranularity` parameter of the [`granularitySpec`](../ingestion/ingestion-spec.md#granularityspec). diff --git a/docs/design/zookeeper.md b/docs/design/zookeeper.md index d69ba92f0a1c..fb704884f0e5 100644 --- a/docs/design/zookeeper.md +++ b/docs/design/zookeeper.md @@ -23,7 +23,7 @@ title: "ZooKeeper" --> -Apache Druid uses [Apache ZooKeeper](http://zookeeper.apache.org/) (ZK) for management of current cluster state. +Apache® Druid uses [Apache ZooKeeper](http://zookeeper.apache.org/) (ZK) for management of current cluster state. ## Minimum ZooKeeper versions diff --git a/docs/ingestion/data-formats.md b/docs/ingestion/data-formats.md index 6a2aedc39764..303e3f7188b8 100644 --- a/docs/ingestion/data-formats.md +++ b/docs/ingestion/data-formats.md @@ -23,7 +23,7 @@ sidebar_label: Source input formats ~ under the License. --> -Apache Druid can ingest denormalized data in JSON, CSV, or a delimited form such as TSV, or any custom format. While most examples in the documentation use data in JSON format, it is not difficult to configure Druid to ingest any other delimited data. +Apache® Druid can ingest denormalized data in JSON, CSV, or a delimited form such as TSV, or any custom format. While most examples in the documentation use data in JSON format, it is not difficult to configure Druid to ingest any other delimited data. We welcome any contributions to new formats. This page lists all default and core extension data formats supported by Druid. diff --git a/docs/ingestion/hadoop.md b/docs/ingestion/hadoop.md index 35c4eb373e2c..472496cc18ac 100644 --- a/docs/ingestion/hadoop.md +++ b/docs/ingestion/hadoop.md @@ -23,7 +23,7 @@ sidebar_label: "Hadoop-based" ~ under the License. --> -Support for Apache Hadoop-based ingestion was removed from Apache Druid 37.0.0. Please use +Support for Apache Hadoop-based ingestion was removed from Apache® Druid 37.0.0. Please use [SQL-based ingestion](../multi-stage-query/index.md) or [native batch](../ingestion/native-batch.md) instead. The associated `materialized-view-selection` and `materialized-view-maintenance` contrib extensions were also removed diff --git a/docs/ingestion/index.md b/docs/ingestion/index.md index 4d63fd64020e..cd8d95afd03c 100644 --- a/docs/ingestion/index.md +++ b/docs/ingestion/index.md @@ -56,7 +56,7 @@ supervisor. | **Method** | [Kafka](../ingestion/kafka-ingestion.md) | [Kinesis](../ingestion/kinesis-ingestion.md) | |---|-----|--------------| | **Supervisor type** | `kafka` | `kinesis`| -| **How it works** | Druid reads directly from Apache Kafka. | Druid reads directly from Amazon Kinesis.| +| **How it works** | Druid reads directly from Apache Kafka®. | Druid reads directly from Amazon Kinesis.| | **Can ingest late data?** | Yes. | Yes. | | **Exactly-once guarantees?** | Yes. | Yes. | diff --git a/docs/ingestion/ingestion-spec.md b/docs/ingestion/ingestion-spec.md index ad0dc31bb8a9..90954999539b 100644 --- a/docs/ingestion/ingestion-spec.md +++ b/docs/ingestion/ingestion-spec.md @@ -443,7 +443,7 @@ Projections you define become a dimension for your datasource. To remove a proje ## `ioConfig` -The `ioConfig` influences how data is read from a source system, such as Apache Kafka, Amazon S3, a mounted +The `ioConfig` influences how data is read from a source system, such as Apache Kafka®, Amazon S3, a mounted filesystem, or any other supported source system. The `inputFormat` property applies to all [ingestion method](./index.md#ingestion-methods). The rest of `ioConfig` is specific to each individual ingestion method. diff --git a/docs/ingestion/input-sources.md b/docs/ingestion/input-sources.md index f2d4ce3afec2..05b019ef3f3f 100644 --- a/docs/ingestion/input-sources.md +++ b/docs/ingestion/input-sources.md @@ -23,7 +23,7 @@ sidebar_label: "Input sources" ~ under the License. --> -The input source defines where your index task reads data for Apache Druid native batch ingestion. Only the native parallel task and simple task support the input source. +The input source defines where your index task reads data for Apache® Druid native batch ingestion. Only the native parallel task and simple task support the input source. For general information on native batch indexing and parallel task indexing, see [Native batch ingestion](./native-batch.md). diff --git a/docs/ingestion/kafka-ingestion.md b/docs/ingestion/kafka-ingestion.md index 1d8127a767ce..79232c9f5a28 100644 --- a/docs/ingestion/kafka-ingestion.md +++ b/docs/ingestion/kafka-ingestion.md @@ -25,7 +25,7 @@ description: "Overview of the Kafka indexing service for Druid. Includes example --> :::info -To use the Kafka indexing service, you must be on Apache Kafka version 0.11.x or higher. +To use the Kafka indexing service, you must be on Apache Kafka® version 0.11.x or higher. If you are using an older version, refer to the [Apache Kafka upgrade guide](https://kafka.apache.org/documentation/#upgrade). ::: diff --git a/docs/ingestion/kinesis-ingestion.md b/docs/ingestion/kinesis-ingestion.md index 487a74f2a1d5..f001a305d332 100644 --- a/docs/ingestion/kinesis-ingestion.md +++ b/docs/ingestion/kinesis-ingestion.md @@ -29,7 +29,7 @@ import TabItem from '@theme/TabItem'; When you enable the Kinesis indexing service, you can configure supervisors on the Overlord to manage the creation and lifetime of Kinesis indexing tasks. Kinesis indexing tasks read events using the Kinesis shard and sequence number mechanism to guarantee exactly-once ingestion. The supervisor oversees the state of the indexing tasks to coordinate handoffs, manage failures, and ensure that scalability and replication requirements are maintained. -This topic contains configuration information for the Kinesis indexing service supervisor for Apache Druid. +This topic contains configuration information for the Kinesis indexing service supervisor for Apache® Druid. ## Setup diff --git a/docs/ingestion/native-batch.md b/docs/ingestion/native-batch.md index 96ab037b2126..abf7605bd62c 100644 --- a/docs/ingestion/native-batch.md +++ b/docs/ingestion/native-batch.md @@ -27,7 +27,7 @@ sidebar_label: JSON-based batch This page describes JSON-based batch ingestion using [ingestion specs](ingestion-spec.md). For SQL-based batch ingestion using the [multi-stage query (MSQ) task engine](../multi-stage-query/index.md), see [SQL-based ingestion](../multi-stage-query/index.md). Refer to the [ingestion methods](../ingestion/index.md#batch) table to determine which ingestion method is right for you. ::: -Apache Druid supports the following types of JSON-based batch indexing tasks: +Apache® Druid supports the following types of JSON-based batch indexing tasks: - Parallel task indexing (`index_parallel`) that can run multiple indexing tasks concurrently. Parallel task works well for production ingestion tasks. - Simple task indexing (`index`) that run a single indexing task at a time. Simple task indexing is suitable for development and test environments. diff --git a/docs/ingestion/standalone-realtime.md b/docs/ingestion/standalone-realtime.md index 94a8565baad7..ed54d51f06d5 100644 --- a/docs/ingestion/standalone-realtime.md +++ b/docs/ingestion/standalone-realtime.md @@ -23,7 +23,7 @@ title: "Realtime Process" ~ under the License. --> -Older versions of Apache Druid supported a standalone 'Realtime' process to query and index 'stream pull' +Older versions of Apache® Druid supported a standalone 'Realtime' process to query and index 'stream pull' modes of real-time ingestion. These processes would periodically build segments for the data they had collected over some span of time and then set up hand-off to [Historical](../design/historical.md) servers. diff --git a/docs/ingestion/streaming.md b/docs/ingestion/streaming.md index 942ed46b9821..cf9f32b3bb53 100644 --- a/docs/ingestion/streaming.md +++ b/docs/ingestion/streaming.md @@ -22,9 +22,9 @@ title: "Streaming ingestion" ~ under the License. --> -Apache Druid can consume data streams from the following external streaming sources: +Apache® Druid can consume data streams from the following external streaming sources: -* Apache Kafka through the bundled [Kafka indexing service](kafka-ingestion.md) extension. +* Apache Kafka® through the bundled [Kafka indexing service](kafka-ingestion.md) extension. * Amazon Kinesis through the bundled [Kinesis indexing service](kinesis-ingestion.md) extension. Each indexing service provides real-time data ingestion with exactly-once stream processing guarantee. diff --git a/docs/ingestion/supervisor.md b/docs/ingestion/supervisor.md index b642aefec45e..2a4f2a260061 100644 --- a/docs/ingestion/supervisor.md +++ b/docs/ingestion/supervisor.md @@ -23,10 +23,10 @@ sidebar_label: Supervisor ~ under the License. --> -Apache Druid uses supervisors to manage streaming ingestion from external streaming sources into Druid. +Apache® Druid uses supervisors to manage streaming ingestion from external streaming sources into Druid. Supervisors oversee the state of indexing tasks to coordinate handoffs, manage failures, and ensure that the scalability and replication requirements are maintained. They can also be used to perform [automatic compaction](../data-management/automatic-compaction.md) after data has been ingested. -This 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 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. ## Supervisor spec diff --git a/docs/ingestion/tranquility.md b/docs/ingestion/tranquility.md index 9124ff04b86b..10df7ca45cf1 100644 --- a/docs/ingestion/tranquility.md +++ b/docs/ingestion/tranquility.md @@ -26,5 +26,5 @@ title: "Tranquility" streams to Druid in real-time. It is not compatible with recent versions of Druid. For new projects that require streaming ingestion, we recommend using Druid's native support for -[Apache Kafka](../ingestion/kafka-ingestion.md) or +[Apache Kafka®](../ingestion/kafka-ingestion.md) or [Amazon Kinesis](../ingestion/kinesis-ingestion.md). diff --git a/docs/multi-stage-query/reference.md b/docs/multi-stage-query/reference.md index 82d85b52eb73..310c1451654a 100644 --- a/docs/multi-stage-query/reference.md +++ b/docs/multi-stage-query/reference.md @@ -25,7 +25,7 @@ sidebar_label: Reference ## SQL reference -This topic is a reference guide for the multi-stage query architecture in Apache Druid. For examples of real-world +This topic is a reference guide for the multi-stage query architecture in Apache® Druid. For examples of real-world usage, refer to the [Examples](examples.md) page. `INSERT` and `REPLACE` load data into a Druid datasource from either an external input source, or from another diff --git a/docs/release-info/migr-ansi-sql-null.md b/docs/release-info/migr-ansi-sql-null.md index b8548e8ce1a1..8eebf7f5c749 100644 --- a/docs/release-info/migr-ansi-sql-null.md +++ b/docs/release-info/migr-ansi-sql-null.md @@ -25,7 +25,7 @@ sidebar_label: SQL compliant mode import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -In Apache Druid 32.0.0, legacy configurations which were incompatible with the ANSI SQL standard were removed. +In Apache® Druid 32.0.0, legacy configurations which were incompatible with the ANSI SQL standard were removed. These configurations were: * `druid.generic.useDefaultValueForNull` diff --git a/docs/release-info/migr-front-coded-dict.md b/docs/release-info/migr-front-coded-dict.md index 5d8833f13b11..6b60992cb580 100644 --- a/docs/release-info/migr-front-coded-dict.md +++ b/docs/release-info/migr-front-coded-dict.md @@ -23,7 +23,7 @@ sidebar_label: Front-coded dictionaries ~ under the License. --> -Apache Druid stores STRING columns using dictionary encoding for better compression, where each string value is added to a lexicographically sorted dictionary and the actual column just stores a pointer to a dictionary entry. +Apache® Druid stores STRING columns using dictionary encoding for better compression, where each string value is added to a lexicographically sorted dictionary and the actual column just stores a pointer to a dictionary entry. Front coding is an optional incremental encoding strategy that lets you further compress STRING and [COMPLEX<json>](../querying/nested-columns.md) columns in Druid with minimal performance impact. Front-coded dictionaries can reduce storage and improve performance by optimizing values with a shared common prefix to avoid storing duplicate data. For example, if you are tracking website visits, most URLs start with `https://domain.xyz/`, and front coding is able to exploit this pattern for more optimal compression when storing such datasets. diff --git a/docs/release-info/migration-guide.md b/docs/release-info/migration-guide.md index 760b691d143d..b208cd1c024e 100644 --- a/docs/release-info/migration-guide.md +++ b/docs/release-info/migration-guide.md @@ -23,7 +23,7 @@ description: How to migrate from legacy features to get the most from Druid upda ~ under the License. --> -In general, when we introduce new features and behaviors into Apache Druid, we make every effort to avoid breaking existing features when introducing new behaviors. However, sometimes there are either bugs or performance limitations with the old behaviors that are not possible to fix in a backward-compatible way. In these cases, we must introduce breaking changes for the future maintainability of Druid. +In general, when we introduce new features and behaviors into Apache® Druid, we make every effort to avoid breaking existing features when introducing new behaviors. However, sometimes there are either bugs or performance limitations with the old behaviors that are not possible to fix in a backward-compatible way. In these cases, we must introduce breaking changes for the future maintainability of Druid. The guides in this section outline breaking changes introduced in Druid 25.0.0 and later. Each guide provides instructions to migrate to new features. From 1d443ba85fd8c091679d564c916cefbbe72264db Mon Sep 17 00:00:00 2001 From: avaamsel Date: Thu, 2 Jul 2026 15:29:34 -0700 Subject: [PATCH 07/11] added trademarks to development section in docs --- docs/development/build.md | 2 +- docs/development/extensions-core/approximate-histograms.md | 2 +- docs/development/extensions-core/avro.md | 2 +- docs/development/extensions-core/azure.md | 2 +- docs/development/extensions-core/bloom-filter.md | 2 +- docs/development/extensions-core/datasketches-extension.md | 2 +- docs/development/extensions-core/datasketches-hll.md | 2 +- docs/development/extensions-core/datasketches-kll.md | 2 +- docs/development/extensions-core/datasketches-quantiles.md | 2 +- docs/development/extensions-core/datasketches-theta.md | 2 +- docs/development/extensions-core/datasketches-tuple.md | 2 +- docs/development/extensions-core/druid-basic-security.md | 2 +- docs/development/extensions-core/druid-kerberos.md | 2 +- docs/development/extensions-core/druid-lookups.md | 2 +- docs/development/extensions-core/druid-pac4j.md | 2 +- docs/development/extensions-core/examples.md | 2 +- docs/development/extensions-core/google.md | 2 +- docs/development/extensions-core/hdfs.md | 2 +- docs/development/extensions-core/k8s-jobs.md | 2 +- docs/development/extensions-core/kubernetes.md | 2 +- docs/development/extensions-core/mysql.md | 2 +- docs/development/extensions-core/orc.md | 2 +- docs/development/extensions-core/parquet.md | 2 +- docs/development/extensions-core/postgresql.md | 2 +- docs/development/extensions-core/protobuf.md | 2 +- docs/development/extensions-core/s3.md | 2 +- docs/development/extensions-core/simple-client-sslcontext.md | 2 +- docs/development/extensions-core/stats.md | 2 +- docs/development/extensions-core/test-stats.md | 2 +- docs/development/javascript.md | 2 +- 30 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/development/build.md b/docs/development/build.md index 3bfaca192d4d..6aa3bf33fb0e 100644 --- a/docs/development/build.md +++ b/docs/development/build.md @@ -23,7 +23,7 @@ title: "Build from source" --> -You can build Apache Druid directly from source. Use the version of this page +You can build Apache® Druid directly from source. Use the version of this page that matches the version you want to build. For building the latest code in master, follow the latest version of this page [here](https://github.com/apache/druid/blob/master/docs/development/build.md): diff --git a/docs/development/extensions-core/approximate-histograms.md b/docs/development/extensions-core/approximate-histograms.md index 240d87a5a0af..a7a03a680fa1 100644 --- a/docs/development/extensions-core/approximate-histograms.md +++ b/docs/development/extensions-core/approximate-histograms.md @@ -27,7 +27,7 @@ title: "Approximate Histogram aggregators" The Approximate Histogram aggregator is deprecated. Use [DataSketches Quantiles](../extensions-core/datasketches-quantiles.md) instead as it provides a superior distribution-independent algorithm with formal error guarantees. ::: -To use this Apache Druid extension, [include](../../configuration/extensions.md#loading-extensions) `druid-histogram` in the extensions load list. +To use this Apache® Druid extension, [include](../../configuration/extensions.md#loading-extensions) `druid-histogram` in the extensions load list. The `druid-histogram` extension provides an approximate histogram aggregator and a fixed buckets histogram aggregator. diff --git a/docs/development/extensions-core/avro.md b/docs/development/extensions-core/avro.md index c51c85043750..1885426f3614 100644 --- a/docs/development/extensions-core/avro.md +++ b/docs/development/extensions-core/avro.md @@ -22,7 +22,7 @@ title: "Apache Avro" ~ under the License. --> -This Apache Druid extension enables Druid to ingest and parse the Apache Avro data format as follows: +This Apache® Druid extension enables Druid to ingest and parse the Apache Avro data format as follows: - [Avro stream input format](../../ingestion/data-formats.md#avro-stream) for Kafka and Kinesis. - [Avro OCF input format](../../ingestion/data-formats.md#avro-ocf) for native batch ingestion. diff --git a/docs/development/extensions-core/azure.md b/docs/development/extensions-core/azure.md index d6310e32cf99..b76148c7ee54 100644 --- a/docs/development/extensions-core/azure.md +++ b/docs/development/extensions-core/azure.md @@ -32,7 +32,7 @@ This extension allows you to do the following: :::info -To use this Apache Druid extension, [include](../../configuration/extensions.md#loading-extensions) `druid-azure-extensions` in the extensions load list. +To use this Apache® Druid extension, [include](../../configuration/extensions.md#loading-extensions) `druid-azure-extensions` in the extensions load list. ::: diff --git a/docs/development/extensions-core/bloom-filter.md b/docs/development/extensions-core/bloom-filter.md index c0167e446da4..3255101e6d01 100644 --- a/docs/development/extensions-core/bloom-filter.md +++ b/docs/development/extensions-core/bloom-filter.md @@ -23,7 +23,7 @@ title: "Bloom Filter" --> -To use the Apache Druid® Bloom filter extension, include `druid-bloom-filter` in the extensions load list. See [Loading extensions](../../configuration/extensions.md#loading-extensions) for more information. +To use the Apache® Druid Bloom filter extension, include `druid-bloom-filter` in the extensions load list. See [Loading extensions](../../configuration/extensions.md#loading-extensions) for more information. This extension adds the abilities to construct Bloom filters from query results and to filter query results by testing against a Bloom filter. A Bloom filter is a probabilistic data structure to check for set membership. A Bloom diff --git a/docs/development/extensions-core/datasketches-extension.md b/docs/development/extensions-core/datasketches-extension.md index 00c955dc98a8..17f903da84ec 100644 --- a/docs/development/extensions-core/datasketches-extension.md +++ b/docs/development/extensions-core/datasketches-extension.md @@ -23,7 +23,7 @@ title: "DataSketches extension" --> -Apache Druid aggregators based on [Apache DataSketches](https://datasketches.apache.org/) library. Sketches are data structures implementing approximate streaming mergeable algorithms. Sketches can be ingested from the outside of Druid or built from raw data at ingestion time. Sketches can be stored in Druid segments as additive metrics. +Apache® Druid aggregators based on [Apache DataSketches](https://datasketches.apache.org/) library. Sketches are data structures implementing approximate streaming mergeable algorithms. Sketches can be ingested from the outside of Druid or built from raw data at ingestion time. Sketches can be stored in Druid segments as additive metrics. To use the datasketches aggregators, make sure you [include](../../configuration/extensions.md#loading-extensions) the extension in your config file: diff --git a/docs/development/extensions-core/datasketches-hll.md b/docs/development/extensions-core/datasketches-hll.md index 4e2b369e5e0d..becb61b55e47 100644 --- a/docs/development/extensions-core/datasketches-hll.md +++ b/docs/development/extensions-core/datasketches-hll.md @@ -23,7 +23,7 @@ title: "DataSketches HLL Sketch module" --> -This module provides Apache Druid aggregators for distinct counting based on HLL sketch from [Apache DataSketches](https://datasketches.apache.org/) library. At ingestion time, this aggregator creates the HLL sketch objects to store in Druid segments. By default, Druid reads and merges sketches at query time. The default result is +This module provides Apache® Druid aggregators for distinct counting based on HLL sketch from [Apache DataSketches](https://datasketches.apache.org/) library. At ingestion time, this aggregator creates the HLL sketch objects to store in Druid segments. By default, Druid reads and merges sketches at query time. The default result is the estimate of the number of distinct values presented to the sketch. You can also use post aggregators to produce a union of sketch columns in the same row. You can use the HLL sketch aggregator on any column to estimate its cardinality. diff --git a/docs/development/extensions-core/datasketches-kll.md b/docs/development/extensions-core/datasketches-kll.md index b8e372dc9429..2f0b63cae3a3 100644 --- a/docs/development/extensions-core/datasketches-kll.md +++ b/docs/development/extensions-core/datasketches-kll.md @@ -23,7 +23,7 @@ title: "DataSketches KLL Sketch module" --> -This module provides Apache Druid aggregators based on numeric quantiles KllFloatsSketch and KllDoublesSketch from [Apache DataSketches](https://datasketches.apache.org/) library. KLL quantiles sketch is a mergeable streaming algorithm to estimate the distribution of values, and approximately answer queries about the rank of a value, probability mass function of the distribution (PMF) or histogram, cumulative distribution function (CDF), and quantiles (median, min, max, 95th percentile and such). See [Quantiles Sketch Overview](https://datasketches.apache.org/docs/Quantiles/QuantilesSketchOverview.html). This document applies to both KllFloatsSketch and KllDoublesSketch. Only one of them will be used in the examples. +This module provides Apache® Druid aggregators based on numeric quantiles KllFloatsSketch and KllDoublesSketch from [Apache DataSketches](https://datasketches.apache.org/) library. KLL quantiles sketch is a mergeable streaming algorithm to estimate the distribution of values, and approximately answer queries about the rank of a value, probability mass function of the distribution (PMF) or histogram, cumulative distribution function (CDF), and quantiles (median, min, max, 95th percentile and such). See [Quantiles Sketch Overview](https://datasketches.apache.org/docs/Quantiles/QuantilesSketchOverview.html). This document applies to both KllFloatsSketch and KllDoublesSketch. Only one of them will be used in the examples. There are three major modes of operation: diff --git a/docs/development/extensions-core/datasketches-quantiles.md b/docs/development/extensions-core/datasketches-quantiles.md index e6845d92db3e..a2e73229ee8b 100644 --- a/docs/development/extensions-core/datasketches-quantiles.md +++ b/docs/development/extensions-core/datasketches-quantiles.md @@ -23,7 +23,7 @@ title: "DataSketches Quantiles Sketch module" --> -This module provides Apache Druid aggregators based on numeric quantiles DoublesSketch from [Apache DataSketches](https://datasketches.apache.org/) library. Quantiles sketch is a mergeable streaming algorithm to estimate the distribution of values, and approximately answer queries about the rank of a value, probability mass function of the distribution (PMF) or histogram, cumulative distribution function (CDF), and quantiles (median, min, max, 95th percentile and such). See [Quantiles Sketch Overview](https://datasketches.apache.org/docs/Quantiles/QuantilesSketchOverview.html). +This module provides Apache® Druid aggregators based on numeric quantiles DoublesSketch from [Apache DataSketches](https://datasketches.apache.org/) library. Quantiles sketch is a mergeable streaming algorithm to estimate the distribution of values, and approximately answer queries about the rank of a value, probability mass function of the distribution (PMF) or histogram, cumulative distribution function (CDF), and quantiles (median, min, max, 95th percentile and such). See [Quantiles Sketch Overview](https://datasketches.apache.org/docs/Quantiles/QuantilesSketchOverview.html). There are three major modes of operation: diff --git a/docs/development/extensions-core/datasketches-theta.md b/docs/development/extensions-core/datasketches-theta.md index 33bdbe9d3d57..13776856d85a 100644 --- a/docs/development/extensions-core/datasketches-theta.md +++ b/docs/development/extensions-core/datasketches-theta.md @@ -23,7 +23,7 @@ title: "DataSketches Theta Sketch module" --> -This module provides Apache Druid aggregators based on Theta sketch from [Apache DataSketches](https://datasketches.apache.org/) library. +This module provides Apache® Druid aggregators based on Theta sketch from [Apache DataSketches](https://datasketches.apache.org/) library. Sketch algorithms are approximate. For more information, see [Accuracy](https://datasketches.apache.org/docs/Theta/ThetaAccuracy.html) in the DataSketches documentation. At ingestion time, the Theta sketch aggregator creates Theta sketch objects which are stored in Druid segments. Logically speaking, a Theta sketch object can be thought of as a Set data structure. At query time, sketches are read and aggregated (set unioned) together. In the end, by default, you receive the estimate of the number of unique entries in the sketch object. You can use post aggregators to do union, intersection or difference on sketch columns in the same row. diff --git a/docs/development/extensions-core/datasketches-tuple.md b/docs/development/extensions-core/datasketches-tuple.md index 1dcf76c0b972..ea4f27e92aaa 100644 --- a/docs/development/extensions-core/datasketches-tuple.md +++ b/docs/development/extensions-core/datasketches-tuple.md @@ -23,7 +23,7 @@ title: "DataSketches Tuple Sketch module" --> -This module provides Apache Druid aggregators based on Tuple sketch from [Apache DataSketches](https://datasketches.apache.org/) library. ArrayOfDoublesSketch sketches extend the functionality of the count-distinct Theta sketches by adding arrays of double values associated with unique keys. +This module provides Apache® Druid aggregators based on Tuple sketch from [Apache DataSketches](https://datasketches.apache.org/) library. ArrayOfDoublesSketch sketches extend the functionality of the count-distinct Theta sketches by adding arrays of double values associated with unique keys. To use this aggregator, make sure you [include](../../configuration/extensions.md#loading-extensions) the extension in your config file: diff --git a/docs/development/extensions-core/druid-basic-security.md b/docs/development/extensions-core/druid-basic-security.md index 80df2d18add9..ab011669ced9 100644 --- a/docs/development/extensions-core/druid-basic-security.md +++ b/docs/development/extensions-core/druid-basic-security.md @@ -23,7 +23,7 @@ title: "Basic Security" --> -The Basic Security extension for Apache Druid adds: +The Basic Security extension for Apache® Druid adds: - an Authenticator which supports [HTTP Basic authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) using the Druid metadata store or LDAP as its credentials store. - an Escalator which determines the authentication scheme for internal Druid processes. diff --git a/docs/development/extensions-core/druid-kerberos.md b/docs/development/extensions-core/druid-kerberos.md index 8858e535488e..082beb105cf7 100644 --- a/docs/development/extensions-core/druid-kerberos.md +++ b/docs/development/extensions-core/druid-kerberos.md @@ -23,7 +23,7 @@ title: "Kerberos" --> -Apache Druid Extension to enable Authentication for Druid Processes using Kerberos. +Apache® Druid Extension to enable Authentication for Druid Processes using Kerberos. This extension adds an Authenticator which is used to protect HTTP Endpoints using the simple and protected GSSAPI negotiation mechanism [SPNEGO](https://en.wikipedia.org/wiki/SPNEGO). Make sure to [include](../../configuration/extensions.md#loading-extensions) `druid-kerberos` in the extensions load list. diff --git a/docs/development/extensions-core/druid-lookups.md b/docs/development/extensions-core/druid-lookups.md index e3514a0d0c2d..39d09cffd569 100644 --- a/docs/development/extensions-core/druid-lookups.md +++ b/docs/development/extensions-core/druid-lookups.md @@ -23,7 +23,7 @@ title: "Cached Lookup Module" --> ## Description -This Apache Druid module provides a per-lookup caching mechanism for JDBC data sources. +This Apache® Druid module provides a per-lookup caching mechanism for JDBC data sources. The main goal of this cache is to speed up the access to a high latency lookup sources and to provide a caching isolation for every lookup source. Thus user can define various caching strategies or and implementation per lookup, even if the source is the same. This module can be used side to side with other lookup module like the global cached lookup module. diff --git a/docs/development/extensions-core/druid-pac4j.md b/docs/development/extensions-core/druid-pac4j.md index a81752cb66ad..a86da7cb07d3 100644 --- a/docs/development/extensions-core/druid-pac4j.md +++ b/docs/development/extensions-core/druid-pac4j.md @@ -23,7 +23,7 @@ title: "Druid pac4j based Security extension" --> -Apache Druid Extension to enable [OpenID Connect](https://openid.net/connect/) based Authentication for Druid Processes using [pac4j](https://github.com/pac4j/pac4j) as the underlying client library. +Apache® Druid Extension to enable [OpenID Connect](https://openid.net/connect/) based Authentication for Druid Processes using [pac4j](https://github.com/pac4j/pac4j) as the underlying client library. This can be used with any authentication server that supports same e.g. [Okta](https://developer.okta.com/). The pac4j authenticator should only be used at the router node to enable a group of users in existing authentication server to interact with Druid cluster, using the [web console](../../operations/web-console.md). diff --git a/docs/development/extensions-core/examples.md b/docs/development/extensions-core/examples.md index 577ee30f65f9..8878256e1de0 100644 --- a/docs/development/extensions-core/examples.md +++ b/docs/development/extensions-core/examples.md @@ -23,4 +23,4 @@ title: "Extension Examples" --> -This extension was removed in Apache Druid 0.16.0. In prior versions, the extension provided obsolete facilities to ingest data from the Twitter 'Spritzer' data stream as well as the Wikipedia changes IRC channel. +This extension was removed in Apache® Druid 0.16.0. In prior versions, the extension provided obsolete facilities to ingest data from the Twitter 'Spritzer' data stream as well as the Wikipedia changes IRC channel. diff --git a/docs/development/extensions-core/google.md b/docs/development/extensions-core/google.md index a9d1edefec42..bff1d2696117 100644 --- a/docs/development/extensions-core/google.md +++ b/docs/development/extensions-core/google.md @@ -28,7 +28,7 @@ This extension allows you to do 2 things: * [Ingest data](#reading-data-from-google-cloud-storage) from files stored in Google Cloud Storage. * Write segments to [deep storage](#deep-storage) in GCS. -To use this Apache Druid extension, [include](../../configuration/extensions.md#loading-extensions) `druid-google-extensions` in the extensions load list. +To use this Apache® Druid extension, [include](../../configuration/extensions.md#loading-extensions) `druid-google-extensions` in the extensions load list. ### Required Configuration diff --git a/docs/development/extensions-core/hdfs.md b/docs/development/extensions-core/hdfs.md index f6994e663102..32a84a179342 100644 --- a/docs/development/extensions-core/hdfs.md +++ b/docs/development/extensions-core/hdfs.md @@ -22,7 +22,7 @@ title: "HDFS" ~ under the License. --> -To use this Apache Druid extension, [include](../../configuration/extensions.md#loading-extensions) `druid-hdfs-storage` in the extensions load list and run druid processes with `GOOGLE_APPLICATION_CREDENTIALS=/path/to/service_account_keyfile` in the environment. +To use this Apache® Druid extension, [include](../../configuration/extensions.md#loading-extensions) `druid-hdfs-storage` in the extensions load list and run druid processes with `GOOGLE_APPLICATION_CREDENTIALS=/path/to/service_account_keyfile` in the environment. ## Deep Storage diff --git a/docs/development/extensions-core/k8s-jobs.md b/docs/development/extensions-core/k8s-jobs.md index b65a7bb496bd..dfdbfd45684d 100644 --- a/docs/development/extensions-core/k8s-jobs.md +++ b/docs/development/extensions-core/k8s-jobs.md @@ -25,7 +25,7 @@ title: "MM-less Druid in K8s" import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Apache Druid Extension to enable using Kubernetes for launching and managing tasks instead of the Middle Managers. This extension allows you to launch tasks as kubernetes jobs removing the need for your middle manager. +Apache® Druid Extension to enable using Kubernetes for launching and managing tasks instead of the Middle Managers. This extension allows you to launch tasks as kubernetes jobs removing the need for your middle manager. ## How it works diff --git a/docs/development/extensions-core/kubernetes.md b/docs/development/extensions-core/kubernetes.md index 3115ee9056b2..a33e0a47eb00 100644 --- a/docs/development/extensions-core/kubernetes.md +++ b/docs/development/extensions-core/kubernetes.md @@ -24,7 +24,7 @@ title: "Kubernetes" Consider this an [EXPERIMENTAL](../experimental.md) feature mostly because it has not been tested yet on a wide variety of long running Druid clusters. -Apache Druid Extension to enable using Kubernetes API Server for node discovery and leader election. This extension allows Druid cluster deployment on Kubernetes without Zookeeper. It allows running multiple Druid clusters within same Kubernetes Cluster, See `clusterIdentifier` config below. +Apache® Druid Extension to enable using Kubernetes API Server for node discovery and leader election. This extension allows Druid cluster deployment on Kubernetes without Zookeeper. It allows running multiple Druid clusters within same Kubernetes Cluster, See `clusterIdentifier` config below. ## Configuration diff --git a/docs/development/extensions-core/mysql.md b/docs/development/extensions-core/mysql.md index a3678f65056f..77e26446bbbb 100644 --- a/docs/development/extensions-core/mysql.md +++ b/docs/development/extensions-core/mysql.md @@ -23,7 +23,7 @@ title: "MySQL metadata store" --> -To use this Apache Druid extension, [include](../../configuration/extensions.md#loading-extensions) `mysql-metadata-storage` in the extensions load list. +To use this Apache® Druid extension, [include](../../configuration/extensions.md#loading-extensions) `mysql-metadata-storage` in the extensions load list. With the MySQL extension, you can use MySQL as a metadata store or ingest from a MySQL database. diff --git a/docs/development/extensions-core/orc.md b/docs/development/extensions-core/orc.md index cd9125155268..ac705252e459 100644 --- a/docs/development/extensions-core/orc.md +++ b/docs/development/extensions-core/orc.md @@ -24,7 +24,7 @@ title: "ORC Extension" ## ORC extension -This Apache Druid extension enables Druid to ingest and understand the Apache ORC data format. +This Apache® Druid extension enables Druid to ingest and understand the Apache ORC data format. The extension provides the [ORC input format](../../ingestion/data-formats.md#orc) for [native batch ingestion](../../ingestion/native-batch.md). diff --git a/docs/development/extensions-core/parquet.md b/docs/development/extensions-core/parquet.md index cbeb446b82c7..f14d04fcf98b 100644 --- a/docs/development/extensions-core/parquet.md +++ b/docs/development/extensions-core/parquet.md @@ -23,5 +23,5 @@ title: "Apache Parquet Extension" --> -This Apache Druid module extends [Druid native batch](../../ingestion/native-batch.md) to ingest data directly from offline +This Apache® Druid module extends [Druid native batch](../../ingestion/native-batch.md) to ingest data directly from offline Apache Parquet files. diff --git a/docs/development/extensions-core/postgresql.md b/docs/development/extensions-core/postgresql.md index 006a65ed4279..a2fc8911a452 100644 --- a/docs/development/extensions-core/postgresql.md +++ b/docs/development/extensions-core/postgresql.md @@ -23,7 +23,7 @@ title: "PostgreSQL metadata store" --> -To use this Apache Druid extension, [include](../../configuration/extensions.md#loading-extensions) `postgresql-metadata-storage` in the extensions load list. +To use this Apache® Druid extension, [include](../../configuration/extensions.md#loading-extensions) `postgresql-metadata-storage` in the extensions load list. With the PostgreSQL extension, you can use PostgreSQL as a metadata store or ingest from a PostgreSQL database. diff --git a/docs/development/extensions-core/protobuf.md b/docs/development/extensions-core/protobuf.md index ff976224dd47..ca95aed72e9f 100644 --- a/docs/development/extensions-core/protobuf.md +++ b/docs/development/extensions-core/protobuf.md @@ -23,7 +23,7 @@ title: "Protobuf" --> -This Apache Druid extension enables Druid to ingest and understand the Protobuf data format. Make sure to [include](../../configuration/extensions.md#loading-extensions) `druid-protobuf-extensions` in the extensions load list. +This Apache® Druid extension enables Druid to ingest and understand the Protobuf data format. Make sure to [include](../../configuration/extensions.md#loading-extensions) `druid-protobuf-extensions` in the extensions load list. The `druid-protobuf-extensions` provides the [Protobuf InputFormat](../../ingestion/data-formats.md#protobuf) for [stream ingestion](../../ingestion/index.md#streaming). See corresponding docs for details. diff --git a/docs/development/extensions-core/s3.md b/docs/development/extensions-core/s3.md index f56861e613ee..32f09f93ff7e 100644 --- a/docs/development/extensions-core/s3.md +++ b/docs/development/extensions-core/s3.md @@ -29,7 +29,7 @@ This extension allows you to do 2 things: * [Ingest data](#reading-data-from-s3) from files stored in S3. * Write segments to [deep storage](#deep-storage) in S3. -To use this Apache Druid extension, [include](../../configuration/extensions.md#loading-extensions) `druid-s3-extensions` in the extensions load list. +To use this Apache® Druid extension, [include](../../configuration/extensions.md#loading-extensions) `druid-s3-extensions` in the extensions load list. ### Reading data from S3 diff --git a/docs/development/extensions-core/simple-client-sslcontext.md b/docs/development/extensions-core/simple-client-sslcontext.md index 981e00107a45..be764c3d9b6f 100644 --- a/docs/development/extensions-core/simple-client-sslcontext.md +++ b/docs/development/extensions-core/simple-client-sslcontext.md @@ -23,7 +23,7 @@ title: "Simple SSLContext Provider Module" --> -This Apache Druid module contains a simple implementation of [SSLContext](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/SSLContext.html) +This Apache® Druid module contains a simple implementation of [SSLContext](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/SSLContext.html) that will be injected to be used with HttpClient that Druid processes use internally to communicate with each other. To learn more about Java's SSL support, please refer to [this](https://docs.oracle.com/en/java/javase/17/security/java-secure-socket-extension-jsse-reference-guide.html) guide. diff --git a/docs/development/extensions-core/stats.md b/docs/development/extensions-core/stats.md index 280c3d5b6d83..54d6d93e795b 100644 --- a/docs/development/extensions-core/stats.md +++ b/docs/development/extensions-core/stats.md @@ -23,7 +23,7 @@ title: "Stats aggregator" --> -This Apache Druid extension includes stat-related aggregators, including variance and standard deviations, etc. Make sure to [include](../../configuration/extensions.md#loading-extensions) `druid-stats` in the extensions load list. +This Apache® Druid extension includes stat-related aggregators, including variance and standard deviations, etc. Make sure to [include](../../configuration/extensions.md#loading-extensions) `druid-stats` in the extensions load list. ## Variance aggregator diff --git a/docs/development/extensions-core/test-stats.md b/docs/development/extensions-core/test-stats.md index e37051b43564..023d9d1a865a 100644 --- a/docs/development/extensions-core/test-stats.md +++ b/docs/development/extensions-core/test-stats.md @@ -23,7 +23,7 @@ title: "Test stats aggregators" --> -The `druid-stats` extension for Apache Druid incorporates aggregators to compute test statistics, including z-scores and p-values. +The `druid-stats` extension for Apache® Druid incorporates aggregators to compute test statistics, including z-scores and p-values. Please refer to [Democratizing Experimentation Data for Product Innovations](https://medium.com/paypal-tech/democratizing-experimentation-data-for-product-innovations-8b6e1cf40c27) for math background and details. Make sure to include `druid-stats` extension in order to use these aggregators. diff --git a/docs/development/javascript.md b/docs/development/javascript.md index 4c3fc3dc21b1..f96787ec5c27 100644 --- a/docs/development/javascript.md +++ b/docs/development/javascript.md @@ -24,7 +24,7 @@ sidebar_label: "JavaScript functionality" --> -This page discusses how to use JavaScript to extend Apache Druid. +This page discusses how to use JavaScript to extend Apache® Druid. ## Examples From 1a259b2d1f6b07fb4d847cf6b9964d2c57ffca90 Mon Sep 17 00:00:00 2001 From: avaamsel Date: Thu, 2 Jul 2026 15:37:44 -0700 Subject: [PATCH 08/11] added trademarks to operations section of docs --- docs/multi-stage-query/index.md | 2 +- docs/operations/alerts.md | 2 +- docs/operations/auth-ldap.md | 2 +- docs/operations/auth.md | 2 +- docs/operations/basic-cluster-tuning.md | 2 +- docs/operations/clean-metadata-store.md | 2 +- docs/operations/dump-segment.md | 2 +- docs/operations/high-availability.md | 2 +- docs/operations/http-compression.md | 2 +- docs/operations/insert-segment-to-db.md | 2 +- docs/operations/java.md | 2 +- docs/operations/kubernetes.md | 2 +- docs/operations/mixed-workloads.md | 2 +- docs/operations/password-provider.md | 2 +- docs/operations/pull-deps.md | 2 +- docs/operations/request-logging.md | 2 +- docs/operations/reset-cluster.md | 2 +- docs/operations/rolling-updates.md | 2 +- docs/operations/rule-configuration.md | 2 +- docs/operations/security-overview.md | 4 ++-- docs/operations/segment-optimization.md | 2 +- docs/operations/tls-support.md | 2 +- 22 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/multi-stage-query/index.md b/docs/multi-stage-query/index.md index 63f48c4e4ca5..c0a8b3b44b72 100644 --- a/docs/multi-stage-query/index.md +++ b/docs/multi-stage-query/index.md @@ -26,7 +26,7 @@ description: Introduces multi-stage query architecture and its task engine This page describes SQL-based batch ingestion using the [multi-stage query (MSQ) task engine](../multi-stage-query/index.md). Refer to the [ingestion methods](../ingestion/index.md#batch) table to determine which ingestion method is right for you. -Apache® Druid supports SQL-based ingestion using MSQ task engine that allows running SQL +Apache® Druid supports SQL-based ingestion using MSQ task engine that allows running SQL [INSERT](concepts.md#load-data-with-insert) and [REPLACE](concepts.md#overwrite-data-with-replace) statements as batch tasks. As an experimental feature, the task engine also supports running `SELECT` queries as batch tasks. diff --git a/docs/operations/alerts.md b/docs/operations/alerts.md index da9d7b1b9740..98c7172125e5 100644 --- a/docs/operations/alerts.md +++ b/docs/operations/alerts.md @@ -25,7 +25,7 @@ title: "Alerts" Druid generates alerts on getting into unexpected situations. -Alerts are emitted as JSON objects to a runtime log file or over HTTP (to a service such as Apache Kafka). Alert emission is disabled by default. +Alerts are emitted as JSON objects to a runtime log file or over HTTP (to a service such as Apache Kafka®). Alert emission is disabled by default. All Druid alerts share a common set of fields: diff --git a/docs/operations/auth-ldap.md b/docs/operations/auth-ldap.md index f45f7419b307..1f66b6ee6dbf 100644 --- a/docs/operations/auth-ldap.md +++ b/docs/operations/auth-ldap.md @@ -23,7 +23,7 @@ sidebar_label: "LDAP auth" ~ under the License. --> -You can use [Lightweight Directory Access Protocol (LDAP)](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol) to secure access to Apache Druid. This topic describes how to set up Druid authentication and authorization with LDAP and LDAP over TLS (LDAPS). The examples on this page show the configuration for an Active Directory LDAP system. +You can use [Lightweight Directory Access Protocol (LDAP)](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol) to secure access to Apache® Druid. This topic describes how to set up Druid authentication and authorization with LDAP and LDAP over TLS (LDAPS). The examples on this page show the configuration for an Active Directory LDAP system. The first step is to enable LDAP authentication and authorization for Druid. You then map an LDAP group to Druid roles and assign permissions to those roles. After you've completed this configuration you can optionally choose to enable LDAPS to make LDAP traffic confidential and secure. diff --git a/docs/operations/auth.md b/docs/operations/auth.md index 893b9c1e3dcb..d1c4e077d921 100644 --- a/docs/operations/auth.md +++ b/docs/operations/auth.md @@ -23,7 +23,7 @@ title: "Authentication and Authorization" --> -This document describes non-extension specific Apache Druid authentication and authorization configurations. +This document describes non-extension specific Apache® Druid authentication and authorization configurations. |Property|Type|Description|Default|Required| |--------|-----------|--------|--------|--------| diff --git a/docs/operations/basic-cluster-tuning.md b/docs/operations/basic-cluster-tuning.md index 7060b8c7bee4..36cf35f8b734 100644 --- a/docs/operations/basic-cluster-tuning.md +++ b/docs/operations/basic-cluster-tuning.md @@ -23,7 +23,7 @@ title: "Basic cluster tuning" --> -This document provides basic guidelines for configuration properties and cluster architecture considerations related to performance tuning of an Apache Druid deployment. +This document provides basic guidelines for configuration properties and cluster architecture considerations related to performance tuning of an Apache® Druid deployment. Please note that this document provides general guidelines and rules-of-thumb: these are not absolute, universal rules for cluster tuning, and this introductory guide is not an exhaustive description of all Druid tuning properties, which are described in the [configuration reference](../configuration/index.md). diff --git a/docs/operations/clean-metadata-store.md b/docs/operations/clean-metadata-store.md index 71f673d2a3aa..33be8489480a 100644 --- a/docs/operations/clean-metadata-store.md +++ b/docs/operations/clean-metadata-store.md @@ -24,7 +24,7 @@ description: "Defines a strategy to maintain Druid metadata store performance by ~ under the License. --> -Apache Druid relies on [metadata storage](../design/metadata-storage.md) to track information on data storage, operations, and system configuration. +Apache® Druid relies on [metadata storage](../design/metadata-storage.md) to track information on data storage, operations, and system configuration. The metadata store includes the following: - Segment records diff --git a/docs/operations/dump-segment.md b/docs/operations/dump-segment.md index f80b6275192d..6fd0889207ca 100644 --- a/docs/operations/dump-segment.md +++ b/docs/operations/dump-segment.md @@ -23,7 +23,7 @@ title: "dump-segment tool" --> -The DumpSegment tool can be used to dump the metadata or contents of an Apache Druid segment for debugging purposes. Note that the +The DumpSegment tool can be used to dump the metadata or contents of an Apache® Druid segment for debugging purposes. Note that the dump is not necessarily a full-fidelity translation of the segment. In particular, not all metadata is included, and complex metric values may not be complete. diff --git a/docs/operations/high-availability.md b/docs/operations/high-availability.md index 7d142628fa7c..3d4a1179ee29 100644 --- a/docs/operations/high-availability.md +++ b/docs/operations/high-availability.md @@ -30,7 +30,7 @@ We recommend either installing ZooKeeper on its own hardware, or running 3 or 5 and configuring ZooKeeper on them appropriately. See the [ZooKeeper admin guide](https://zookeeper.apache.org/doc/current/zookeeperAdmin) for more details. - For highly-available metadata storage, we recommend MySQL or PostgreSQL with replication and failover enabled. See [MySQL Enterprise High Availability](https://www.mysql.com/products/enterprise/high_availability.html) and [PostgreSQL's High Availability, Load Balancing, and Replication](https://www.postgresql.org/docs/current/high-availability.html) for more information. -- For highly-available Apache Druid Coordinators and Overlords, we recommend to run multiple servers. +- For highly-available Apache® Druid Coordinators and Overlords, we recommend to run multiple servers. If they are all configured to use the same ZooKeeper cluster and metadata storage, then they will automatically failover between each other as necessary. Only one will be active at a time, but inactive servers will redirect to the currently active server. diff --git a/docs/operations/http-compression.md b/docs/operations/http-compression.md index 58fd5aef367c..77d01a87ce9c 100644 --- a/docs/operations/http-compression.md +++ b/docs/operations/http-compression.md @@ -23,7 +23,7 @@ title: "HTTP compression" --> -Apache Druid supports http request decompression and response compression, to use this, http request header `Content-Encoding:gzip` and `Accept-Encoding:gzip` is needed to be set. +Apache® Druid supports http request decompression and response compression, to use this, http request header `Content-Encoding:gzip` and `Accept-Encoding:gzip` is needed to be set. |Property|Description|Default| |--------|-----------|-------| diff --git a/docs/operations/insert-segment-to-db.md b/docs/operations/insert-segment-to-db.md index 4de93a76f00f..ff583173e44b 100644 --- a/docs/operations/insert-segment-to-db.md +++ b/docs/operations/insert-segment-to-db.md @@ -23,7 +23,7 @@ title: "insert-segment-to-db tool" --> -In older versions of Apache Druid, `insert-segment-to-db` was a tool that could scan deep storage and +In older versions of Apache® Druid, `insert-segment-to-db` was a tool that could scan deep storage and insert data from there into Druid metadata storage. It was intended to be used to update the segment table in the metadata storage after manually migrating segments from one place to another, or even to recover lost metadata storage by telling it where the segments are stored. diff --git a/docs/operations/java.md b/docs/operations/java.md index c6117e1f4263..7154171425cd 100644 --- a/docs/operations/java.md +++ b/docs/operations/java.md @@ -22,7 +22,7 @@ title: "Java runtime" ~ under the License. --> -Apache Druid is written in Java and requires a Java runtime. This page provides details about obtaining and configuring +Apache® Druid is written in Java and requires a Java runtime. This page provides details about obtaining and configuring a Java runtime for Druid. ## Selecting a Java runtime diff --git a/docs/operations/kubernetes.md b/docs/operations/kubernetes.md index 9d7b3b6c6bae..a86b4d6a57f2 100644 --- a/docs/operations/kubernetes.md +++ b/docs/operations/kubernetes.md @@ -23,7 +23,7 @@ title: "kubernetes" --> -Apache Druid distribution is also available as [Docker](https://www.docker.com/) image from [Docker Hub](https://hub.docker.com/r/apache/druid) . For example, you can obtain latest release using the command below. +Apache® Druid distribution is also available as [Docker](https://www.docker.com/) image from [Docker Hub](https://hub.docker.com/r/apache/druid) . For example, you can obtain latest release using the command below. ``` $ docker pull apache/druid diff --git a/docs/operations/mixed-workloads.md b/docs/operations/mixed-workloads.md index d99fb8987726..18c18410f572 100644 --- a/docs/operations/mixed-workloads.md +++ b/docs/operations/mixed-workloads.md @@ -23,7 +23,7 @@ sidebar_label: Mixed workloads ~ under the License. --> -If you frequently run concurrent, heterogeneous workloads on your Apache Druid cluster, configure Druid to properly allocate cluster resources to optimize your overall query performance. +If you frequently run concurrent, heterogeneous workloads on your Apache® Druid cluster, configure Druid to properly allocate cluster resources to optimize your overall query performance. Each Druid query consumes a certain amount of cluster resources, such as processing threads, memory buffers for intermediate query results, and HTTP threads for communicating between Brokers and data servers. "Heavy" queries that return large results are more resource-intensive than short-running, "light" queries. diff --git a/docs/operations/password-provider.md b/docs/operations/password-provider.md index d1c116dcbe27..11a0b5c27443 100644 --- a/docs/operations/password-provider.md +++ b/docs/operations/password-provider.md @@ -23,7 +23,7 @@ title: "Password providers" --> -Passwords help secure Apache Druid systems such as the metadata store and the keystore that contains server certificates, and so on. +Passwords help secure Apache® Druid systems such as the metadata store and the keystore that contains server certificates, and so on. These passwords have corresponding runtime properties associated with them, for example `druid.metadata.storage.connector.password` corresponds to the metadata store password. diff --git a/docs/operations/pull-deps.md b/docs/operations/pull-deps.md index 39c85a1ba5fe..8a027f5336f0 100644 --- a/docs/operations/pull-deps.md +++ b/docs/operations/pull-deps.md @@ -23,7 +23,7 @@ title: "pull-deps tool" --> -`pull-deps` is an Apache Druid tool that can pull down dependencies to the local repository and lay dependencies out into the extension directory as needed. +`pull-deps` is an Apache® Druid tool that can pull down dependencies to the local repository and lay dependencies out into the extension directory as needed. `pull-deps` has several command line options, they are as follows: diff --git a/docs/operations/request-logging.md b/docs/operations/request-logging.md index 6ce65c0421e2..4c317d234d8f 100644 --- a/docs/operations/request-logging.md +++ b/docs/operations/request-logging.md @@ -23,7 +23,7 @@ sidebar_label: Request logging ~ under the License. --> -All Apache Druid services that can serve queries can also log the query requests they process. +All Apache® Druid services that can serve queries can also log the query requests they process. Request logs contain information on query metrics, including execution time and memory usage. You can use information in the request logs to monitor query performance, determine bottlenecks, and analyze and improve slow queries. diff --git a/docs/operations/reset-cluster.md b/docs/operations/reset-cluster.md index 476a68ef865a..838fad5102cb 100644 --- a/docs/operations/reset-cluster.md +++ b/docs/operations/reset-cluster.md @@ -23,7 +23,7 @@ title: "reset-cluster tool" --> -In older versions of Apache Druid, `reset-cluster` was a tool that could wipe out Apache Druid cluster state stored in +In older versions of Apache® Druid, `reset-cluster` was a tool that could wipe out Apache Druid cluster state stored in metadata and deep storage, intended primarily for use in dev and test environments. However, this tool was prone to becoming out of sync with the codebase since it was not used in practice during dev and testing, and could not cover all cleanup cases when extensions were involved. It was removed in Druid 35.0.0. diff --git a/docs/operations/rolling-updates.md b/docs/operations/rolling-updates.md index 07cf3b4c8fc0..35ccbc5caf5c 100644 --- a/docs/operations/rolling-updates.md +++ b/docs/operations/rolling-updates.md @@ -23,7 +23,7 @@ title: "Rolling updates" --> -For rolling Apache Druid cluster updates with no downtime, we recommend updating Druid processes in the +For rolling Apache® Druid cluster updates with no downtime, we recommend updating Druid processes in the following order: 1. Historical diff --git a/docs/operations/rule-configuration.md b/docs/operations/rule-configuration.md index 9117973f0b85..5d68b5882a90 100644 --- a/docs/operations/rule-configuration.md +++ b/docs/operations/rule-configuration.md @@ -22,7 +22,7 @@ title: "Using rules to drop and retain data" ~ under the License. --> -Data retention rules allow you to configure Apache Druid to conform to your data retention policies. Your data retention policies specify which data to retain and which data to drop from the cluster. +Data retention rules allow you to configure Apache® Druid to conform to your data retention policies. Your data retention policies specify which data to retain and which data to drop from the cluster. Druid supports [load](#load-rules), [drop](#drop-rules), and [broadcast](#broadcast-rules) rules. Each rule is a JSON object. See the [rule definitions below](#load-rules) for details. diff --git a/docs/operations/security-overview.md b/docs/operations/security-overview.md index dfbc7946dc26..f4144a10dbad 100644 --- a/docs/operations/security-overview.md +++ b/docs/operations/security-overview.md @@ -1,7 +1,7 @@ --- id: security-overview title: "Security overview" -description: Overiew of Apache Druid security. Includes best practices, configuration instructions, a description of the security model and documentation on how to report security issues. +description: Overview of Apache® Druid security. Includes best practices, configuration instructions, a description of the security model and documentation on how to report security issues. --- -This document provides an overview of Apache Druid security features, configuration instructions, and some best practices to secure Druid. +This document provides an overview of Apache® Druid security features, configuration instructions, and some best practices to secure Druid. By default, security features in Druid are disabled, which simplifies the initial deployment experience. However, security features must be configured in a production deployment. These features include TLS, authentication, and authorization. diff --git a/docs/operations/segment-optimization.md b/docs/operations/segment-optimization.md index 85c64a482a74..7830e5cec9a2 100644 --- a/docs/operations/segment-optimization.md +++ b/docs/operations/segment-optimization.md @@ -23,7 +23,7 @@ title: "Segment size optimization" --> -In Apache Druid, it's important to optimize the segment size because +In Apache® Druid, it's important to optimize the segment size because 1. Druid stores data in segments. If you're using the [best-effort roll-up](../ingestion/rollup.md) mode, increasing the segment size might introduce further aggregation which reduces the dataSource size. diff --git a/docs/operations/tls-support.md b/docs/operations/tls-support.md index 23dc13324484..fea9f416ad53 100644 --- a/docs/operations/tls-support.md +++ b/docs/operations/tls-support.md @@ -33,7 +33,7 @@ and `druid.tlsPort` properties on each process. Please see `Configuration` secti ## Jetty server configuration -Apache Druid uses Jetty as its embedded web server. +Apache® Druid uses Jetty as its embedded web server. To get familiar with TLS/SSL, along with related concepts like keys and certificates, read [Configuring Secure Protocols](https://www.eclipse.org/jetty/documentation/jetty-12/operations-guide/index.html#og-protocols-ssl) in the Jetty documentation. From 091b4961396c5f658d35a62c048e693c2efbcc4e Mon Sep 17 00:00:00 2001 From: avaamsel Date: Thu, 2 Jul 2026 15:43:11 -0700 Subject: [PATCH 09/11] added trademarks to tutorials section of docs --- docs/tutorials/cluster.md | 2 +- docs/tutorials/docker.md | 2 +- docs/tutorials/index.md | 4 ++-- docs/tutorials/tutorial-append-data.md | 4 ++-- docs/tutorials/tutorial-batch-native.md | 2 +- docs/tutorials/tutorial-batch.md | 2 +- docs/tutorials/tutorial-compaction.md | 2 +- docs/tutorials/tutorial-delete-data.md | 2 +- docs/tutorials/tutorial-extern.md | 2 +- docs/tutorials/tutorial-ingestion-spec.md | 2 +- docs/tutorials/tutorial-kafka.md | 6 +++--- docs/tutorials/tutorial-latest-by.md | 2 +- docs/tutorials/tutorial-query.md | 2 +- docs/tutorials/tutorial-retention.md | 2 +- docs/tutorials/tutorial-rollup.md | 2 +- docs/tutorials/tutorial-sketches-theta.md | 2 +- docs/tutorials/tutorial-sql-null.md | 2 +- docs/tutorials/tutorial-sql-query-view.md | 2 +- docs/tutorials/tutorial-transform.md | 2 +- docs/tutorials/tutorial-update-data.md | 4 ++-- 20 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/tutorials/cluster.md b/docs/tutorials/cluster.md index baf2ef46e67f..700f3a8141e7 100644 --- a/docs/tutorials/cluster.md +++ b/docs/tutorials/cluster.md @@ -24,7 +24,7 @@ sidebar_label: Clustered deployment --> -Apache Druid is designed to be deployed as a scalable, fault-tolerant cluster. +Apache® Druid is designed to be deployed as a scalable, fault-tolerant cluster. In this document, we'll set up a simple cluster and discuss how it can be further configured to meet your needs. diff --git a/docs/tutorials/docker.md b/docs/tutorials/docker.md index b8b06b346ccf..4b5d562b45c6 100644 --- a/docs/tutorials/docker.md +++ b/docs/tutorials/docker.md @@ -23,7 +23,7 @@ sidebar_label: Run with Docker ~ under the License. --> -This quickstart guides you through the steps to download the Apache Druid image from [Docker Hub](https://hub.docker.com/r/apache/druid) and deploy it on a single machine using [Docker](https://www.docker.com/get-started) and [Docker Compose](https://docs.docker.com/compose/). +This quickstart guides you through the steps to download the Apache® Druid image from [Docker Hub](https://hub.docker.com/r/apache/druid) and deploy it on a single machine using [Docker](https://www.docker.com/get-started) and [Docker Compose](https://docs.docker.com/compose/). After you finish the initial setup, the cluster will be ready to load data. Before beginning the quickstart, it is helpful to read the [general Druid overview](../design/index.md) and the [ingestion overview](../ingestion/index.md), because the tutorials refer to concepts discussed on those pages. It also helps to be familiar with [Docker](https://www.docker.com/get-started). diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index 730fef78d074..0fb3cc6eabce 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -23,7 +23,7 @@ sidebar_label: Local quickstart ~ under the License. --> -This quickstart helps you install Apache Druid and introduces you to Druid ingestion and query features. For this tutorial, you need a machine with at least 6 GiB of RAM. +This quickstart helps you install Apache® Druid and introduces you to Druid ingestion and query features. For this tutorial, you need a machine with at least 6 GiB of RAM. In this quickstart, you'll: - install Druid @@ -219,7 +219,7 @@ See the following topics for more information: * [Ingestion overview](../ingestion/index.md) to explore options for ingesting more data. * [Tutorial: Load files using SQL](./tutorial-msq-extern.md) to learn how to generate a SQL query that loads external data into a Druid datasource. * [Tutorial: Load data with native batch ingestion](tutorial-batch-native.md) to load and query data with Druid's native batch ingestion feature. -* [Tutorial: Load stream data from Apache Kafka](./tutorial-kafka.md) to load streaming data from a Kafka topic. +* [Tutorial: Load stream data from Apache Kafka®](./tutorial-kafka.md) to load streaming data from a Kafka topic. * [Extensions](../configuration/extensions.md) for details on Druid extensions. Remember that after stopping Druid services, you can start clean next time by deleting the `var` directory from the Druid root directory and running the `bin/start-druid` script again. You may want to do this before using other data ingestion tutorials, since they use the same Wikipedia datasource. diff --git a/docs/tutorials/tutorial-append-data.md b/docs/tutorials/tutorial-append-data.md index acdb05442516..43694bb04d19 100644 --- a/docs/tutorials/tutorial-append-data.md +++ b/docs/tutorials/tutorial-append-data.md @@ -2,7 +2,7 @@ id: tutorial-append-data title: Append data sidebar_label: Append data -description: Learn how to append data to a datasource without changing the existing data in Apache Druid. +description: Learn how to append data to a datasource without changing the existing data in Apache® Druid. --- -This tutorial shows you how to use the Apache Druid SQL [INSERT](../multi-stage-query/reference.md#insert) function to append data to a [datasource](../design/storage.md) without changing the existing data. +This tutorial shows you how to use the Apache® Druid SQL [INSERT](../multi-stage-query/reference.md#insert) function to append data to a [datasource](../design/storage.md) without changing the existing data. The examples in the tutorial use the [multi-stage query (MSQ)](../multi-stage-query/index.md) task engine to executes SQL statements. ## Prerequisites diff --git a/docs/tutorials/tutorial-batch-native.md b/docs/tutorials/tutorial-batch-native.md index 012af22b86b3..65fed6476b51 100644 --- a/docs/tutorials/tutorial-batch-native.md +++ b/docs/tutorials/tutorial-batch-native.md @@ -24,7 +24,7 @@ sidebar_label: Load data with native batch ingestion --> -This topic shows you how to load and query data files in Apache Druid using its native batch ingestion feature. +This topic shows you how to load and query data files in Apache® Druid using its native batch ingestion feature. ## Prerequisites diff --git a/docs/tutorials/tutorial-batch.md b/docs/tutorials/tutorial-batch.md index 765f91d104d3..3fc0f64d8207 100644 --- a/docs/tutorials/tutorial-batch.md +++ b/docs/tutorials/tutorial-batch.md @@ -24,7 +24,7 @@ sidebar_label: "Load files natively" --> -This tutorial demonstrates how to load data into Apache Druid from a file using Apache Druid's native batch ingestion feature. +This tutorial demonstrates how to load data into Apache® Druid from a file using Apache Druid's native batch ingestion feature. You initiate data loading in Druid by submitting an *ingestion task* spec to the Druid Overlord. You can write ingestion specs by hand or using the _data loader_ built into the web console. diff --git a/docs/tutorials/tutorial-compaction.md b/docs/tutorials/tutorial-compaction.md index 7f8c4cc9bb0e..fa84e6cd0809 100644 --- a/docs/tutorials/tutorial-compaction.md +++ b/docs/tutorials/tutorial-compaction.md @@ -24,7 +24,7 @@ sidebar_label: Compact segments --> -This tutorial demonstrates how to compact existing segments into fewer but larger segments in Apache Druid. +This tutorial demonstrates how to compact existing segments into fewer but larger segments in Apache® Druid. There is some per-segment memory and processing overhead during query processing. Therefore, it can be beneficial to reduce the total number of segments. diff --git a/docs/tutorials/tutorial-delete-data.md b/docs/tutorials/tutorial-delete-data.md index 9c176c9cb9a4..2f7a8f6dc59c 100644 --- a/docs/tutorials/tutorial-delete-data.md +++ b/docs/tutorials/tutorial-delete-data.md @@ -27,7 +27,7 @@ sidebar_label: "Deleting data" This tutorial demonstrates how to delete existing data. This tutorial requires the following: -* A running Apache Druid instance. If you don't have Druid, see the [single-machine quickstart](index.md) to get started. +* A running Apache® Druid instance. If you don't have Druid, see the [single-machine quickstart](index.md) to get started. * The command-line JSON processor, [jq](https://stedolan.github.io/jq/download/). ## Load initial data diff --git a/docs/tutorials/tutorial-extern.md b/docs/tutorials/tutorial-extern.md index d6924e5b9675..c6d292309613 100644 --- a/docs/tutorials/tutorial-extern.md +++ b/docs/tutorials/tutorial-extern.md @@ -27,7 +27,7 @@ description: How to use EXTERN to export query results. import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This tutorial demonstrates how to use the Apache Druid® SQL [EXTERN](../multi-stage-query/reference.md#extern-function) function to export data. +This tutorial demonstrates how to use the Apache® Druid SQL [EXTERN](../multi-stage-query/reference.md#extern-function) function to export data. ## Prerequisites diff --git a/docs/tutorials/tutorial-ingestion-spec.md b/docs/tutorials/tutorial-ingestion-spec.md index d26fcc73bc2b..49b2e12d3e1c 100644 --- a/docs/tutorials/tutorial-ingestion-spec.md +++ b/docs/tutorials/tutorial-ingestion-spec.md @@ -26,7 +26,7 @@ sidebar_label: Write an ingestion spec This tutorial will guide the reader through the process of defining an ingestion spec, pointing out key considerations and guidelines. -For this tutorial, we'll assume you've already downloaded Apache Druid as described in +For this tutorial, we'll assume you've already downloaded Apache® Druid as described in the [single-machine quickstart](index.md) and have it running on your local machine. It will also be helpful to have finished [Tutorial: Loading a file](../tutorials/tutorial-batch.md), [Tutorial: Querying data](../tutorials/tutorial-query.md), and [Tutorial: Rollup](../tutorials/tutorial-rollup.md). diff --git a/docs/tutorials/tutorial-kafka.md b/docs/tutorials/tutorial-kafka.md index c5ae50aaccb4..7f17c389513c 100644 --- a/docs/tutorials/tutorial-kafka.md +++ b/docs/tutorials/tutorial-kafka.md @@ -1,6 +1,6 @@ --- id: tutorial-kafka -title: Load streaming data from Apache Kafka +title: Load streaming data from Apache Kafka® sidebar_label: Load from Apache Kafka --- @@ -24,7 +24,7 @@ sidebar_label: Load from Apache Kafka --> -This tutorial shows you how to load data into Apache Druid from a Kafka stream, using Druid's Kafka indexing service. +This tutorial shows you how to load data into Apache® Druid from a Kafka stream, using Druid's Kafka indexing service. The tutorial guides you through the steps to load sample nested clickstream data from the [Koalas to the Max](https://www.koalastothemax.com/) game into a Kafka topic, then ingest the data into Druid. @@ -34,7 +34,7 @@ Before you follow the steps in this tutorial, download Druid as described in the ## Download and start Kafka -[Apache Kafka](http://kafka.apache.org/) is a high-throughput message bus that works well with Druid. For this tutorial, use Kafka 2.7.0. +[Apache Kafka®](http://kafka.apache.org/) is a high-throughput message bus that works well with Druid. For this tutorial, use Kafka 2.7.0. 1. To download Kafka, run the following commands in your terminal: diff --git a/docs/tutorials/tutorial-latest-by.md b/docs/tutorials/tutorial-latest-by.md index 4c35bb2434a0..10b6b6a4e4a6 100644 --- a/docs/tutorials/tutorial-latest-by.md +++ b/docs/tutorials/tutorial-latest-by.md @@ -24,7 +24,7 @@ description: How to use LATEST_BY or deltas for up-to-date values. ~ under the License. --> -This tutorial describes strategies in Apache Druid for use cases that might be handled by UPSERT in other databases. You can use the LATEST_BY aggregation at query time or "deltas" for numeric dimensions at insert time. +This tutorial describes strategies in Apache® Druid for use cases that might be handled by UPSERT in other databases. You can use the LATEST_BY aggregation at query time or "deltas" for numeric dimensions at insert time. The [Update data](./tutorial-update-data.md) tutorial demonstrates how to use batch operations to update data according to the timestamp, including UPSERT cases. However, with streaming data, you can potentially use LATEST_BY or deltas to satisfy requirements otherwise handled with updates. diff --git a/docs/tutorials/tutorial-query.md b/docs/tutorials/tutorial-query.md index 66b38974db2a..479de58233e5 100644 --- a/docs/tutorials/tutorial-query.md +++ b/docs/tutorials/tutorial-query.md @@ -24,7 +24,7 @@ sidebar_label: Query data --> -This tutorial demonstrates how to query data in Apache Druid using SQL. +This tutorial demonstrates how to query data in Apache® Druid using SQL. It assumes that you've completed the [Quickstart](../tutorials/index.md) or one of the following tutorials, since we'll query datasources that you would have created diff --git a/docs/tutorials/tutorial-retention.md b/docs/tutorials/tutorial-retention.md index 2e6381bfe7d0..57c505aa2a7b 100644 --- a/docs/tutorials/tutorial-retention.md +++ b/docs/tutorials/tutorial-retention.md @@ -26,7 +26,7 @@ sidebar_label: Configure data retention This tutorial demonstrates how to configure retention rules on a datasource to set the time intervals of data that will be retained or dropped. -For this tutorial, we'll assume you've already downloaded Apache Druid as described in +For this tutorial, we'll assume you've already downloaded Apache® Druid as described in the [single-machine quickstart](index.md) and have it running on your local machine. It will also be helpful to have finished [Load a file](../tutorials/tutorial-batch.md) and [Query data](../tutorials/tutorial-query.md) tutorials. diff --git a/docs/tutorials/tutorial-rollup.md b/docs/tutorials/tutorial-rollup.md index 12a7e2a900a2..e287acb1e485 100644 --- a/docs/tutorials/tutorial-rollup.md +++ b/docs/tutorials/tutorial-rollup.md @@ -24,7 +24,7 @@ sidebar_label: Aggregate data with rollup --> -Apache Druid® can summarize raw data at ingestion time using a process known as "rollup." [Rollup](../multi-stage-query/concepts.md#rollup) is a first-level aggregation operation over a selected set of columns that reduces the size of stored data. +Apache® Druid can summarize raw data at ingestion time using a process known as "rollup." [Rollup](../multi-stage-query/concepts.md#rollup) is a first-level aggregation operation over a selected set of columns that reduces the size of stored data. This tutorial demonstrates how to apply rollup during ingestion and highlights its effects during query execution. The examples in the tutorial use the [multi-stage query (MSQ)](../multi-stage-query/index.md) task engine to execute SQL statements. diff --git a/docs/tutorials/tutorial-sketches-theta.md b/docs/tutorials/tutorial-sketches-theta.md index 681db68b88a8..abddfb569eb3 100644 --- a/docs/tutorials/tutorial-sketches-theta.md +++ b/docs/tutorials/tutorial-sketches-theta.md @@ -23,7 +23,7 @@ sidebar_label: Theta sketches tutorial ~ under the License. --> -Apache Druid can power real-time collection, streaming, and interactive visualization of clickstreams. +Apache® Druid can power real-time collection, streaming, and interactive visualization of clickstreams. A common problem in clickstream analytics is counting unique things, like visitors or sessions. Generally this involves scanning through all detail data, because unique counts do not add up as you aggregate the numbers. diff --git a/docs/tutorials/tutorial-sql-null.md b/docs/tutorials/tutorial-sql-null.md index b91e8019bc25..9d70adb4c518 100644 --- a/docs/tutorials/tutorial-sql-null.md +++ b/docs/tutorials/tutorial-sql-null.md @@ -24,7 +24,7 @@ description: Introduction to null handling in Druid ~ under the License. --> -This tutorial introduces the basic concepts of null handling for string and numeric columns in Apache Druid. +This tutorial introduces the basic concepts of null handling for string and numeric columns in Apache® Druid. The tutorial focuses on filters using the logical NOT operation on columns with NULL values. ## Prerequisites diff --git a/docs/tutorials/tutorial-sql-query-view.md b/docs/tutorials/tutorial-sql-query-view.md index e51661f56b72..e60ad7fe3d74 100644 --- a/docs/tutorials/tutorial-sql-query-view.md +++ b/docs/tutorials/tutorial-sql-query-view.md @@ -24,7 +24,7 @@ sidebar_label: Get to know Query view --> -This tutorial demonstrates some useful features built into Query view in Apache Druid. +This tutorial demonstrates some useful features built into Query view in Apache® Druid. Query view lets you run [Druid SQL queries](../querying/sql.md) and [native (JSON-based) queries](../querying/querying.md) against ingested data. diff --git a/docs/tutorials/tutorial-transform.md b/docs/tutorials/tutorial-transform.md index 930dc5bad323..e4a5aca082b1 100644 --- a/docs/tutorials/tutorial-transform.md +++ b/docs/tutorials/tutorial-transform.md @@ -28,7 +28,7 @@ This tutorial demonstrates how to transform input data during ingestion. ## Prerequisite -Before proceeding, download Apache Druid® as described in [Quickstart (local)](./index.md) and have it running on your local machine. You don't need to load any data into the Druid cluster. +Before proceeding, download Apache® Druid as described in [Quickstart (local)](./index.md) and have it running on your local machine. You don't need to load any data into the Druid cluster. You should be familiar with data querying in Druid. If you haven't already, go through the [Query data](../tutorials/tutorial-query.md) tutorial first. diff --git a/docs/tutorials/tutorial-update-data.md b/docs/tutorials/tutorial-update-data.md index e761cd2a95d7..87e68dfee27d 100644 --- a/docs/tutorials/tutorial-update-data.md +++ b/docs/tutorials/tutorial-update-data.md @@ -2,7 +2,7 @@ id: tutorial-update-data title: Update data sidebar_label: Update data -description: Learn how to update data in Apache Druid. +description: Learn how to update data in Apache® Druid. --- -Apache Druid stores data and indexes in [segment files](../design/segments.md) partitioned by time. +Apache® Druid stores data and indexes in [segment files](../design/segments.md) partitioned by time. After Druid creates a segment, its contents can't be modified. You can either replace data for the whole segment, or, in some cases, overshadow a portion of the segment data. From 944e77907dc208fad19d9a03135960cfb14ab3b8 Mon Sep 17 00:00:00 2001 From: avaamsel Date: Thu, 2 Jul 2026 15:52:15 -0700 Subject: [PATCH 10/11] added trademarks to querying section of docs --- docs/querying/aggregations.md | 4 ++-- docs/querying/arrays.md | 4 ++-- docs/querying/caching.md | 4 ++-- docs/querying/datasource.md | 2 +- docs/querying/datasourcemetadataquery.md | 4 ++-- docs/querying/dimensionspecs.md | 4 ++-- docs/querying/filters.md | 4 ++-- docs/querying/geo.md | 4 ++-- docs/querying/granularities.md | 4 ++-- docs/querying/groupbyquery.md | 4 ++-- docs/querying/having.md | 4 ++-- docs/querying/hll-old.md | 2 +- docs/querying/joins.md | 2 +- docs/querying/kafka-extraction-namespace.md | 4 ++-- docs/querying/limitspec.md | 2 +- docs/querying/lookups-cached-global.md | 2 +- docs/querying/lookups.md | 2 +- docs/querying/math-expr.md | 2 +- docs/querying/multi-value-dimensions.md | 4 ++-- docs/querying/multitenancy.md | 2 +- docs/querying/nested-columns.md | 2 +- docs/querying/post-aggregations.md | 4 ++-- docs/querying/query-context-reference.md | 2 +- docs/querying/query-context.md | 2 +- docs/querying/query-processing.md | 2 +- docs/querying/querying.md | 2 +- docs/querying/scan-query.md | 4 ++-- docs/querying/searchquery.md | 4 ++-- docs/querying/segmentmetadataquery.md | 4 ++-- docs/querying/select-query.md | 2 +- docs/querying/sorting-orders.md | 2 +- docs/querying/sql-aggregations.md | 2 +- docs/querying/sql-array-functions.md | 2 +- docs/querying/sql-data-types.md | 2 +- docs/querying/sql-functions.md | 4 ++-- docs/querying/sql-metadata-tables.md | 2 +- docs/querying/sql-multivalue-string-functions.md | 2 +- docs/querying/sql-operators.md | 2 +- docs/querying/sql-query-context.md | 4 ++-- docs/querying/sql-scalar.md | 2 +- docs/querying/sql-translation.md | 2 +- docs/querying/sql-window-functions.md | 4 ++-- docs/querying/sql.md | 4 ++-- docs/querying/timeboundaryquery.md | 4 ++-- docs/querying/timeseriesquery.md | 4 ++-- docs/querying/tips-good-queries.md | 2 +- docs/querying/topnmetricspec.md | 4 ++-- docs/querying/topnquery.md | 4 ++-- docs/querying/virtual-columns.md | 4 ++-- 49 files changed, 74 insertions(+), 74 deletions(-) diff --git a/docs/querying/aggregations.md b/docs/querying/aggregations.md index 3add7863c46a..d84194055b73 100644 --- a/docs/querying/aggregations.md +++ b/docs/querying/aggregations.md @@ -23,14 +23,14 @@ title: "Aggregations" --> :::info -Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). +Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes the native language. For information about aggregators available in SQL, refer to the [SQL documentation](sql-aggregations.md). ::: You can use aggregations: -- in the ingestion spec during ingestion to summarize data before it enters Apache Druid. +- in the ingestion spec during ingestion to summarize data before it enters Apache® Druid. - at query time to summarize result data. The following sections list the available aggregate functions. Unless otherwise noted, aggregations are available at both ingestion and query time. diff --git a/docs/querying/arrays.md b/docs/querying/arrays.md index d9a9f3911880..b08e7a06efe9 100644 --- a/docs/querying/arrays.md +++ b/docs/querying/arrays.md @@ -23,7 +23,7 @@ title: "Arrays" --> -Apache Druid supports SQL standard `ARRAY` typed columns for `VARCHAR`, `BIGINT`, and `DOUBLE` types (native types `ARRAY`, `ARRAY`, and `ARRAY`). Other more complicated ARRAY types must be stored in [nested columns](nested-columns.md). Druid ARRAY types are distinct from [multi-value dimension](multi-value-dimensions.md), which have significantly different behavior than standard arrays. +Apache® Druid supports SQL standard `ARRAY` typed columns for `VARCHAR`, `BIGINT`, and `DOUBLE` types (native types `ARRAY`, `ARRAY`, and `ARRAY`). Other more complicated ARRAY types must be stored in [nested columns](nested-columns.md). Druid ARRAY types are distinct from [multi-value dimension](multi-value-dimensions.md), which have significantly different behavior than standard arrays. This document describes inserting, filtering, and grouping behavior for `ARRAY` typed columns. Refer to the [Druid SQL data type documentation](sql-data-types.md#arrays) and [SQL array function reference](sql-array-functions.md) for additional details @@ -42,7 +42,7 @@ The following sections describe inserting, filtering, and grouping behavior base ## Ingesting arrays ### Native batch and streaming ingestion -When using native [batch](../ingestion/native-batch.md) or streaming ingestion such as with [Apache Kafka](../ingestion/kafka-ingestion.md), arrays can be ingested using the [`"auto"`](../ingestion/ingestion-spec.md#dimension-objects) type dimension schema which is shared with [type-aware schema discovery](../ingestion/schema-design.md#type-aware-schema-discovery). +When using native [batch](../ingestion/native-batch.md) or streaming ingestion such as with [Apache Kafka®](../ingestion/kafka-ingestion.md), arrays can be ingested using the [`"auto"`](../ingestion/ingestion-spec.md#dimension-objects) type dimension schema which is shared with [type-aware schema discovery](../ingestion/schema-design.md#type-aware-schema-discovery). When ingesting from TSV or CSV data, you can specify the array delimiters using the `listDelimiter` field in the `inputFormat`. JSON data must be formatted as a JSON array to be ingested as an array type. JSON data does not require `inputFormat` configuration. diff --git a/docs/querying/caching.md b/docs/querying/caching.md index cbd70d6581dd..e3cee26ad752 100644 --- a/docs/querying/caching.md +++ b/docs/querying/caching.md @@ -1,7 +1,7 @@ --- id: caching title: "Query caching" -description: "Describes Apache Druid per-segment and whole-query cache types. Identifies services where you can enable caching and suggestions for caching strategy." +description: "Describes Apache® Druid per-segment and whole-query cache types. Identifies services where you can enable caching and suggestions for caching strategy." --- -You can enable caching in Apache Druid to improve query times for frequently accessed data. This topic defines the different types of caching for Druid. It describes the default caching behavior and provides guidance and examples to help you hone your caching strategy. +You can enable caching in Apache® Druid to improve query times for frequently accessed data. This topic defines the different types of caching for Druid. It describes the default caching behavior and provides guidance and examples to help you hone your caching strategy. If you're unfamiliar with Druid architecture, review the following topics before proceeding with caching: - [Druid Design](../design/architecture.md) diff --git a/docs/querying/datasource.md b/docs/querying/datasource.md index 3cc6265bfb70..d2652592aabe 100644 --- a/docs/querying/datasource.md +++ b/docs/querying/datasource.md @@ -26,7 +26,7 @@ import TabItem from '@theme/TabItem'; ~ under the License. --> -Datasources in Apache Druid are things that you can query. The most common kind of datasource is a table datasource, +Datasources in Apache® Druid are things that you can query. The most common kind of datasource is a table datasource, and in many contexts the word "datasource" implicitly refers to table datasources. This is especially true [during data ingestion](../ingestion/index.md), where ingestion is always creating or writing into a table datasource. But at query time, there are many other types of datasources available. diff --git a/docs/querying/datasourcemetadataquery.md b/docs/querying/datasourcemetadataquery.md index c7fc2fb35ae8..9380b1aa3aec 100644 --- a/docs/querying/datasourcemetadataquery.md +++ b/docs/querying/datasourcemetadataquery.md @@ -24,7 +24,7 @@ sidebar_label: "DatasourceMetadata" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes a query type that is only available in the native language. ::: @@ -46,7 +46,7 @@ There are 2 main parts to a Data Source Metadata query: |property|description|required?| |--------|-----------|---------| -|queryType|This String should always be "dataSourceMetadata"; this is the first thing Apache Druid looks at to figure out how to interpret the query|yes| +|queryType|This String should always be "dataSourceMetadata"; this is the first thing Apache® Druid looks at to figure out how to interpret the query|yes| |dataSource|A String or Object defining the data source to query, very similar to a table in a relational database. See [DataSource](../querying/datasource.md) for more information.|yes| |context|See [Query context reference](../querying/query-context-reference.md)|no| diff --git a/docs/querying/dimensionspecs.md b/docs/querying/dimensionspecs.md index dba52abcc689..b9856b568715 100644 --- a/docs/querying/dimensionspecs.md +++ b/docs/querying/dimensionspecs.md @@ -24,7 +24,7 @@ sidebar_label: "Dimensions" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes the native language. For information about functions available in SQL, refer to the [SQL documentation](sql-scalar.md). @@ -73,7 +73,7 @@ Please refer to the [Output Types](#output-types) section for more details. ### Filtered DimensionSpecs -A filtered `DimensionSpec` is only useful for multi-value dimensions. Say you have a row in Apache Druid that has a multi-value dimension with values ["v1", "v2", "v3"] and you send a groupBy/topN query grouping by that dimension with a [query filter](filters.md) for a value of "v1". In the response you will get 3 rows containing "v1", "v2" and "v3". This behavior might be unintuitive for some use cases. +A filtered `DimensionSpec` is only useful for multi-value dimensions. Say you have a row in Apache® Druid that has a multi-value dimension with values ["v1", "v2", "v3"] and you send a groupBy/topN query grouping by that dimension with a [query filter](filters.md) for a value of "v1". In the response you will get 3 rows containing "v1", "v2" and "v3". This behavior might be unintuitive for some use cases. This happens because Druid uses the "query filter" internally on bitmaps to match the row to include in query result processing. With multi-value dimensions, "query filter" behaves like a contains check, which matches the row with dimension value ["v1", "v2", "v3"]. diff --git a/docs/querying/filters.md b/docs/querying/filters.md index d088d92641ea..5d21d380cc48 100644 --- a/docs/querying/filters.md +++ b/docs/querying/filters.md @@ -29,13 +29,13 @@ Filters are commonly applied on dimensions, but can be applied on aggregated met By default, Druid uses SQL compatible three-value logic when filtering. See [Boolean logic](./sql-data-types.md#boolean-logic) for more details. :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes the native language. For information about aggregators available in SQL, refer to the [SQL documentation](sql-scalar.md). ::: -This topic describes the filter types supported in Apache Druid. +This topic describes the filter types supported in Apache® Druid. ## Selector filter diff --git a/docs/querying/geo.md b/docs/querying/geo.md index e5a9e0bba0d2..9e27a809950c 100644 --- a/docs/querying/geo.md +++ b/docs/querying/geo.md @@ -23,11 +23,11 @@ title: "Spatial filters" --> :::info - Apache Druid supports two query languages: [Druid SQL](../querying/sql.md) and [native queries](../querying/querying.md). + Apache® Druid supports two query languages: [Druid SQL](../querying/sql.md) and [native queries](../querying/querying.md). This document describes a feature that is only available in the native language. ::: -Apache Druid supports filtering spatially indexed columns based on an origin and a bound. +Apache® Druid supports filtering spatially indexed columns based on an origin and a bound. This topic explains how to ingest and query spatial filters. For information on other filters supported by Druid, see [Query filters](../querying/filters.md). diff --git a/docs/querying/granularities.md b/docs/querying/granularities.md index 1aa534297eca..80b9c77e4912 100644 --- a/docs/querying/granularities.md +++ b/docs/querying/granularities.md @@ -24,7 +24,7 @@ sidebar_label: "Granularities" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes the native language. For information about time functions available in SQL, refer to the [SQL documentation](sql-scalar.md#date-and-time-functions). @@ -70,7 +70,7 @@ The minimum and maximum granularities are `none` and `all`, described as follows #### Example: -Suppose you have data below stored in Apache Druid with millisecond ingestion granularity, +Suppose you have data below stored in Apache® Druid with millisecond ingestion granularity, ``` json {"timestamp": "2013-08-31T01:02:33Z", "page": "AAA", "language" : "en"} diff --git a/docs/querying/groupbyquery.md b/docs/querying/groupbyquery.md index be4ff0462a59..54cec98791c4 100644 --- a/docs/querying/groupbyquery.md +++ b/docs/querying/groupbyquery.md @@ -24,13 +24,13 @@ sidebar_label: "GroupBy" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes a query type in the native language. For information about when Druid SQL will use this query type, refer to the [SQL documentation](sql-translation.md#query-types). ::: -These types of Apache Druid queries take a groupBy query object and return an array of JSON objects where each object represents a +These types of Apache® Druid queries take a groupBy query object and return an array of JSON objects where each object represents a grouping asked for by the query. :::info diff --git a/docs/querying/having.md b/docs/querying/having.md index f13020c4b377..579fb4a8c69d 100644 --- a/docs/querying/having.md +++ b/docs/querying/having.md @@ -23,7 +23,7 @@ title: "Having filters (groupBy)" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes the native language. For information about functions available in SQL, refer to the [SQL documentation](sql-scalar.md). @@ -33,7 +33,7 @@ A having clause is a JSON object identifying which rows from a groupBy query sho It is essentially the equivalent of the HAVING clause in SQL. -Apache Druid supports the following types of having clauses. +Apache® Druid supports the following types of having clauses. ### Query filters diff --git a/docs/querying/hll-old.md b/docs/querying/hll-old.md index 8e40c999fdc2..5d5f5d45eb3f 100644 --- a/docs/querying/hll-old.md +++ b/docs/querying/hll-old.md @@ -25,7 +25,7 @@ title: "Cardinality/HyperUnique aggregators" ## Cardinality aggregator -Computes the cardinality of a set of Apache Druid dimensions, using HyperLogLog to estimate the cardinality. Please note that this +Computes the cardinality of a set of Apache® Druid dimensions, using HyperLogLog to estimate the cardinality. Please note that this aggregator will be much slower than indexing a column with the hyperUnique aggregator. This aggregator also runs over a dimension column, which means the string dimension cannot be removed from the dataset to improve rollup. In general, we strongly recommend using the hyperUnique aggregator instead of the cardinality aggregator if you do not care about the individual values of a dimension. diff --git a/docs/querying/joins.md b/docs/querying/joins.md index d200b757e4dd..40c2d6cc3529 100644 --- a/docs/querying/joins.md +++ b/docs/querying/joins.md @@ -22,7 +22,7 @@ title: "Joins" ~ under the License. --> -Apache Druid has two features related to joining of data: +Apache® Druid has two features related to joining of data: 1. [Join](datasource.md#join) operators. These are available using a [join datasource](datasource.md#join) in native queries, or using the [JOIN operator](sql.md) in Druid SQL. Refer to the diff --git a/docs/querying/kafka-extraction-namespace.md b/docs/querying/kafka-extraction-namespace.md index 1cfa91aac554..f5c91e7847d7 100644 --- a/docs/querying/kafka-extraction-namespace.md +++ b/docs/querying/kafka-extraction-namespace.md @@ -22,7 +22,7 @@ title: "Apache Kafka Lookups" ~ under the License. --> -To use this Apache Druid extension, [include](../configuration/extensions.md#loading-extensions) `druid-lookups-cached-global` and `druid-kafka-extraction-namespace` in the extensions load list. +To use this Apache® Druid extension, [include](../configuration/extensions.md#loading-extensions) `druid-lookups-cached-global` and `druid-kafka-extraction-namespace` in the extensions load list. If you need updates to populate as promptly as possible, it is possible to plug into a Kafka topic whose key is the old value and message is the desired new value (both in UTF-8) as a LookupExtractorFactory. @@ -43,7 +43,7 @@ If you need updates to populate as promptly as possible, it is possible to plug | `connectTimeout` | How long to wait for an initial connection | No | `0` (do not wait) | | `isOneToOne` | The map is a one-to-one (see [Lookup DimensionSpecs](./dimensionspecs.md)) | No | `false` | -The extension `kafka-extraction-namespace` enables reading from an [Apache Kafka](https://kafka.apache.org/) topic which has name/key pairs to allow renaming of dimension values. An example use case would be to rename an ID to a human-readable format. +The extension `kafka-extraction-namespace` enables reading from an [Apache Kafka®](https://kafka.apache.org/) topic which has name/key pairs to allow renaming of dimension values. An example use case would be to rename an ID to a human-readable format. ## How it Works diff --git a/docs/querying/limitspec.md b/docs/querying/limitspec.md index a734860e6320..598fdb97317a 100644 --- a/docs/querying/limitspec.md +++ b/docs/querying/limitspec.md @@ -23,7 +23,7 @@ title: "Sorting and limiting (groupBy)" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes the native language. For information about sorting in SQL, refer to the [SQL documentation](sql.md#order-by). ::: diff --git a/docs/querying/lookups-cached-global.md b/docs/querying/lookups-cached-global.md index 68a7b6421304..b482f59be488 100644 --- a/docs/querying/lookups-cached-global.md +++ b/docs/querying/lookups-cached-global.md @@ -22,7 +22,7 @@ title: "Globally Cached Lookups" ~ under the License. --> -To use this Apache Druid extension, [include](../configuration/extensions.md#loading-extensions) `druid-lookups-cached-global` in the extensions load list. +To use this Apache® Druid extension, [include](../configuration/extensions.md#loading-extensions) `druid-lookups-cached-global` in the extensions load list. ## Configuration :::info diff --git a/docs/querying/lookups.md b/docs/querying/lookups.md index 2b5af42aa4a5..9af99a29f2a4 100644 --- a/docs/querying/lookups.md +++ b/docs/querying/lookups.md @@ -22,7 +22,7 @@ title: "Lookups" ~ under the License. --> -Lookups are a concept in Apache Druid where dimension values are (optionally) replaced with new values, allowing join-like +Lookups are a concept in Apache® Druid where dimension values are (optionally) replaced with new values, allowing join-like functionality. Applying lookups in Druid is similar to joining a dimension table in a data warehouse. See [dimension specs](./dimensionspecs.md) for more information. For the purpose of these documents, a "key" refers to a dimension value to match, and a "value" refers to its replacement. So if you wanted to map diff --git a/docs/querying/math-expr.md b/docs/querying/math-expr.md index 028af3f01f2e..ec8928851bcc 100644 --- a/docs/querying/math-expr.md +++ b/docs/querying/math-expr.md @@ -23,7 +23,7 @@ title: "Expressions" --> :::info - Apache Druid supports two query languages: [native queries](../querying/querying.md) and [Druid SQL](../querying/sql.md). + Apache® Druid supports two query languages: [native queries](../querying/querying.md) and [Druid SQL](../querying/sql.md). This document describes the native language. For information about functions available in SQL, refer to the [SQL documentation](../querying/sql-scalar.md). ::: diff --git a/docs/querying/multi-value-dimensions.md b/docs/querying/multi-value-dimensions.md index f18f45994fb0..4d26a90dc4c8 100644 --- a/docs/querying/multi-value-dimensions.md +++ b/docs/querying/multi-value-dimensions.md @@ -23,7 +23,7 @@ title: "Multi-value dimensions" --> -Apache Druid supports "multi-value" string dimensions. Multi-value string dimensions result from input fields that contain an +Apache® Druid supports "multi-value" string dimensions. Multi-value string dimensions result from input fields that contain an array of values instead of a single value, such as the `tags` values in the following JSON array example: ``` @@ -49,7 +49,7 @@ The following sections describe inserting, filtering, and grouping behavior base ## Ingestion ### Native batch and streaming ingestion -When using native [batch](../ingestion/native-batch.md) or streaming ingestion such as with [Apache Kafka](../ingestion/kafka-ingestion.md), the Druid web console data loader can detect multi-value dimensions and configure the `dimensionsSpec` accordingly. +When using native [batch](../ingestion/native-batch.md) or streaming ingestion such as with [Apache Kafka®](../ingestion/kafka-ingestion.md), the Druid web console data loader can detect multi-value dimensions and configure the `dimensionsSpec` accordingly. For TSV or CSV data, you can specify the multi-value delimiters using the `listDelimiter` field in the `inputFormat`. JSON data must be formatted as a JSON array to be ingested as a multi-value dimension. JSON data does not require `inputFormat` configuration. diff --git a/docs/querying/multitenancy.md b/docs/querying/multitenancy.md index e303f4dfb06c..5cc91ab98dea 100644 --- a/docs/querying/multitenancy.md +++ b/docs/querying/multitenancy.md @@ -24,7 +24,7 @@ sidebar_label: "Multitenancy" --> -Apache Druid is often used to power user-facing data applications, where multitenancy is an important requirement. This +Apache® Druid is often used to power user-facing data applications, where multitenancy is an important requirement. This document outlines Druid's multitenant storage and querying features. ## Shared datasources or datasource-per-tenant? diff --git a/docs/querying/nested-columns.md b/docs/querying/nested-columns.md index 6073ec774368..5d4ffc2ffd7a 100644 --- a/docs/querying/nested-columns.md +++ b/docs/querying/nested-columns.md @@ -27,7 +27,7 @@ import TabItem from '@theme/TabItem'; ~ under the License. --> -Apache Druid supports directly storing nested data structures in `COMPLEX` columns. `COMPLEX` columns store a copy of the structured data in JSON format and specialized internal columns and indexes for nested primitive values—STRING, LONG, and DOUBLE types, as well as ARRAY of STRING, LONG, and DOUBLE values. An optimized [virtual column](./virtual-columns.md#nested-field-virtual-column) allows Druid to read and filter these values at speeds consistent with standard Druid LONG, DOUBLE, and STRING columns. +Apache® Druid supports directly storing nested data structures in `COMPLEX` columns. `COMPLEX` columns store a copy of the structured data in JSON format and specialized internal columns and indexes for nested primitive values—STRING, LONG, and DOUBLE types, as well as ARRAY of STRING, LONG, and DOUBLE values. An optimized [virtual column](./virtual-columns.md#nested-field-virtual-column) allows Druid to read and filter these values at speeds consistent with standard Druid LONG, DOUBLE, and STRING columns. Druid [SQL JSON functions](./sql-json-functions.md) allow you to extract, transform, and create `COMPLEX` values in SQL queries, using the specialized virtual columns where appropriate. You can use the [JSON nested columns functions](math-expr.md#json-functions) in [native queries](./querying.md) using [expression virtual columns](./virtual-columns.md#expression-virtual-column), and in native ingestion with a [`transformSpec`](../ingestion/ingestion-spec.md#transformspec). diff --git a/docs/querying/post-aggregations.md b/docs/querying/post-aggregations.md index 169ab9d4bc50..3c8bfbc6cd43 100644 --- a/docs/querying/post-aggregations.md +++ b/docs/querying/post-aggregations.md @@ -23,13 +23,13 @@ title: "Post-aggregations" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes the native language. For information about functions available in SQL, refer to the [SQL documentation](sql-aggregations.md). ::: -Post-aggregations are specifications of processing that should happen on aggregated values as they come out of Apache Druid. If you include a post aggregation as part of a query, make sure to include all aggregators the post-aggregator requires. +Post-aggregations are specifications of processing that should happen on aggregated values as they come out of Apache® Druid. If you include a post aggregation as part of a query, make sure to include all aggregators the post-aggregator requires. There are several post-aggregators available. diff --git a/docs/querying/query-context-reference.md b/docs/querying/query-context-reference.md index 41bd206199e7..d37d2b80799a 100644 --- a/docs/querying/query-context-reference.md +++ b/docs/querying/query-context-reference.md @@ -23,7 +23,7 @@ sidebar_label: "Query context reference" ~ under the License. --> -The query context provides runtime configuration for individual queries in Apache Druid. Each parameter in the query context controls a specific aspect of query behavior—from execution timeouts and resource limits to caching policies and processing strategies. +The query context provides runtime configuration for individual queries in Apache® Druid. Each parameter in the query context controls a specific aspect of query behavior—from execution timeouts and resource limits to caching policies and processing strategies. This reference contains context parameters organized by their scope: diff --git a/docs/querying/query-context.md b/docs/querying/query-context.md index 076508a4df3e..98e8b708aef0 100644 --- a/docs/querying/query-context.md +++ b/docs/querying/query-context.md @@ -27,7 +27,7 @@ description: --> -The query context gives you fine-grained control over how Apache Druid executes your individual queries. While the default settings in Druid work well for most queries, you can set the query context to handle specific requirements and optimize performance. +The query context gives you fine-grained control over how Apache® Druid executes your individual queries. While the default settings in Druid work well for most queries, you can set the query context to handle specific requirements and optimize performance. Common use cases for the query context include: - Override default timeouts for long-running queries or complex aggregations. diff --git a/docs/querying/query-processing.md b/docs/querying/query-processing.md index b4ecd006f072..cf6ac2b14c05 100644 --- a/docs/querying/query-processing.md +++ b/docs/querying/query-processing.md @@ -22,7 +22,7 @@ title: "Query processing" ~ under the License. --> -This topic provides a high-level overview of how Apache Druid distributes and processes queries. +This topic provides a high-level overview of how Apache® Druid distributes and processes queries. The general flow is as follows: diff --git a/docs/querying/querying.md b/docs/querying/querying.md index ba173fdb0a66..3605f218ca10 100644 --- a/docs/querying/querying.md +++ b/docs/querying/querying.md @@ -24,7 +24,7 @@ title: "Native queries" :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes the native query language. For information about how Druid SQL chooses which native query types to use when it runs a SQL query, refer to the [SQL documentation](sql-translation.md#query-types). diff --git a/docs/querying/scan-query.md b/docs/querying/scan-query.md index 07decff8b1a7..693e951e28b5 100644 --- a/docs/querying/scan-query.md +++ b/docs/querying/scan-query.md @@ -24,13 +24,13 @@ sidebar_label: "Scan" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes a query type in the native language. For information about when Druid SQL will use this query type, refer to the [SQL documentation](sql-translation.md#query-types). ::: -The Scan query returns raw Apache Druid rows in streaming mode. +The Scan query returns raw Apache® Druid rows in streaming mode. In addition to straightforward usage where a Scan query is issued to the Broker, the Scan query can also be issued directly to Historical processes or streaming ingestion tasks. This can be useful if you want to retrieve large diff --git a/docs/querying/searchquery.md b/docs/querying/searchquery.md index 97ddf59372a2..190ec483ded2 100644 --- a/docs/querying/searchquery.md +++ b/docs/querying/searchquery.md @@ -24,7 +24,7 @@ sidebar_label: "Search" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes a query type that is only available in the native language. ::: @@ -57,7 +57,7 @@ There are several main parts to a search query: |property|description|required?| |--------|-----------|---------| -|queryType|This String should always be "search"; this is the first thing Apache Druid looks at to figure out how to interpret the query.|yes| +|queryType|This String should always be "search"; this is the first thing Apache® Druid looks at to figure out how to interpret the query.|yes| |dataSource|A String or Object defining the data source to query, very similar to a table in a relational database. See [DataSource](../querying/datasource.md) for more information.|yes| |granularity|Defines the granularity of the query. See [Granularities](../querying/granularities.md).|no (default to `all`)| |filter|See [Filters](../querying/filters.md).|no| diff --git a/docs/querying/segmentmetadataquery.md b/docs/querying/segmentmetadataquery.md index 58eb93b4cf0b..0462aea9df5f 100644 --- a/docs/querying/segmentmetadataquery.md +++ b/docs/querying/segmentmetadataquery.md @@ -24,7 +24,7 @@ sidebar_label: "SegmentMetadata" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes a query type that is only available in the native language. However, Druid SQL contains similar functionality in its [metadata tables](sql-metadata-tables.md). @@ -57,7 +57,7 @@ There are several main parts to a segment metadata query: |property|description|required?| |--------|-----------|---------| -|queryType|This String should always be "segmentMetadata"; this is the first thing Apache Druid looks at to figure out how to interpret the query|yes| +|queryType|This String should always be "segmentMetadata"; this is the first thing Apache® Druid looks at to figure out how to interpret the query|yes| |dataSource|A String or Object defining the data source to query, very similar to a table in a relational database. See [DataSource](../querying/datasource.md) for more information.|yes| |intervals|A JSON Object representing ISO-8601 Intervals. This defines the time ranges to run the query over.|no| |toInclude|A JSON Object representing what columns should be included in the result. Defaults to "all".|no| diff --git a/docs/querying/select-query.md b/docs/querying/select-query.md index 734073dc531e..57271b211733 100644 --- a/docs/querying/select-query.md +++ b/docs/querying/select-query.md @@ -24,4 +24,4 @@ sidebar_label: "Select" --> -Older versions of Apache Druid included a Select query type. Since Druid 0.17.0, it has been removed and replaced by the [Scan query](../querying/scan-query.md), which offers improved memory usage and performance. This solves issues that users had with Select queries causing Druid to run out of memory or slow down. +Older versions of Apache® Druid included a Select query type. Since Druid 0.17.0, it has been removed and replaced by the [Scan query](../querying/scan-query.md), which offers improved memory usage and performance. This solves issues that users had with Select queries causing Druid to run out of memory or slow down. diff --git a/docs/querying/sorting-orders.md b/docs/querying/sorting-orders.md index 4860cdee52f1..6eb55bf85b6b 100644 --- a/docs/querying/sorting-orders.md +++ b/docs/querying/sorting-orders.md @@ -23,7 +23,7 @@ title: "String comparators" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes the native language. For information about functions available in SQL, refer to the [SQL documentation](sql-scalar.md). diff --git a/docs/querying/sql-aggregations.md b/docs/querying/sql-aggregations.md index c251690ce717..ae709b898310 100644 --- a/docs/querying/sql-aggregations.md +++ b/docs/querying/sql-aggregations.md @@ -31,7 +31,7 @@ sidebar_label: "Aggregation functions" --> :::info - Apache Druid supports two query languages: Druid SQL and [native queries](querying.md). + Apache® Druid supports two query languages: Druid SQL and [native queries](querying.md). This document describes the SQL language. ::: diff --git a/docs/querying/sql-array-functions.md b/docs/querying/sql-array-functions.md index 5073fc3efc23..647e6a738346 100644 --- a/docs/querying/sql-array-functions.md +++ b/docs/querying/sql-array-functions.md @@ -32,7 +32,7 @@ sidebar_label: "Array functions" :::info - Apache Druid supports two query languages: Druid SQL and [native queries](querying.md). + Apache® Druid supports two query languages: Druid SQL and [native queries](querying.md). This document describes the SQL language. ::: diff --git a/docs/querying/sql-data-types.md b/docs/querying/sql-data-types.md index 08492fcf76d3..c7288802e467 100644 --- a/docs/querying/sql-data-types.md +++ b/docs/querying/sql-data-types.md @@ -24,7 +24,7 @@ sidebar_label: "SQL data types" --> :::info - Apache Druid supports two query languages: Druid SQL and [native queries](querying.md). + Apache® Druid supports two query languages: Druid SQL and [native queries](querying.md). This document describes the SQL language. ::: diff --git a/docs/querying/sql-functions.md b/docs/querying/sql-functions.md index beaa4c4eb3e0..9fdfa56e4368 100644 --- a/docs/querying/sql-functions.md +++ b/docs/querying/sql-functions.md @@ -24,11 +24,11 @@ sidebar_label: "All functions" --> :::info - Apache Druid supports two query languages: Druid SQL and [native queries](querying.md). + Apache® Druid supports two query languages: Druid SQL and [native queries](querying.md). This document describes the SQL language. ::: -This page provides a reference of Apache Druid® SQL functions in alphabetical order. For more details on a function, refer to the following: +This page provides a reference of Apache® Druid SQL functions in alphabetical order. For more details on a function, refer to the following: * [Aggregation functions](sql-aggregations.md) * [Array functions](sql-array-functions.md) * [JSON functions](sql-json-functions.md) diff --git a/docs/querying/sql-metadata-tables.md b/docs/querying/sql-metadata-tables.md index 53184a034a90..055305d81e50 100644 --- a/docs/querying/sql-metadata-tables.md +++ b/docs/querying/sql-metadata-tables.md @@ -24,7 +24,7 @@ sidebar_label: "SQL metadata tables" --> :::info - Apache Druid supports two query languages: Druid SQL and [native queries](querying.md). + Apache® Druid supports two query languages: Druid SQL and [native queries](querying.md). This document describes the SQL language. ::: diff --git a/docs/querying/sql-multivalue-string-functions.md b/docs/querying/sql-multivalue-string-functions.md index 7cba8a70f61e..37f629c88360 100644 --- a/docs/querying/sql-multivalue-string-functions.md +++ b/docs/querying/sql-multivalue-string-functions.md @@ -32,7 +32,7 @@ sidebar_label: "Multi-value string functions" :::info - Apache Druid supports two query languages: Druid SQL and [native queries](querying.md). + Apache® Druid supports two query languages: Druid SQL and [native queries](querying.md). This document describes the SQL language. ::: diff --git a/docs/querying/sql-operators.md b/docs/querying/sql-operators.md index ebf68099019c..e1c335d059f5 100644 --- a/docs/querying/sql-operators.md +++ b/docs/querying/sql-operators.md @@ -32,7 +32,7 @@ sidebar_label: "Operators" :::info - Apache Druid supports two query languages: Druid SQL and [native queries](querying.md). + Apache® Druid supports two query languages: Druid SQL and [native queries](querying.md). This document describes the SQL language. ::: diff --git a/docs/querying/sql-query-context.md b/docs/querying/sql-query-context.md index 31ec12338aab..23e9f41347a8 100644 --- a/docs/querying/sql-query-context.md +++ b/docs/querying/sql-query-context.md @@ -24,11 +24,11 @@ sidebar_label: "SQL query context" --> :::info - Apache Druid supports two query languages: Druid SQL and [native queries](querying.md). + Apache® Druid supports two query languages: Druid SQL and [native queries](querying.md). This document describes the SQL language. ::: -In Apache Druid, you can control how your [Druid SQL queries](./sql.md) queries run by using query context parameters. The parameters let you adjust aspects of query processing such as using approximations, selecting particular filters, controlling how lookups are executed. +In Apache® Druid, you can control how your [Druid SQL queries](./sql.md) queries run by using query context parameters. The parameters let you adjust aspects of query processing such as using approximations, selecting particular filters, controlling how lookups are executed. For additional context parameters supported for all query types, refer to [Query context reference](query-context-reference.md). To learn how to set the query context, see [Set query context](../querying/query-context.md). diff --git a/docs/querying/sql-scalar.md b/docs/querying/sql-scalar.md index 59c3e2893a86..38fadfc807c3 100644 --- a/docs/querying/sql-scalar.md +++ b/docs/querying/sql-scalar.md @@ -32,7 +32,7 @@ sidebar_label: "Scalar functions" :::info - Apache Druid supports two query languages: Druid SQL and [native queries](querying.md). + Apache® Druid supports two query languages: Druid SQL and [native queries](querying.md). This document describes the SQL language. ::: diff --git a/docs/querying/sql-translation.md b/docs/querying/sql-translation.md index 9049d0746262..8c2e323b6b48 100644 --- a/docs/querying/sql-translation.md +++ b/docs/querying/sql-translation.md @@ -24,7 +24,7 @@ sidebar_label: "SQL query translation" --> :::info - Apache Druid supports two query languages: Druid SQL and [native queries](querying.md). + Apache® Druid supports two query languages: Druid SQL and [native queries](querying.md). This document describes the Druid SQL language. ::: diff --git a/docs/querying/sql-window-functions.md b/docs/querying/sql-window-functions.md index b7f6b17d868e..cac12ffbd4a0 100644 --- a/docs/querying/sql-window-functions.md +++ b/docs/querying/sql-window-functions.md @@ -25,12 +25,12 @@ description: Reference for window functions :::info -Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). +Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes the SQL language. ::: -Window functions in Apache Druid produce values based upon the relationship of one row within a window of rows to the other rows within the same window. A window is a group of related rows within a result set. For example, rows with the same value for a specific dimension. +Window functions in Apache® Druid produce values based upon the relationship of one row within a window of rows to the other rows within the same window. A window is a group of related rows within a result set. For example, rows with the same value for a specific dimension. Window functions in Druid require a GROUP BY statement. Druid performs the row-level aggregations for the GROUP BY before performing the window function calculations. diff --git a/docs/querying/sql.md b/docs/querying/sql.md index c2310531694e..98fd97b2411b 100644 --- a/docs/querying/sql.md +++ b/docs/querying/sql.md @@ -24,7 +24,7 @@ sidebar_label: "Overview and syntax" --> :::info - Apache Druid supports two query languages: Druid SQL and [native queries](querying.md). + Apache® Druid supports two query languages: Druid SQL and [native queries](querying.md). This document describes the SQL language. ::: @@ -470,7 +470,7 @@ SELECT count(city) from druid.table where SCALAR_IN_ARRAY(city, ?) ## Reserved keywords -Druid SQL reserves certain keywords which are used in its query language. Apache Druid inherits all of the reserved keywords from [Apache Calcite](https://calcite.apache.org/docs/reference.html#keywords). In addition to these, the following reserved keywords are unique to Apache Druid: +Druid SQL reserves certain keywords which are used in its query language. Apache® Druid inherits all of the reserved keywords from [Apache Calcite](https://calcite.apache.org/docs/reference.html#keywords). In addition to these, the following reserved keywords are unique to Apache Druid: * **CLUSTERED** * **PARTITIONED** diff --git a/docs/querying/timeboundaryquery.md b/docs/querying/timeboundaryquery.md index 161662039422..688bfd33054c 100644 --- a/docs/querying/timeboundaryquery.md +++ b/docs/querying/timeboundaryquery.md @@ -24,7 +24,7 @@ sidebar_label: "TimeBoundary" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes a query type that is only available in the native language. ::: @@ -44,7 +44,7 @@ There are 3 main parts to a time boundary query: |property|description|required?| |--------|-----------|---------| -|queryType|This String should always be "timeBoundary"; this is the first thing Apache Druid looks at to figure out how to interpret the query|yes| +|queryType|This String should always be "timeBoundary"; this is the first thing Apache® Druid looks at to figure out how to interpret the query|yes| |dataSource|A String or Object defining the data source to query, very similar to a table in a relational database. See [DataSource](../querying/datasource.md) for more information.|yes| |bound | Optional, set to `maxTime` or `minTime` to return only the latest or earliest timestamp. Default to returning both if not set| no | |filter|See [Filters](../querying/filters.md)|no| diff --git a/docs/querying/timeseriesquery.md b/docs/querying/timeseriesquery.md index 6d093f2a7492..53ab7ed17e13 100644 --- a/docs/querying/timeseriesquery.md +++ b/docs/querying/timeseriesquery.md @@ -24,7 +24,7 @@ sidebar_label: "Timeseries" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes a query type in the native language. For information about when Druid SQL will use this query type, refer to the [SQL documentation](sql-translation.md#query-types). @@ -74,7 +74,7 @@ There are 7 main parts to a timeseries query: |property|description|required?| |--------|-----------|---------| -|queryType|This String should always be "timeseries"; this is the first thing Apache Druid looks at to figure out how to interpret the query|yes| +|queryType|This String should always be "timeseries"; this is the first thing Apache® Druid looks at to figure out how to interpret the query|yes| |dataSource|A String or Object defining the data source to query, very similar to a table in a relational database. See [DataSource](../querying/datasource.md) for more information.|yes| |descending|Whether to make descending ordered result. Default is `false`(ascending).|no| |intervals|A JSON Object representing ISO-8601 Intervals. This defines the time ranges to run the query over.|yes| diff --git a/docs/querying/tips-good-queries.md b/docs/querying/tips-good-queries.md index adbba8d59bed..e8f9050e496c 100644 --- a/docs/querying/tips-good-queries.md +++ b/docs/querying/tips-good-queries.md @@ -23,7 +23,7 @@ sidebar_label: "Tips for writing good queries" ~ under the License. --> -This topic includes tips and examples that can help you investigate and improve query performance and accuracy using [Apache Druid SQL](./sql.md). +This topic includes tips and examples that can help you investigate and improve query performance and accuracy using [Apache® Druid SQL](./sql.md). For an interactive tutorial on Druid SQL, see [Learn the basics of Druid SQL](https://github.com/implydata/learn-druid/tree/main/notebooks) within the [Learn Druid repo](https://github.com/implydata/learn-druid). diff --git a/docs/querying/topnmetricspec.md b/docs/querying/topnmetricspec.md index 844f0cf30662..b62bc3ddaf0c 100644 --- a/docs/querying/topnmetricspec.md +++ b/docs/querying/topnmetricspec.md @@ -23,12 +23,12 @@ title: "Sorting (topN)" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes the native language. For information about sorting in SQL, refer to the [SQL documentation](sql.md#order-by). ::: -In Apache Druid, the topN metric spec specifies how topN values should be sorted. +In Apache® Druid, the topN metric spec specifies how topN values should be sorted. ## Numeric TopNMetricSpec diff --git a/docs/querying/topnquery.md b/docs/querying/topnquery.md index c9c0f7b62e2b..e15ecf66f26a 100644 --- a/docs/querying/topnquery.md +++ b/docs/querying/topnquery.md @@ -24,13 +24,13 @@ sidebar_label: "TopN" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes a query type in the native language. For information about when Druid SQL will use this query type, refer to the [SQL documentation](sql-translation.md#query-types). ::: -Apache Druid TopN queries return a sorted set of results for the values in a given dimension according to some criteria. Conceptually, they can be thought of as an approximate [GroupByQuery](../querying/groupbyquery.md) over a single dimension with an [Ordering](../querying/limitspec.md) spec. TopNs are much faster and resource efficient than GroupBys for this use case. These types of queries take a topN query object and return an array of JSON objects where each object represents a value asked for by the topN query. +Apache® Druid TopN queries return a sorted set of results for the values in a given dimension according to some criteria. Conceptually, they can be thought of as an approximate [GroupByQuery](../querying/groupbyquery.md) over a single dimension with an [Ordering](../querying/limitspec.md) spec. TopNs are much faster and resource efficient than GroupBys for this use case. These types of queries take a topN query object and return an array of JSON objects where each object represents a value asked for by the topN query. TopNs are approximate in that each data process will rank their top K results and only return those top K results to the Broker. K, by default in Druid, is `max(1000, threshold)`. diff --git a/docs/querying/virtual-columns.md b/docs/querying/virtual-columns.md index fbfae24ed545..335057945046 100644 --- a/docs/querying/virtual-columns.md +++ b/docs/querying/virtual-columns.md @@ -23,7 +23,7 @@ title: "Virtual columns" --> :::info - Apache Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). + Apache® Druid supports two query languages: [Druid SQL](sql.md) and [native queries](querying.md). This document describes the native language. For information about functions available in SQL, refer to the [SQL documentation](sql-scalar.md). @@ -35,7 +35,7 @@ A virtual column can potentially draw from multiple underlying columns, although Virtual columns can be referenced by their output names to be used as [dimensions](./dimensionspecs.md) or as inputs to [filters](./filters.md) and [aggregators](./aggregations.md). -Each Apache Druid query can accept a list of virtual columns as a parameter. The following scan query is provided as an example: +Each Apache® Druid query can accept a list of virtual columns as a parameter. The following scan query is provided as an example: ``` { From 7ed03d12ec6f48f5bd67ad44a3ead2d782f2598f Mon Sep 17 00:00:00 2001 From: avaamsel Date: Thu, 2 Jul 2026 15:57:36 -0700 Subject: [PATCH 11/11] misc trademarks --- docs/configuration/extensions.md | 2 +- docs/development/docs-contribute.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/extensions.md b/docs/configuration/extensions.md index 2ad0ad180b2a..e0769c3d9eb1 100644 --- a/docs/configuration/extensions.md +++ b/docs/configuration/extensions.md @@ -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)| diff --git a/docs/development/docs-contribute.md b/docs/development/docs-contribute.md index 270713e15875..be6e855cdc61 100644 --- a/docs/development/docs-contribute.md +++ b/docs/development/docs-contribute.md @@ -22,7 +22,7 @@ title: "Contribute to Druid docs" ~ under the License. --> -Apache Druid is a [community-led project](https://druid.apache.org/community/). We are delighted to receive contributions to the docs ranging from minor fixes to big new features. +Apache® Druid is a [community-led project](https://druid.apache.org/community/). We are delighted to receive contributions to the docs ranging from minor fixes to big new features. Druid docs contributors: