Back to Druid

DatasourceMetadata queries

docs/querying/datasourcemetadataquery.md

latest2.2 KB
Original Source
<!-- ~ 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. -->

:::info 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. :::

Data Source Metadata queries return metadata information for a dataSource. These queries return information about:

  • maxIngestedEventTime: The timestamp of the latest ingested event for the dataSource. For realtime datasources, this may be later than MAX(__time) if queryGranularity is being used. For non-realtime datasources, this is equivalent to MAX(__time).

The grammar for these queries is:

json
{
    "queryType" : "dataSourceMetadata",
    "dataSource": "sample_datasource"
}

There are 2 main parts to a Data Source Metadata query:

propertydescriptionrequired?
queryTypeThis String should always be "dataSourceMetadata"; this is the first thing Apache Druid looks at to figure out how to interpret the queryyes
dataSourceA String or Object defining the data source to query, very similar to a table in a relational database. See DataSource for more information.yes
contextSee Query context referenceno

The format of the result is:

json
[ {
  "timestamp" : "2013-05-09T18:24:00.000Z",
  "result" : {
    "maxIngestedEventTime" : "2013-05-09T18:24:09.007Z"
  }
} ]