| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta name="description" content="Apache Druid"> |
| <meta name="keywords" content="druid,kafka,database,analytics,streaming,real-time,real time,apache,open source"> |
| <meta name="author" content="Apache Software Foundation"> |
| |
| <title>Druid | Timeseries queries</title> |
| |
| <link rel="alternate" type="application/atom+xml" href="/feed"> |
| <link rel="shortcut icon" href="/img/favicon.png"> |
| |
| <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css" integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous"> |
| |
| <link href='//fonts.googleapis.com/css?family=Open+Sans+Condensed:300,700,300italic|Open+Sans:300italic,400italic,600italic,400,300,600,700' rel='stylesheet' type='text/css'> |
| |
| <link rel="stylesheet" href="/css/bootstrap-pure.css?v=1.1"> |
| <link rel="stylesheet" href="/css/base.css?v=1.1"> |
| <link rel="stylesheet" href="/css/header.css?v=1.1"> |
| <link rel="stylesheet" href="/css/footer.css?v=1.1"> |
| <link rel="stylesheet" href="/css/syntax.css?v=1.1"> |
| <link rel="stylesheet" href="/css/docs.css?v=1.1"> |
| |
| <script> |
| (function() { |
| var cx = '000162378814775985090:molvbm0vggm'; |
| var gcse = document.createElement('script'); |
| gcse.type = 'text/javascript'; |
| gcse.async = true; |
| gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + |
| '//cse.google.com/cse.js?cx=' + cx; |
| var s = document.getElementsByTagName('script')[0]; |
| s.parentNode.insertBefore(gcse, s); |
| })(); |
| </script> |
| |
| |
| </head> |
| |
| <body> |
| <!-- Start page_header include --> |
| <script src="//ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script> |
| |
| <div class="top-navigator"> |
| <div class="container"> |
| <div class="left-cont"> |
| <a class="logo" href="/"><span class="druid-logo"></span></a> |
| </div> |
| <div class="right-cont"> |
| <ul class="links"> |
| <li class=""><a href="/technology">Technology</a></li> |
| <li class=""><a href="/use-cases">Use Cases</a></li> |
| <li class=""><a href="/druid-powered">Powered By</a></li> |
| <li class=""><a href="/docs/latest/design/">Docs</a></li> |
| <li class=""><a href="/community/">Community</a></li> |
| <li class="header-dropdown"> |
| <a>Apache</a> |
| <div class="header-dropdown-menu"> |
| <a href="https://www.apache.org/" target="_blank">Foundation</a> |
| <a href="https://www.apache.org/events/current-event" target="_blank">Events</a> |
| <a href="https://www.apache.org/licenses/" target="_blank">License</a> |
| <a href="https://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a> |
| <a href="https://www.apache.org/security/" target="_blank">Security</a> |
| <a href="https://www.apache.org/foundation/sponsorship.html" target="_blank">Sponsorship</a> |
| </div> |
| </li> |
| <li class=" button-link"><a href="/downloads.html">Download</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="action-button menu-icon"> |
| <span class="fa fa-bars"></span> MENU |
| </div> |
| <div class="action-button menu-icon-close"> |
| <span class="fa fa-times"></span> MENU |
| </div> |
| </div> |
| |
| <script type="text/javascript"> |
| var $menu = $('.right-cont'); |
| var $menuIcon = $('.menu-icon'); |
| var $menuIconClose = $('.menu-icon-close'); |
| |
| function showMenu() { |
| $menu.fadeIn(100); |
| $menuIcon.fadeOut(100); |
| $menuIconClose.fadeIn(100); |
| } |
| |
| $menuIcon.click(showMenu); |
| |
| function hideMenu() { |
| $menu.fadeOut(100); |
| $menuIconClose.fadeOut(100); |
| $menuIcon.fadeIn(100); |
| } |
| |
| $menuIconClose.click(hideMenu); |
| |
| $(window).resize(function() { |
| if ($(window).width() >= 840) { |
| $menu.fadeIn(100); |
| $menuIcon.fadeOut(100); |
| $menuIconClose.fadeOut(100); |
| } |
| else { |
| $menu.fadeOut(100); |
| $menuIcon.fadeIn(100); |
| $menuIconClose.fadeOut(100); |
| } |
| }); |
| </script> |
| |
| <!-- Stop page_header include --> |
| |
| |
| <div class="container doc-container"> |
| |
| |
| |
| |
| <p> Looking for the <a href="/docs/0.22.1/">latest stable documentation</a>?</p> |
| |
| |
| <div class="row"> |
| <div class="col-md-9 doc-content"> |
| <p> |
| <a class="btn btn-default btn-xs visible-xs-inline-block visible-sm-inline-block" href="#toc">Table of Contents</a> |
| </p> |
| <!-- |
| ~ 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. |
| --> |
| |
| <h1 id="timeseries-queries">Timeseries queries</h1> |
| |
| <p>These types of queries take a timeseries query object and return an array of JSON objects where each object represents a value asked for by the timeseries query.</p> |
| |
| <p>An example timeseries query object is shown below:</p> |
| <div class="highlight"><pre><code class="language-json" data-lang="json"><span></span><span class="p">{</span> |
| <span class="nt">"queryType"</span><span class="p">:</span> <span class="s2">"timeseries"</span><span class="p">,</span> |
| <span class="nt">"dataSource"</span><span class="p">:</span> <span class="s2">"sample_datasource"</span><span class="p">,</span> |
| <span class="nt">"granularity"</span><span class="p">:</span> <span class="s2">"day"</span><span class="p">,</span> |
| <span class="nt">"descending"</span><span class="p">:</span> <span class="s2">"true"</span><span class="p">,</span> |
| <span class="nt">"filter"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"and"</span><span class="p">,</span> |
| <span class="nt">"fields"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"selector"</span><span class="p">,</span> <span class="nt">"dimension"</span><span class="p">:</span> <span class="s2">"sample_dimension1"</span><span class="p">,</span> <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"sample_value1"</span> <span class="p">},</span> |
| <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"or"</span><span class="p">,</span> |
| <span class="nt">"fields"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"selector"</span><span class="p">,</span> <span class="nt">"dimension"</span><span class="p">:</span> <span class="s2">"sample_dimension2"</span><span class="p">,</span> <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"sample_value2"</span> <span class="p">},</span> |
| <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"selector"</span><span class="p">,</span> <span class="nt">"dimension"</span><span class="p">:</span> <span class="s2">"sample_dimension3"</span><span class="p">,</span> <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"sample_value3"</span> <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">},</span> |
| <span class="nt">"aggregations"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"longSum"</span><span class="p">,</span> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"sample_name1"</span><span class="p">,</span> <span class="nt">"fieldName"</span><span class="p">:</span> <span class="s2">"sample_fieldName1"</span> <span class="p">},</span> |
| <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"doubleSum"</span><span class="p">,</span> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"sample_name2"</span><span class="p">,</span> <span class="nt">"fieldName"</span><span class="p">:</span> <span class="s2">"sample_fieldName2"</span> <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="nt">"postAggregations"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"arithmetic"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"sample_divide"</span><span class="p">,</span> |
| <span class="nt">"fn"</span><span class="p">:</span> <span class="s2">"/"</span><span class="p">,</span> |
| <span class="nt">"fields"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"fieldAccess"</span><span class="p">,</span> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"postAgg__sample_name1"</span><span class="p">,</span> <span class="nt">"fieldName"</span><span class="p">:</span> <span class="s2">"sample_name1"</span> <span class="p">},</span> |
| <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"fieldAccess"</span><span class="p">,</span> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"postAgg__sample_name2"</span><span class="p">,</span> <span class="nt">"fieldName"</span><span class="p">:</span> <span class="s2">"sample_name2"</span> <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="nt">"intervals"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"2012-01-01T00:00:00.000/2012-01-03T00:00:00.000"</span> <span class="p">]</span> |
| <span class="p">}</span> |
| </code></pre></div> |
| <p>There are 7 main parts to a timeseries query:</p> |
| |
| <table><thead> |
| <tr> |
| <th>property</th> |
| <th>description</th> |
| <th>required?</th> |
| </tr> |
| </thead><tbody> |
| <tr> |
| <td>queryType</td> |
| <td>This String should always be "timeseries"; this is the first thing Apache Druid (incubating) looks at to figure out how to interpret the query</td> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <td>dataSource</td> |
| <td>A String or Object defining the data source to query, very similar to a table in a relational database. See <a href="../querying/datasource.html">DataSource</a> for more information.</td> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <td>descending</td> |
| <td>Whether to make descending ordered result. Default is <code>false</code>(ascending).</td> |
| <td>no</td> |
| </tr> |
| <tr> |
| <td>intervals</td> |
| <td>A JSON Object representing ISO-8601 Intervals. This defines the time ranges to run the query over.</td> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <td>granularity</td> |
| <td>Defines the granularity to bucket query results. See <a href="../querying/granularities.html">Granularities</a></td> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <td>filter</td> |
| <td>See <a href="../querying/filters.html">Filters</a></td> |
| <td>no</td> |
| </tr> |
| <tr> |
| <td>aggregations</td> |
| <td>See <a href="../querying/aggregations.html">Aggregations</a></td> |
| <td>no</td> |
| </tr> |
| <tr> |
| <td>postAggregations</td> |
| <td>See <a href="../querying/post-aggregations.html">Post Aggregations</a></td> |
| <td>no</td> |
| </tr> |
| <tr> |
| <td>context</td> |
| <td>Can be used to modify query behavior, including <a href="#grand-totals">grand totals</a> and <a href="#zero-filling">zero-filling</a>. See also <a href="../querying/query-context.html">Context</a> for parameters that apply to all query types.</td> |
| <td>no</td> |
| </tr> |
| </tbody></table> |
| |
| <p>To pull it all together, the above query would return 2 data points, one for each day between 2012-01-01 and 2012-01-03, from the "sample_datasource" table. Each data point would be the (long) sum of sample_fieldName1, the (double) sum of sample_fieldName2 and the (double) result of sample_fieldName1 divided by sample_fieldName2 for the filter set. The output looks like this:</p> |
| <div class="highlight"><pre><code class="language-json" data-lang="json"><span></span><span class="p">[</span> |
| <span class="p">{</span> |
| <span class="nt">"timestamp"</span><span class="p">:</span> <span class="s2">"2012-01-01T00:00:00.000Z"</span><span class="p">,</span> |
| <span class="nt">"result"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"sample_name1"</span><span class="p">:</span> <span class="err"><some_value></span><span class="p">,</span> <span class="nt">"sample_name2"</span><span class="p">:</span> <span class="err"><some_value></span><span class="p">,</span> <span class="nt">"sample_divide"</span><span class="p">:</span> <span class="err"><some_value></span> <span class="p">}</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"timestamp"</span><span class="p">:</span> <span class="s2">"2012-01-02T00:00:00.000Z"</span><span class="p">,</span> |
| <span class="nt">"result"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"sample_name1"</span><span class="p">:</span> <span class="err"><some_value></span><span class="p">,</span> <span class="nt">"sample_name2"</span><span class="p">:</span> <span class="err"><some_value></span><span class="p">,</span> <span class="nt">"sample_divide"</span><span class="p">:</span> <span class="err"><some_value></span> <span class="p">}</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| </code></pre></div> |
| <h4 id="grand-totals">Grand totals</h4> |
| |
| <p>Druid can include an extra "grand totals" row as the last row of a timeseries result set. To enable this, add |
| <code>"grandTotal" : true</code> to your query context. For example:</p> |
| <div class="highlight"><pre><code class="language-json" data-lang="json"><span></span><span class="p">{</span> |
| <span class="nt">"queryType"</span><span class="p">:</span> <span class="s2">"timeseries"</span><span class="p">,</span> |
| <span class="nt">"dataSource"</span><span class="p">:</span> <span class="s2">"sample_datasource"</span><span class="p">,</span> |
| <span class="nt">"intervals"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"2012-01-01T00:00:00.000/2012-01-03T00:00:00.000"</span> <span class="p">],</span> |
| <span class="nt">"granularity"</span><span class="p">:</span> <span class="s2">"day"</span><span class="p">,</span> |
| <span class="nt">"aggregations"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"longSum"</span><span class="p">,</span> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"sample_name1"</span><span class="p">,</span> <span class="nt">"fieldName"</span><span class="p">:</span> <span class="s2">"sample_fieldName1"</span> <span class="p">},</span> |
| <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"doubleSum"</span><span class="p">,</span> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"sample_name2"</span><span class="p">,</span> <span class="nt">"fieldName"</span><span class="p">:</span> <span class="s2">"sample_fieldName2"</span> <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="nt">"context"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"grandTotal"</span><span class="p">:</span> <span class="kc">true</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </code></pre></div> |
| <p>The grand totals row will appear as the last row in the result array, and will have no timestamp. It will be the last |
| row even if the query is run in "descending" mode. Post-aggregations in the grand totals row will be computed based |
| upon the grand total aggregations.</p> |
| |
| <h4 id="zero-filling">Zero-filling</h4> |
| |
| <p>Timeseries queries normally fill empty interior time buckets with zeroes. For example, if you issue a "day" granularity |
| timeseries query for the interval 2012-01-01/2012-01-04, and no data exists for 2012-01-02, you will receive:</p> |
| <div class="highlight"><pre><code class="language-json" data-lang="json"><span></span><span class="p">[</span> |
| <span class="p">{</span> |
| <span class="nt">"timestamp"</span><span class="p">:</span> <span class="s2">"2012-01-01T00:00:00.000Z"</span><span class="p">,</span> |
| <span class="nt">"result"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"sample_name1"</span><span class="p">:</span> <span class="err"><some_value></span> <span class="p">}</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"timestamp"</span><span class="p">:</span> <span class="s2">"2012-01-02T00:00:00.000Z"</span><span class="p">,</span> |
| <span class="nt">"result"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"sample_name1"</span><span class="p">:</span> <span class="mi">0</span> <span class="p">}</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"timestamp"</span><span class="p">:</span> <span class="s2">"2012-01-03T00:00:00.000Z"</span><span class="p">,</span> |
| <span class="nt">"result"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"sample_name1"</span><span class="p">:</span> <span class="err"><some_value></span> <span class="p">}</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| </code></pre></div> |
| <p>Time buckets that lie completely outside the data interval are not zero-filled.</p> |
| |
| <p>You can disable all zero-filling with the context flag "skipEmptyBuckets". In this mode, the data point for 2012-01-02 |
| would be omitted from the results.</p> |
| |
| <p>A query with this context flag set would look like:</p> |
| <div class="highlight"><pre><code class="language-json" data-lang="json"><span></span><span class="p">{</span> |
| <span class="nt">"queryType"</span><span class="p">:</span> <span class="s2">"timeseries"</span><span class="p">,</span> |
| <span class="nt">"dataSource"</span><span class="p">:</span> <span class="s2">"sample_datasource"</span><span class="p">,</span> |
| <span class="nt">"granularity"</span><span class="p">:</span> <span class="s2">"day"</span><span class="p">,</span> |
| <span class="nt">"aggregations"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"longSum"</span><span class="p">,</span> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"sample_name1"</span><span class="p">,</span> <span class="nt">"fieldName"</span><span class="p">:</span> <span class="s2">"sample_fieldName1"</span> <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="nt">"intervals"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"2012-01-01T00:00:00.000/2012-01-04T00:00:00.000"</span> <span class="p">],</span> |
| <span class="nt">"context"</span> <span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"skipEmptyBuckets"</span><span class="p">:</span> <span class="s2">"true"</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </code></pre></div> |
| </div> |
| <div class="col-md-3"> |
| <div class="searchbox"> |
| <gcse:searchbox-only></gcse:searchbox-only> |
| </div> |
| <div id="toc" class="nav toc hidden-print"> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <!-- Start page_footer include --> |
| <footer class="druid-footer"> |
| <div class="container"> |
| <div class="text-center"> |
| <p> |
| <a href="/technology">Technology</a> ·  |
| <a href="/use-cases">Use Cases</a> ·  |
| <a href="/druid-powered">Powered by Druid</a> ·  |
| <a href="/docs/latest/">Docs</a> ·  |
| <a href="/community/">Community</a> ·  |
| <a href="/downloads.html">Download</a> ·  |
| <a href="/faq">FAQ</a> |
| </p> |
| </div> |
| <div class="text-center"> |
| <a title="Join the user group" href="https://groups.google.com/forum/#!forum/druid-user" target="_blank"><span class="fa fa-comments"></span></a> ·  |
| <a title="Follow Druid" href="https://twitter.com/druidio" target="_blank"><span class="fab fa-twitter"></span></a> ·  |
| <a title="GitHub" href="https://github.com/apache/druid" target="_blank"><span class="fab fa-github"></span></a> |
| </div> |
| <div class="text-center license"> |
| Copyright © 2020 <a href="https://www.apache.org/" target="_blank">Apache Software Foundation</a>.<br> |
| Except where otherwise noted, licensed under <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a>.<br> |
| Apache Druid, Druid, and the Druid logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries. |
| </div> |
| </div> |
| </footer> |
| |
| <script async src="https://www.googletagmanager.com/gtag/js?id=UA-131010415-1"></script> |
| <script> |
| window.dataLayer = window.dataLayer || []; |
| function gtag(){dataLayer.push(arguments);} |
| gtag('js', new Date()); |
| gtag('config', 'UA-131010415-1'); |
| </script> |
| <script> |
| function trackDownload(type, url) { |
| ga('send', 'event', 'download', type, url); |
| } |
| </script> |
| <script src="//code.jquery.com/jquery.min.js"></script> |
| <script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script> |
| <script src="/assets/js/druid.js"></script> |
| <!-- stop page_footer include --> |
| |
| |
| <script> |
| $(function() { |
| $(".toc").load("/docs/0.15.1-incubating/toc.html"); |
| |
| // There is no way to tell when .gsc-input will be async loaded into the page so just try to set a placeholder until it works |
| var tries = 0; |
| var timer = setInterval(function() { |
| tries++; |
| if (tries > 300) clearInterval(timer); |
| var searchInput = $('input.gsc-input'); |
| if (searchInput.length) { |
| searchInput.attr('placeholder', 'Search'); |
| clearInterval(timer); |
| } |
| }, 100); |
| }); |
| </script> |
| </body> |
| </html> |