druid/timeboundaryquery.md at ec6c6e2d535ab84ea5441e752bd953887398cc88

mirror of https://github.com/apache/druid.git synced 2025-02-06 10:08:26 +00:00

* Refresh query docs.

Larger changes:

- New doc: querying/datasource.md describes the various kinds of
datasources you can use, and has examples for both SQL and native.
- New doc: querying/query-execution.md describes how native queries
are executed at a high level. It doesn't go into the details of specific
query engines or how queries run at a per-segment level. But I think it
would be good to add or link that content here in the future.
- Refreshed doc: querying/sql.md updated to refer to joins, reformatted
a bit, added a new "Query translation" section that explains how
queries are translated from SQL to native, and removed configuration
details (moved to configuration/index.md).
- Refreshed doc: querying/joins.md updated to refer to join datasources.

Smaller changes:

- Add helpful banners to the top of query documentation pages telling
people whether a given page describes SQL, native, or both.
- Add SQL metrics to operations/metrics.md.
- Add some color and cross-links in various places.
- Add native query component docs to the sidebar, and renamed them so
they look nicer.
- Remove Select query from the sidebar.
- Fix Broker SQL configs in configuration/index.md. Remove them from
querying/sql.md.
- Combined querying/searchquery.md and querying/searchqueryspec.md.

* Updates.

* Fix numbering.

* Fix glitches.

* Add new words to spellcheck file.

* Assorted changes.

* Further adjustments.

* Add missing punctuation.

2020-04-15 16:12:20 -07:00

2.3 KiB

Raw Blame History

id	title	sidebar_label
timeboundaryquery	TimeBoundary queries	TimeBoundary

Apache Druid supports two query languages: Druid SQL and native queries. This document describes a query type that is only available in the native language.

Time boundary queries return the earliest and latest data points of a data set. The grammar is:

{
    "queryType" : "timeBoundary",
    "dataSource": "sample_datasource",
    "bound"     : < "maxTime" | "minTime" > # optional, defaults to returning both timestamps if not set
    "filter"    : { "type": "and", "fields": [<filter>, <filter>, ...] } # optional
}

There are 3 main parts to a time boundary query:

property	description	required?
queryType	This String should always be "timeBoundary"; this is the first thing Apache 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 for more information.	yes
bound	Optional, set to `maxTime` or `minTime` to return only the latest or earliest timestamp. Default to returning both if not set	no
filter	See Filters	no
context	See Context	no

The format of the result is:

[ {
  "timestamp" : "2013-05-09T18:24:00.000Z",
  "result" : {
    "minTime" : "2013-05-09T18:24:00.000Z",
    "maxTime" : "2013-05-09T18:37:00.000Z"
  }
} ]

2.3 KiB Raw Blame History

2.3 KiB

Raw Blame History