Apache
/
druid
mirror of https://github.com/apache/druid.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
druid/docs/content/toc.md

183 lines
10 KiB
Markdown
Raw Normal View History

Front Matter header needs to be on the first line for md to be rendered properly by jekyll (#6733)
2018-12-13 14:47:20 -05:00
---
layout: toc
---
add missing license headers, in particular to MD files; clean up RAT … (#6563) * add missing license headers, in particular to MD files; clean up RAT exclusions * revert inadvertent doc changes * docs * cr changes * fix modified druid-production.svg
2018-11-13 12:38:37 -05:00
<!--
~ Licensed to the Apache Software Foundation (ASF) under one
~ or more contributor license agreements. See the NOTICE file
~ distributed with this work for additional information
~ regarding copyright ownership. The ASF licenses this file
~ to you under the Apache License, Version 2.0 (the
~ "License"); you may not use this file except in compliance
~ with the License. You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing,
~ software distributed under the License is distributed on an
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~ KIND, either express or implied. See the License for the
~ specific language governing permissions and limitations
~ under the License.
-->
move table of contents to Markdown fixes #2397
2016-02-04 17:35:38 -05:00
## Getting Started
New docs intro (#6122) * New docs intro * PR comments * Fix arch diagram * PR comment * PR comment * PR comment
2018-08-09 17:19:11 -04:00
* [Design](/docs/VERSION/design/index.html)
* [What is Druid?](/docs/VERSION/design/index.html#what-is-druid)
reorganizing the ToC (#7734)
2019-05-23 12:24:38 -04:00
* [When should I use Druid?](/docs/VERSION/design/index.html#when-to-use-druid)
New docs intro (#6122) * New docs intro * PR comments * Fix arch diagram * PR comment * PR comment * PR comment
2018-08-09 17:19:11 -04:00
* [Architecture](/docs/VERSION/design/index.html#architecture)
* [Datasources & Segments](/docs/VERSION/design/index.html#datasources-and-segments)
* [Query processing](/docs/VERSION/design/index.html#query-processing)
* [External dependencies](/docs/VERSION/design/index.html#external-dependencies)
Docs consistency cleanup (#6259)
2018-09-04 15:54:41 -04:00
* [Ingestion overview](/docs/VERSION/ingestion/index.html)
Add basic tuning guide, getting started page, updated clustering docs (#7629) * Add basic tuning guide, getting started page, updated clustering docs * Add note about caching, fix tutorial paths * Adjust hadoop wording * Add license * Tweak * Shrink overlord heaps, fix tutorial urls * Tweak xlarge peon, update peon sizing * Update Data peon buffer size * Fix cluster start scripts * Add upper level _common to classpath * Fix cluster data/query confs * Address PR comments * Elaborate on connection pools * PR comments * Increase druid.broker.http.maxQueuedBytes * Add guidelines for broker backpressure * PR comments
2019-05-16 14:13:48 -04:00
* [Getting Started](/docs/VERSION/operations/getting-started.html)
* [Single-server Quickstart](/docs/VERSION/tutorials/index.html)
reorganizing the ToC (#7734)
2019-05-23 12:24:38 -04:00
* [Tutorial: Loading a file from local disk](/docs/VERSION/tutorials/tutorial-batch.html)
Add basic tuning guide, getting started page, updated clustering docs (#7629) * Add basic tuning guide, getting started page, updated clustering docs * Add note about caching, fix tutorial paths * Adjust hadoop wording * Add license * Tweak * Shrink overlord heaps, fix tutorial urls * Tweak xlarge peon, update peon sizing * Update Data peon buffer size * Fix cluster start scripts * Add upper level _common to classpath * Fix cluster data/query confs * Address PR comments * Elaborate on connection pools * PR comments * Increase druid.broker.http.maxQueuedBytes * Add guidelines for broker backpressure * PR comments
2019-05-16 14:13:48 -04:00
* [Tutorial: Loading stream data from Apache Kafka](/docs/VERSION/tutorials/tutorial-kafka.html)
* [Tutorial: Loading a file using Apache Hadoop](/docs/VERSION/tutorials/tutorial-batch-hadoop.html)
* [Tutorial: Loading stream data using HTTP push](/docs/VERSION/tutorials/tutorial-tranquility.html)
* [Tutorial: Querying data](/docs/VERSION/tutorials/tutorial-query.html)
* Further tutorials
* [Tutorial: Rollup](/docs/VERSION/tutorials/tutorial-rollup.html)
* [Tutorial: Configuring retention](/docs/VERSION/tutorials/tutorial-retention.html)
* [Tutorial: Updating existing data](/docs/VERSION/tutorials/tutorial-update-data.html)
* [Tutorial: Compacting segments](/docs/VERSION/tutorials/tutorial-compaction.html)
* [Tutorial: Deleting data](/docs/VERSION/tutorials/tutorial-delete-data.html)
* [Tutorial: Writing your own ingestion specs](/docs/VERSION/tutorials/tutorial-ingestion-spec.html)
reorganizing the ToC (#7734)
2019-05-23 12:24:38 -04:00
* [Tutorial: Transforming input data](/docs/VERSION/tutorials/tutorial-transform-spec.html)
Add basic tuning guide, getting started page, updated clustering docs (#7629) * Add basic tuning guide, getting started page, updated clustering docs * Add note about caching, fix tutorial paths * Adjust hadoop wording * Add license * Tweak * Shrink overlord heaps, fix tutorial urls * Tweak xlarge peon, update peon sizing * Update Data peon buffer size * Fix cluster start scripts * Add upper level _common to classpath * Fix cluster data/query confs * Address PR comments * Elaborate on connection pools * PR comments * Increase druid.broker.http.maxQueuedBytes * Add guidelines for broker backpressure * PR comments
2019-05-16 14:13:48 -04:00
* [Clustering](/docs/VERSION/tutorials/cluster.html)
reorganizing the ToC (#7734)
2019-05-23 12:24:38 -04:00
* Further examples
* [Single-server deployment](/docs/VERSION/operations/single-server.html)
Fix TOC clustering example link (#7749)
2019-05-23 22:41:27 -04:00
* [Clustered deployment](/docs/VERSION/tutorials/cluster.html#fresh-deployment)
move table of contents to Markdown fixes #2397
2016-02-04 17:35:38 -05:00
## Data Ingestion
Docs consistency cleanup (#6259)
2018-09-04 15:54:41 -04:00
* [Ingestion overview](/docs/VERSION/ingestion/index.html)
More docs on data modeling. (#6899) * More docs on data modeling. * Try to fix formatting. * Fix indentation. * More details and adjustments after feedback.
2019-01-27 14:33:21 -05:00
* [Schema Design](/docs/VERSION/ingestion/schema-design.html)
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Data Formats](/docs/VERSION/ingestion/data-formats.html)
Docs consistency cleanup (#6259)
2018-09-04 15:54:41 -04:00
* [Tasks Overview](/docs/VERSION/ingestion/tasks.html)
* [Ingestion Spec](/docs/VERSION/ingestion/ingestion-spec.html)
* [Transform Specs](/docs/VERSION/ingestion/transform-spec.html)
* [Firehoses](/docs/VERSION/ingestion/firehose.html)
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Schema Changes](/docs/VERSION/ingestion/schema-changes.html)
* [Batch File Ingestion](/docs/VERSION/ingestion/batch-ingestion.html)
New doc fixes (#6156)
2018-08-13 14:11:32 -04:00
* [Native Batch Ingestion](/docs/VERSION/ingestion/native_tasks.html)
* [Hadoop Batch Ingestion](/docs/VERSION/ingestion/hadoop.html)
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Stream Ingestion](/docs/VERSION/ingestion/stream-ingestion.html)
Docs consistency cleanup (#6259)
2018-09-04 15:54:41 -04:00
* [Kafka Indexing Service (Stream Pull)](/docs/VERSION/development/extensions-core/kafka-ingestion.html)
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Stream Push](/docs/VERSION/ingestion/stream-push.html)
Docs consistency cleanup (#6259)
2018-09-04 15:54:41 -04:00
* [Compaction](/docs/VERSION/ingestion/compaction.html)
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Updating Existing Data](/docs/VERSION/ingestion/update-existing-data.html)
Docs consistency cleanup (#6259)
2018-09-04 15:54:41 -04:00
* [Deleting Data](/docs/VERSION/ingestion/delete-data.html)
* [Task Locking & Priority](/docs/VERSION/ingestion/locking-and-priority.html)
Docs for ingestion stat reports and new parse exception handling (#6373)
2018-09-24 20:45:05 -04:00
* [Task Reports](/docs/VERSION/ingestion/reports.html)
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [FAQ](/docs/VERSION/ingestion/faq.html)
Docs consistency cleanup (#6259)
2018-09-04 15:54:41 -04:00
* [Misc. Tasks](/docs/VERSION/ingestion/misc-tasks.html)
move table of contents to Markdown fixes #2397
2016-02-04 17:35:38 -05:00
## Querying
Remove SQL experimental banner and other doc adjustments. (#7591) * Remove SQL experimental banner and other doc adjustments. Also, - Adjust the ToC and other docs a bit so SQL and native queries are presented on more equal footing. - De-emphasize querying historicals and peons directly in the native query docs. This is a really niche thing and may have been confusing to include prominently in the very first paragraph. - Remove DataSketches and Kafka indexing service from the experimental features ToC. They are not experimental any longer and were there in error. * More notes. * Slight tweak. * Remove extra extra word. * Remove RT node from ToC.
2019-05-06 15:31:51 -04:00
* [Druid SQL](/docs/VERSION/querying/sql.html)
* [Native queries](/docs/VERSION/querying/querying.html)
* [Timeseries](/docs/VERSION/querying/timeseriesquery.html)
* [TopN](/docs/VERSION/querying/topnquery.html)
* [GroupBy](/docs/VERSION/querying/groupbyquery.html)
* [Time Boundary](/docs/VERSION/querying/timeboundaryquery.html)
* [Segment Metadata](/docs/VERSION/querying/segmentmetadataquery.html)
* [DataSource Metadata](/docs/VERSION/querying/datasourcemetadataquery.html)
* [Search](/docs/VERSION/querying/searchquery.html)
* [Scan](/docs/VERSION/querying/scan-query.html)
* [Select](/docs/VERSION/querying/select-query.html)
* Components
* [Datasources](/docs/VERSION/querying/datasource.html)
* [Filters](/docs/VERSION/querying/filters.html)
* [Aggregations](/docs/VERSION/querying/aggregations.html)
* [Post Aggregations](/docs/VERSION/querying/post-aggregations.html)
* [Granularities](/docs/VERSION/querying/granularities.html)
* [DimensionSpecs](/docs/VERSION/querying/dimensionspecs.html)
* [Sorting Orders](/docs/VERSION/querying/sorting-orders.html)
* [Virtual Columns](/docs/VERSION/querying/virtual-columns.html)
* [Context](/docs/VERSION/querying/query-context.html)
* Concepts
* [Multi-value dimensions](/docs/VERSION/querying/multi-value-dimensions.html)
* [Lookups](/docs/VERSION/querying/lookups.html)
* [Joins](/docs/VERSION/querying/joins.html)
* [Multitenancy](/docs/VERSION/querying/multitenancy.html)
* [Caching](/docs/VERSION/querying/caching.html)
* [Geographic Queries](/docs/VERSION/development/geo.html) (experimental)
move table of contents to Markdown fixes #2397
2016-02-04 17:35:38 -05:00
## Design
Docs consistency cleanup (#6259)
2018-09-04 15:54:41 -04:00
* [Overview](/docs/VERSION/design/index.html)
move table of contents to Markdown fixes #2397
2016-02-04 17:35:38 -05:00
* Storage
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Segments](/docs/VERSION/design/segments.html)
reorganizing the ToC (#7734)
2019-05-23 12:24:38 -04:00
* [Servers and Processes](/docs/VERSION/design/processes.html)
* Master server
* [Coordinator](/docs/VERSION/design/coordinator.html)
* [Overlord](/docs/VERSION/design/overlord.html)
* Query server
* [Broker](/docs/VERSION/design/broker.html)
* [Router](/docs/VERSION/development/router.html) (optional; experimental)
* Data server
* [Historical](/docs/VERSION/design/historical.html)
* [MiddleManager](/docs/VERSION/design/middlemanager.html)
* [Peons](/docs/VERSION/design/peons.html)
move table of contents to Markdown fixes #2397
2016-02-04 17:35:38 -05:00
* Dependencies
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Deep Storage](/docs/VERSION/dependencies/deep-storage.html)
* [Metadata Storage](/docs/VERSION/dependencies/metadata-storage.html)
* [ZooKeeper](/docs/VERSION/dependencies/zookeeper.html)
move table of contents to Markdown fixes #2397
2016-02-04 17:35:38 -05:00
## Operations
some more doc improvements (#7675)
2019-05-16 16:17:21 -04:00
* [Management UIs](/docs/VERSION/operations/management-uis.html)
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Including Extensions](/docs/VERSION/operations/including-extensions.html)
* [Data Retention](/docs/VERSION/operations/rule-configuration.html)
some more doc improvements (#7675)
2019-05-16 16:17:21 -04:00
* [High Availability](/docs/VERSION/operations/high-availability.html)
* [Updating the Cluster](/docs/VERSION/operations/rolling-updates.html)
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Metrics and Monitoring](/docs/VERSION/operations/metrics.html)
* [Alerts](/docs/VERSION/operations/alerts.html)
* [Different Hadoop Versions](/docs/VERSION/operations/other-hadoop.html)
reorganizing the ToC (#7734)
2019-05-23 12:24:38 -04:00
* [HTTP Compression](/docs/VERSION/operations/http-compression.html)
some more doc improvements (#7675)
2019-05-16 16:17:21 -04:00
* [API Reference](/docs/VERSION/operations/api-reference.html)
* [Coordinator](/docs/VERSION/operations/api-reference.html#coordinator)
* [Overlord](/docs/VERSION/operations/api-reference.html#overlord)
* [MiddleManager](/docs/VERSION/operations/api-reference.html#middlemanager)
* [Peon](/docs/VERSION/operations/api-reference.html#peon)
* [Broker](/docs/VERSION/operations/api-reference.html#broker)
reorganizing the ToC (#7734)
2019-05-23 12:24:38 -04:00
* [Historical](/docs/VERSION/operations/api-reference.html#historical)
* Tuning and Recommendations
* [Basic Cluster Tuning](/docs/VERSION/operations/basic-cluster-tuning.html)
* [General Recommendations](/docs/VERSION/operations/recommendations.html)
* [JVM Best Practices](/docs/VERSION/configuration/index.html#jvm-configuration-best-practices)
some more doc improvements (#7675)
2019-05-16 16:17:21 -04:00
* Tools
* [Dump Segment Tool](/docs/VERSION/operations/dump-segment.html)
* [Insert Segment Tool](/docs/VERSION/operations/insert-segment-to-db.html)
* [Pull Dependencies Tool](/docs/VERSION/operations/pull-deps.html)
* Security
* [TLS Support](/docs/VERSION/operations/tls-support.html)
* [Password Provider](/docs/VERSION/operations/password-provider.html)
move table of contents to Markdown fixes #2397
2016-02-04 17:35:38 -05:00
## Configuration
Unified configuration doc page (#6127) * Unified configuration doc page * Rename to index.md, update redirects * PR comments * PR comments * PR comment
2018-08-09 17:52:14 -04:00
* [Configuration Reference](/docs/VERSION/configuration/index.html)
reorganizing the ToC (#7734)
2019-05-23 12:24:38 -04:00
* [Recommended Configuration File Organization](/docs/VERSION/configuration/index.html#recommended-configuration-file-organization)
Unified configuration doc page (#6127) * Unified configuration doc page * Rename to index.md, update redirects * PR comments * PR comments * PR comment
2018-08-09 17:52:14 -04:00
* [Common Configuration](/docs/VERSION/configuration/index.html#common-configurations)
some more doc improvements (#7675)
2019-05-16 16:17:21 -04:00
* Processes
* [Coordinator](/docs/VERSION/configuration/index.html#coordinator)
* [Overlord](/docs/VERSION/configuration/index.html#overlord)
* [MiddleManager & Peons](/docs/VERSION/configuration/index.html#middle-manager-and-peons)
* [Historical](/docs/VERSION/configuration/index.html#historical)
* [Broker](/docs/VERSION/configuration/index.html#broker)
Unified configuration doc page (#6127) * Unified configuration doc page * Rename to index.md, update redirects * PR comments * PR comments * PR comment
2018-08-09 17:52:14 -04:00
* [Caching](/docs/VERSION/configuration/index.html#cache-configuration)
* [General Query Configuration](/docs/VERSION/configuration/index.html#general-query-configuration)
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Configuring Logging](/docs/VERSION/configuration/logging.html)
Add basic tuning guide, getting started page, updated clustering docs (#7629) * Add basic tuning guide, getting started page, updated clustering docs * Add note about caching, fix tutorial paths * Adjust hadoop wording * Add license * Tweak * Shrink overlord heaps, fix tutorial urls * Tweak xlarge peon, update peon sizing * Update Data peon buffer size * Fix cluster start scripts * Add upper level _common to classpath * Fix cluster data/query confs * Address PR comments * Elaborate on connection pools * PR comments * Increase druid.broker.http.maxQueuedBytes * Add guidelines for broker backpressure * PR comments
2019-05-16 14:13:48 -04:00
move table of contents to Markdown fixes #2397
2016-02-04 17:35:38 -05:00
## Development
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Overview](/docs/VERSION/development/overview.html)
Fix broken links in docs, add broken link checker. (#7658) Also adds back insert-segment-to-db.md with some docs about why and when it was removed (in #6911).
2019-05-15 17:49:50 -04:00
* [Libraries](/libraries.html)
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Extensions](/docs/VERSION/development/extensions.html)
JavaScript docs: Fix links and typos, add to TOC. (#3457)
2016-09-13 18:26:44 -04:00
* [JavaScript](/docs/VERSION/development/javascript.html)
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Build From Source](/docs/VERSION/development/build.html)
* [Versioning](/docs/VERSION/development/versioning.html)
* [Integration](/docs/VERSION/development/integrating-druid-with-other-technologies.html)
Remove SQL experimental banner and other doc adjustments. (#7591) * Remove SQL experimental banner and other doc adjustments. Also, - Adjust the ToC and other docs a bit so SQL and native queries are presented on more equal footing. - De-emphasize querying historicals and peons directly in the native query docs. This is a really niche thing and may have been confusing to include prominently in the very first paragraph. - Remove DataSketches and Kafka indexing service from the experimental features ToC. They are not experimental any longer and were there in error. * More notes. * Slight tweak. * Remove extra extra word. * Remove RT node from ToC.
2019-05-06 15:31:51 -04:00
* [Experimental Features](/docs/VERSION/development/experimental.html)
Supervisor for KafkaIndexTask (#2656) * supervisor for kafka indexing tasks * cr changes
2016-05-05 02:13:13 -04:00
move table of contents to Markdown fixes #2397
2016-02-04 17:35:38 -05:00
## Misc
Add docs for virtual columns and transform specs (#6119) * Add docs for virtual columns and transform specs * PR Comments * PR comment
2018-08-09 16:42:52 -04:00
* [Druid Expressions Language](/docs/VERSION/misc/math-expr.html)
Update absolute TOC links. (#3138) See druid-io/druid-io.github.io#286.
2016-06-13 20:57:52 -04:00
* [Papers & Talks](/docs/VERSION/misc/papers-and-talks.html)
move table of contents to Markdown fixes #2397
2016-02-04 17:35:38 -05:00
* [Thanks](/thanks.html)