docs/dev/java/flight_sql_jdbc_driver.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>Arrow Flight SQL JDBC Driver &#8212; Apache Arrow v17.0.0.dev59</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/flight_sql_jdbc_driver';</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/flight_sql_jdbc_driver.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="Dataset" href="dataset.html" />
     <link rel="prev" title="Arrow Flight SQL" href="flight_sql.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.dev59 - Home"/>
     <script>document.write(`<img src="../_static/arrow-dark.png" class="logo__image only-dark" alt="Apache Arrow v17.0.0.dev59 - 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"><a class="reference internal" href="install.html">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 current active"><a class="current reference internal" href="#">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">Arrow...</li>
   </ul>
 </nav>
 </div>

     </div>


 </div>
 </div>


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

   <section id="arrow-flight-sql-jdbc-driver">
 <h1><a class="toc-backref" href="#id1" role="doc-backlink">Arrow Flight SQL JDBC Driver</a><a class="headerlink" href="#arrow-flight-sql-jdbc-driver" title="Permalink to this heading">#</a></h1>
 <p>The Flight SQL JDBC driver is a JDBC driver implementation that uses
 the <a class="reference internal" href="../format/FlightSql.html"><span class="doc">Flight SQL protocol</span></a> under the hood.
 This driver can be used with any database that implements Flight SQL.</p>
 <nav class="contents" id="contents">
 <p class="topic-title">Contents</p>
 <ul class="simple">
 <li><p><a class="reference internal" href="#arrow-flight-sql-jdbc-driver" id="id1">Arrow Flight SQL JDBC Driver</a></p>
 <ul>
 <li><p><a class="reference internal" href="#installation-and-requirements" id="id2">Installation and Requirements</a></p></li>
 <li><p><a class="reference internal" href="#connecting-to-a-database" id="id3">Connecting to a Database</a></p></li>
 </ul>
 </li>
 </ul>
 </nav>
 <section id="installation-and-requirements">
 <h2><a class="toc-backref" href="#id2" role="doc-backlink">Installation and Requirements</a><a class="headerlink" href="#installation-and-requirements" title="Permalink to this heading">#</a></h2>
 <p>The driver is compatible with JDK 8+.  On JDK 9+, the following JVM
 parameter is required:</p>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>java<span class="w"> </span>--add-opens<span class="o">=</span>java.base/java.nio<span class="o">=</span>ALL-UNNAMED<span class="w"> </span>...
 </pre></div>
 </div>
 <p>To add a dependency via Maven, use a <code class="docutils literal notranslate"><span class="pre">pom.xml</span></code> like the following:</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>10.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-sql-jdbc-driver<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>
 </section>
 <section id="connecting-to-a-database">
 <h2><a class="toc-backref" href="#id3" role="doc-backlink">Connecting to a Database</a><a class="headerlink" href="#connecting-to-a-database" title="Permalink to this heading">#</a></h2>
 <p>The URI format is as follows:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>jdbc:arrow-flight-sql://HOSTNAME:PORT[/?param1=val1&amp;param2=val2&amp;...]
 </pre></div>
 </div>
 <p>For example, take this URI:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>jdbc:arrow-flight-sql://localhost:12345/?username=admin&amp;password=pass&amp;useEncryption=1
 </pre></div>
 </div>
 <p>This will connect to a Flight SQL service running on <code class="docutils literal notranslate"><span class="pre">localhost</span></code> on
 port 12345.  It will create a secure, encrypted connection, and
 authenticate using the username <code class="docutils literal notranslate"><span class="pre">admin</span></code> and the password <code class="docutils literal notranslate"><span class="pre">pass</span></code>.</p>
 <p>The components of the URI are as follows.</p>
 <ul class="simple">
 <li><p>The URI scheme must be <code class="docutils literal notranslate"><span class="pre">jdbc:arrow-flight-sql://</span></code>.</p></li>
 <li><p><strong>HOSTNAME</strong> is the hostname of the Flight SQL service.</p></li>
 <li><p><strong>PORT</strong> is the port of the Flight SQL service.</p></li>
 </ul>
 <p>Additional options can be passed as query parameters. Parameter names are
 case-sensitive. The supported parameters are:</p>
 <table class="table">
 <thead>
 <tr class="row-odd"><th class="head"><p>Parameter</p></th>
 <th class="head"><p>Default</p></th>
 <th class="head"><p>Description</p></th>
 </tr>
 </thead>
 <tbody>
 <tr class="row-even"><td><p>disableCertificateVerification</p></td>
 <td><p>false</p></td>
 <td><p>When TLS is enabled, whether to verify the server certificate</p></td>
 </tr>
 <tr class="row-odd"><td><p>password</p></td>
 <td><p>null</p></td>
 <td><p>The password for user/password authentication</p></td>
 </tr>
 <tr class="row-even"><td><p>threadPoolSize</p></td>
 <td><p>1</p></td>
 <td><p>The size of an internal thread pool</p></td>
 </tr>
 <tr class="row-odd"><td><p>token</p></td>
 <td><p>null</p></td>
 <td><p>The token used for token authentication</p></td>
 </tr>
 <tr class="row-even"><td><p>trustStore</p></td>
 <td><p>null</p></td>
 <td><p>When TLS is enabled, the path to the certificate store</p></td>
 </tr>
 <tr class="row-odd"><td><p>trustStorePassword</p></td>
 <td><p>null</p></td>
 <td><p>When TLS is enabled, the password for the certificate store</p></td>
 </tr>
 <tr class="row-even"><td><p>tlsRootCerts</p></td>
 <td><p>null</p></td>
 <td><p>Path to PEM-encoded root certificates for TLS - use this as
 an alternative to <code class="docutils literal notranslate"><span class="pre">trustStore</span></code></p></td>
 </tr>
 <tr class="row-odd"><td><p>clientCertificate</p></td>
 <td><p>null</p></td>
 <td><p>Path to PEM-encoded client mTLS certificate when the Flight
 SQL server requires client verification.</p></td>
 </tr>
 <tr class="row-even"><td><p>clientKey</p></td>
 <td><p>null</p></td>
 <td><p>Path to PEM-encoded client mTLS key when the Flight
 SQL server requires client verification.</p></td>
 </tr>
 <tr class="row-odd"><td><p>useEncryption</p></td>
 <td><p>true</p></td>
 <td><p>Whether to use TLS (the default is an encrypted connection)</p></td>
 </tr>
 <tr class="row-even"><td><p>user</p></td>
 <td><p>null</p></td>
 <td><p>The username for user/password authentication</p></td>
 </tr>
 <tr class="row-odd"><td><p>useSystemTrustStore</p></td>
 <td><p>true</p></td>
 <td><p>When TLS is enabled, whether to use the system certificate store</p></td>
 </tr>
 <tr class="row-even"><td><p>retainCookies</p></td>
 <td><p>true</p></td>
 <td><p>Whether to use cookies from the initial connection in subsequent
 internal connections when retrieving streams from separate endpoints.</p></td>
 </tr>
 <tr class="row-odd"><td><p>retainAuth</p></td>
 <td><p>true</p></td>
 <td><p>Whether to use bearer tokens obtained from the initial connection
 in subsequent internal connections used for retrieving streams
 from separate endpoints.</p></td>
 </tr>
 </tbody>
 </table>
 <p>Note that URI values must be URI-encoded if they contain characters such
 as !, &#64;, $, etc.</p>
 <p>Any URI parameters that are not handled by the driver are passed to
 the Flight SQL service as gRPC headers. For example, the following URI</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>jdbc:arrow-flight-sql://localhost:12345/?useEncryption=0&amp;database=mydb
 </pre></div>
 </div>
 <p>This will connect without authentication or encryption, to a Flight
 SQL service running on <code class="docutils literal notranslate"><span class="pre">localhost</span></code> on port 12345. Each request will
 also include a <cite>database=mydb</cite> gRPC header.</p>
 <p>Connection parameters may also be supplied using the Properties object
 when using the JDBC Driver Manager to connect. When supplying using
 the Properties object, values should <em>not</em> be URI-encoded.</p>
 <p>Parameters specified by the URI supercede parameters supplied by the
 Properties object. When calling the <a class="reference external" href="https://docs.oracle.com/javase/8/docs/api/java/sql/DriverManager.html#getConnection-java.lang.String-java.lang.String-java.lang.String-">user/password overload of
 DriverManager#getConnection()</a>,
 the username and password supplied on the URI supercede the username and
 password arguments to the function call.</p>
 </section>
 </section>


                 </article>


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

 <div class="prev-next-area">
     <a class="left-prev"
        href="flight_sql.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">Arrow Flight SQL</p>
       </div>
     </a>
     <a class="right-next"
        href="dataset.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
         <p class="prev-next-title">Dataset</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="#installation-and-requirements">Installation and Requirements</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#connecting-to-a-database">Connecting to a Database</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/flight_sql_jdbc_driver.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>