druid/docs/development/build.md

id	title
build	Build from source

You can build Apache Druid directly from source. Use the version of this page that matches the version you want to build. For building the latest code in master, follow the latest version of this page here: make sure it has /master/ in the URL.

Prerequisites

Installing Java and Maven

• See our Java documentation for information about obtaining a supported JDK
• Maven version 3.x

Other Dependencies

• Distribution builds require Python 3.x and the pyyaml module.
• Integration tests require pyyaml version 5.1 or later.

Downloading the Source Code

git clone git@github.com:apache/druid.git
cd druid

Building from Source

The basic command to build Druid from source is:

mvn clean install

This will run static analysis, unit tests, compile classes, and package the projects into JARs. It will not generate the source or binary distribution tarball. Note that this build may take some time to complete.

In addition to the basic stages, you may also want to add the following profiles and properties:

• -Pdist - Distribution profile: Generates the binary distribution tarball by pulling in core extensions and dependencies and packaging the files as distribution/target/apache-druid-x.x.x-bin.tar.gz
• -Papache-release - Apache release profile: Generates GPG signature and checksums, and builds the source distribution tarball as distribution/target/apache-druid-x.x.x-src.tar.gz
• -Prat - Apache Rat profile: Runs the Apache Rat license audit tool
• -DskipTests - Skips unit tests (which reduces build time)
• -Dweb.console.skip=true - Skip front end project

Putting these together, if you wish to build the source and binary distributions with signatures and checksums, audit licenses, and skip the unit tests, you would run:

mvn clean install -Papache-release,dist,rat -DskipTests

Building for Development

For development, use only the dist profile and skip the Apache release and Apache rat profiles.

mvn clean install -Pdist -DskipTests

If you want to speed up the build even more, you can enable parallel building with the -T1C option and skip some static analysis checks.

mvn clean install -Pdist -T1C -DskipTests -Dforbiddenapis.skip=true -Dcheckstyle.skip=true -Dpmd.skip=true -Dmaven.javadoc.skip=true -Denforcer.skip=true

You will expect to find your distribution tar file under the distribution/target directory.

Potential issues

Missing pyyaml

You are building Druid from source following the instructions on this page but you get

[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.6.0:exec (generate-binary-license) on project distribution: Command execution failed.: Process exited with an error: 1 (Exit value: 1) -> [Help 1]

Resolution: Make sure you have Python installed as well as the yaml module:

pip install pyyaml

On some systems, ensure you use the Python 3.x version of pip:

pip3 install pyyaml