| <!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="Java Development" href="developers/index.html" /><link rel="prev" title="High-Level Overview" href="overview.html" /> |
| |
| <!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> |
| <title>Installing Java Modules - 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 current current-page"><a class="current reference internal" href="#">Installing Java Modules</a></li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="developers/index.html">Java Development</a><input 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> |
| <li class="toctree-l2"><a class="reference internal" href="developers/building.html">Building Arrow Java</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="developers/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/install.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="installing-java-modules"> |
| <h1>Installing Java Modules<a class="headerlink" href="#installing-java-modules" title="Link to this heading">¶</a></h1> |
| <section id="system-compatibility"> |
| <h2>System Compatibility<a class="headerlink" href="#system-compatibility" title="Link to this heading">¶</a></h2> |
| <p>Java modules are regularly built and tested on macOS and Linux distributions.</p> |
| </section> |
| <section id="java-compatibility"> |
| <h2>Java Compatibility<a class="headerlink" href="#java-compatibility" title="Link to this heading">¶</a></h2> |
| <p>Java modules are compatible with JDK 11 and above. Currently, JDK versions |
| 11, 17, 21, and latest are tested in CI.</p> |
| <p>Note that some JDK internals must be exposed by |
| adding <code class="docutils literal notranslate"><span class="pre">--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED</span></code> to the <code class="docutils literal notranslate"><span class="pre">java</span></code> command:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># Directly on the command line</span> |
| $<span class="w"> </span>java<span class="w"> </span>--add-opens<span class="o">=</span>java.base/java.nio<span class="o">=</span>org.apache.arrow.memory.core,ALL-UNNAMED<span class="w"> </span>-jar<span class="w"> </span>... |
| <span class="c1"># Indirectly via environment variables</span> |
| $<span class="w"> </span>env<span class="w"> </span><span class="nv">JDK_JAVA_OPTIONS</span><span class="o">=</span><span class="s2">"--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED"</span><span class="w"> </span>java<span class="w"> </span>-jar<span class="w"> </span>... |
| </pre></div> |
| </div> |
| <p>Otherwise, you may see errors like <code class="docutils literal notranslate"><span class="pre">module</span> <span class="pre">java.base</span> <span class="pre">does</span> <span class="pre">not</span> <span class="pre">"opens</span> |
| <span class="pre">java.nio"</span> <span class="pre">to</span> <span class="pre">unnamed</span> <span class="pre">module</span></code> or <code class="docutils literal notranslate"><span class="pre">module</span> <span class="pre">java.base</span> <span class="pre">does</span> <span class="pre">not</span> <span class="pre">"opens</span> |
| <span class="pre">java.nio"</span> <span class="pre">to</span> <span class="pre">org.apache.arrow.memory.core</span></code></p> |
| <p>Note that the command has changed from Arrow 15 and earlier. If you are still using the flags from that version |
| (<code class="docutils literal notranslate"><span class="pre">--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED</span></code>) you will see the |
| <code class="docutils literal notranslate"><span class="pre">module</span> <span class="pre">java.base</span> <span class="pre">does</span> <span class="pre">not</span> <span class="pre">"opens</span> <span class="pre">java.nio"</span> <span class="pre">to</span> <span class="pre">org.apache.arrow.memory.core</span></code> error.</p> |
| <p>If you are using flight-core or dependent modules, you will need to mark that flight-core can read unnamed modules. |
| Modifying the command above for Flight:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># Directly on the command line</span> |
| $<span class="w"> </span>java<span class="w"> </span>--add-opens<span class="o">=</span>java.base/java.nio<span class="o">=</span>org.apache.arrow.memory.core,ALL-UNNAMED<span class="w"> </span>-jar<span class="w"> </span>... |
| <span class="c1"># Indirectly via environment variables</span> |
| $<span class="w"> </span>env<span class="w"> </span><span class="nv">JDK_JAVA_OPTIONS</span><span class="o">=</span><span class="s2">"--add-reads=org.apache.arrow.flight.core=ALL-UNNAMED --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED"</span><span class="w"> </span>java<span class="w"> </span>-jar<span class="w"> </span>... |
| </pre></div> |
| </div> |
| <p>Otherwise, you may see errors like <code class="docutils literal notranslate"><span class="pre">java.lang.IllegalAccessError:</span> <span class="pre">superclass</span> <span class="pre">access</span> <span class="pre">check</span> <span class="pre">failed:</span> <span class="pre">class</span> |
| <span class="pre">org.apache.arrow.flight.ArrowMessage$ArrowBufRetainingCompositeByteBuf</span> <span class="pre">(in</span> <span class="pre">module</span> <span class="pre">org.apache.arrow.flight.core)</span> |
| <span class="pre">cannot</span> <span class="pre">access</span> <span class="pre">class</span> <span class="pre">io.netty.buffer.CompositeByteBuf</span> <span class="pre">(in</span> <span class="pre">unnamed</span> <span class="pre">module</span> <span class="pre">...)</span> <span class="pre">because</span> <span class="pre">module</span> |
| <span class="pre">org.apache.arrow.flight.core</span> <span class="pre">does</span> <span class="pre">not</span> <span class="pre">read</span> <span class="pre">unnamed</span> <span class="pre">module</span> <span class="pre">...</span></code></p> |
| <p>Finally, if you are using arrow-dataset, you’ll also need to report that JDK internals need to be exposed. |
| Modifying the command above for arrow-memory:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># Directly on the command line</span> |
| $<span class="w"> </span>java<span class="w"> </span>--add-opens<span class="o">=</span>java.base/java.nio<span class="o">=</span>org.apache.arrow.memory.core,ALL-UNNAMED<span class="w"> </span>-jar<span class="w"> </span>... |
| <span class="c1"># Indirectly via environment variables</span> |
| $<span class="w"> </span>env<span class="w"> </span><span class="nv">JDK_JAVA_OPTIONS</span><span class="o">=</span><span class="s2">"--add-opens=java.base/java.nio=org.apache.arrow.dataset,org.apache.arrow.memory.core,ALL-UNNAMED"</span><span class="w"> </span>java<span class="w"> </span>-jar<span class="w"> </span>... |
| </pre></div> |
| </div> |
| <p>Otherwise you may see errors such as <code class="docutils literal notranslate"><span class="pre">java.lang.RuntimeException:</span> <span class="pre">java.lang.reflect.InaccessibleObjectException:</span> |
| <span class="pre">Unable</span> <span class="pre">to</span> <span class="pre">make</span> <span class="pre">static</span> <span class="pre">void</span> <span class="pre">java.nio.Bits.reserveMemory(long,long)</span> <span class="pre">accessible:</span> <span class="pre">module</span> |
| <span class="pre">java.base</span> <span class="pre">does</span> <span class="pre">not</span> <span class="pre">"opens</span> <span class="pre">java.nio"</span> <span class="pre">to</span> <span class="pre">module</span> <span class="pre">org.apache.arrow.dataset</span></code></p> |
| <p>If using Maven and Surefire for unit testing, <a class="reference internal" href="#java-install-maven-testing"><span class="std std-ref">this argument must |
| be added to Surefire as well</span></a>.</p> |
| </section> |
| <section id="installing-from-maven"> |
| <h2>Installing from Maven<a class="headerlink" href="#installing-from-maven" title="Link to this heading">¶</a></h2> |
| <p>By default, Maven will download from the central repository: <a class="reference external" href="https://repo.maven.apache.org/maven2/org/apache/arrow/">https://repo.maven.apache.org/maven2/org/apache/arrow/</a></p> |
| <p>Configure your pom.xml with the Java modules needed, for example: |
| arrow-vector, and arrow-memory-netty.</p> |
| <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span> |
| <span class="nt"><project</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">"http://maven.apache.org/POM/4.0.0"</span> |
| <span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> |
| <span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"</span><span class="nt">></span> |
| <span class="w"> </span><span class="nt"><modelVersion></span>4.0.0<span class="nt"></modelVersion></span> |
| <span class="w"> </span><span class="nt"><groupId></span>org.example<span class="nt"></groupId></span> |
| <span class="w"> </span><span class="nt"><artifactId></span>demo<span class="nt"></artifactId></span> |
| <span class="w"> </span><span class="nt"><version></span>1.0-SNAPSHOT<span class="nt"></version></span> |
| <span class="w"> </span><span class="nt"><properties></span> |
| <span class="w"> </span><span class="nt"><arrow.version></span>9.0.0<span class="nt"></arrow.version></span> |
| <span class="w"> </span><span class="nt"></properties></span> |
| <span class="w"> </span><span class="nt"><dependencies></span> |
| <span class="w"> </span><span class="nt"><dependency></span> |
| <span class="w"> </span><span class="nt"><groupId></span>org.apache.arrow<span class="nt"></groupId></span> |
| <span class="w"> </span><span class="nt"><artifactId></span>arrow-vector<span class="nt"></artifactId></span> |
| <span class="w"> </span><span class="nt"><version></span>${arrow.version}<span class="nt"></version></span> |
| <span class="w"> </span><span class="nt"></dependency></span> |
| <span class="w"> </span><span class="nt"><dependency></span> |
| <span class="w"> </span><span class="nt"><groupId></span>org.apache.arrow<span class="nt"></groupId></span> |
| <span class="w"> </span><span class="nt"><artifactId></span>arrow-memory-netty<span class="nt"></artifactId></span> |
| <span class="w"> </span><span class="nt"><version></span>${arrow.version}<span class="nt"></version></span> |
| <span class="w"> </span><span class="nt"></dependency></span> |
| <span class="w"> </span><span class="nt"></dependencies></span> |
| <span class="nt"></project></span> |
| </pre></div> |
| </div> |
| <p>A bill of materials (BOM) module has been provided to simplify adding |
| Arrow modules. This eliminates the need to specify the version for |
| every module. An alternative to the above would be:</p> |
| <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span> |
| <span class="nt"><project</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">"http://maven.apache.org/POM/4.0.0"</span> |
| <span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> |
| <span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"</span><span class="nt">></span> |
| <span class="w"> </span><span class="nt"><modelVersion></span>4.0.0<span class="nt"></modelVersion></span> |
| <span class="w"> </span><span class="nt"><groupId></span>org.example<span class="nt"></groupId></span> |
| <span class="w"> </span><span class="nt"><artifactId></span>demo<span class="nt"></artifactId></span> |
| <span class="w"> </span><span class="nt"><version></span>1.0-SNAPSHOT<span class="nt"></version></span> |
| <span class="w"> </span><span class="nt"><properties></span> |
| <span class="w"> </span><span class="nt"><arrow.version></span>15.0.0<span class="nt"></arrow.version></span> |
| <span class="w"> </span><span class="nt"></properties></span> |
| <span class="w"> </span><span class="nt"><dependencies></span> |
| <span class="w"> </span><span class="nt"><dependency></span> |
| <span class="w"> </span><span class="nt"><groupId></span>org.apache.arrow<span class="nt"></groupId></span> |
| <span class="w"> </span><span class="nt"><artifactId></span>arrow-vector<span class="nt"></artifactId></span> |
| <span class="w"> </span><span class="nt"></dependency></span> |
| <span class="w"> </span><span class="nt"><dependency></span> |
| <span class="w"> </span><span class="nt"><groupId></span>org.apache.arrow<span class="nt"></groupId></span> |
| <span class="w"> </span><span class="nt"><artifactId></span>arrow-memory-netty<span class="nt"></artifactId></span> |
| <span class="w"> </span><span class="nt"></dependency></span> |
| <span class="w"> </span><span class="nt"></dependencies></span> |
| <span class="w"> </span><span class="nt"><dependencyManagement></span> |
| <span class="w"> </span><span class="nt"><dependencies></span> |
| <span class="w"> </span><span class="nt"><dependency></span> |
| <span class="w"> </span><span class="nt"><groupId></span>org.apache.arrow<span class="nt"></groupId></span> |
| <span class="w"> </span><span class="nt"><artifactId></span>arrow-bom<span class="nt"></artifactId></span> |
| <span class="w"> </span><span class="nt"><version></span>${arrow.version}<span class="nt"></version></span> |
| <span class="w"> </span><span class="nt"><type></span>pom<span class="nt"></type></span> |
| <span class="w"> </span><span class="nt"><scope></span>import<span class="nt"></scope></span> |
| <span class="w"> </span><span class="nt"></dependency></span> |
| <span class="w"> </span><span class="nt"></dependencies></span> |
| <span class="w"> </span><span class="nt"></dependencyManagement></span> |
| <span class="nt"></project></span> |
| </pre></div> |
| </div> |
| <p>To use the Arrow Flight dependencies, also add the <code class="docutils literal notranslate"><span class="pre">os-maven-plugin</span></code> |
| plugin. This plugin generates useful platform-dependent properties |
| such as <code class="docutils literal notranslate"><span class="pre">os.detected.name</span></code> and <code class="docutils literal notranslate"><span class="pre">os.detected.arch</span></code> needed to resolve |
| transitive dependencies of Flight.</p> |
| <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span> |
| <span class="nt"><project</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">"http://maven.apache.org/POM/4.0.0"</span> |
| <span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> |
| <span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"</span><span class="nt">></span> |
| <span class="w"> </span><span class="nt"><modelVersion></span>4.0.0<span class="nt"></modelVersion></span> |
| <span class="w"> </span><span class="nt"><groupId></span>org.example<span class="nt"></groupId></span> |
| <span class="w"> </span><span class="nt"><artifactId></span>demo<span class="nt"></artifactId></span> |
| <span class="w"> </span><span class="nt"><version></span>1.0-SNAPSHOT<span class="nt"></version></span> |
| <span class="w"> </span><span class="nt"><properties></span> |
| <span class="w"> </span><span class="nt"><arrow.version></span>9.0.0<span class="nt"></arrow.version></span> |
| <span class="w"> </span><span class="nt"></properties></span> |
| <span class="w"> </span><span class="nt"><dependencies></span> |
| <span class="w"> </span><span class="nt"><dependency></span> |
| <span class="w"> </span><span class="nt"><groupId></span>org.apache.arrow<span class="nt"></groupId></span> |
| <span class="w"> </span><span class="nt"><artifactId></span>flight-core<span class="nt"></artifactId></span> |
| <span class="w"> </span><span class="nt"><version></span>${arrow.version}<span class="nt"></version></span> |
| <span class="w"> </span><span class="nt"></dependency></span> |
| <span class="w"> </span><span class="nt"></dependencies></span> |
| <span class="w"> </span><span class="nt"><build></span> |
| <span class="w"> </span><span class="nt"><extensions></span> |
| <span class="w"> </span><span class="nt"><extension></span> |
| <span class="w"> </span><span class="nt"><groupId></span>kr.motd.maven<span class="nt"></groupId></span> |
| <span class="w"> </span><span class="nt"><artifactId></span>os-maven-plugin<span class="nt"></artifactId></span> |
| <span class="w"> </span><span class="nt"><version></span>1.7.0<span class="nt"></version></span> |
| <span class="w"> </span><span class="nt"></extension></span> |
| <span class="w"> </span><span class="nt"></extensions></span> |
| <span class="w"> </span><span class="nt"></build></span> |
| <span class="nt"></project></span> |
| </pre></div> |
| </div> |
| <p id="java-install-maven-testing">The <code class="docutils literal notranslate"><span class="pre">--add-opens</span></code> flag must be added when running unit tests through Maven:</p> |
| <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><build></span> |
| <span class="w"> </span><span class="nt"><plugins></span> |
| <span class="w"> </span><span class="nt"><plugin></span> |
| <span class="w"> </span><span class="nt"><groupId></span>org.apache.maven.plugins<span class="nt"></groupId></span> |
| <span class="w"> </span><span class="nt"><artifactId></span>maven-surefire-plugin<span class="nt"></artifactId></span> |
| <span class="w"> </span><span class="nt"><version></span>3.0.0-M6<span class="nt"></version></span> |
| <span class="w"> </span><span class="nt"><configuration></span> |
| <span class="w"> </span><span class="nt"><argLine></span>--add-opens=java.base/java.nio=ALL-UNNAMED<span class="nt"></argLine></span> |
| <span class="w"> </span><span class="nt"></configuration></span> |
| <span class="w"> </span><span class="nt"></plugin></span> |
| <span class="w"> </span><span class="nt"></plugins></span> |
| <span class="nt"></build></span> |
| </pre></div> |
| </div> |
| <p>Or they can be added via environment variable, for example when executing your code:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">JDK_JAVA_OPTIONS</span><span class="o">=</span><span class="s2">"--add-opens=java.base/java.nio=ALL-UNNAMED"</span> <span class="n">mvn</span> <span class="n">exec</span><span class="p">:</span><span class="n">java</span> <span class="o">-</span><span class="n">Dexec</span><span class="o">.</span><span class="n">mainClass</span><span class="o">=</span><span class="s2">"YourMainCode"</span> |
| </pre></div> |
| </div> |
| </section> |
| <section id="installing-from-source"> |
| <h2>Installing from Source<a class="headerlink" href="#installing-from-source" title="Link to this heading">¶</a></h2> |
| <p>See <a class="reference internal" href="developers/index.html#java-development"><span class="std std-ref">Java Development</span></a>.</p> |
| </section> |
| <section id="ide-configuration"> |
| <h2>IDE Configuration<a class="headerlink" href="#ide-configuration" title="Link to this heading">¶</a></h2> |
| <p>Generally, no additional configuration should be needed. However, |
| ensure your Maven or other build configuration has the <code class="docutils literal notranslate"><span class="pre">--add-opens</span></code> |
| flag as described above, so that the IDE picks it up and runs tests |
| with that flag as well.</p> |
| </section> |
| </section> |
| |
| </article> |
| </div> |
| <footer> |
| |
| <div class="related-pages"> |
| <a class="next-page" href="developers/index.html"> |
| <div class="page-info"> |
| <div class="context"> |
| <span>Next</span> |
| </div> |
| <div class="title">Java Development</div> |
| </div> |
| <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> |
| </a> |
| <a class="prev-page" href="overview.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">High-Level Overview</div> |
| |
| </div> |
| </a> |
| </div> |
| <div class="bottom-of-page"> |
| <div class="left-details"> |
| <div class="copyright"> |
| Copyright © 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="#">Installing Java Modules</a><ul> |
| <li><a class="reference internal" href="#system-compatibility">System Compatibility</a></li> |
| <li><a class="reference internal" href="#java-compatibility">Java Compatibility</a></li> |
| <li><a class="reference internal" href="#installing-from-maven">Installing from Maven</a></li> |
| <li><a class="reference internal" href="#installing-from-source">Installing from Source</a></li> |
| <li><a class="reference internal" href="#ide-configuration">IDE Configuration</a></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> |
