This is an automated email from the ASF dual-hosted git repository.
cwylie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/druid.git
The following commit(s) were added to refs/heads/master by this push:
new 69fe1f04e5 document virtualColumns in native query documentation, fix
some redirects (#12917)
69fe1f04e5 is described below
commit 69fe1f04e5657139b2d0e22d085df089b27fa788
Author: Clint Wylie <[email protected]>
AuthorDate: Thu Aug 18 20:49:23 2022 -0700
document virtualColumns in native query documentation, fix some redirects
(#12917)
* document virtualColumns in native query documentation, fix some redirects
* after all that, forgot to run spellcheck locally
* review stuff
---
docs/querying/groupbyquery.md | 1 +
docs/querying/searchquery.md | 1 +
docs/querying/timeseriesquery.md | 1 +
docs/querying/topnquery.md | 1 +
website/.spelling | 1 +
website/i18n/en.json | 94 +++++++++++++++++++++++++++++++++++++---
website/redirects.json | 12 +++--
7 files changed, 98 insertions(+), 13 deletions(-)
diff --git a/docs/querying/groupbyquery.md b/docs/querying/groupbyquery.md
index 48bf3fb132..9c6d6c0acf 100644
--- a/docs/querying/groupbyquery.md
+++ b/docs/querying/groupbyquery.md
@@ -86,6 +86,7 @@ Following are main parts to a groupBy query:
|queryType|This String should always be "groupBy"; this is the first thing
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|
|dimensions|A JSON list of dimensions to do the groupBy over; or see
[DimensionSpec](../querying/dimensionspecs.md) for ways to extract dimensions.
|yes|
+|virtualColumns|A JSON list of [virtual columns](./virtual-columns.md). You
can reference the virtual columns in `dimensions`, `aggregations`, or
`postAggregations`.| no (default none)|
|limitSpec|See [LimitSpec](../querying/limitspec.md).|no|
|having|See [Having](../querying/having.md).|no|
|granularity|Defines the granularity of the query. See
[Granularities](../querying/granularities.md)|yes|
diff --git a/docs/querying/searchquery.md b/docs/querying/searchquery.md
index 895e455070..3ee13e78b1 100644
--- a/docs/querying/searchquery.md
+++ b/docs/querying/searchquery.md
@@ -62,6 +62,7 @@ There are several main parts to a search query:
|limit| Defines the maximum number per Historical process (parsed as int) of
search results to return. |no (default to 1000)|
|intervals|A JSON Object representing ISO-8601 Intervals. This defines the
time ranges to run the query over.|yes|
|searchDimensions|The dimensions to run the search over. Excluding this means
the search is run over all dimensions.|no|
+|virtualColumns|A JSON list of [virtual columns](./virtual-columns.md)
available to use in `searchDimensions`.| no (default none)|
|query|See [SearchQuerySpec](#searchqueryspec).|yes|
|sort|An object specifying how the results of the search should be
sorted.<br/>Possible types are "lexicographic" (the default sort),
"alphanumeric", "strlen", and "numeric".<br/>See [Sorting
Orders](./sorting-orders.md) for more details.|no|
|context|See [Context](../querying/query-context.md)|no|
diff --git a/docs/querying/timeseriesquery.md b/docs/querying/timeseriesquery.md
index 48f512a8e0..1de8d901de 100644
--- a/docs/querying/timeseriesquery.md
+++ b/docs/querying/timeseriesquery.md
@@ -78,6 +78,7 @@ There are 7 main parts to a timeseries query:
|intervals|A JSON Object representing ISO-8601 Intervals. This defines the
time ranges to run the query over.|yes|
|granularity|Defines the granularity to bucket query results. See
[Granularities](../querying/granularities.md)|yes|
|filter|See [Filters](../querying/filters.md)|no|
+|virtualColumns|A JSON list of [virtual columns](./virtual-columns.md). You
can reference the virtual columns in `aggregations` or `postAggregations`.| no
(default none)|
|aggregations|See [Aggregations](../querying/aggregations.md)|no|
|postAggregations|See [Post Aggregations](../querying/post-aggregations.md)|no|
|limit|An integer that limits the number of results. The default is
unlimited.|no|
diff --git a/docs/querying/topnquery.md b/docs/querying/topnquery.md
index 8de7f46f96..775d34af3a 100644
--- a/docs/querying/topnquery.md
+++ b/docs/querying/topnquery.md
@@ -103,6 +103,7 @@ There are 11 parts to a topN query.
|intervals|A JSON Object representing ISO-8601 Intervals. This defines the
time ranges to run the query over.|yes|
|granularity|Defines the granularity to bucket query results. See
[Granularities](../querying/granularities.md)|yes|
|filter|See [Filters](../querying/filters.md)|no|
+|virtualColumns|A JSON list of [virtual columns](./virtual-columns.md). You
can reference a virtual column as the grouping `dimension` or as an input in
`aggregations` or `postAggregations`.| no (default none)|
|aggregations|See [Aggregations](../querying/aggregations.md)|for numeric
metricSpec, aggregations or postAggregations should be specified. Otherwise no.|
|postAggregations|See [Post
Aggregations](../querying/post-aggregations.md)|for numeric metricSpec,
aggregations or postAggregations should be specified. Otherwise no.|
|dimension|A String or JSON object defining the dimension that you want the
top taken for. For more info, see
[DimensionSpecs](../querying/dimensionspecs.md)|yes|
diff --git a/website/.spelling b/website/.spelling
index ad1ccc318b..f37e44cc8c 100644
--- a/website/.spelling
+++ b/website/.spelling
@@ -469,6 +469,7 @@ vectorizable
vectorize
vectorizeVirtualColumns
versioning
+virtualColumns
w.r.t.
whitelist
whitelisted
diff --git a/website/i18n/en.json b/website/i18n/en.json
index 821796a5db..2a8fa02823 100644
--- a/website/i18n/en.json
+++ b/website/i18n/en.json
@@ -214,7 +214,15 @@
},
"development/extensions-core/kafka-ingestion": {
"title": "Apache Kafka ingestion",
- "sidebar_label": "Apache Kafka"
+ "sidebar_label": "Apache Kafka ingestion"
+ },
+ "development/extensions-core/kafka-supervisor-operations": {
+ "title": "Apache Kafka supervisor operations reference",
+ "sidebar_label": "Apache Kafka operations"
+ },
+ "development/extensions-core/kafka-supervisor-reference": {
+ "title": "Apache Kafka supervisor reference",
+ "sidebar_label": "Apache Kafka supervisor"
},
"development/extensions-core/kinesis-ingestion": {
"title": "Amazon Kinesis ingestion",
@@ -273,6 +281,9 @@
"development/versioning": {
"title": "Versioning"
},
+ "ingestion/automatic-compaction": {
+ "title": "Automatic compaction"
+ },
"ingestion/compaction": {
"title": "Compaction"
},
@@ -301,6 +312,18 @@
"title": "Ingestion spec reference",
"sidebar_label": "Ingestion spec"
},
+ "ingestion/native-batch-firehose": {
+ "title": "Native batch ingestion with firehose",
+ "sidebar_label": "Firehose"
+ },
+ "ingestion/native-batch-input-sources": {
+ "title": "Native batch input sources",
+ "sidebar_label": "Input sources"
+ },
+ "ingestion/native-batch-simple-task": {
+ "title": "Native batch simple task indexing",
+ "sidebar_label": "Simple task indexing"
+ },
"ingestion/native-batch": {
"title": "Native batch ingestion",
"sidebar_label": "Native batch"
@@ -351,7 +374,7 @@
"title": "Deep storage migration"
},
"operations/druid-console": {
- "title": "Web console"
+ "title": "Druid console"
},
"operations/dump-segment": {
"title": "dump-segment tool"
@@ -374,6 +397,9 @@
"operations/insert-segment-to-db": {
"title": "insert-segment-to-db tool"
},
+ "operations/java": {
+ "title": "Java runtime"
+ },
"operations/kubernetes": {
"title": "kubernetes"
},
@@ -386,6 +412,10 @@
"operations/metrics": {
"title": "Metrics"
},
+ "operations/mixed-workloads": {
+ "title": "Configure Druid for mixed workloads",
+ "sidebar_label": "Mixed workloads"
+ },
"operations/other-hadoop": {
"title": "Working with different versions of Apache Hadoop"
},
@@ -395,6 +425,10 @@
"operations/pull-deps": {
"title": "pull-deps tool"
},
+ "operations/request-logging": {
+ "title": "Request logging",
+ "sidebar_label": "Request logging"
+ },
"operations/reset-cluster": {
"title": "reset-cluster tool"
},
@@ -411,7 +445,7 @@
"title": "User authentication and authorization"
},
"operations/segment-optimization": {
- "title": "Segment Size Optimization"
+ "title": "Segment size optimization"
},
"operations/single-server": {
"title": "Single server deployment"
@@ -478,7 +512,7 @@
},
"querying/query-context": {
"title": "Query context",
- "sidebar_label": "Context parameters"
+ "sidebar_label": "Query context"
},
"querying/query-execution": {
"title": "Query execution"
@@ -505,9 +539,53 @@
"querying/sorting-orders": {
"title": "String comparators"
},
+ "querying/sql-aggregations": {
+ "title": "SQL aggregation functions",
+ "sidebar_label": "Aggregation functions"
+ },
+ "querying/sql-api": {
+ "title": "Druid SQL API",
+ "sidebar_label": "Druid SQL API"
+ },
+ "querying/sql-data-types": {
+ "title": "SQL data types",
+ "sidebar_label": "SQL data types"
+ },
+ "querying/sql-functions": {
+ "title": "All Druid SQL functions",
+ "sidebar_label": "All functions"
+ },
+ "querying/sql-jdbc": {
+ "title": "SQL JDBC driver API",
+ "sidebar_label": "JDBC driver API"
+ },
+ "querying/sql-metadata-tables": {
+ "title": "SQL metadata tables",
+ "sidebar_label": "SQL metadata tables"
+ },
+ "querying/sql-multivalue-string-functions": {
+ "title": "SQL multi-value string functions",
+ "sidebar_label": "Multi-value string functions"
+ },
+ "querying/sql-operators": {
+ "title": "Druid SQL Operators",
+ "sidebar_label": "Operators"
+ },
+ "querying/sql-query-context": {
+ "title": "SQL query context",
+ "sidebar_label": "SQL query context"
+ },
+ "querying/sql-scalar": {
+ "title": "SQL scalar functions",
+ "sidebar_label": "Scalar functions"
+ },
+ "querying/sql-translation": {
+ "title": "SQL query translation",
+ "sidebar_label": "SQL query translation"
+ },
"querying/sql": {
- "title": "SQL",
- "sidebar_label": "Druid SQL"
+ "title": "Druid SQL overview",
+ "sidebar_label": "Overview and syntax"
},
"querying/timeboundaryquery": {
"title": "TimeBoundary queries",
@@ -524,6 +602,10 @@
"title": "TopN queries",
"sidebar_label": "TopN"
},
+ "querying/troubleshooting": {
+ "title": "Troubleshooting query execution in Druid",
+ "sidebar_label": "Troubleshooting"
+ },
"querying/using-caching": {
"title": "Using query caching"
},
diff --git a/website/redirects.json b/website/redirects.json
index 6435eab6d2..d1f4bd94a4 100644
--- a/website/redirects.json
+++ b/website/redirects.json
@@ -32,7 +32,7 @@
{"source": "Evaluate.html", "target": "tutorials/cluster.html"}
{"source": "Examples.html", "target": "tutorials/index.html"}
{"source": "Filters.html", "target": "querying/filters.html"}
-{"source": "Firehose.html", "target":
"ingestion/native-batch.html#firehoses-deprecated"}
+{"source": "Firehose.html", "target": "ingestion/native-batch-firehose.html"}
{"source": "GeographicQueries.html", "target": "development/geo.html"}
{"source": "Granularities.html", "target": "querying/granularities.html"}
{"source": "GroupByQuery.html", "target": "querying/groupbyquery.html"}
@@ -157,12 +157,10 @@
{"source": "index.html", "target": "design/index.html"}
{"source": "ingestion/batch-ingestion.html", "target": "index.html#batch"}
{"source": "ingestion/command-line-hadoop-indexer.html", "target":
"hadoop.html#cli"}
-{"source": "ingestion/compaction.html", "target":
"data-management.html#compact"}
{"source": "ingestion/delete-data.html", "target":
"data-management.html#delete"}
-{"source": "ingestion/firehose.html", "target":
"native-batch.html#firehoses-deprecated"}
-{"source": "ingestion/flatten-json.html", "target": "index.html#flattenspec"}
+{"source": "ingestion/firehose.html", "target": "native-batch-firehose.html"}
+{"source": "ingestion/flatten-json.html", "target":
"ingestion-spec.html#flattenspec"}
{"source": "ingestion/hadoop-vs-native-batch.html", "target":
"index.html#batch"}
-{"source": "ingestion/ingestion-spec.html", "target": "index.html#spec"}
{"source": "ingestion/ingestion.html", "target": "index.html"}
{"source": "ingestion/locking-and-priority.html", "target": "tasks.html#locks"}
{"source": "ingestion/misc-tasks.html", "target": "tasks.html#all-task-types"}
@@ -171,11 +169,11 @@
{"source": "ingestion/overview.html", "target": "index.html"}
{"source": "ingestion/realtime-ingestion.html", "target": "index.html"}
{"source": "ingestion/reports.html", "target": "tasks.html#reports"}
-{"source": "ingestion/schema-changes.html", "target":
"data-management.html#schema-changes"}
+{"source": "ingestion/schema-changes.html", "target":
"design/segments.html#segments-with-different-schemas"}
{"source": "ingestion/stream-ingestion.html", "target": "index.html#streaming"}
{"source": "ingestion/stream-pull.html", "target":
"../ingestion/standalone-realtime.html"}
{"source": "ingestion/stream-push.html", "target": "tranquility.html"}
-{"source": "ingestion/transform-spec.html", "target":
"index.html#transformspec"}
+{"source": "ingestion/transform-spec.html", "target":
"ingestion-spec.html#transformspec"}
{"source": "ingestion/update-existing-data.html", "target":
"data-management.html#update"}
{"source": "misc/cluster-setup.html", "target": "../tutorials/cluster.html"}
{"source": "misc/evaluate.html", "target": "../tutorials/cluster.html"}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
