| <!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 | JSON Flatten Spec</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.16.0-incubating/">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="json-flatten-spec">JSON Flatten Spec</h1> |
| |
| <table><thead> |
| <tr> |
| <th>Field</th> |
| <th>Type</th> |
| <th>Description</th> |
| <th>Required</th> |
| </tr> |
| </thead><tbody> |
| <tr> |
| <td>useFieldDiscovery</td> |
| <td>Boolean</td> |
| <td>If true, interpret all fields with singular values (not a map or list) and flat lists (lists of singular values) at the root level as columns.</td> |
| <td>no (default == true)</td> |
| </tr> |
| <tr> |
| <td>fields</td> |
| <td>JSON Object array</td> |
| <td>Specifies the fields of interest and how they are accessed</td> |
| <td>no (default == [])</td> |
| </tr> |
| </tbody></table> |
| |
| <p>Defining the JSON Flatten Spec allows nested JSON fields to be flattened during ingestion time. Only parseSpecs of types "json" or <a href="../development/extensions-core/avro.html">"avro"</a> support flattening.</p> |
| |
| <p>'fields' is a list of JSON Objects, describing the field names and how the fields are accessed:</p> |
| |
| <h2 id="json-field-spec">JSON Field Spec</h2> |
| |
| <table><thead> |
| <tr> |
| <th>Field</th> |
| <th>Type</th> |
| <th>Description</th> |
| <th>Required</th> |
| </tr> |
| </thead><tbody> |
| <tr> |
| <td>type</td> |
| <td>String</td> |
| <td>Type of the field, "root", "path" or "jq".</td> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <td>name</td> |
| <td>String</td> |
| <td>This string will be used as the column name when the data has been ingested.</td> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <td>expr</td> |
| <td>String</td> |
| <td>Defines an expression for accessing the field within the JSON object, using <a href="https://github.com/jayway/JsonPath">JsonPath</a> notation for type "path", and <a href="https://github.com/eiiches/jackson-jq">jackson-jq</a> for type "jq". This field is only used for type "path" and "jq", otherwise ignored.</td> |
| <td>only for type "path" or "jq"</td> |
| </tr> |
| </tbody></table> |
| |
| <p>Suppose the event JSON has the following form:</p> |
| <div class="highlight"><pre><code class="language-json" data-lang="json"><span></span><span class="p">{</span> |
| <span class="nt">"timestamp"</span><span class="p">:</span> <span class="s2">"2015-09-12T12:10:53.155Z"</span><span class="p">,</span> |
| <span class="nt">"dim1"</span><span class="p">:</span> <span class="s2">"qwerty"</span><span class="p">,</span> |
| <span class="nt">"dim2"</span><span class="p">:</span> <span class="s2">"asdf"</span><span class="p">,</span> |
| <span class="nt">"dim3"</span><span class="p">:</span> <span class="s2">"zxcv"</span><span class="p">,</span> |
| <span class="nt">"ignore_me"</span><span class="p">:</span> <span class="s2">"ignore this"</span><span class="p">,</span> |
| <span class="nt">"metrica"</span><span class="p">:</span> <span class="mi">9999</span><span class="p">,</span> |
| <span class="nt">"foo"</span><span class="p">:</span> <span class="p">{</span><span class="nt">"bar"</span><span class="p">:</span> <span class="s2">"abc"</span><span class="p">},</span> |
| <span class="nt">"foo.bar"</span><span class="p">:</span> <span class="s2">"def"</span><span class="p">,</span> |
| <span class="nt">"nestmet"</span><span class="p">:</span> <span class="p">{</span><span class="nt">"val"</span><span class="p">:</span> <span class="mi">42</span><span class="p">},</span> |
| <span class="nt">"hello"</span><span class="p">:</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">,</span> <span class="mf">5.0</span><span class="p">],</span> |
| <span class="nt">"mixarray"</span><span class="p">:</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">,</span> <span class="p">{</span><span class="nt">"last"</span><span class="p">:</span> <span class="mi">5</span><span class="p">}],</span> |
| <span class="nt">"world"</span><span class="p">:</span> <span class="p">[{</span><span class="nt">"hey"</span><span class="p">:</span> <span class="s2">"there"</span><span class="p">},</span> <span class="p">{</span><span class="nt">"tree"</span><span class="p">:</span> <span class="s2">"apple"</span><span class="p">}],</span> |
| <span class="nt">"thing"</span><span class="p">:</span> <span class="p">{</span><span class="nt">"food"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"sandwich"</span><span class="p">,</span> <span class="s2">"pizza"</span><span class="p">]}</span> |
| <span class="p">}</span> |
| </code></pre></div> |
| <p>The column "metrica" is a Long metric column, "hello" is an array of Double metrics, and "nestmet.val" is a nested Long metric. All other columns are dimensions.</p> |
| |
| <p>To flatten this JSON, the parseSpec could be defined as follows:</p> |
| <div class="highlight"><pre><code class="language-json" data-lang="json"><span></span><span class="s2">"parseSpec"</span><span class="err">:</span> <span class="p">{</span> |
| <span class="nt">"format"</span><span class="p">:</span> <span class="s2">"json"</span><span class="p">,</span> |
| <span class="nt">"flattenSpec"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"useFieldDiscovery"</span><span class="p">:</span> <span class="kc">true</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">"root"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"dim1"</span> |
| <span class="p">},</span> |
| <span class="s2">"dim2"</span><span class="p">,</span> |
| <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"path"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"foo.bar"</span><span class="p">,</span> |
| <span class="nt">"expr"</span><span class="p">:</span> <span class="s2">"$.foo.bar"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"foo.bar"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"path"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"path-metric"</span><span class="p">,</span> |
| <span class="nt">"expr"</span><span class="p">:</span> <span class="s2">"$.nestmet.val"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"path"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"hello-0"</span><span class="p">,</span> |
| <span class="nt">"expr"</span><span class="p">:</span> <span class="s2">"$.hello[0]"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"path"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"hello-4"</span><span class="p">,</span> |
| <span class="nt">"expr"</span><span class="p">:</span> <span class="s2">"$.hello[4]"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"path"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"world-hey"</span><span class="p">,</span> |
| <span class="nt">"expr"</span><span class="p">:</span> <span class="s2">"$.world[0].hey"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"path"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"worldtree"</span><span class="p">,</span> |
| <span class="nt">"expr"</span><span class="p">:</span> <span class="s2">"$.world[1].tree"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"path"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"first-food"</span><span class="p">,</span> |
| <span class="nt">"expr"</span><span class="p">:</span> <span class="s2">"$.thing.food[0]"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"path"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"second-food"</span><span class="p">,</span> |
| <span class="nt">"expr"</span><span class="p">:</span> <span class="s2">"$.thing.food[1]"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"jq"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"first-food-by-jq"</span><span class="p">,</span> |
| <span class="nt">"expr"</span><span class="p">:</span> <span class="s2">".thing.food[1]"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"jq"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"hello-total"</span><span class="p">,</span> |
| <span class="nt">"expr"</span><span class="p">:</span> <span class="s2">".hello | sum"</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">},</span> |
| <span class="nt">"dimensionsSpec"</span> <span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"dimensions"</span> <span class="p">:</span> <span class="p">[],</span> |
| <span class="nt">"dimensionsExclusions"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"ignore_me"</span><span class="p">]</span> |
| <span class="p">},</span> |
| <span class="nt">"timestampSpec"</span> <span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"format"</span> <span class="p">:</span> <span class="s2">"auto"</span><span class="p">,</span> |
| <span class="nt">"column"</span> <span class="p">:</span> <span class="s2">"timestamp"</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </code></pre></div> |
| <p>Fields "dim3", "ignore_me", and "metrica" will be automatically discovered because 'useFieldDiscovery' is true, so they have been omitted from the field spec list.</p> |
| |
| <p>"ignore_me" will be automatically discovered but excluded as specified by dimensionsExclusions.</p> |
| |
| <p>Aggregators should use the metric column names as defined in the flattenSpec. Using the example above:</p> |
| <div class="highlight"><pre><code class="language-json" data-lang="json"><span></span><span class="s2">"metricsSpec"</span> <span class="err">:</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">"path-metric-sum"</span><span class="p">,</span> |
| <span class="nt">"fieldName"</span> <span class="p">:</span> <span class="s2">"path-metric"</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">"hello-0-sum"</span><span class="p">,</span> |
| <span class="nt">"fieldName"</span> <span class="p">:</span> <span class="s2">"hello-0"</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">"metrica-sum"</span><span class="p">,</span> |
| <span class="nt">"fieldName"</span> <span class="p">:</span> <span class="s2">"metrica"</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| </code></pre></div> |
| <p>Note that:</p> |
| |
| <ul> |
| <li>For convenience, when defining a root-level field, it is possible to define only the field name, as a string, shown with "dim2" above.</li> |
| <li>Enabling 'useFieldDiscovery' will only autodetect fields at the root level with a single value (not a map or list), as well as fields referring to a list of single values. In the example above, "dim1", "dim2", "dim3", "ignore_me", "metrica", and "foo.bar" (at the root) would be automatically detected as columns. The "hello" field is a list of Doubles and will be autodiscovered, but note that the example ingests the individual list members as separate fields. The "world" field must be explicitly defined because its value is a map. The "mixarray" field, while similar to "hello", must also be explicitly defined because its last value is a map.<br></li> |
| <li>Duplicate field definitions are not allowed, an exception will be thrown.</li> |
| <li>If auto field discovery is enabled, any discovered field with the same name as one already defined in the field specs will be skipped and not added twice.</li> |
| <li>The JSON input must be a JSON object at the root, not an array. e.g., {"valid": "true"} and {"valid":[1,2,3]} are supported but [{"invalid": "true"}] and [1,2,3] are not.</li> |
| <li><a href="http://jsonpath.herokuapp.com/">http://jsonpath.herokuapp.com/</a> is useful for testing the path expressions.</li> |
| <li>jackson-jq supports subset of <a href="https://stedolan.github.io/jq/">./jq</a> syntax. Please refer jackson-jq document.</li> |
| </ul> |
| |
| </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="Download via Apache" href="https://www.apache.org/dyn/closer.cgi?path=/incubator/druid/0.16.0-incubating/apache-druid-0.16.0-incubating-bin.tar.gz" target="_blank"><span class="fas fa-feather"></span></a> ·  |
| <a title="GitHub" href="https://github.com/apache/incubator-druid" target="_blank"><span class="fab fa-github"></span></a> |
| </div> |
| <div class="text-center license"> |
| Copyright © 2019 <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.0-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> |