blob: 2b4603145796e6ac07d19364a3ec34ba0dd70d5a [file] [log] [blame]
<!doctype html>
<html class="no-js" lang="en" data-content_root="../">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Development Guidelines" href="development.html" /><link rel="prev" title="Java Development" href="index.html" />
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Building Arrow Java - arrow-java 18.1.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" />
<style>
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
<title>Auto light/dark, in light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
<circle cx="14.5" cy="9.55" r="3.6"/>
</svg>
</symbol>
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
<title>Auto light/dark, in dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
</svg>
</symbol>
<symbol id="svg-pencil" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
<path d="M13.5 6.5l4 4" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
<symbol id="svg-eye" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
<path
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="../index.html"><div class="brand">arrow-java 18.1.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
<span class="sidebar-brand-text">arrow-java 18.1.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../quickstartguide.html">Quick Start Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../overview.html">High-Level Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../install.html">Installing Java Modules</a></li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">Java Development</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Java Development</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Building Arrow Java</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.html">Development Guidelines</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory Management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../vector.html">ValueVector</a></li>
<li class="toctree-l1"><a class="reference internal" href="../vector_schema_root.html">Tabular Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../table.html">Table</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ipc.html">Reading/Writing IPC formats</a></li>
<li class="toctree-l1"><a class="reference internal" href="../algorithm.html">Java Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="../flight.html">Arrow Flight RPC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../flight_sql.html">Arrow Flight SQL</a></li>
<li class="toctree-l1"><a class="reference internal" href="../flight_sql_jdbc_driver.html">Arrow Flight SQL JDBC Driver</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dataset.html">Dataset</a></li>
<li class="toctree-l1"><a class="reference internal" href="../substrait.html">Substrait</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cdata.html">C Data Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../jdbc.html">Arrow JDBC Adapter</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference (javadoc)</a></li>
<li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/cookbook/java/">Cookbook</a></li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="view-this-page">
<a class="muted-link" href="../_sources/developers/building.rst.txt" title="View this page">
<svg><use href="#svg-eye"></use></svg>
<span class="visually-hidden">View this page</span>
</a>
</div>
<div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main" id="furo-main-content">
<section id="building-arrow-java">
<span id="id1"></span><h1><a class="toc-backref" href="#id6" role="doc-backlink">Building Arrow Java</a><a class="headerlink" href="#building-arrow-java" title="Link to this heading"></a></h1>
<nav class="contents" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#building-arrow-java" id="id6">Building Arrow Java</a></p>
<ul>
<li><p><a class="reference internal" href="#system-setup" id="id7">System Setup</a></p></li>
<li><p><a class="reference internal" href="#building" id="id8">Building</a></p>
<ul>
<li><p><a class="reference internal" href="#building-java-modules" id="id9">Building Java Modules</a></p>
<ul>
<li><p><a class="reference internal" href="#id2" id="id10">Maven</a></p></li>
<li><p><a class="reference internal" href="#docker-compose" id="id11">Docker compose</a></p></li>
<li><p><a class="reference internal" href="#archery" id="id12">Archery</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#building-jni-libraries-dylib-so-dll" id="id13">Building JNI Libraries (*.dylib / *.so / *.dll)</a></p>
<ul>
<li><p><a class="reference internal" href="#id3" id="id14">Maven</a></p></li>
<li><p><a class="reference internal" href="#cmake" id="id15">CMake</a></p></li>
<li><p><a class="reference internal" href="#id4" id="id16">Archery</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#building-java-jni-modules" id="id17">Building Java JNI Modules</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#testing" id="id18">Testing</a></p>
<ul>
<li><p><a class="reference internal" href="#configuring-maven-toolchains" id="id19">Configuring Maven toolchains</a></p></li>
<li><p><a class="reference internal" href="#testing-with-a-specific-jdk" id="id20">Testing with a specific JDK</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#ide-configuration" id="id21">IDE Configuration</a></p>
<ul>
<li><p><a class="reference internal" href="#intellij" id="id22">IntelliJ</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#common-errors" id="id23">Common Errors</a></p></li>
<li><p><a class="reference internal" href="#installing-nightly-packages" id="id24">Installing Nightly Packages</a></p>
<ul>
<li><p><a class="reference internal" href="#installing-from-apache-nightlies" id="id25">Installing from Apache Nightlies</a></p></li>
<li><p><a class="reference internal" href="#installing-manually" id="id26">Installing Manually</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#installing-staging-packages" id="id27">Installing Staging Packages</a></p>
<ul>
<li><p><a class="reference internal" href="#installing-from-apache-staging" id="id28">Installing from Apache Staging</a></p></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
<section id="system-setup">
<h2><a class="toc-backref" href="#id7" role="doc-backlink">System Setup</a><a class="headerlink" href="#system-setup" title="Link to this heading"></a></h2>
<p>Arrow Java uses the <a class="reference external" href="https://maven.apache.org/">Maven</a> build system.</p>
<p>Building requires:</p>
<ul class="simple">
<li><p>JDK 11+</p></li>
<li><p>Maven 3+</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>CI will test all supported JDK LTS versions, plus the latest non-LTS version.</p>
</div>
</section>
<section id="building">
<h2><a class="toc-backref" href="#id8" role="doc-backlink">Building</a><a class="headerlink" href="#building" title="Link to this heading"></a></h2>
<p>All the instructions below assume that you have cloned the Arrow git
repository:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/apache/arrow.git
<span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>arrow
<span class="gp">$ </span>git<span class="w"> </span>submodule<span class="w"> </span>update<span class="w"> </span>--init<span class="w"> </span>--recursive
</pre></div>
</div>
<p>These are the options available to compile Arrow Java modules with:</p>
<ul class="simple">
<li><p>Maven build tool.</p></li>
<li><p>Docker Compose.</p></li>
<li><p>Archery.</p></li>
</ul>
<section id="building-java-modules">
<h3><a class="toc-backref" href="#id9" role="doc-backlink">Building Java Modules</a><a class="headerlink" href="#building-java-modules" title="Link to this heading"></a></h3>
<p>To build the default modules, go to the project root and execute:</p>
<section id="id2">
<h4><a class="toc-backref" href="#id10" role="doc-backlink">Maven</a><a class="headerlink" href="#id2" title="Link to this heading"></a></h4>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>arrow/java
<span class="gp">$ </span><span class="nb">export</span><span class="w"> </span><span class="nv">JAVA_HOME</span><span class="o">=</span>&lt;absolute<span class="w"> </span>path<span class="w"> </span>to<span class="w"> </span>your<span class="w"> </span>java<span class="w"> </span>home&gt;
<span class="gp">$ </span>java<span class="w"> </span>--version
<span class="gp">$ </span>mvn<span class="w"> </span>clean<span class="w"> </span>install
</pre></div>
</div>
</section>
<section id="docker-compose">
<h4><a class="toc-backref" href="#id11" role="doc-backlink">Docker compose</a><a class="headerlink" href="#docker-compose" title="Link to this heading"></a></h4>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>arrow/java
<span class="gp">$ </span><span class="nb">export</span><span class="w"> </span><span class="nv">JAVA_HOME</span><span class="o">=</span>&lt;absolute<span class="w"> </span>path<span class="w"> </span>to<span class="w"> </span>your<span class="w"> </span>java<span class="w"> </span>home&gt;
<span class="gp">$ </span>java<span class="w"> </span>--version
<span class="gp">$ </span>docker<span class="w"> </span>compose<span class="w"> </span>run<span class="w"> </span>java
</pre></div>
</div>
</section>
<section id="archery">
<h4><a class="toc-backref" href="#id12" role="doc-backlink">Archery</a><a class="headerlink" href="#archery" title="Link to this heading"></a></h4>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>arrow/java
<span class="gp">$ </span><span class="nb">export</span><span class="w"> </span><span class="nv">JAVA_HOME</span><span class="o">=</span>&lt;absolute<span class="w"> </span>path<span class="w"> </span>to<span class="w"> </span>your<span class="w"> </span>java<span class="w"> </span>home&gt;
<span class="gp">$ </span>java<span class="w"> </span>--version
<span class="gp">$ </span>archery<span class="w"> </span>docker<span class="w"> </span>run<span class="w"> </span>java
</pre></div>
</div>
</section>
</section>
<section id="building-jni-libraries-dylib-so-dll">
<h3><a class="toc-backref" href="#id13" role="doc-backlink">Building JNI Libraries (*.dylib / *.so / *.dll)</a><a class="headerlink" href="#building-jni-libraries-dylib-so-dll" title="Link to this heading"></a></h3>
<p>First, we need to build the <a class="reference external" href="https://arrow.apache.org/docs/cpp/build_system.html">C++ shared libraries</a> that the JNI bindings will use.
We can build these manually or we can use <a class="reference external" href="https://github.com/apache/arrow/blob/main/dev/archery/README.md">Archery</a> to build them using a Docker container
(This will require installing Docker, Docker Compose, and Archery).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you are building on Apple Silicon, be sure to use a JDK version that was compiled
for that architecture. See, for example, the <a class="reference external" href="https://www.azul.com/downloads/?os=macos&amp;architecture=arm-64-bit&amp;package=jdk">Azul JDK</a>.</p>
<p>If you are building on Windows OS, see <a class="reference external" href="https://arrow.apache.org/docs/developers/cpp/windows.html#developers-cpp-windows" title="(in Apache Arrow v19.0.0)"><span class="xref std std-ref">Developing on Windows</span></a>.</p>
</div>
<section id="id3">
<h4><a class="toc-backref" href="#id14" role="doc-backlink">Maven</a><a class="headerlink" href="#id3" title="Link to this heading"></a></h4>
<ul>
<li><p>To build only the JNI C Data Interface library (macOS / Linux):</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ cd arrow/java
$ export JAVA_HOME=&lt;absolute path to your java home&gt;
$ java --version
$ mvn generate-resources -Pgenerate-libs-cdata-all-os -N
$ ls -latr ../java-dist/lib
|__ arrow_cdata_jni/
</pre></div>
</div>
</li>
<li><p>To build only the JNI C Data Interface library (Windows):</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>arrow/java
<span class="gp">$ </span>mvn<span class="w"> </span>generate-resources<span class="w"> </span>-Pgenerate-libs-cdata-all-os<span class="w"> </span>-N
<span class="gp">$ </span>dir<span class="w"> </span><span class="s2">&quot;../java-dist/bin&quot;</span>
<span class="go">|__ arrow_cdata_jni/</span>
</pre></div>
</div>
</li>
<li><p>To build all JNI libraries (macOS / Linux) except the JNI C Data Interface library:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ cd arrow/java
$ export JAVA_HOME=&lt;absolute path to your java home&gt;
$ java --version
$ mvn generate-resources -Pgenerate-libs-jni-macos-linux -N
$ ls -latr java-dist/lib
|__ arrow_dataset_jni/
|__ arrow_orc_jni/
|__ gandiva_jni/
</pre></div>
</div>
</li>
<li><p>To build all JNI libraries (Windows) except the JNI C Data Interface library:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>arrow/java
<span class="gp">$ </span>mvn<span class="w"> </span>generate-resources<span class="w"> </span>-Pgenerate-libs-jni-windows<span class="w"> </span>-N
<span class="gp">$ </span>dir<span class="w"> </span><span class="s2">&quot;../java-dist/bin&quot;</span>
<span class="go">|__ arrow_dataset_jni/</span>
</pre></div>
</div>
</li>
</ul>
</section>
<section id="cmake">
<h4><a class="toc-backref" href="#id15" role="doc-backlink">CMake</a><a class="headerlink" href="#cmake" title="Link to this heading"></a></h4>
<ul>
<li><p>To build only the JNI C Data Interface library (macOS / Linux):</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ cd arrow
$ mkdir -p java-dist java-cdata
$ cmake \
-S java \
-B java-cdata \
-DARROW_JAVA_JNI_ENABLE_C=ON \
-DARROW_JAVA_JNI_ENABLE_DEFAULT=OFF \
-DBUILD_TESTING=OFF \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=java-dist
$ cmake --build java-cdata --target install --config Release
$ ls -latr java-dist/lib
|__ arrow_cdata_jni/
</pre></div>
</div>
</li>
<li><p>To build only the JNI C Data Interface library (Windows):</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ cd arrow
$ mkdir java-dist, java-cdata
$ cmake ^
-S java ^
-B java-cdata ^
-DARROW_JAVA_JNI_ENABLE_C=ON ^
-DARROW_JAVA_JNI_ENABLE_DEFAULT=OFF ^
-DBUILD_TESTING=OFF ^
-DCMAKE_BUILD_TYPE=Release ^
-DCMAKE_INSTALL_PREFIX=java-dist
$ cmake --build java-cdata --target install --config Release
$ dir &quot;java-dist/bin&quot;
|__ arrow_cdata_jni/
</pre></div>
</div>
</li>
<li><p>To build all JNI libraries (macOS / Linux) except the JNI C Data Interface library:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ cd arrow
$ brew bundle --file=cpp/Brewfile
# Homebrew Bundle complete! 25 Brewfile dependencies now installed.
$ brew uninstall aws-sdk-cpp
# (We can&#39;t use aws-sdk-cpp installed by Homebrew because it has
# an issue: https://github.com/aws/aws-sdk-cpp/issues/1809 )
$ export JAVA_HOME=&lt;absolute path to your java home&gt;
$ mkdir -p java-dist cpp-jni
$ cmake \
-S cpp \
-B cpp-jni \
-DARROW_BUILD_SHARED=OFF \
-DARROW_CSV=ON \
-DARROW_DATASET=ON \
-DARROW_DEPENDENCY_SOURCE=BUNDLED \
-DARROW_DEPENDENCY_USE_SHARED=OFF \
-DARROW_FILESYSTEM=ON \
-DARROW_GANDIVA=ON \
-DARROW_GANDIVA_STATIC_LIBSTDCPP=ON \
-DARROW_JSON=ON \
-DARROW_ORC=ON \
-DARROW_PARQUET=ON \
-DARROW_S3=ON \
-DARROW_SUBSTRAIT=ON \
-DARROW_USE_CCACHE=ON \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=java-dist \
-DCMAKE_UNITY_BUILD=ON
$ cmake --build cpp-jni --target install --config Release
$ cmake \
-S java \
-B java-jni \
-DARROW_JAVA_JNI_ENABLE_C=OFF \
-DARROW_JAVA_JNI_ENABLE_DEFAULT=ON \
-DBUILD_TESTING=OFF \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=java-dist \
-DCMAKE_PREFIX_PATH=$PWD/java-dist \
-DProtobuf_ROOT=$PWD/../cpp-jni/protobuf_ep-install \
-DProtobuf_USE_STATIC_LIBS=ON
$ cmake --build java-jni --target install --config Release
$ ls -latr java-dist/lib/
|__ arrow_dataset_jni/
|__ arrow_orc_jni/
|__ gandiva_jni/
</pre></div>
</div>
</li>
<li><p>To build all JNI libraries (Windows) except the JNI C Data Interface library:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>arrow
<span class="gp">$ </span>mkdir<span class="w"> </span>java-dist,<span class="w"> </span>cpp-jni
<span class="gp">$ </span>cmake<span class="w"> </span>^
<span class="go"> -S cpp ^</span>
<span class="go"> -B cpp-jni ^</span>
<span class="go"> -DARROW_BUILD_SHARED=OFF ^</span>
<span class="go"> -DARROW_CSV=ON ^</span>
<span class="go"> -DARROW_DATASET=ON ^</span>
<span class="go"> -DARROW_DEPENDENCY_USE_SHARED=OFF ^</span>
<span class="go"> -DARROW_FILESYSTEM=ON ^</span>
<span class="go"> -DARROW_GANDIVA=OFF ^</span>
<span class="go"> -DARROW_JSON=ON ^</span>
<span class="go"> -DARROW_ORC=ON ^</span>
<span class="go"> -DARROW_PARQUET=ON ^</span>
<span class="go"> -DARROW_S3=ON ^</span>
<span class="go"> -DARROW_SUBSTRAIT=ON ^</span>
<span class="go"> -DARROW_USE_CCACHE=ON ^</span>
<span class="go"> -DARROW_WITH_BROTLI=ON ^</span>
<span class="go"> -DARROW_WITH_LZ4=ON ^</span>
<span class="go"> -DARROW_WITH_SNAPPY=ON ^</span>
<span class="go"> -DARROW_WITH_ZLIB=ON ^</span>
<span class="go"> -DARROW_WITH_ZSTD=ON ^</span>
<span class="go"> -DCMAKE_BUILD_TYPE=Release ^</span>
<span class="go"> -DCMAKE_INSTALL_PREFIX=java-dist ^</span>
<span class="go"> -DCMAKE_UNITY_BUILD=ON ^</span>
<span class="go"> -GNinja</span>
<span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>cpp-jni
<span class="gp">$ </span>ninja<span class="w"> </span>install
<span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>../
<span class="gp">$ </span>cmake<span class="w"> </span>^
<span class="go"> -S java ^</span>
<span class="go"> -B java-jni ^</span>
<span class="go"> -DARROW_JAVA_JNI_ENABLE_C=OFF ^</span>
<span class="go"> -DARROW_JAVA_JNI_ENABLE_DATASET=ON ^</span>
<span class="go"> -DARROW_JAVA_JNI_ENABLE_DEFAULT=ON ^</span>
<span class="go"> -DARROW_JAVA_JNI_ENABLE_GANDIVA=OFF ^</span>
<span class="go"> -DARROW_JAVA_JNI_ENABLE_ORC=ON ^</span>
<span class="go"> -DBUILD_TESTING=OFF ^</span>
<span class="go"> -DCMAKE_BUILD_TYPE=Release ^</span>
<span class="go"> -DCMAKE_INSTALL_PREFIX=java-dist ^</span>
<span class="go"> -DCMAKE_PREFIX_PATH=$PWD/java-dist</span>
<span class="gp">$ </span>cmake<span class="w"> </span>--build<span class="w"> </span>java-jni<span class="w"> </span>--target<span class="w"> </span>install<span class="w"> </span>--config<span class="w"> </span>Release
<span class="gp">$ </span>dir<span class="w"> </span><span class="s2">&quot;java-dist/bin&quot;</span>
<span class="go">|__ arrow_orc_jni/</span>
<span class="go">|__ arrow_dataset_jni/</span>
</pre></div>
</div>
</li>
</ul>
</section>
<section id="id4">
<h4><a class="toc-backref" href="#id16" role="doc-backlink">Archery</a><a class="headerlink" href="#id4" title="Link to this heading"></a></h4>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ cd arrow
$ archery docker run java-jni-manylinux-2014
$ ls -latr java-dist
|__ arrow_cdata_jni/
|__ arrow_dataset_jni/
|__ arrow_orc_jni/
|__ gandiva_jni/
</pre></div>
</div>
</section>
</section>
<section id="building-java-jni-modules">
<h3><a class="toc-backref" href="#id17" role="doc-backlink">Building Java JNI Modules</a><a class="headerlink" href="#building-java-jni-modules" title="Link to this heading"></a></h3>
<ul>
<li><p>To compile the JNI bindings, use the <code class="docutils literal notranslate"><span class="pre">arrow-c-data</span></code> Maven profile:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>arrow/java
<span class="gp">$ </span>mvn<span class="w"> </span>-Darrow.c.jni.dist.dir<span class="o">=</span>&lt;absolute<span class="w"> </span>path<span class="w"> </span>to<span class="w"> </span>your<span class="w"> </span>arrow<span class="w"> </span>folder&gt;/java-dist/lib<span class="w"> </span>-Parrow-c-data<span class="w"> </span>clean<span class="w"> </span>install
</pre></div>
</div>
</li>
<li><p>To compile the JNI bindings for ORC / Gandiva / Dataset, use the <code class="docutils literal notranslate"><span class="pre">arrow-jni</span></code> Maven profile:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>arrow/java
<span class="gp">$ </span>mvn<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-Darrow.cpp.build.dir<span class="o">=</span>&lt;absolute<span class="w"> </span>path<span class="w"> </span>to<span class="w"> </span>your<span class="w"> </span>arrow<span class="w"> </span>folder&gt;/java-dist/lib/<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-Darrow.c.jni.dist.dir<span class="o">=</span>&lt;absolute<span class="w"> </span>path<span class="w"> </span>to<span class="w"> </span>your<span class="w"> </span>arrow<span class="w"> </span>folder&gt;/java-dist/lib/<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-Parrow-jni<span class="w"> </span>clean<span class="w"> </span>install
</pre></div>
</div>
</li>
</ul>
</section>
</section>
<section id="testing">
<h2><a class="toc-backref" href="#id18" role="doc-backlink">Testing</a><a class="headerlink" href="#testing" title="Link to this heading"></a></h2>
<p>By default, Maven uses the same Java version to both build the code and run the tests.</p>
<p>It is also possible to use a different JDK version for the tests. This requires Maven
toolchains to be configured beforehand, and then a specific test property needs to be set.</p>
<section id="configuring-maven-toolchains">
<h3><a class="toc-backref" href="#id19" role="doc-backlink">Configuring Maven toolchains</a><a class="headerlink" href="#configuring-maven-toolchains" title="Link to this heading"></a></h3>
<p>To be able to use a JDK version for testing, it needs to be registered first in Maven <code class="docutils literal notranslate"><span class="pre">toolchains.xml</span></code>
configuration file usually located under <code class="docutils literal notranslate"><span class="pre">${HOME}/.m2</span></code> with the following snippet added to it:</p>
<blockquote>
<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF8&quot;?&gt;</span>
<span class="go">&lt;toolchains&gt;</span>
<span class="go"> [...]</span>
<span class="go"> &lt;toolchain&gt;</span>
<span class="go"> &lt;type&gt;jdk&lt;/type&gt;</span>
<span class="go"> &lt;provides&gt;</span>
<span class="go"> &lt;version&gt;21&lt;/version&gt; &lt;!-- Replace with the corresponding JDK version: 11, 17, ... --&gt;</span>
<span class="go"> &lt;vendor&gt;temurin&lt;/vendor&gt; &lt;!-- Replace with the vendor/distribution: temurin, oracle, zulu ... --&gt;</span>
<span class="go"> &lt;/provides&gt;</span>
<span class="go"> &lt;configuration&gt;</span>
<span class="go"> &lt;jdkHome&gt;path/to/jdk/home&lt;/jdkHome&gt; &lt;!-- Replace with the path to the JDK --&gt;</span>
<span class="go"> &lt;/configuration&gt;</span>
<span class="go"> &lt;/toolchain&gt;</span>
<span class="go"> [...]</span>
<span class="go">&lt;/toolchains&gt;</span>
</pre></div>
</div>
</div></blockquote>
</section>
<section id="testing-with-a-specific-jdk">
<h3><a class="toc-backref" href="#id20" role="doc-backlink">Testing with a specific JDK</a><a class="headerlink" href="#testing-with-a-specific-jdk" title="Link to this heading"></a></h3>
<p>To run Arrow tests with a specific JDK version, use the <code class="docutils literal notranslate"><span class="pre">arrow.test.jdk-version</span></code> property.</p>
<p>For example, to run Arrow tests with JDK 17, use the following snippet:</p>
<blockquote>
<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>arrow/java
<span class="gp">$ </span>mvn<span class="w"> </span>-Darrow.test.jdk-version<span class="o">=</span><span class="m">17</span><span class="w"> </span>clean<span class="w"> </span>verify
</pre></div>
</div>
</div></blockquote>
</section>
</section>
<section id="ide-configuration">
<h2><a class="toc-backref" href="#id21" role="doc-backlink">IDE Configuration</a><a class="headerlink" href="#ide-configuration" title="Link to this heading"></a></h2>
<section id="intellij">
<h3><a class="toc-backref" href="#id22" role="doc-backlink">IntelliJ</a><a class="headerlink" href="#intellij" title="Link to this heading"></a></h3>
<p>To start working on Arrow in IntelliJ: build the project once from the command
line using <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">clean</span> <span class="pre">install</span></code>. Then open the <code class="docutils literal notranslate"><span class="pre">java/</span></code> subdirectory of the
Arrow repository, and update the following settings:</p>
<ul class="simple">
<li><p>In the Files tool window, find the path <code class="docutils literal notranslate"><span class="pre">vector/target/generated-sources</span></code>,
right click the directory, and select Mark Directory as &gt; Generated Sources
Root. There is no need to mark other generated sources directories, as only
the <code class="docutils literal notranslate"><span class="pre">vector</span></code> module generates sources.</p></li>
<li><p>For JDK 11, due to an <a class="reference external" href="https://youtrack.jetbrains.com/issue/IDEA-201168">IntelliJ bug</a>, you must go into
Settings &gt; Build, Execution, Deployment &gt; Compiler &gt; Java Compiler and disable
“Use ‘–release’ option for cross-compilation (Java 9 and later)”. Otherwise
you will get an error like “package sun.misc does not exist”.</p></li>
<li><p>You may want to disable error-prone entirely if it gives spurious
warnings (disable both error-prone profiles in the Maven tool window
and “Reload All Maven Projects”).</p></li>
<li><p>If using IntelliJ’s Maven integration to build, you may need to change
<code class="docutils literal notranslate"><span class="pre">&lt;fork&gt;</span></code> to <code class="docutils literal notranslate"><span class="pre">false</span></code> in the pom.xml files due to an <a class="reference external" href="https://youtrack.jetbrains.com/issue/IDEA-278903">IntelliJ bug</a>.</p></li>
<li><p>To enable debugging JNI-based modules like <code class="docutils literal notranslate"><span class="pre">dataset</span></code>,
activate specific profiles in the Maven tab under “Profiles”.
Ensure the profiles <code class="docutils literal notranslate"><span class="pre">arrow-c-data</span></code>, <code class="docutils literal notranslate"><span class="pre">arrow-jni</span></code>, <code class="docutils literal notranslate"><span class="pre">generate-libs-cdata-all-os</span></code>,
<code class="docutils literal notranslate"><span class="pre">generate-libs-jni-macos-linux</span></code>, and <code class="docutils literal notranslate"><span class="pre">jdk11+</span></code> are enabled, so that the
IDE can build them and enable debugging.</p></li>
</ul>
<p>You may not need to update all of these settings if you build/test with the
IntelliJ Maven integration instead of with IntelliJ directly.</p>
</section>
</section>
<section id="common-errors">
<h2><a class="toc-backref" href="#id23" role="doc-backlink">Common Errors</a><a class="headerlink" href="#common-errors" title="Link to this heading"></a></h2>
<ul>
<li><p>When working with the JNI code: if the C++ build cannot find dependencies, with errors like these:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">Could NOT find Boost (missing: Boost_INCLUDE_DIR system filesystem)</span>
<span class="go">Could NOT find Lz4 (missing: LZ4_LIB)</span>
<span class="go">Could NOT find zstd (missing: ZSTD_LIB)</span>
</pre></div>
</div>
<p>Specify that the dependencies should be downloaded at build time (more details at <a class="reference external" href="https://arrow.apache.org/docs/developers/cpp/building.html#individual-dependency-resolution">Dependency Resolution</a>):</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">-Dre2_SOURCE=BUNDLED \</span>
<span class="go">-DBoost_SOURCE=BUNDLED \</span>
<span class="go">-Dutf8proc_SOURCE=BUNDLED \</span>
<span class="go">-DSnappy_SOURCE=BUNDLED \</span>
<span class="go">-DORC_SOURCE=BUNDLED \</span>
<span class="go">-DZLIB_SOURCE=BUNDLED</span>
</pre></div>
</div>
</li>
</ul>
</section>
<section id="installing-nightly-packages">
<h2><a class="toc-backref" href="#id24" role="doc-backlink">Installing Nightly Packages</a><a class="headerlink" href="#installing-nightly-packages" title="Link to this heading"></a></h2>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>These packages are not official releases. Use them at your own risk.</p>
</div>
<p>Arrow nightly builds are posted on the mailing list at <a class="reference external" href="https://lists.apache.org/list.html?builds&#64;arrow.apache.org">builds&#64;arrow.apache.org</a>.
The artifacts are uploaded to GitHub. For example, for 2022/07/30, they can be found at <a class="reference external" href="https://github.com/ursacomputing/crossbow/releases/tag/nightly-packaging-2022-07-30-0-github-java-jars">GitHub Nightly</a>.</p>
<section id="installing-from-apache-nightlies">
<h3><a class="toc-backref" href="#id25" role="doc-backlink">Installing from Apache Nightlies</a><a class="headerlink" href="#installing-from-apache-nightlies" title="Link to this heading"></a></h3>
<ol class="arabic">
<li><p>Look up the nightly version number for the Arrow libraries used.</p>
<p>For example, for <code class="docutils literal notranslate"><span class="pre">arrow-memory</span></code>, visit <a class="reference external" href="https://nightlies.apache.org/arrow/java/org/apache/arrow/arrow-memory/">https://nightlies.apache.org/arrow/java/org/apache/arrow/arrow-memory/</a> and see what versions are available (e.g. 9.0.0.dev501).</p>
</li>
<li><p>Add Apache Nightlies Repository to the Maven/Gradle project.</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;properties&gt;</span>
<span class="w"> </span><span class="nt">&lt;arrow.version&gt;</span>9.0.0.dev501<span class="nt">&lt;/arrow.version&gt;</span>
<span class="nt">&lt;/properties&gt;</span>
...
<span class="nt">&lt;repositories&gt;</span>
<span class="w"> </span><span class="nt">&lt;repository&gt;</span>
<span class="w"> </span><span class="nt">&lt;id&gt;</span>arrow-apache-nightlies<span class="nt">&lt;/id&gt;</span>
<span class="w"> </span><span class="nt">&lt;url&gt;</span>https://nightlies.apache.org/arrow/java<span class="nt">&lt;/url&gt;</span>
<span class="w"> </span><span class="nt">&lt;/repository&gt;</span>
<span class="nt">&lt;/repositories&gt;</span>
...
<span class="nt">&lt;dependencies&gt;</span>
<span class="w"> </span><span class="nt">&lt;dependency&gt;</span>
<span class="w"> </span><span class="nt">&lt;groupId&gt;</span>org.apache.arrow<span class="nt">&lt;/groupId&gt;</span>
<span class="w"> </span><span class="nt">&lt;artifactId&gt;</span>arrow-vector<span class="nt">&lt;/artifactId&gt;</span>
<span class="w"> </span><span class="nt">&lt;version&gt;</span>${arrow.version}<span class="nt">&lt;/version&gt;</span>
<span class="w"> </span><span class="nt">&lt;/dependency&gt;</span>
<span class="nt">&lt;/dependencies&gt;</span>
...
</pre></div>
</div>
</li>
</ol>
</section>
<section id="installing-manually">
<h3><a class="toc-backref" href="#id26" role="doc-backlink">Installing Manually</a><a class="headerlink" href="#installing-manually" title="Link to this heading"></a></h3>
<ol class="arabic">
<li><p>Decide nightly packages repository to use, for example: <a class="reference external" href="https://github.com/ursacomputing/crossbow/releases/tag/nightly-packaging-2022-07-30-0-github-java-jars">https://github.com/ursacomputing/crossbow/releases/tag/nightly-packaging-2022-07-30-0-github-java-jars</a></p></li>
<li><p>Add packages to your pom.xml, for example: flight-core (it depends on: arrow-format, arrow-vector, arrow-memory-core and arrow-memory-netty).</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;properties&gt;</span>
<span class="w"> </span><span class="nt">&lt;maven.compiler.source&gt;</span>8<span class="nt">&lt;/maven.compiler.source&gt;</span>
<span class="w"> </span><span class="nt">&lt;maven.compiler.target&gt;</span>8<span class="nt">&lt;/maven.compiler.target&gt;</span>
<span class="w"> </span><span class="nt">&lt;arrow.version&gt;</span>9.0.0.dev501<span class="nt">&lt;/arrow.version&gt;</span>
<span class="nt">&lt;/properties&gt;</span>
<span class="nt">&lt;dependencies&gt;</span>
<span class="w"> </span><span class="nt">&lt;dependency&gt;</span>
<span class="w"> </span><span class="nt">&lt;groupId&gt;</span>org.apache.arrow<span class="nt">&lt;/groupId&gt;</span>
<span class="w"> </span><span class="nt">&lt;artifactId&gt;</span>flight-core<span class="nt">&lt;/artifactId&gt;</span>
<span class="w"> </span><span class="nt">&lt;version&gt;</span>${arrow.version}<span class="nt">&lt;/version&gt;</span>
<span class="w"> </span><span class="nt">&lt;/dependency&gt;</span>
<span class="nt">&lt;/dependencies&gt;</span>
</pre></div>
</div>
</li>
<li><p>Download the necessary pom and jar files to a temporary directory:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>mkdir<span class="w"> </span>nightly-packaging-2022-07-30-0-github-java-jars
$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>nightly-packaging-2022-07-30-0-github-java-jars
$<span class="w"> </span>wget<span class="w"> </span>https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-java-root-9.0.0.dev501.pom
$<span class="w"> </span>wget<span class="w"> </span>https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-format-9.0.0.dev501.pom
$<span class="w"> </span>wget<span class="w"> </span>https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-format-9.0.0.dev501.jar
$<span class="w"> </span>wget<span class="w"> </span>https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-vector-9.0.0.dev501.pom
$<span class="w"> </span>wget<span class="w"> </span>https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-vector-9.0.0.dev501.jar
$<span class="w"> </span>wget<span class="w"> </span>https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-9.0.0.dev501.pom
$<span class="w"> </span>wget<span class="w"> </span>https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-core-9.0.0.dev501.pom
$<span class="w"> </span>wget<span class="w"> </span>https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-netty-9.0.0.dev501.pom
$<span class="w"> </span>wget<span class="w"> </span>https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-core-9.0.0.dev501.jar
$<span class="w"> </span>wget<span class="w"> </span>https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-netty-9.0.0.dev501.jar
$<span class="w"> </span>wget<span class="w"> </span>https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-flight-9.0.0.dev501.pom
$<span class="w"> </span>wget<span class="w"> </span>https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/flight-core-9.0.0.dev501.pom
$<span class="w"> </span>wget<span class="w"> </span>https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/flight-core-9.0.0.dev501.jar
$<span class="w"> </span>tree
.
├──<span class="w"> </span>arrow-flight-9.0.0.dev501.pom
├──<span class="w"> </span>arrow-format-9.0.0.dev501.jar
├──<span class="w"> </span>arrow-format-9.0.0.dev501.pom
├──<span class="w"> </span>arrow-java-root-9.0.0.dev501.pom
├──<span class="w"> </span>arrow-memory-9.0.0.dev501.pom
├──<span class="w"> </span>arrow-memory-core-9.0.0.dev501.jar
├──<span class="w"> </span>arrow-memory-core-9.0.0.dev501.pom
├──<span class="w"> </span>arrow-memory-netty-9.0.0.dev501.jar
├──<span class="w"> </span>arrow-memory-netty-9.0.0.dev501.pom
├──<span class="w"> </span>arrow-vector-9.0.0.dev501.jar
├──<span class="w"> </span>arrow-vector-9.0.0.dev501.pom
├──<span class="w"> </span>flight-core-9.0.0.dev501.jar
└──<span class="w"> </span>flight-core-9.0.0.dev501.pom
</pre></div>
</div>
</li>
<li><p>Install the artifacts to the local Maven repository with <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">install:install-file</span></code>:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>mvn<span class="w"> </span>install:install-file<span class="w"> </span>-Dfile<span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/arrow-java-root-9.0.0.dev501.pom&quot;</span><span class="w"> </span>-DgroupId<span class="o">=</span>org.apache.arrow<span class="w"> </span>-DartifactId<span class="o">=</span>arrow-java-root<span class="w"> </span>-Dversion<span class="o">=</span><span class="m">9</span>.0.0.dev501<span class="w"> </span>-Dpackaging<span class="o">=</span>pom
$<span class="w"> </span>mvn<span class="w"> </span>install:install-file<span class="w"> </span>-Dfile<span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/arrow-format-9.0.0.dev501.pom&quot;</span><span class="w"> </span>-DgroupId<span class="o">=</span>org.apache.arrow<span class="w"> </span>-DartifactId<span class="o">=</span>arrow-format<span class="w"> </span>-Dversion<span class="o">=</span><span class="m">9</span>.0.0.dev501<span class="w"> </span>-Dpackaging<span class="o">=</span>pom
$<span class="w"> </span>mvn<span class="w"> </span>install:install-file<span class="w"> </span>-Dfile<span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/arrow-format-9.0.0.dev501.jar&quot;</span><span class="w"> </span>-DgroupId<span class="o">=</span>org.apache.arrow<span class="w"> </span>-DartifactId<span class="o">=</span>arrow-format<span class="w"> </span>-Dversion<span class="o">=</span><span class="m">9</span>.0.0.dev501<span class="w"> </span>-Dpackaging<span class="o">=</span>jar
$<span class="w"> </span>mvn<span class="w"> </span>install:install-file<span class="w"> </span>-Dfile<span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/arrow-vector-9.0.0.dev501.pom&quot;</span><span class="w"> </span>-DgroupId<span class="o">=</span>org.apache.arrow<span class="w"> </span>-DartifactId<span class="o">=</span>arrow-vector<span class="w"> </span>-Dversion<span class="o">=</span><span class="m">9</span>.0.0.dev501<span class="w"> </span>-Dpackaging<span class="o">=</span>pom
$<span class="w"> </span>mvn<span class="w"> </span>install:install-file<span class="w"> </span>-Dfile<span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/arrow-vector-9.0.0.dev501.jar&quot;</span><span class="w"> </span>-DgroupId<span class="o">=</span>org.apache.arrow<span class="w"> </span>-DartifactId<span class="o">=</span>arrow-vector<span class="w"> </span>-Dversion<span class="o">=</span><span class="m">9</span>.0.0.dev501<span class="w"> </span>-Dpackaging<span class="o">=</span>jar
$<span class="w"> </span>mvn<span class="w"> </span>install:install-file<span class="w"> </span>-Dfile<span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/arrow-memory-9.0.0.dev501.pom&quot;</span><span class="w"> </span>-DgroupId<span class="o">=</span>org.apache.arrow<span class="w"> </span>-DartifactId<span class="o">=</span>arrow-memory<span class="w"> </span>-Dversion<span class="o">=</span><span class="m">9</span>.0.0.dev501<span class="w"> </span>-Dpackaging<span class="o">=</span>pom
$<span class="w"> </span>mvn<span class="w"> </span>install:install-file<span class="w"> </span>-Dfile<span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/arrow-memory-core-9.0.0.dev501.pom&quot;</span><span class="w"> </span>-DgroupId<span class="o">=</span>org.apache.arrow<span class="w"> </span>-DartifactId<span class="o">=</span>arrow-memory-core<span class="w"> </span>-Dversion<span class="o">=</span><span class="m">9</span>.0.0.dev501<span class="w"> </span>-Dpackaging<span class="o">=</span>pom
$<span class="w"> </span>mvn<span class="w"> </span>install:install-file<span class="w"> </span>-Dfile<span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/arrow-memory-netty-9.0.0.dev501.pom&quot;</span><span class="w"> </span>-DgroupId<span class="o">=</span>org.apache.arrow<span class="w"> </span>-DartifactId<span class="o">=</span>arrow-memory-netty<span class="w"> </span>-Dversion<span class="o">=</span><span class="m">9</span>.0.0.dev501<span class="w"> </span>-Dpackaging<span class="o">=</span>pom
$<span class="w"> </span>mvn<span class="w"> </span>install:install-file<span class="w"> </span>-Dfile<span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/arrow-memory-core-9.0.0.dev501.jar&quot;</span><span class="w"> </span>-DgroupId<span class="o">=</span>org.apache.arrow<span class="w"> </span>-DartifactId<span class="o">=</span>arrow-memory-core<span class="w"> </span>-Dversion<span class="o">=</span><span class="m">9</span>.0.0.dev501<span class="w"> </span>-Dpackaging<span class="o">=</span>jar
$<span class="w"> </span>mvn<span class="w"> </span>install:install-file<span class="w"> </span>-Dfile<span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/arrow-memory-netty-9.0.0.dev501.jar&quot;</span><span class="w"> </span>-DgroupId<span class="o">=</span>org.apache.arrow<span class="w"> </span>-DartifactId<span class="o">=</span>arrow-memory-netty<span class="w"> </span>-Dversion<span class="o">=</span><span class="m">9</span>.0.0.dev501<span class="w"> </span>-Dpackaging<span class="o">=</span>jar
$<span class="w"> </span>mvn<span class="w"> </span>install:install-file<span class="w"> </span>-Dfile<span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/arrow-flight-9.0.0.dev501.pom&quot;</span><span class="w"> </span>-DgroupId<span class="o">=</span>org.apache.arrow<span class="w"> </span>-DartifactId<span class="o">=</span>arrow-flight<span class="w"> </span>-Dversion<span class="o">=</span><span class="m">9</span>.0.0.dev501<span class="w"> </span>-Dpackaging<span class="o">=</span>pom
$<span class="w"> </span>mvn<span class="w"> </span>install:install-file<span class="w"> </span>-Dfile<span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/flight-core-9.0.0.dev501.pom&quot;</span><span class="w"> </span>-DgroupId<span class="o">=</span>org.apache.arrow<span class="w"> </span>-DartifactId<span class="o">=</span>flight-core<span class="w"> </span>-Dversion<span class="o">=</span><span class="m">9</span>.0.0.dev501<span class="w"> </span>-Dpackaging<span class="o">=</span>pom
$<span class="w"> </span>mvn<span class="w"> </span>install:install-file<span class="w"> </span>-Dfile<span class="o">=</span><span class="s2">&quot;</span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span><span class="s2">/flight-core-9.0.0.dev501.jar&quot;</span><span class="w"> </span>-DgroupId<span class="o">=</span>org.apache.arrow<span class="w"> </span>-DartifactId<span class="o">=</span>flight-core<span class="w"> </span>-Dversion<span class="o">=</span><span class="m">9</span>.0.0.dev501<span class="w"> </span>-Dpackaging<span class="o">=</span>jar
</pre></div>
</div>
</li>
<li><p>Validate that the packages were installed:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>tree<span class="w"> </span>~/.m2/repository/org/apache/arrow
.
├──<span class="w"> </span>arrow-flight
<span class="w">   </span>├──<span class="w"> </span><span class="m">9</span>.0.0.dev501
<span class="w">   </span><span class="w">   </span>└──<span class="w"> </span>arrow-flight-9.0.0.dev501.pom
├──<span class="w"> </span>arrow-format
<span class="w">   </span>├──<span class="w"> </span><span class="m">9</span>.0.0.dev501
<span class="w">   </span><span class="w">   </span>├──<span class="w"> </span>arrow-format-9.0.0.dev501.jar
<span class="w">   </span><span class="w">   </span>└──<span class="w"> </span>arrow-format-9.0.0.dev501.pom
├──<span class="w"> </span>arrow-java-root
<span class="w">   </span>├──<span class="w"> </span><span class="m">9</span>.0.0.dev501
<span class="w">   </span><span class="w">   </span>└──<span class="w"> </span>arrow-java-root-9.0.0.dev501.pom
├──<span class="w"> </span>arrow-memory
<span class="w">   </span>├──<span class="w"> </span><span class="m">9</span>.0.0.dev501
<span class="w">   </span><span class="w">   </span>└──<span class="w"> </span>arrow-memory-9.0.0.dev501.pom
├──<span class="w"> </span>arrow-memory-core
<span class="w">   </span>├──<span class="w"> </span><span class="m">9</span>.0.0.dev501
<span class="w">   </span><span class="w">   </span>├──<span class="w"> </span>arrow-memory-core-9.0.0.dev501.jar
<span class="w">   </span><span class="w">   </span>└──<span class="w"> </span>arrow-memory-core-9.0.0.dev501.pom
├──<span class="w"> </span>arrow-memory-netty
<span class="w">   </span>├──<span class="w"> </span><span class="m">9</span>.0.0.dev501
<span class="w">   </span><span class="w">   </span>├──<span class="w"> </span>arrow-memory-netty-9.0.0.dev501.jar
<span class="w">   </span><span class="w">   </span>└──<span class="w"> </span>arrow-memory-netty-9.0.0.dev501.pom
├──<span class="w"> </span>arrow-vector
<span class="w">   </span>├──<span class="w"> </span><span class="m">9</span>.0.0.dev501
<span class="w">   </span><span class="w">   </span>├──<span class="w"> </span>_remote.repositories
<span class="w">   </span><span class="w">   </span>├──<span class="w"> </span>arrow-vector-9.0.0.dev501.jar
<span class="w">   </span><span class="w">   </span>└──<span class="w"> </span>arrow-vector-9.0.0.dev501.pom
└──<span class="w"> </span>flight-core
<span class="w"> </span>├──<span class="w"> </span><span class="m">9</span>.0.0.dev501
<span class="w"> </span><span class="w">   </span>├──<span class="w"> </span>flight-core-9.0.0.dev501.jar
<span class="w"> </span><span class="w">   </span>└──<span class="w"> </span>flight-core-9.0.0.dev501.pom
</pre></div>
</div>
</li>
<li><p>Compile your project like usual with <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">clean</span> <span class="pre">install</span></code>.</p></li>
</ol>
</section>
</section>
<section id="installing-staging-packages">
<h2><a class="toc-backref" href="#id27" role="doc-backlink">Installing Staging Packages</a><a class="headerlink" href="#installing-staging-packages" title="Link to this heading"></a></h2>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>These packages are not official releases. Use them at your own risk.</p>
</div>
<p>Arrow staging builds are created when a Release Candidate (RC) is being prepared. This allows users to test the RC in their applications before voting on the release.</p>
<section id="installing-from-apache-staging">
<h3><a class="toc-backref" href="#id28" role="doc-backlink">Installing from Apache Staging</a><a class="headerlink" href="#installing-from-apache-staging" title="Link to this heading"></a></h3>
<ol class="arabic">
<li><p>Look up the next version number for the Arrow libraries used.</p></li>
<li><p>Add Apache Staging Repository to the Maven/Gradle project.</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;properties&gt;</span>
<span class="w"> </span><span class="nt">&lt;arrow.version&gt;</span>9.0.0<span class="nt">&lt;/arrow.version&gt;</span>
<span class="nt">&lt;/properties&gt;</span>
...
<span class="nt">&lt;repositories&gt;</span>
<span class="w"> </span><span class="nt">&lt;repository&gt;</span>
<span class="w"> </span><span class="nt">&lt;id&gt;</span>arrow-apache-staging<span class="nt">&lt;/id&gt;</span>
<span class="w"> </span><span class="nt">&lt;url&gt;</span>https://repository.apache.org/content/repositories/staging<span class="nt">&lt;/url&gt;</span>
<span class="w"> </span><span class="nt">&lt;/repository&gt;</span>
<span class="nt">&lt;/repositories&gt;</span>
...
<span class="nt">&lt;dependencies&gt;</span>
<span class="w"> </span><span class="nt">&lt;dependency&gt;</span>
<span class="w"> </span><span class="nt">&lt;groupId&gt;</span>org.apache.arrow<span class="nt">&lt;/groupId&gt;</span>
<span class="w"> </span><span class="nt">&lt;artifactId&gt;</span>arrow-vector<span class="nt">&lt;/artifactId&gt;</span>
<span class="w"> </span><span class="nt">&lt;version&gt;</span>${arrow.version}<span class="nt">&lt;/version&gt;</span>
<span class="w"> </span><span class="nt">&lt;/dependency&gt;</span>
<span class="nt">&lt;/dependencies&gt;</span>
...
</pre></div>
</div>
</li>
</ol>
</section>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="development.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Development Guidelines</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="index.html">
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">Java Development</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2025, Apache Arrow Developers
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Building Arrow Java</a><ul>
<li><a class="reference internal" href="#system-setup">System Setup</a></li>
<li><a class="reference internal" href="#building">Building</a><ul>
<li><a class="reference internal" href="#building-java-modules">Building Java Modules</a><ul>
<li><a class="reference internal" href="#id2">Maven</a></li>
<li><a class="reference internal" href="#docker-compose">Docker compose</a></li>
<li><a class="reference internal" href="#archery">Archery</a></li>
</ul>
</li>
<li><a class="reference internal" href="#building-jni-libraries-dylib-so-dll">Building JNI Libraries (*.dylib / *.so / *.dll)</a><ul>
<li><a class="reference internal" href="#id3">Maven</a></li>
<li><a class="reference internal" href="#cmake">CMake</a></li>
<li><a class="reference internal" href="#id4">Archery</a></li>
</ul>
</li>
<li><a class="reference internal" href="#building-java-jni-modules">Building Java JNI Modules</a></li>
</ul>
</li>
<li><a class="reference internal" href="#testing">Testing</a><ul>
<li><a class="reference internal" href="#configuring-maven-toolchains">Configuring Maven toolchains</a></li>
<li><a class="reference internal" href="#testing-with-a-specific-jdk">Testing with a specific JDK</a></li>
</ul>
</li>
<li><a class="reference internal" href="#ide-configuration">IDE Configuration</a><ul>
<li><a class="reference internal" href="#intellij">IntelliJ</a></li>
</ul>
</li>
<li><a class="reference internal" href="#common-errors">Common Errors</a></li>
<li><a class="reference internal" href="#installing-nightly-packages">Installing Nightly Packages</a><ul>
<li><a class="reference internal" href="#installing-from-apache-nightlies">Installing from Apache Nightlies</a></li>
<li><a class="reference internal" href="#installing-manually">Installing Manually</a></li>
</ul>
</li>
<li><a class="reference internal" href="#installing-staging-packages">Installing Staging Packages</a><ul>
<li><a class="reference internal" href="#installing-from-apache-staging">Installing from Apache Staging</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script src="../_static/documentation_options.js?v=c4c92189"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/scripts/furo.js?v=5fa4622c"></script>
</body>
</html>