ContextQMD
Back to Druid

pull-deps tool

docs/operations/pull-deps.md

latest4.6 KB
Original Source
<!-- ~ 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. -->

pull-deps is an Apache Druid tool that can pull down dependencies to the local repository and lay dependencies out into the extension directory as needed.

pull-deps has several command line options, they are as follows:

-c or --coordinate (Can be specified multiple times)

Extension coordinate to pull down, followed by a maven coordinate, e.g. org.apache.druid.extensions:mysql-metadata-storage

--clean

Remove existing extension directories before pulling down dependencies.

-l or --localRepository

A local repository that Maven will use to put downloaded files. Then pull-deps will lay these files out into the extensions directory as needed.

-r or --remoteRepository

Add a remote repository. Unless --no-default-remote-repositories is provided, these will be used after https://repo1.maven.org/maven2/.

--no-default-remote-repositories

Don't use the default remote repository, https://repo1.maven.org/maven2/. Only use the repositories provided directly via --remoteRepository.

-d or --defaultVersion

Version to use for extension coordinate that doesn't have a version information. For example, if extension coordinate is org.apache.druid.extensions:mysql-metadata-storage, and default version is {{DRUIDVERSION}}, then this coordinate will be treated as org.apache.druid.extensions:mysql-metadata-storage:{{DRUIDVERSION}}

--use-proxy

Use http/https proxy to send request to the remote repository servers. --proxy-host and --proxy-port must be set explicitly if this option is enabled.

--proxy-type

Set the proxy type, Should be either http or https, default value is https.

--proxy-host

Set the proxy host. e.g. proxy.com.

--proxy-port

Set the proxy port number. e.g. 8080.

--proxy-username

Set a username to connect to the proxy, this option is only required if the proxy server uses authentication.

--proxy-password

Set a password to connect to the proxy, this option is only required if the proxy server uses authentication.

To run pull-deps, you should

  1. Specify druid.extensions.directory which tells pull-deps where to put extensions. If you don't specify them, default values will be used, see Configuration.

  2. Tell pull-deps what to download using -c option, which are followed by a maven coordinate.

Example:

Suppose you want to download mysql-metadata-storage with a specific version, you can run pull-deps command with -c org.apache.druid.extensions:mysql-metadata-storage:{{DRUIDVERSION}}, an example command would be:

java -classpath "/my/druid/lib/*" org.apache.druid.cli.Main tools pull-deps --clean -c org.apache.druid.extensions:mysql-metadata-storage:{{DRUIDVERSION}}

Because --clean is supplied, this command will first remove the directories specified at druid.extensions.directory, then recreate them and start downloading the extensions there. After finishing downloading, if you go to the extension directories you specified, you will see

tree extensions
extensions
└── mysql-metadata-storage
    └── mysql-metadata-storage-{{DRUIDVERSION}}.jar

Note that if you specify --defaultVersion, you don't have to put version information in the coordinate. For example, if you want mysql-metadata-storage to use version {{DRUIDVERSION}}, you can change the command above to

java -classpath "/my/druid/lib/*" org.apache.druid.cli.Main tools pull-deps --defaultVersion {{DRUIDVERSION}} --clean -c org.apache.druid.extensions:mysql-metadata-storage

:::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 here, the groupId is "org.apache.druid.extensions.contrib" and the artifactId is the name of the extension. :::