| <!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: Loading a file</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="tutorial-loading-a-file">Tutorial: Loading a file</h1> |
| |
| <h2 id="getting-started">Getting started</h2> |
| |
| <p>This tutorial demonstrates how to perform a batch file load, using Druid's native batch 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. You |
| don't need to have loaded any data yet.</p> |
| |
| <h2 id="preparing-the-data-and-the-ingestion-task-spec">Preparing the data and the ingestion task spec</h2> |
| |
| <p>A data load is initiated by submitting an <em>ingestion task</em> spec to the Druid overlord. For this tutorial, we'll be loading the sample Wikipedia page edits data.</p> |
| |
| <p>The Druid package includes the following sample native batch ingestion task spec at <code>quickstart/tutorial/wikipedia-index.json</code>, shown here for convenience, |
| which has been configured to read the <code>quickstart/tutorial/wikiticker-2015-09-12-sampled.json.gz</code> input file:</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">"wikipedia"</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">"channel"</span><span class="p">,</span> |
| <span class="s2">"cityName"</span><span class="p">,</span> |
| <span class="s2">"comment"</span><span class="p">,</span> |
| <span class="s2">"countryIsoCode"</span><span class="p">,</span> |
| <span class="s2">"countryName"</span><span class="p">,</span> |
| <span class="s2">"isAnonymous"</span><span class="p">,</span> |
| <span class="s2">"isMinor"</span><span class="p">,</span> |
| <span class="s2">"isNew"</span><span class="p">,</span> |
| <span class="s2">"isRobot"</span><span class="p">,</span> |
| <span class="s2">"isUnpatrolled"</span><span class="p">,</span> |
| <span class="s2">"metroCode"</span><span class="p">,</span> |
| <span class="s2">"namespace"</span><span class="p">,</span> |
| <span class="s2">"page"</span><span class="p">,</span> |
| <span class="s2">"regionIsoCode"</span><span class="p">,</span> |
| <span class="s2">"regionName"</span><span class="p">,</span> |
| <span class="s2">"user"</span><span class="p">,</span> |
| <span class="p">{</span> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"added"</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="nt">"name"</span><span class="p">:</span> <span class="s2">"deleted"</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="nt">"name"</span><span class="p">:</span> <span class="s2">"delta"</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">"time"</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="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">"none"</span><span class="p">,</span> |
| <span class="nt">"intervals"</span> <span class="p">:</span> <span class="p">[</span><span class="s2">"2015-09-12/2015-09-13"</span><span class="p">],</span> |
| <span class="nt">"rollup"</span> <span class="p">:</span> <span class="kc">false</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">"wikiticker-2015-09-12-sampled.json.gz"</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>This spec will create a datasource named "wikipedia", </p> |
| |
| <h2 id="load-batch-data">Load batch data</h2> |
| |
| <p>We've included a sample of Wikipedia edits from September 12, 2015 to get you started.</p> |
| |
| <p>To load this data into Druid, you can submit an <em>ingestion task</em> pointing to the file. We've included |
| a task that loads the <code>wikiticker-2015-09-12-sampled.json.gz</code> file included in the archive. </p> |
| |
| <p>For convenience, the Druid package includes a batch ingestion helper script at <code>bin/post-index-task</code>.</p> |
| |
| <p>This script will POST an ingestion task to the Druid overlord and poll Druid until the data is available for querying.</p> |
| |
| <p>Run the following command from Druid package root:</p> |
| <div class="highlight"><pre><code class="language-bash" data-lang="bash"><span></span>bin/post-index-task --file quickstart/tutorial/wikipedia-index.json |
| </code></pre></div> |
| <p>You should see output like the following:</p> |
| <div class="highlight"><pre><code class="language-bash" data-lang="bash"><span></span>Beginning indexing data <span class="k">for</span> wikipedia |
| Task started: index_wikipedia_2018-07-27T06:37:44.323Z |
| Task log: http://localhost:8090/druid/indexer/v1/task/index_wikipedia_2018-07-27T06:37:44.323Z/log |
| Task status: http://localhost:8090/druid/indexer/v1/task/index_wikipedia_2018-07-27T06:37:44.323Z/status |
| Task index_wikipedia_2018-07-27T06:37:44.323Z still running... |
| Task index_wikipedia_2018-07-27T06:37:44.323Z still running... |
| Task finished with status: SUCCESS |
| Completed indexing data <span class="k">for</span> wikipedia. Now loading indexed data onto the cluster... |
| wikipedia loading complete! You may now query your data |
| </code></pre></div> |
| <h2 id="querying-your-data">Querying your data</h2> |
| |
| <p>Once the data is loaded, please follow the <a href="../tutorials/tutorial-query.html">query tutorial</a> to run some example queries on the newly loaded data.</p> |
| |
| <h2 id="cleanup">Cleanup</h2> |
| |
| <p>If you wish to go through any of the other ingestion tutorials, you will need to shut down the cluster and reset the cluster state by removing the contents of the <code>var</code> directory under the druid package, as the other tutorials will write to the same "wikipedia" datasource.</p> |
| |
| <h2 id="extra-loading-data-without-the-script">Extra: Loading data without the script</h2> |
| |
| <p>Let's briefly discuss how we would've submitted the ingestion task without using the script. You do not need to run these commands.</p> |
| |
| <p>To submit the task, POST it to Druid in a new terminal window from the apache-druid-0.13.0-incubating directory:</p> |
| <div class="highlight"><pre><code class="language-bash" data-lang="bash"><span></span>curl -X <span class="s1">'POST'</span> -H <span class="s1">'Content-Type:application/json'</span> -d @quickstart/tutorial/wikipedia-index.json http://localhost:8090/druid/indexer/v1/task |
| </code></pre></div> |
| <p>Which will print the ID of the task if the submission was successful:</p> |
| <div class="highlight"><pre><code class="language-bash" data-lang="bash"><span></span><span class="o">{</span><span class="s2">"task"</span>:<span class="s2">"index_wikipedia_2018-06-09T21:30:32.802Z"</span><span class="o">}</span> |
| </code></pre></div> |
| <p>To view the status of the ingestion task, go to the overlord console: |
| <a href="http://localhost:8090/console.html">http://localhost:8090/console.html</a>. You can refresh the console periodically, and after |
| the task is successful, you should see a "SUCCESS" status for the task.</p> |
| |
| <p>After the ingestion task finishes, the data will be loaded by historical nodes and available for |
| querying within a minute or two. You can monitor the progress of loading the data in the |
| coordinator console, by checking whether there is a datasource "wikipedia" with a blue circle |
| indicating "fully available": <a href="http://localhost:8081/#/">http://localhost:8081/#/</a>.</p> |
| |
| <p><img src="../tutorials/img/tutorial-batch-01.png" alt="Coordinator console" title="Wikipedia 100% loaded"></p> |
| |
| <h2 id="further-reading">Further reading</h2> |
| |
| <p>For more information on loading batch data, please see <a href="../ingestion/batch-ingestion.html">the batch ingestion documentation</a>.</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="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.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> |