blob: 0e44e9e6ca9e6d5f3f551ac3436f3bbcc595c7a2 [file] [log] [blame]
"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[3920],{28453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>d});var r=n(96540);const i={},s=r.createContext(i);function a(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),r.createElement(s.Provider,{value:t},e.children)}},78374:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>d,default:()=>u,frontMatter:()=>a,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"querying/timeboundaryquery","title":"TimeBoundary queries","description":"\x3c!--","source":"@site/docs/33.0.0/querying/timeboundaryquery.md","sourceDirName":"querying","slug":"/querying/timeboundaryquery","permalink":"/docs/33.0.0/querying/timeboundaryquery","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"id":"timeboundaryquery","title":"TimeBoundary queries","sidebar_label":"TimeBoundary"},"sidebar":"docs","previous":{"title":"Search","permalink":"/docs/33.0.0/querying/searchquery"},"next":{"title":"SegmentMetadata","permalink":"/docs/33.0.0/querying/segmentmetadataquery"}}');var i=n(74848),s=n(28453);const a={id:"timeboundaryquery",title:"TimeBoundary queries",sidebar_label:"TimeBoundary"},d=void 0,o={},c=[];function l(e){const t={a:"a",admonition:"admonition",code:"code",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.admonition,{type:"info",children:(0,i.jsxs)(t.p,{children:["Apache Druid supports two query languages: ",(0,i.jsx)(t.a,{href:"/docs/33.0.0/querying/sql",children:"Druid SQL"})," and ",(0,i.jsx)(t.a,{href:"/docs/33.0.0/querying/",children:"native queries"}),".\nThis document describes a query\ntype that is only available in the native language."]})}),"\n",(0,i.jsx)(t.p,{children:"Time boundary queries return the earliest and latest data points of a data set. The grammar is:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-json",children:'{\n "queryType" : "timeBoundary",\n "dataSource": "sample_datasource",\n "bound" : < "maxTime" | "minTime" > # optional, defaults to returning both timestamps if not set\n "filter" : { "type": "and", "fields": [<filter>, <filter>, ...] } # optional\n}\n'})}),"\n",(0,i.jsx)(t.p,{children:"There are 3 main parts to a time boundary query:"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"property"}),(0,i.jsx)(t.th,{children:"description"}),(0,i.jsx)(t.th,{children:"required?"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"queryType"}),(0,i.jsx)(t.td,{children:'This String should always be "timeBoundary"; this is the first thing Apache Druid looks at to figure out how to interpret the query'}),(0,i.jsx)(t.td,{children:"yes"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"dataSource"}),(0,i.jsxs)(t.td,{children:["A String or Object defining the data source to query, very similar to a table in a relational database. See ",(0,i.jsx)(t.a,{href:"/docs/33.0.0/querying/datasource",children:"DataSource"})," for more information."]}),(0,i.jsx)(t.td,{children:"yes"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"bound"}),(0,i.jsxs)(t.td,{children:["Optional, set to ",(0,i.jsx)(t.code,{children:"maxTime"})," or ",(0,i.jsx)(t.code,{children:"minTime"})," to return only the latest or earliest timestamp. Default to returning both if not set"]}),(0,i.jsx)(t.td,{children:"no"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"filter"}),(0,i.jsxs)(t.td,{children:["See ",(0,i.jsx)(t.a,{href:"/docs/33.0.0/querying/filters",children:"Filters"})]}),(0,i.jsx)(t.td,{children:"no"})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"context"}),(0,i.jsxs)(t.td,{children:["See ",(0,i.jsx)(t.a,{href:"/docs/33.0.0/querying/query-context",children:"Context"})]}),(0,i.jsx)(t.td,{children:"no"})]})]})]}),"\n",(0,i.jsx)(t.p,{children:"The format of the result is:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-json",children:'[ {\n "timestamp" : "2013-05-09T18:24:00.000Z",\n "result" : {\n "minTime" : "2013-05-09T18:24:00.000Z",\n "maxTime" : "2013-05-09T18:37:00.000Z"\n }\n} ]\n'})})]})}function u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}}}]);