mirror of https://github.com/apache/druid.git
87 lines
3.1 KiB
Markdown
87 lines
3.1 KiB
Markdown
---
|
|
id: topnmetricspec
|
|
title: "TopNMetricSpec"
|
|
---
|
|
|
|
<!--
|
|
~ 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.
|
|
-->
|
|
|
|
|
|
In Apache Druid (incubating), the topN metric spec specifies how topN values should be sorted.
|
|
|
|
## Numeric TopNMetricSpec
|
|
|
|
The simplest metric specification is a String value indicating the metric to sort topN results by. They are included in a topN query with:
|
|
|
|
```json
|
|
"metric": "<metric_name>"
|
|
```
|
|
|
|
The metric field can also be given as a JSON object. The grammar for dimension values sorted by numeric value is shown below:
|
|
|
|
```json
|
|
"metric": {
|
|
"type": "numeric",
|
|
"metric": "<metric_name>"
|
|
}
|
|
```
|
|
|
|
|property|description|required?|
|
|
|--------|-----------|---------|
|
|
|type|this indicates a numeric sort|yes|
|
|
|metric|the actual metric field in which results will be sorted by|yes|
|
|
|
|
## Dimension TopNMetricSpec
|
|
|
|
This metric specification sorts TopN results by dimension value, using one of the sorting orders described here: [Sorting Orders](./sorting-orders.md)
|
|
|
|
|property|type|description|required?|
|
|
|--------|----|-----------|---------|
|
|
|type|String|this indicates a sort a dimension's values|yes, must be 'dimension'|
|
|
|ordering|String|Specifies the sorting order. Can be one of the following values: "lexicographic", "alphanumeric", "numeric", "strlen". See [Sorting Orders](./sorting-orders.md) for more details.|no, default: "lexicographic"|
|
|
|previousStop|String|the starting point of the sort. For example, if a previousStop value is 'b', all values before 'b' are discarded. This field can be used to paginate through all the dimension values.|no|
|
|
|
|
The following metricSpec uses lexicographic sorting.
|
|
|
|
```json
|
|
"metric": {
|
|
"type": "dimension",
|
|
"ordering": "lexicographic",
|
|
"previousStop": "<previousStop_value>"
|
|
}
|
|
```
|
|
|
|
Note that in earlier versions of Druid, the functionality provided by the DimensionTopNMetricSpec was handled by two separate spec types, Lexicographic and Alphanumeric (when only two sorting orders were supported). These spec types have been deprecated but are still usable.
|
|
|
|
## Inverted TopNMetricSpec
|
|
|
|
Sort dimension values in inverted order, i.e inverts the order of the delegate metric spec. It can be used to sort the values in ascending order.
|
|
|
|
```json
|
|
"metric": {
|
|
"type": "inverted",
|
|
"metric": <delegate_top_n_metric_spec>
|
|
}
|
|
```
|
|
|
|
|property|description|required?|
|
|
|--------|-----------|---------|
|
|
|type|this indicates an inverted sort|yes|
|
|
|metric|the delegate metric spec. |yes|
|