| <!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 | Tutorial: Transforming input data</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="tutorial-transforming-input-data">Tutorial: Transforming input data</h1> |
| |
| <p>This tutorial will demonstrate how to use transform specs to filter and transform input data during ingestion.</p> |
| |
| <p>For this tutorial, we'll assume you've already downloaded Druid as described in |
| the <a href="index.html">single-machine quickstart</a> and have it running on your local machine.</p> |
| |
| <p>It will also be helpful to have finished <a href="../tutorials/tutorial-batch.html">Tutorial: Loading a file</a> and <a href="../tutorials/tutorial-query.html">Tutorial: Querying data</a>.</p> |
| |
| <h2 id="sample-data">Sample data</h2> |
| |
| <p>We've included sample data for this tutorial at <code>quickstart/tutorial/transform-data.json</code>, reproduced here for convenience:</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">"2018-01-01T07:01:35Z"</span><span class="p">,</span><span class="nt">"animal"</span><span class="p">:</span><span class="s2">"octopus"</span><span class="p">,</span> <span class="nt">"location"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span> <span class="nt">"number"</span><span class="p">:</span><span class="mi">100</span><span class="p">}</span> |
| <span class="p">{</span><span class="nt">"timestamp"</span><span class="p">:</span><span class="s2">"2018-01-01T05:01:35Z"</span><span class="p">,</span><span class="nt">"animal"</span><span class="p">:</span><span class="s2">"mongoose"</span><span class="p">,</span> <span class="nt">"location"</span><span class="p">:</span><span class="mi">2</span><span class="p">,</span><span class="nt">"number"</span><span class="p">:</span><span class="mi">200</span><span class="p">}</span> |
| <span class="p">{</span><span class="nt">"timestamp"</span><span class="p">:</span><span class="s2">"2018-01-01T06:01:35Z"</span><span class="p">,</span><span class="nt">"animal"</span><span class="p">:</span><span class="s2">"snake"</span><span class="p">,</span> <span class="nt">"location"</span><span class="p">:</span><span class="mi">3</span><span class="p">,</span> <span class="nt">"number"</span><span class="p">:</span><span class="mi">300</span><span class="p">}</span> |
| <span class="p">{</span><span class="nt">"timestamp"</span><span class="p">:</span><span class="s2">"2018-01-01T01:01:35Z"</span><span class="p">,</span><span class="nt">"animal"</span><span class="p">:</span><span class="s2">"lion"</span><span class="p">,</span> <span class="nt">"location"</span><span class="p">:</span><span class="mi">4</span><span class="p">,</span> <span class="nt">"number"</span><span class="p">:</span><span class="mi">300</span><span class="p">}</span> |
| </code></pre></div> |
| <h2 id="load-data-with-transform-specs">Load data with transform specs</h2> |
| |
| <p>We will ingest the sample data using the following spec, which demonstrates the use of transform specs:</p> |
| <div class="highlight"><pre><code class="language-json" data-lang="json"><span></span><span class="p">{</span> |
| <span class="nt">"type"</span> <span class="p">:</span> <span class="s2">"index"</span><span class="p">,</span> |
| <span class="nt">"spec"</span> <span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"dataSchema"</span> <span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"dataSource"</span> <span class="p">:</span> <span class="s2">"transform-tutorial"</span><span class="p">,</span> |
| <span class="nt">"parser"</span> <span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"type"</span> <span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span> |
| <span class="nt">"parseSpec"</span> <span class="p">:</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">"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="s2">"animal"</span><span class="p">,</span> |
| <span class="p">{</span> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"location"</span><span class="p">,</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"long"</span> <span class="p">}</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">"column"</span><span class="p">:</span> <span class="s2">"timestamp"</span><span class="p">,</span> |
| <span class="nt">"format"</span><span class="p">:</span> <span class="s2">"iso"</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| <span class="p">},</span> |
| <span class="nt">"metricsSpec"</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">"count"</span><span class="p">,</span> <span class="nt">"name"</span> <span class="p">:</span> <span class="s2">"count"</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">"number"</span><span class="p">,</span> <span class="nt">"fieldName"</span> <span class="p">:</span> <span class="s2">"number"</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">"triple-number"</span><span class="p">,</span> <span class="nt">"fieldName"</span> <span class="p">:</span> <span class="s2">"triple-number"</span> <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="nt">"granularitySpec"</span> <span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"type"</span> <span class="p">:</span> <span class="s2">"uniform"</span><span class="p">,</span> |
| <span class="nt">"segmentGranularity"</span> <span class="p">:</span> <span class="s2">"week"</span><span class="p">,</span> |
| <span class="nt">"queryGranularity"</span> <span class="p">:</span> <span class="s2">"minute"</span><span class="p">,</span> |
| <span class="nt">"intervals"</span> <span class="p">:</span> <span class="p">[</span><span class="s2">"2018-01-01/2018-01-03"</span><span class="p">],</span> |
| <span class="nt">"rollup"</span> <span class="p">:</span> <span class="kc">true</span> |
| <span class="p">},</span> |
| <span class="nt">"transformSpec"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"transforms"</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">"expression"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"animal"</span><span class="p">,</span> |
| <span class="nt">"expression"</span><span class="p">:</span> <span class="s2">"concat('super-', animal)"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"expression"</span><span class="p">,</span> |
| <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"triple-number"</span><span class="p">,</span> |
| <span class="nt">"expression"</span><span class="p">:</span> <span class="s2">"number * 3"</span> |
| <span class="p">}</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">"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">"animal"</span><span class="p">,</span> <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"super-mongoose"</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">"triple-number"</span><span class="p">,</span> <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"300"</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">"location"</span><span class="p">,</span> <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"3"</span> <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| <span class="p">},</span> |
| <span class="nt">"ioConfig"</span> <span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"type"</span> <span class="p">:</span> <span class="s2">"index"</span><span class="p">,</span> |
| <span class="nt">"firehose"</span> <span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"type"</span> <span class="p">:</span> <span class="s2">"local"</span><span class="p">,</span> |
| <span class="nt">"baseDir"</span> <span class="p">:</span> <span class="s2">"quickstart/tutorial"</span><span class="p">,</span> |
| <span class="nt">"filter"</span> <span class="p">:</span> <span class="s2">"transform-data.json"</span> |
| <span class="p">},</span> |
| <span class="nt">"appendToExisting"</span> <span class="p">:</span> <span class="kc">false</span> |
| <span class="p">},</span> |
| <span class="nt">"tuningConfig"</span> <span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"type"</span> <span class="p">:</span> <span class="s2">"index"</span><span class="p">,</span> |
| <span class="nt">"targetPartitionSize"</span> <span class="p">:</span> <span class="mi">5000000</span><span class="p">,</span> |
| <span class="nt">"maxRowsInMemory"</span> <span class="p">:</span> <span class="mi">25000</span><span class="p">,</span> |
| <span class="nt">"forceExtendableShardSpecs"</span> <span class="p">:</span> <span class="kc">true</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </code></pre></div> |
| <p>In the transform spec, we have two expression transforms: |
| * <code>super-animal</code>: prepends "super-" to the values in the <code>animal</code> column. This will override the <code>animal</code> column with the transformed version, since the transform's name is <code>animal</code>. |
| * <code>triple-number</code>: multiplies the <code>number</code> column by 3. This will create a new <code>triple-number</code> column. Note that we are ingesting both the original and the transformed column.</p> |
| |
| <p>Additionally, we have an OR filter with three clauses: |
| * <code>super-animal</code> values that match "super-mongoose" |
| * <code>triple-number</code> values that match 300 |
| * <code>location</code> values that match 3</p> |
| |
| <p>This filter selects the first 3 rows, and it will exclude the final "lion" row in the input data. Note that the filter is applied after the transformation.</p> |
| |
| <p>Let's submit this task now, which has been included at <code>quickstart/tutorial/transform-index.json</code>:</p> |
| <div class="highlight"><pre><code class="language-bash" data-lang="bash"><span></span>bin/post-index-task --file quickstart/tutorial/transform-index.json |
| </code></pre></div> |
| <h2 id="query-the-transformed-data">Query the transformed data</h2> |
| |
| <p>Let's run <code>bin/dsql</code> and issue a <code>select * from "transform-tutorial";</code> query to see what was ingested:</p> |
| <div class="highlight"><pre><code class="language-bash" data-lang="bash"><span></span>dsql> <span class="k">select</span> * from <span class="s2">"transform-tutorial"</span><span class="p">;</span> |
| ┌──────────────────────────┬────────────────┬───────┬──────────┬────────┬───────────────┐ |
| │ __time │ animal │ count │ location │ number │ triple-number │ |
| ├──────────────────────────┼────────────────┼───────┼──────────┼────────┼───────────────┤ |
| │ <span class="m">2018</span>-01-01T05:01:00.000Z │ super-mongoose │ <span class="m">1</span> │ <span class="m">2</span> │ <span class="m">200</span> │ <span class="m">600</span> │ |
| │ <span class="m">2018</span>-01-01T06:01:00.000Z │ super-snake │ <span class="m">1</span> │ <span class="m">3</span> │ <span class="m">300</span> │ <span class="m">900</span> │ |
| │ <span class="m">2018</span>-01-01T07:01:00.000Z │ super-octopus │ <span class="m">1</span> │ <span class="m">1</span> │ <span class="m">100</span> │ <span class="m">300</span> │ |
| └──────────────────────────┴────────────────┴───────┴──────────┴────────┴───────────────┘ |
| Retrieved <span class="m">3</span> rows in <span class="m">0</span>.03s. |
| </code></pre></div> |
| <p>The "lion" row has been discarded, the <code>animal</code> column has been transformed, and we have both the original and transformed <code>number</code> column.</p> |
| |
| </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.13.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> |