3.5 KiB

Raw Blame History

layout
doc_page

Loading extensions

Loading core extensions

Druid bundles all core extensions out of the box. See the list of extensions for your options. You can load bundled extensions by adding their names to your common.runtime.properties druid.extensions.loadList property. For example, to load the postgresql-metadata-storage and druid-hdfs-storage extensions, use the configuration:

druid.extensions.loadList=["postgresql-metadata-storage", "druid-hdfs-storage"]

These extensions are located in the extensions directory of the distribution.

Druid bundles two sets of configurations: one for the quickstart and one for a clustered configuration. Make sure you are updating the correct common.runtime.properties for your setup.

Because of licensing, the mysql-metadata-storage extension is not packaged with the default Druid tarball. In order to get it, you can download it from druid.io, then unpack and move it into the extensions directory. Make sure to include the name of the extension in the loadList configuration.

Loading community and third-party extensions (contrib extensions)

You can also load community and third-party extensions not already bundled with Druid. To do this, first download the extension and then install it into your extensions directory. You can download extensions from their distributors directly, or if they are available from Maven, the included pull-deps can download them for you. To use pull-deps, specify the full Maven coordinate of the extension in the form groupId:artifactId:version. For example, for the (hypothetical) extension com.example:druid-example-extension:1.0.0, run:

java \
  -cp "dist/druid/lib/*" \
  -Ddruid.extensions.directory="extensions-tmp" \
  -Ddruid.extensions.hadoopDependenciesDir="hadoop-dependencies-tmp" \
  io.druid.cli.Main tools pull-deps \
  --no-default-hadoop \
  -c "com.example:druid-example-extension:1.0.0"

You can install downloaded extensions by copying them into extensions. For example,

cp -R extensions-tmp/druid-example-extension extensions/druid-example-extension

You only have to install the extension once. Then, add "druid-example-extension" to druid.extensions.loadList in common.runtime.properties to instruct Druid to load the extension. If you used pull-deps, then once an extension is installed, you can remove the extensions-tmp and hadoop-dependencies-tmp directories that it created.

The Maven groupId for almost every community extension is io.druid.extensions.contrib. The artifactId is the name of the extension, and the version is the latest Druid stable version.