| <!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 | pull-deps Tool</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.17.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="pull-deps-tool">pull-deps Tool</h1> |
| |
| <p><code>pull-deps</code> is a tool that can pull down dependencies to the local repository and lay dependencies out into the extension directory as needed.</p> |
| |
| <p><code>pull-deps</code> has several command line options, they are as follows:</p> |
| |
| <p><code>-c</code> or <code>--coordinate</code> (Can be specified multiply times)</p> |
| |
| <p>Extension coordinate to pull down, followed by a maven coordinate, e.g. org.apache.druid.extensions:mysql-metadata-storage</p> |
| |
| <p><code>-h</code> or <code>--hadoop-coordinate</code> (Can be specified multiply times)</p> |
| |
| <p>Hadoop dependency to pull down, followed by a maven coordinate, e.g. org.apache.hadoop:hadoop-client:2.4.0</p> |
| |
| <p><code>--no-default-hadoop</code></p> |
| |
| <p>Don't pull down the default hadoop coordinate, i.e., org.apache.hadoop:hadoop-client:2.3.0. If <code>-h</code> option is supplied, then default hadoop coordinate will not be downloaded.</p> |
| |
| <p><code>--clean</code></p> |
| |
| <p>Remove exisiting extension and hadoop dependencies directories before pulling down dependencies.</p> |
| |
| <p><code>-l</code> or <code>--localRepository</code></p> |
| |
| <p>A local repostiry that Maven will use to put downloaded files. Then pull-deps will lay these files out into the extensions directory as needed.</p> |
| |
| <p><code>-r</code> or <code>--remoteRepository</code></p> |
| |
| <p>Add a remote repository. Unless --no-default-remote-repositories is provided, these will be used after https://repo1.maven.org/maven2/ and https://metamx.artifactoryonline.com/metamx/pub-libs-releases-local</p> |
| |
| <p><code>--no-default-remote-repositories</code></p> |
| |
| <p>Don't use the default remote repositories, only use the repositories provided directly via --remoteRepository.</p> |
| |
| <p><code>-d</code> or <code>--defaultVersion</code></p> |
| |
| <p>Version to use for extension coordinate that doesn't have a version information. For example, if extension coordinate is <code>org.apache.druid.extensions:mysql-metadata-storage</code>, and default version is <code>0.13.0-incubating</code>, then this coordinate will be treated as <code>org.apache.druid.extensions:mysql-metadata-storage:0.13.0-incubating</code></p> |
| |
| <p><code>--use-proxy</code></p> |
| |
| <p>Use http/https proxy to send request to the remote repository servers. <code>--proxy-host</code> and <code>--proxy-port</code> must be set explicitly if this option is enabled. </p> |
| |
| <p><code>--proxy-type</code></p> |
| |
| <p>Set the proxy type, Should be either <em>http</em> or <em>https</em>, default value is <em>https</em>.</p> |
| |
| <p><code>--proxy-host</code></p> |
| |
| <p>Set the proxy host. e.g. proxy.com.</p> |
| |
| <p><code>--proxy-port</code></p> |
| |
| <p>Set the proxy port number. e.g. 8080.</p> |
| |
| <p><code>--proxy-username</code></p> |
| |
| <p>Set a username to connect to the proxy, this option is only required if the proxy server uses authentication.</p> |
| |
| <p><code>--proxy-password</code></p> |
| |
| <p>Set a password to connect to the proxy, this option is only required if the proxy server uses authentication.</p> |
| |
| <p>To run <code>pull-deps</code>, you should</p> |
| |
| <p>1) Specify <code>druid.extensions.directory</code> and <code>druid.extensions.hadoopDependenciesDir</code>, these two properties tell <code>pull-deps</code> where to put extensions. If you don't specify them, default values will be used, see <a href="../configuration/index.html">Configuration</a>.</p> |
| |
| <p>2) Tell <code>pull-deps</code> what to download using <code>-c</code> or <code>-h</code> option, which are followed by a maven coordinate.</p> |
| |
| <p>Example:</p> |
| |
| <p>Suppose you want to download <code>druid-rabbitmq</code>, <code>mysql-metadata-storage</code> and <code>hadoop-client</code>(both 2.3.0 and 2.4.0) with a specific version, you can run <code>pull-deps</code> command with <code>-c org.apache.druid.extensions:druid-examples:0.13.0-incubating</code>, <code>-c org.apache.druid.extensions:mysql-metadata-storage:0.13.0-incubating</code>, <code>-h org.apache.hadoop:hadoop-client:2.3.0</code> and <code>-h org.apache.hadoop:hadoop-client:2.4.0</code>, an example command would be:</p> |
| <div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>java -classpath "/my/druid/lib/*" org.apache.druid.cli.Main tools pull-deps --clean -c org.apache.druid.extensions:mysql-metadata-storage:0.13.0-incubating -c org.apache.druid.extensions.contrib:druid-rabbitmq:0.13.0-incubating -h org.apache.hadoop:hadoop-client:2.3.0 -h org.apache.hadoop:hadoop-client:2.4.0 |
| </code></pre></div> |
| <p>Because <code>--clean</code> is supplied, this command will first remove the directories specified at <code>druid.extensions.directory</code> and <code>druid.extensions.hadoopDependenciesDir</code>, then recreate them and start downloading the extensions there. After finishing downloading, if you go to the extension directories you specified, you will see</p> |
| <div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>tree extensions |
| extensions |
| ├── druid-examples |
| │ ├── commons-beanutils-1.8.3.jar |
| │ ├── commons-digester-1.8.jar |
| │ ├── commons-logging-1.1.1.jar |
| │ ├── commons-validator-1.4.0.jar |
| │ ├── druid-examples-0.13.0-incubating.jar |
| │ ├── twitter4j-async-3.0.3.jar |
| │ ├── twitter4j-core-3.0.3.jar |
| │ └── twitter4j-stream-3.0.3.jar |
| └── mysql-metadata-storage |
| └── mysql-metadata-storage-0.13.0-incubating.jar |
| </code></pre></div><div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>tree hadoop-dependencies |
| hadoop-dependencies/ |
| └── hadoop-client |
| ├── 2.3.0 |
| │ ├── activation-1.1.jar |
| │ ├── avro-1.7.4.jar |
| │ ├── commons-beanutils-1.7.0.jar |
| │ ├── commons-beanutils-core-1.8.0.jar |
| │ ├── commons-cli-1.2.jar |
| │ ├── commons-codec-1.4.jar |
| ..... lots of jars |
| └── 2.4.0 |
| ├── activation-1.1.jar |
| ├── avro-1.7.4.jar |
| ├── commons-beanutils-1.7.0.jar |
| ├── commons-beanutils-core-1.8.0.jar |
| ├── commons-cli-1.2.jar |
| ├── commons-codec-1.4.jar |
| ..... lots of jars |
| </code></pre></div> |
| <p>Note that if you specify <code>--defaultVersion</code>, you don't have to put version information in the coordinate. For example, if you want both <code>druid-rabbitmq</code> and <code>mysql-metadata-storage</code> to use version <code>0.13.0-incubating</code>, you can change the command above to</p> |
| <div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>java -classpath "/my/druid/lib/*" org.apache.druid.cli.Main tools pull-deps --defaultVersion 0.13.0-incubating --clean -c org.apache.druid.extensions:mysql-metadata-storage -c org.apache.druid.extensions.contrib:druid-rabbitmq -h org.apache.hadoop:hadoop-client:2.3.0 -h org.apache.hadoop:hadoop-client:2.4.0 |
| </code></pre></div> |
| <div class="note info"> |
| Please note to use the pull-deps tool you must know the Maven groupId, artifactId, and version of your extension. |
| |
| For Druid community extensions listed <a href="../development/extensions.html">here</a>, the groupId is "org.apache.druid.extensions.contrib" and the artifactId is the name of the extension. |
| </div> |
| |
| </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> |
