"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[3834],{15680:(e,t,r)=>{r.d(t,{xA:()=>c,yg:()=>m});var n=r(96540);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function o(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},i=Object.keys(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),s=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},c=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},g="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),g=s(r),d=a,m=g["".concat(p,".").concat(d)]||g[d]||u[d]||i;return r?n.createElement(m,l(l({ref:t},c),{},{components:r})):n.createElement(m,l({ref:t},c))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=d;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[g]="string"==typeof e?e:a,l[1]=o;for(var s=2;s<i;s++)l[s]=r[s];return n.createElement.apply(null,l)}return n.createElement.apply(null,r)}d.displayName="MDXCreateElement"},89493:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>p,default:()=>m,frontMatter:()=>o,metadata:()=>s,toc:()=>g});var n=r(58168),a=r(98587),i=(r(96540),r(15680)),l=["components"],o={id:"topnmetricspec",title:"Sorting (topN)"},p=void 0,s={unversionedId:"querying/topnmetricspec",id:"querying/topnmetricspec",title:"Sorting (topN)",description:"\x3c!--",source:"@site/docs/latest/querying/topnmetricspec.md",sourceDirName:"querying",slug:"/querying/topnmetricspec",permalink:"/docs/latest/querying/topnmetricspec",draft:!1,tags:[],version:"current",frontMatter:{id:"topnmetricspec",title:"Sorting (topN)"},sidebar:"docs",previous:{title:"Sorting and limiting (groupBy)",permalink:"/docs/latest/querying/limitspec"},next:{title:"String comparators",permalink:"/docs/latest/querying/sorting-orders"}},c={},g=[{value:"Numeric TopNMetricSpec",id:"numeric-topnmetricspec",level:2},{value:"Dimension TopNMetricSpec",id:"dimension-topnmetricspec",level:2},{value:"Inverted TopNMetricSpec",id:"inverted-topnmetricspec",level:2}],u={toc:g},d="wrapper";function m(e){var t=e.components,r=(0,a.A)(e,l);return(0,i.yg)(d,(0,n.A)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,i.yg)("admonition",{type:"info"},(0,i.yg)("p",{parentName:"admonition"}," Apache Druid supports two query languages: ",(0,i.yg)("a",{parentName:"p",href:"/docs/latest/querying/sql"},"Druid SQL")," and ",(0,i.yg)("a",{parentName:"p",href:"/docs/latest/querying/"},"native queries"),".\nThis document describes the native\nlanguage. For information about sorting in SQL, refer to the ",(0,i.yg)("a",{parentName:"p",href:"/docs/latest/querying/sql#order-by"},"SQL documentation"),".")),(0,i.yg)("p",null,"In Apache Druid, the topN metric spec specifies how topN values should be sorted."),(0,i.yg)("h2",{id:"numeric-topnmetricspec"},"Numeric TopNMetricSpec"),(0,i.yg)("p",null,"The simplest metric specification is a String value indicating the metric to sort topN results by. They are included in a topN query with:"),(0,i.yg)("pre",null,(0,i.yg)("code",{parentName:"pre",className:"language-json"},'"metric": "<metric_name>"\n')),(0,i.yg)("p",null,"The metric field can also be given as a JSON object. The grammar for dimension values sorted by numeric value is shown below:"),(0,i.yg)("pre",null,(0,i.yg)("code",{parentName:"pre",className:"language-json"},'"metric": {\n    "type": "numeric",\n    "metric": "<metric_name>"\n}\n')),(0,i.yg)("table",null,(0,i.yg)("thead",{parentName:"table"},(0,i.yg)("tr",{parentName:"thead"},(0,i.yg)("th",{parentName:"tr",align:null},"property"),(0,i.yg)("th",{parentName:"tr",align:null},"description"),(0,i.yg)("th",{parentName:"tr",align:null},"required?"))),(0,i.yg)("tbody",{parentName:"table"},(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},"type"),(0,i.yg)("td",{parentName:"tr",align:null},"this indicates a numeric sort"),(0,i.yg)("td",{parentName:"tr",align:null},"yes")),(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},"metric"),(0,i.yg)("td",{parentName:"tr",align:null},"the actual metric field in which results will be sorted by"),(0,i.yg)("td",{parentName:"tr",align:null},"yes")))),(0,i.yg)("h2",{id:"dimension-topnmetricspec"},"Dimension TopNMetricSpec"),(0,i.yg)("p",null,"This metric specification sorts TopN results by dimension value, using one of the sorting orders described here: ",(0,i.yg)("a",{parentName:"p",href:"/docs/latest/querying/sorting-orders"},"Sorting Orders")),(0,i.yg)("table",null,(0,i.yg)("thead",{parentName:"table"},(0,i.yg)("tr",{parentName:"thead"},(0,i.yg)("th",{parentName:"tr",align:null},"property"),(0,i.yg)("th",{parentName:"tr",align:null},"type"),(0,i.yg)("th",{parentName:"tr",align:null},"description"),(0,i.yg)("th",{parentName:"tr",align:null},"required?"))),(0,i.yg)("tbody",{parentName:"table"},(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},"type"),(0,i.yg)("td",{parentName:"tr",align:null},"String"),(0,i.yg)("td",{parentName:"tr",align:null},"this indicates a sort a dimension's values"),(0,i.yg)("td",{parentName:"tr",align:null},"yes, must be 'dimension'")),(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},"ordering"),(0,i.yg)("td",{parentName:"tr",align:null},"String"),(0,i.yg)("td",{parentName:"tr",align:null},'Specifies the sorting order. Can be one of the following values: "lexicographic", "alphanumeric", "numeric", "strlen". See ',(0,i.yg)("a",{parentName:"td",href:"/docs/latest/querying/sorting-orders"},"Sorting Orders")," for more details."),(0,i.yg)("td",{parentName:"tr",align:null},'no, default: "lexicographic"')),(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},"previousStop"),(0,i.yg)("td",{parentName:"tr",align:null},"String"),(0,i.yg)("td",{parentName:"tr",align:null},"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."),(0,i.yg)("td",{parentName:"tr",align:null},"no")))),(0,i.yg)("p",null,"The following metricSpec uses lexicographic sorting."),(0,i.yg)("pre",null,(0,i.yg)("code",{parentName:"pre",className:"language-json"},'"metric": {\n    "type": "dimension",\n    "ordering": "lexicographic",\n    "previousStop": "<previousStop_value>"\n}\n')),(0,i.yg)("p",null,"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."),(0,i.yg)("h2",{id:"inverted-topnmetricspec"},"Inverted TopNMetricSpec"),(0,i.yg)("p",null,"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."),(0,i.yg)("pre",null,(0,i.yg)("code",{parentName:"pre",className:"language-json"},'"metric": {\n    "type": "inverted",\n    "metric": <delegate_top_n_metric_spec>\n}\n')),(0,i.yg)("table",null,(0,i.yg)("thead",{parentName:"table"},(0,i.yg)("tr",{parentName:"thead"},(0,i.yg)("th",{parentName:"tr",align:null},"property"),(0,i.yg)("th",{parentName:"tr",align:null},"description"),(0,i.yg)("th",{parentName:"tr",align:null},"required?"))),(0,i.yg)("tbody",{parentName:"table"},(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},"type"),(0,i.yg)("td",{parentName:"tr",align:null},"this indicates an inverted sort"),(0,i.yg)("td",{parentName:"tr",align:null},"yes")),(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},"metric"),(0,i.yg)("td",{parentName:"tr",align:null},"the delegate metric spec."),(0,i.yg)("td",{parentName:"tr",align:null},"yes")))))}m.isMDXComponent=!0}}]);