| <!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 | Ingestion using Parquet format</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.20.0/">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="ingestion-using-parquet-format">Ingestion using Parquet format</h1> |
| |
| <p>To use this extension, make sure to <a href="../../operations/including-extensions.html">include</a> both <code>druid-avro-extensions</code> and <code>druid-parquet-extensions</code>.</p> |
| |
| <p>This extension enables Druid to ingest and understand the Apache Parquet data format offline.</p> |
| |
| <h2 id="parquet-hadoop-parser">Parquet Hadoop Parser</h2> |
| |
| <p>This is for batch ingestion using the HadoopDruidIndexer. The inputFormat of <code>inputSpec</code> in <code>ioConfig</code> must be set to <code>"org.apache.druid.data.input.parquet.DruidParquetInputFormat"</code>.</p> |
| |
| <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>This should say <code>parquet</code></td> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <td>parseSpec</td> |
| <td>JSON Object</td> |
| <td>Specifies the timestamp and dimensions of the data. Should be a timeAndDims parseSpec.</td> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <td>binaryAsString</td> |
| <td>Boolean</td> |
| <td>Specifies if the bytes parquet column should be converted to strings.</td> |
| <td>no(default == false)</td> |
| </tr> |
| </tbody></table> |
| |
| <p>When the time dimension is a <a href="https://github.com/apache/parquet-format/blob/master/LogicalTypes.md">DateType column</a>, a format should not be supplied. When the format is UTF8 (String), either <code>auto</code> or a explicitly defined <a href="http://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html">format</a> is required.</p> |
| |
| <h3 id="example-json-for-overlord">Example json for overlord</h3> |
| |
| <p>When posting the index job to the overlord, setting the correct <code>inputFormat</code> is required to switch to parquet ingestion. Make sure to set <code>jobProperties</code> to make hdfs path timezone unrelated:</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_hadoop"</span><span class="p">,</span> |
| <span class="nt">"spec"</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">"hadoop"</span><span class="p">,</span> |
| <span class="nt">"inputSpec"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"static"</span><span class="p">,</span> |
| <span class="nt">"inputFormat"</span><span class="p">:</span> <span class="s2">"org.apache.druid.data.input.parquet.DruidParquetInputFormat"</span><span class="p">,</span> |
| <span class="nt">"paths"</span><span class="p">:</span> <span class="s2">"no_metrics"</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">"no_metrics"</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">"parquet"</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">"timeAndDims"</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">"time"</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">"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">"name"</span> |
| <span class="p">],</span> |
| <span class="nt">"dimensionExclusions"</span><span class="p">:</span> <span class="p">[],</span> |
| <span class="nt">"spatialDimensions"</span><span class="p">:</span> <span class="p">[]</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="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="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">"DAY"</span><span class="p">,</span> |
| <span class="nt">"queryGranularity"</span><span class="p">:</span> <span class="s2">"ALL"</span><span class="p">,</span> |
| <span class="nt">"intervals"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"2015-12-31/2016-01-02"</span><span class="p">]</span> |
| <span class="p">}</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">"hadoop"</span><span class="p">,</span> |
| <span class="nt">"partitionsSpec"</span><span class="p">:</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">"jobProperties"</span> <span class="p">:</span> <span class="p">{},</span> |
| <span class="nt">"leaveIntermediate"</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> |
| <h3 id="example-json-for-standalone-jvm">Example json for standalone jvm</h3> |
| |
| <p>When using a standalone JVM instead, additional configuration fields are required. You can just fire a hadoop job with your local compiled jars like:</p> |
| <div class="highlight"><pre><code class="language-bash" data-lang="bash"><span></span><span class="nv">HADOOP_CLASS_PATH</span><span class="o">=</span><span class="sb">`</span>hadoop classpath <span class="p">|</span> sed s/*.jar/*/g<span class="sb">`</span> |
| |
| java -Xmx32m -Duser.timezone<span class="o">=</span>UTC -Dfile.encoding<span class="o">=</span>UTF-8 <span class="se">\</span> |
| -classpath config/overlord:config/_common:lib/*:<span class="nv">$HADOOP_CLASS_PATH</span>:extensions/druid-avro-extensions/* <span class="se">\</span> |
| org.apache.druid.cli.Main index hadoop <span class="se">\</span> |
| wikipedia_hadoop_parquet_job.json |
| </code></pre></div> |
| <p>An example index json when using the standalone JVM:</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_hadoop"</span><span class="p">,</span> |
| <span class="nt">"spec"</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">"hadoop"</span><span class="p">,</span> |
| <span class="nt">"inputSpec"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"static"</span><span class="p">,</span> |
| <span class="nt">"inputFormat"</span><span class="p">:</span> <span class="s2">"org.apache.druid.data.input.parquet.DruidParquetInputFormat"</span><span class="p">,</span> |
| <span class="nt">"paths"</span><span class="p">:</span> <span class="s2">"no_metrics"</span> |
| <span class="p">},</span> |
| <span class="nt">"metadataUpdateSpec"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"postgresql"</span><span class="p">,</span> |
| <span class="nt">"connectURI"</span><span class="p">:</span> <span class="s2">"jdbc:postgresql://localhost/druid"</span><span class="p">,</span> |
| <span class="nt">"user"</span> <span class="p">:</span> <span class="s2">"druid"</span><span class="p">,</span> |
| <span class="nt">"password"</span> <span class="p">:</span> <span class="s2">"asdf"</span><span class="p">,</span> |
| <span class="nt">"segmentTable"</span><span class="p">:</span> <span class="s2">"druid_segments"</span> |
| <span class="p">},</span> |
| <span class="nt">"segmentOutputPath"</span><span class="p">:</span> <span class="s2">"tmp/segments"</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">"no_metrics"</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">"parquet"</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">"timeAndDims"</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">"time"</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">"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">"name"</span> |
| <span class="p">],</span> |
| <span class="nt">"dimensionExclusions"</span><span class="p">:</span> <span class="p">[],</span> |
| <span class="nt">"spatialDimensions"</span><span class="p">:</span> <span class="p">[]</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="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="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">"DAY"</span><span class="p">,</span> |
| <span class="nt">"queryGranularity"</span><span class="p">:</span> <span class="s2">"ALL"</span><span class="p">,</span> |
| <span class="nt">"intervals"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"2015-12-31/2016-01-02"</span><span class="p">]</span> |
| <span class="p">}</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">"hadoop"</span><span class="p">,</span> |
| <span class="nt">"workingPath"</span><span class="p">:</span> <span class="s2">"tmp/working_path"</span><span class="p">,</span> |
| <span class="nt">"partitionsSpec"</span><span class="p">:</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">"jobProperties"</span> <span class="p">:</span> <span class="p">{},</span> |
| <span class="nt">"leaveIntermediate"</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>Almost all the fields listed above are required, including <code>inputFormat</code>, <code>metadataUpdateSpec</code>(<code>type</code>, <code>connectURI</code>, <code>user</code>, <code>password</code>, <code>segmentTable</code>).</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> |