docs/dev/java/install.html - arrow-site - Git at Google



 <!DOCTYPE html>


 <html lang="en" data-content_root="" >

   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

     <title>Installing Java Modules &#8212; Apache Arrow v17.0.0.dev52</title>


   <script data-cfasync="false">
     document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
     document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
   </script>

   <!-- Loaded before other Sphinx assets -->
   <link href="../_static/styles/theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
 <link href="../_static/styles/bootstrap.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
 <link href="../_static/styles/pydata-sphinx-theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" />


   <link href="../_static/vendor/fontawesome/6.5.1/css/all.min.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
   <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2" />
 <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2" />
 <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2" />

     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
     <link rel="stylesheet" type="text/css" href="../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
     <link rel="stylesheet" type="text/css" href="../_static/theme_overrides.css" />

   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
   <script src="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>

     <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
     <script src="../_static/doctools.js"></script>
     <script src="../_static/sphinx_highlight.js"></script>
     <script src="../_static/clipboard.min.js"></script>
     <script src="../_static/copybutton.js"></script>
     <script src="../_static/design-tabs.js"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'java/install';</script>
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.15.2';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = '/docs/_static/versions.json';
         DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'dev/';
         DOCUMENTATION_OPTIONS.show_version_warning_banner = true;
         </script>
     <link rel="canonical" href="https://arrow.apache.org/docs/java/install.html" />
     <link rel="icon" href="../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Memory Management" href="memory.html" />
     <link rel="prev" title="High-Level Overview" href="overview.html" />

   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>

   <!-- Matomo -->
   <script>
     var _paq = window._paq = window._paq || [];
     /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
     /* We explicitly disable cookie tracking to avoid privacy issues */
     _paq.push(['disableCookies']);
     _paq.push(['trackPageView']);
     _paq.push(['enableLinkTracking']);
     (function() {
       var u="https://analytics.apache.org/";
       _paq.push(['setTrackerUrl', u+'matomo.php']);
       _paq.push(['setSiteId', '20']);
       var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
       g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
     })();
   </script>
   <!-- End Matomo Code -->

   </head>


   <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">


   <a id="pst-skip-link" class="skip-link" href="#main-content">Skip to main content</a>

   <div id="pst-scroll-pixel-helper"></div>

   <button type="button" class="btn rounded-pill" id="pst-back-to-top">
     <i class="fa-solid fa-arrow-up"></i>
     Back to top
   </button>


   <input type="checkbox"
           class="sidebar-toggle"
           name="__primary"
           id="__primary"/>
   <label class="overlay overlay-primary" for="__primary"></label>

   <input type="checkbox"
           class="sidebar-toggle"
           name="__secondary"
           id="__secondary"/>
   <label class="overlay overlay-secondary" for="__secondary"></label>

   <div class="search-button__wrapper">
     <div class="search-button__overlay"></div>
     <div class="search-button__search-container">
 <form class="bd-search d-flex align-items-center"
       action="../search.html"
       method="get">
   <i class="fa-solid fa-magnifying-glass"></i>
   <input type="search"
          class="form-control"
          name="q"
          id="search-input"
          placeholder="Search the docs ..."
          aria-label="Search the docs ..."
          autocomplete="off"
          autocorrect="off"
          autocapitalize="off"
          spellcheck="false"/>
   <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
 </form></div>
   </div>

     <header class="bd-header navbar navbar-expand-lg bd-navbar">
 <div class="bd-header__inner bd-page-width">
   <label class="sidebar-toggle primary-toggle" for="__primary">
     <span class="fa-solid fa-bars"></span>
   </label>


   <div class="col-lg-3 navbar-header-items__start">

       <div class="navbar-item">


 <a class="navbar-brand logo" href="../index.html">


     <img src="../_static/arrow.png" class="logo__image only-light" alt="Apache Arrow v17.0.0.dev52 - Home"/>
     <script>document.write(`<img src="../_static/arrow-dark.png" class="logo__image only-dark" alt="Apache Arrow v17.0.0.dev52 - Home"/>`);</script>


 </a></div>

   </div>

   <div class="col-lg-9 navbar-header-items">

     <div class="me-auto navbar-header-items__center">

         <div class="navbar-item">
 <nav class="navbar-nav">
   <ul class="bd-navbar-elements navbar-nav">

                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../format/index.html">
                         Specifications
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../developers/index.html">
                         Development
                       </a>
                     </li>

             <li class="nav-item dropdown">
                 <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links">
                     Implementations
                 </button>
                 <ul id="pst-nav-more-links" class="dropdown-menu">

                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../c_glib/index.html">
                         C/GLib
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../cpp/index.html">
                         C++
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md">
                         C#
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17">
                         Go
                       </a>
                     </li>


                     <li class="nav-item current active">
                       <a class="nav-link dropdown-item nav-internal" href="index.html">
                         Java
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../js/index.html">
                         JavaScript
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/">
                         Julia
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md">
                         MATLAB
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/">
                         nanoarrow
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../python/index.html">
                         Python
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../r/index.html">
                         R
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md">
                         Ruby
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/">
                         Rust
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../status.html">
                         Implementation Status
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/">
                         C++ cookbook
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/">
                         Java cookbook
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/">
                         Python cookbook
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/">
                         R cookbook
                       </a>
                     </li>

                 </ul>
             </li>

   </ul>
 </nav></div>

     </div>


     <div class="navbar-header-items__end">

         <div class="navbar-item navbar-persistent--container">


  <script>
  document.write(`
    <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
     <i class="fa-solid fa-magnifying-glass"></i>
     <span class="search-button__default-text">Search</span>
     <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
    </button>
  `);
  </script>
         </div>


         <div class="navbar-item">
 <script>
 document.write(`
   <div class="version-switcher__container dropdown">
     <button id="pst-version-switcher-button-2"
       type="button"
       class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle"
       data-bs-toggle="dropdown"
       aria-haspopup="listbox"
       aria-controls="pst-version-switcher-list-2"
       aria-label="Version switcher list"
     >
       Choose version  <!-- this text may get changed later by javascript -->
       <span class="caret"></span>
     </button>
     <div id="pst-version-switcher-list-2"
       class="version-switcher__menu dropdown-menu list-group-flush py-0"
       role="listbox" aria-labelledby="pst-version-switcher-button-2">
       <!-- dropdown will be populated by javascript on page load -->
     </div>
   </div>
 `);
 </script></div>

         <div class="navbar-item">

 <script>
 document.write(`
   <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
     <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
     <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
     <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
   </button>
 `);
 </script></div>

         <div class="navbar-item"><ul class="navbar-icon-links navbar-nav"
     aria-label="Icon Links">
         <li class="nav-item">


           <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
             <span class="sr-only">GitHub</span></a>
         </li>
         <li class="nav-item">


           <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span>
             <span class="sr-only">X</span></a>
         </li>
 </ul></div>

     </div>

   </div>


     <div class="navbar-persistent--mobile">

  <script>
  document.write(`
    <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
     <i class="fa-solid fa-magnifying-glass"></i>
     <span class="search-button__default-text">Search</span>
     <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
    </button>
  `);
  </script>
     </div>


     <label class="sidebar-toggle secondary-toggle" for="__secondary" tabindex="0">
       <span class="fa-solid fa-outdent"></span>
     </label>

 </div>

     </header>


   <div class="bd-container">
     <div class="bd-container__inner bd-page-width">


       <div class="bd-sidebar-primary bd-sidebar">


   <div class="sidebar-header-items sidebar-primary__section">


       <div class="sidebar-header-items__center">

           <div class="navbar-item">
 <nav class="navbar-nav">
   <ul class="bd-navbar-elements navbar-nav">

                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../format/index.html">
                         Specifications
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../developers/index.html">
                         Development
                       </a>
                     </li>

             <li class="nav-item dropdown">
                 <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links-2">
                     Implementations
                 </button>
                 <ul id="pst-nav-more-links-2" class="dropdown-menu">

                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../c_glib/index.html">
                         C/GLib
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../cpp/index.html">
                         C++
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md">
                         C#
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17">
                         Go
                       </a>
                     </li>


                     <li class="nav-item current active">
                       <a class="nav-link dropdown-item nav-internal" href="index.html">
                         Java
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../js/index.html">
                         JavaScript
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/">
                         Julia
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md">
                         MATLAB
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/">
                         nanoarrow
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../python/index.html">
                         Python
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../r/index.html">
                         R
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md">
                         Ruby
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/">
                         Rust
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../status.html">
                         Implementation Status
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/">
                         C++ cookbook
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/">
                         Java cookbook
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/">
                         Python cookbook
                       </a>
                     </li>


                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/">
                         R cookbook
                       </a>
                     </li>

                 </ul>
             </li>

   </ul>
 </nav></div>

       </div>


       <div class="sidebar-header-items__end">

           <div class="navbar-item">
 <script>
 document.write(`
   <div class="version-switcher__container dropdown">
     <button id="pst-version-switcher-button-3"
       type="button"
       class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle"
       data-bs-toggle="dropdown"
       aria-haspopup="listbox"
       aria-controls="pst-version-switcher-list-3"
       aria-label="Version switcher list"
     >
       Choose version  <!-- this text may get changed later by javascript -->
       <span class="caret"></span>
     </button>
     <div id="pst-version-switcher-list-3"
       class="version-switcher__menu dropdown-menu list-group-flush py-0"
       role="listbox" aria-labelledby="pst-version-switcher-button-3">
       <!-- dropdown will be populated by javascript on page load -->
     </div>
   </div>
 `);
 </script></div>

           <div class="navbar-item">

 <script>
 document.write(`
   <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
     <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
     <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
     <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
   </button>
 `);
 </script></div>

           <div class="navbar-item"><ul class="navbar-icon-links navbar-nav"
     aria-label="Icon Links">
         <li class="nav-item">


           <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
             <span class="sr-only">GitHub</span></a>
         </li>
         <li class="nav-item">


           <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span>
             <span class="sr-only">X</span></a>
         </li>
 </ul></div>

       </div>

   </div>

     <div class="sidebar-primary-items__start sidebar-primary__section">
         <div class="sidebar-primary-item">
 <nav class="bd-docs-nav bd-links"
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
 <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 active"><a class="current reference internal" href="#">Installing Java Modules</a></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/">Java cookbook</a></li>
 </ul>
 </div>
 </nav></div>
     </div>


   <div class="sidebar-primary-items__end sidebar-primary__section">
   </div>

   <div id="rtd-footer-container"></div>


       </div>

       <main id="main-content" class="bd-main">


           <div class="bd-content">
             <div class="bd-article-container">

               <div class="bd-header-article">
 <div class="header-article-items header-article__inner">

     <div class="header-article-items__start">

         <div class="header-article-item">


 <nav aria-label="Breadcrumb">
   <ul class="bd-breadcrumbs">

     <li class="breadcrumb-item breadcrumb-home">
       <a href="../index.html" class="nav-link" aria-label="Home">
         <i class="fa-solid fa-home"></i>
       </a>
     </li>

     <li class="breadcrumb-item"><a href="index.html" class="nav-link">Java Implementation</a></li>

     <li class="breadcrumb-item active" aria-current="page">Installing...</li>
   </ul>
 </nav>
 </div>

     </div>


 </div>
 </div>


 <div id="searchbox"></div>
                 <article class="bd-article">

   <section id="installing-java-modules">
 <h1><a class="toc-backref" href="#id3" role="doc-backlink">Installing Java Modules</a><a class="headerlink" href="#installing-java-modules" title="Permalink 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="#installing-java-modules" id="id3">Installing Java Modules</a></p>
 <ul>
 <li><p><a class="reference internal" href="#system-compatibility" id="id4">System Compatibility</a></p></li>
 <li><p><a class="reference internal" href="#java-compatibility" id="id5">Java Compatibility</a></p></li>
 <li><p><a class="reference internal" href="#installing-from-maven" id="id6">Installing from Maven</a></p></li>
 <li><p><a class="reference internal" href="#installing-from-source" id="id7">Installing from Source</a></p></li>
 <li><p><a class="reference internal" href="#ide-configuration" id="id8">IDE Configuration</a></p></li>
 </ul>
 </li>
 </ul>
 </nav>
 <section id="system-compatibility">
 <h2><a class="toc-backref" href="#id4" role="doc-backlink">System Compatibility</a><a class="headerlink" href="#system-compatibility" title="Permalink 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><a class="toc-backref" href="#id5" role="doc-backlink">Java Compatibility</a><a class="headerlink" href="#java-compatibility" title="Permalink to this heading">#</a></h2>
 <p>Java modules are compatible with JDK 8 and above. Currently, JDK versions
 8, 11, 17, and 21 are tested in CI. The latest JDK is also tested in CI.</p>
 <p>When using Java 9 or later, 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">_JAVA_OPTIONS</span><span class="o">=</span><span class="s2">&quot;--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED&quot;</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">&quot;opens</span>
 <span class="pre">java.nio&quot;</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">&quot;opens</span>
 <span class="pre">java.nio&quot;</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">&quot;opens</span> <span class="pre">java.nio&quot;</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">_JAVA_OPTIONS</span><span class="o">=</span><span class="s2">&quot;--add-reads=org.apache.arrow.flight.core=ALL-UNNAMED --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED&quot;</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 <a href="#id1"><span class="problematic" id="id2">``</span></a>java.lang.IllegalAccessError: superclass access check failed: class
 org.apache.arrow.flight.ArrowMessage$ArrowBufRetainingCompositeByteBuf (in module org.apache.arrow.flight.core)
 cannot access class io.netty.buffer.CompositeByteBuf (in unnamed module …) because module
 org.apache.arrow.flight.core does not read unnamed module …</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:
 .. code-block:: shell</p>
 <blockquote>
 <div><p># Directly on the command line
 $ java –add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED -jar …
 # Indirectly via environment variables
 $ env _JAVA_OPTIONS=”–add-opens=java.base/java.nio=org.apache.arrow.dataset,org.apache.arrow.memory.core,ALL-UNNAMED” java -jar …</p>
 </div></blockquote>
 <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">&quot;opens</span> <span class="pre">java.nio&quot;</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><a class="toc-backref" href="#id6" role="doc-backlink">Installing from Maven</a><a class="headerlink" href="#installing-from-maven" title="Permalink 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">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
 <span class="nt">&lt;project</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://maven.apache.org/POM/4.0.0&quot;</span>
 <span class="w">         </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span>
 <span class="w">         </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd&quot;</span><span class="nt">&gt;</span>
 <span class="w">    </span><span class="nt">&lt;modelVersion&gt;</span>4.0.0<span class="nt">&lt;/modelVersion&gt;</span>
 <span class="w">    </span><span class="nt">&lt;groupId&gt;</span>org.example<span class="nt">&lt;/groupId&gt;</span>
 <span class="w">    </span><span class="nt">&lt;artifactId&gt;</span>demo<span class="nt">&lt;/artifactId&gt;</span>
 <span class="w">    </span><span class="nt">&lt;version&gt;</span>1.0-SNAPSHOT<span class="nt">&lt;/version&gt;</span>
 <span class="w">    </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="w">    </span><span class="nt">&lt;/properties&gt;</span>
 <span class="w">    </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="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-memory-netty<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="w">    </span><span class="nt">&lt;/dependencies&gt;</span>
 <span class="nt">&lt;/project&gt;</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">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
 <span class="nt">&lt;project</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://maven.apache.org/POM/4.0.0&quot;</span>
 <span class="w">         </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span>
 <span class="w">         </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd&quot;</span><span class="nt">&gt;</span>
 <span class="w">    </span><span class="nt">&lt;modelVersion&gt;</span>4.0.0<span class="nt">&lt;/modelVersion&gt;</span>
 <span class="w">    </span><span class="nt">&lt;groupId&gt;</span>org.example<span class="nt">&lt;/groupId&gt;</span>
 <span class="w">    </span><span class="nt">&lt;artifactId&gt;</span>demo<span class="nt">&lt;/artifactId&gt;</span>
 <span class="w">    </span><span class="nt">&lt;version&gt;</span>1.0-SNAPSHOT<span class="nt">&lt;/version&gt;</span>
 <span class="w">    </span><span class="nt">&lt;properties&gt;</span>
 <span class="w">        </span><span class="nt">&lt;arrow.version&gt;</span>15.0.0<span class="nt">&lt;/arrow.version&gt;</span>
 <span class="w">    </span><span class="nt">&lt;/properties&gt;</span>
 <span class="w">    </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;/dependency&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-memory-netty<span class="nt">&lt;/artifactId&gt;</span>
 <span class="w">        </span><span class="nt">&lt;/dependency&gt;</span>
 <span class="w">    </span><span class="nt">&lt;/dependencies&gt;</span>
 <span class="w">    </span><span class="nt">&lt;dependencyManagement&gt;</span>
 <span class="w">        </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-bom<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;type&gt;</span>pom<span class="nt">&lt;/type&gt;</span>
 <span class="w">                </span><span class="nt">&lt;scope&gt;</span>import<span class="nt">&lt;/scope&gt;</span>
 <span class="w">            </span><span class="nt">&lt;/dependency&gt;</span>
 <span class="w">        </span><span class="nt">&lt;/dependencies&gt;</span>
 <span class="w">    </span><span class="nt">&lt;/dependencyManagement&gt;</span>
 <span class="nt">&lt;/project&gt;</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">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
 <span class="nt">&lt;project</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://maven.apache.org/POM/4.0.0&quot;</span>
 <span class="w">         </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span>
 <span class="w">         </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd&quot;</span><span class="nt">&gt;</span>
 <span class="w">    </span><span class="nt">&lt;modelVersion&gt;</span>4.0.0<span class="nt">&lt;/modelVersion&gt;</span>
 <span class="w">    </span><span class="nt">&lt;groupId&gt;</span>org.example<span class="nt">&lt;/groupId&gt;</span>
 <span class="w">    </span><span class="nt">&lt;artifactId&gt;</span>demo<span class="nt">&lt;/artifactId&gt;</span>
 <span class="w">    </span><span class="nt">&lt;version&gt;</span>1.0-SNAPSHOT<span class="nt">&lt;/version&gt;</span>
 <span class="w">    </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="w">    </span><span class="nt">&lt;/properties&gt;</span>
 <span class="w">    </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="w">    </span><span class="nt">&lt;/dependencies&gt;</span>
 <span class="w">    </span><span class="nt">&lt;build&gt;</span>
 <span class="w">        </span><span class="nt">&lt;extensions&gt;</span>
 <span class="w">            </span><span class="nt">&lt;extension&gt;</span>
 <span class="w">                </span><span class="nt">&lt;groupId&gt;</span>kr.motd.maven<span class="nt">&lt;/groupId&gt;</span>
 <span class="w">                </span><span class="nt">&lt;artifactId&gt;</span>os-maven-plugin<span class="nt">&lt;/artifactId&gt;</span>
 <span class="w">                </span><span class="nt">&lt;version&gt;</span>1.7.0<span class="nt">&lt;/version&gt;</span>
 <span class="w">            </span><span class="nt">&lt;/extension&gt;</span>
 <span class="w">        </span><span class="nt">&lt;/extensions&gt;</span>
 <span class="w">    </span><span class="nt">&lt;/build&gt;</span>
 <span class="nt">&lt;/project&gt;</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">&lt;build&gt;</span>
 <span class="w">    </span><span class="nt">&lt;plugins&gt;</span>
 <span class="w">        </span><span class="nt">&lt;plugin&gt;</span>
 <span class="w">            </span><span class="nt">&lt;groupId&gt;</span>org.apache.maven.plugins<span class="nt">&lt;/groupId&gt;</span>
 <span class="w">            </span><span class="nt">&lt;artifactId&gt;</span>maven-surefire-plugin<span class="nt">&lt;/artifactId&gt;</span>
 <span class="w">            </span><span class="nt">&lt;version&gt;</span>3.0.0-M6<span class="nt">&lt;/version&gt;</span>
 <span class="w">            </span><span class="nt">&lt;configuration&gt;</span>
 <span class="w">                    </span><span class="nt">&lt;argLine&gt;</span>--add-opens=java.base/java.nio=ALL-UNNAMED<span class="nt">&lt;/argLine&gt;</span>
 <span class="w">            </span><span class="nt">&lt;/configuration&gt;</span>
 <span class="w">        </span><span class="nt">&lt;/plugin&gt;</span>
 <span class="w">    </span><span class="nt">&lt;/plugins&gt;</span>
 <span class="nt">&lt;/build&gt;</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">_JAVA_OPTIONS</span><span class="o">=</span><span class="s2">&quot;--add-opens=java.base/java.nio=ALL-UNNAMED&quot;</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">&quot;YourMainCode&quot;</span>
 </pre></div>
 </div>
 </section>
 <section id="installing-from-source">
 <h2><a class="toc-backref" href="#id7" role="doc-backlink">Installing from Source</a><a class="headerlink" href="#installing-from-source" title="Permalink to this heading">#</a></h2>
 <p>See <a class="reference internal" href="../developers/java/index.html#java-development"><span class="std std-ref">Java Development</span></a>.</p>
 </section>
 <section id="ide-configuration">
 <h2><a class="toc-backref" href="#id8" role="doc-backlink">IDE Configuration</a><a class="headerlink" href="#ide-configuration" title="Permalink 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>


                 <footer class="prev-next-footer">

 <div class="prev-next-area">
     <a class="left-prev"
        href="overview.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
         <p class="prev-next-subtitle">previous</p>
         <p class="prev-next-title">High-Level Overview</p>
       </div>
     </a>
     <a class="right-next"
        href="memory.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
         <p class="prev-next-title">Memory Management</p>
       </div>
       <i class="fa-solid fa-angle-right"></i>
     </a>
 </div>
                 </footer>

             </div>


                 <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


   <div class="sidebar-secondary-item">
 <div
     id="pst-page-navigation-heading-2"
     class="page-toc tocsection onthispage">
     <i class="fa-solid fa-list"></i> On this page
   </div>
   <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#system-compatibility">System Compatibility</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#java-compatibility">Java Compatibility</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installing-from-maven">Installing from Maven</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installing-from-source">Installing from Source</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#ide-configuration">IDE Configuration</a></li>
 </ul>
   </nav></div>

   <div class="sidebar-secondary-item">


   <div class="tocsection editthispage">
     <a href="https://github.com/apache/arrow/edit/main/docs/source/java/install.rst">
       <i class="fa-solid fa-pencil"></i>


           Edit on GitHub


     </a>
   </div>
 </div>

 </div></div>


           </div>
           <footer class="bd-footer-content">

           </footer>

       </main>
     </div>
   </div>

   <!-- Scripts loaded after <body> so the DOM is not blocked -->
   <script src="../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae"></script>
 <script src="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae"></script>

   <footer class="bd-footer">
 <div class="bd-footer__inner bd-page-width">

     <div class="footer-items__start">

         <div class="footer-item">

   <p class="copyright">

       © Copyright 2016-2024 Apache Software Foundation.
 Apache Arrow, Arrow, Apache, the Apache feather logo, and the Apache Arrow project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.
       <br/>

   </p>
 </div>

         <div class="footer-item">

   <p class="sphinx-version">
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
     <br/>
   </p>
 </div>

     </div>


     <div class="footer-items__end">

         <div class="footer-item">
 <p class="theme-version">
   Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.15.2.
 </p></div>

     </div>

 </div>

   </footer>
   </body>
 </html>