current/configuration.html - arrow-flight-sql-postgresql - Git at Google


 <!DOCTYPE html>


 <html lang="en" >

   <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>Configuration &#8212; Apache Arrow Flight SQL adapter for PostgreSQL current documentation</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=e353d410970836974a52" rel="stylesheet" />
 <link href="_static/styles/bootstrap.css?digest=e353d410970836974a52" rel="stylesheet" />
 <link href="_static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52" rel="stylesheet" />


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

     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/tabs.css" />

   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />

     <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/tabs.js"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'configuration';</script>
     <script>
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://arrow.apache.org/flight-sql-postgresql/devel/_static/switcher.json';
         DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'current';
         </script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Client" href="client.html" />
     <link rel="prev" title="Install" href="install.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </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 class="skip-link" href="#main-content">Skip to main content</a>

   <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>

     <nav 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="navbar-header-items__start">

       <div class="navbar-item">


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


     <img src="_static/logo-light.png" class="logo__image only-light" alt="Apache Arrow Flight SQL adapter for PostgreSQL"/>
     <script>document.write(`<img src="_static/logo-dark.png" class="logo__image only-dark" alt="Apache Arrow Flight SQL adapter for PostgreSQL"/>`);</script>


 </a></div>

   </div>


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


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

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

 <script>
 document.write(`
   <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
     <i class="fa-solid fa-magnifying-glass"></i>
   </button>
 `);
 </script>
         </div>


         <div class="navbar-item">
 <script>
 document.write(`
   <button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
     <span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
     <span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
     <span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></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-flight-sql-postgresql" 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"></i></span>
             <label class="sr-only">GitHub</label></a>
         </li>
 </ul></div>

         <div class="navbar-item">
 <script>
 document.write(`
   <div class="version-switcher__container dropdown">
     <button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-bs-toggle="dropdown">
       current  <!-- this text may get changed later by javascript -->
       <span class="caret"></span>
     </button>
     <div class="version-switcher__menu dropdown-menu list-group-flush py-0">
     <!-- dropdown will be populated by javascript on page load -->
     </div>
   </div>
 `);
 </script></div>

     </div>

   </div>


     <div class="navbar-persistent--mobile">
 <script>
 document.write(`
   <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
     <i class="fa-solid fa-magnifying-glass"></i>
   </button>
 `);
 </script>
     </div>


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

 </div>

     </nav>

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

       <div class="bd-sidebar-primary bd-sidebar hide-on-wide">


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


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

           <div class="navbar-item">
 <script>
 document.write(`
   <button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
     <span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
     <span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
     <span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></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-flight-sql-postgresql" 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"></i></span>
             <label class="sr-only">GitHub</label></a>
         </li>
 </ul></div>

           <div class="navbar-item">
 <script>
 document.write(`
   <div class="version-switcher__container dropdown">
     <button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-bs-toggle="dropdown">
       current  <!-- this text may get changed later by javascript -->
       <span class="caret"></span>
     </button>
     <div class="version-switcher__menu dropdown-menu list-group-flush py-0">
     <!-- dropdown will be populated by javascript on page load -->
     </div>
   </div>
 `);
 </script></div>

       </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="Breadcrumbs">
   <ul class="bd-breadcrumbs" role="navigation" aria-label="Breadcrumb">

     <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 active" aria-current="page">Configuration</li>
   </ul>
 </nav>
 </div>

     </div>


 </div>
 </div>


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

   <!--
   Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.
 -->
 <section class="tex2jax_ignore mathjax_ignore" id="configuration">
 <h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading">#</a></h1>
 <section id="shared-preload-libraries">
 <h2><code class="docutils literal notranslate"><span class="pre">shared_preload_libraries</span></code><a class="headerlink" href="#shared-preload-libraries" title="Permalink to this heading">#</a></h2>
 <p>You must add <code class="docutils literal notranslate"><span class="pre">arrow_flight_sql</span></code> to
 <a class="reference external" href="https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-SHARED-PRELOAD-LIBRARIES"><code class="docutils literal notranslate"><span class="pre">shared_preload_libraries</span></code></a>.</p>
 <p>You need to restart your PostgreSQL after changing
 <code class="docutils literal notranslate"><span class="pre">shared_preload_libraries</span></code>.</p>
 </section>
 <section id="arrow-flight-sql-uri">
 <h2><code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.uri</span></code><a class="headerlink" href="#arrow-flight-sql-uri" title="Permalink to this heading">#</a></h2>
 <p>The endpoint URI for Apache Arrow Flight SQL.</p>
 <p>The default is <code class="docutils literal notranslate"><span class="pre">grpc://127.0.0.1:15432</span></code>.</p>
 <p>If you want to use TLS to connect the Apache Arrow Flight SQL
 endpoint, you need to do the followings:</p>
 <ol class="arabic simple">
 <li><p>Use <code class="docutils literal notranslate"><span class="pre">grpc+tls</span></code> schema such as <code class="docutils literal notranslate"><span class="pre">grpc+tls://127.0.0.1:15432</span></code> for
 <code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.uri</span></code></p></li>
 <li><p>Prepare the standard PostgreSQL TLS configurations such as
 <a class="reference external" href="https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-SSL"><code class="docutils literal notranslate"><span class="pre">ssl</span></code></a>,
 <a class="reference external" href="https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-SSL-CA-FILE"><code class="docutils literal notranslate"><span class="pre">ssl_ca_file</span></code></a>. Apache Arrow Flight SQL
 adapter for PostgreSQL uses the PostgreSQL’s TLS configurations. So
 you don’t need to prepare TLS related things only for Apache Arrow
 Flight SQL for PostgreSQL. See also the PostgreSQL’s <a class="reference external" href="https://www.postgresql.org/docs/current/ssl-tcp.html">Secure TCP/IP
 Connections with SSL</a> documentation.</p></li>
 </ol>
 <p>Note that you also need to setup client side. For example, see the
 following documentations for the C++ implementation of Apache Arrow
 Flight SQL client:</p>
 <ul class="simple">
 <li><p><a class="reference external" href="https://arrow.apache.org/docs/cpp/flight.html#enabling-tls">Enable TLS</a></p></li>
 </ul>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>mTLS (mutual-TLS) isn’t implemented yet. If you’re interested in mTLS,
 please see the issue for it: <a class="github reference external" href="https://github.com/apache/arrow-flight-sql-postgresql/issues/79">apache/arrow-flight-sql-postgresql#79</a></p>
 </div>
 </section>
 <section id="arrow-flight-sql-session-timeout">
 <h2><code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.session_timeout</span></code><a class="headerlink" href="#arrow-flight-sql-session-timeout" title="Permalink to this heading">#</a></h2>
 <p>The maximum session duration in seconds.</p>
 <p>The default is 300 seconds.</p>
 <p>-1 means no timeout.</p>
 <p>If no query is executed during the timeout, the session is closed
 automatically.</p>
 </section>
 <section id="arrow-flight-sql-max-n-rows-per-record-batch">
 <h2><code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.max_n_rows_per_record_batch</span></code><a class="headerlink" href="#arrow-flight-sql-max-n-rows-per-record-batch" title="Permalink to this heading">#</a></h2>
 <p>The maximum number of rows per record batch.</p>
 <p>The default is 1 * 1024 * 1024 rows.</p>
 <p>If this value is small, total data exchange time will be slower.</p>
 <p>If this value is larger, latency will be larger.</p>
 </section>
 </section>


                 </article>


                 <footer class="bd-footer-article">

 <div class="footer-article-items footer-article__inner">

     <div class="footer-article-item"><!-- Previous / next buttons -->
 <div class="prev-next-area">
     <a class="left-prev"
        href="install.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">Install</p>
       </div>
     </a>
     <a class="right-next"
        href="client.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
         <p class="prev-next-title">Client</p>
       </div>
       <i class="fa-solid fa-angle-right"></i>
     </a>
 </div></div>

 </div>

                 </footer>

             </div>


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

   <div class="sidebar-secondary-item">
   <div class="page-toc tocsection onthispage">
     <i class="fa-solid fa-list"></i> On this page
   </div>
   <nav class="bd-toc-nav page-toc">
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#shared-preload-libraries"><code class="docutils literal notranslate"><span class="pre">shared_preload_libraries</span></code></a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#arrow-flight-sql-uri"><code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.uri</span></code></a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#arrow-flight-sql-session-timeout"><code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.session_timeout</span></code></a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#arrow-flight-sql-max-n-rows-per-record-batch"><code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.max_n_rows_per_record_batch</span></code></a></li>
 </ul>
   </nav></div>

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

   <div class="tocsection editthispage">
     <a href="https://github.com/apache/arrow-flight-sql-postgresql/edit/main/docs/source/configuration.md">
       <i class="fa-solid fa-pencil"></i>


           Edit on GitHub


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

   <div class="sidebar-secondary-item">
   <div class="tocsection sourcelink">
     <a href="_sources/configuration.md.txt">
       <i class="fa-solid fa-file-lines"></i> Show Source
     </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=e353d410970836974a52"></script>
 <script src="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52"></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 2022-2023, Apache Arrow Developers.
       <br/>

   </p>
 </div>

         <div class="footer-item">
   <p class="sphinx-version">
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.0.1.
     <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.13.3.
 </p></div>

     </div>

 </div>

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

	<!DOCTYPE html>


	<html lang="en" >

	<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>Configuration — Apache Arrow Flight SQL adapter for PostgreSQL current documentation</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=e353d410970836974a52" rel="stylesheet" />
	<link href="_static/styles/bootstrap.css?digest=e353d410970836974a52" rel="stylesheet" />
	<link href="_static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52" rel="stylesheet" />


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

	<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
	<link rel="stylesheet" type="text/css" href="_static/tabs.css" />

	<!-- Pre-loaded scripts that we'll load fully later -->
	<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
	<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />

	<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/tabs.js"></script>
	<script>DOCUMENTATION_OPTIONS.pagename = 'configuration';</script>
	<script>
	DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://arrow.apache.org/flight-sql-postgresql/devel/_static/switcher.json';
	DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'current';
	</script>
	<link rel="index" title="Index" href="genindex.html" />
	<link rel="search" title="Search" href="search.html" />
	<link rel="next" title="Client" href="client.html" />
	<link rel="prev" title="Install" href="install.html" />
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<meta name="docsearch:language" content="en"/>
	</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 class="skip-link" href="#main-content">Skip to main content</a>

	<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>

	<nav 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="navbar-header-items__start">

	<div class="navbar-item">


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









	<img src="_static/logo-light.png" class="logo__image only-light" alt="Apache Arrow Flight SQL adapter for PostgreSQL"/>
	<script>document.write(`<img src="_static/logo-dark.png" class="logo__image only-dark" alt="Apache Arrow Flight SQL adapter for PostgreSQL"/>`);</script>


	</a></div>

	</div>


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


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

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

	<script>
	document.write(`
	<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
	<i class="fa-solid fa-magnifying-glass"></i>
	</button>
	`);
	</script>
	</div>


	<div class="navbar-item">
	<script>
	document.write(`
	<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
	<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
	<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
	<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></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-flight-sql-postgresql" 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"></i></span>
	<label class="sr-only">GitHub</label></a>
	</li>
	</ul></div>

	<div class="navbar-item">
	<script>
	document.write(`
	<div class="version-switcher__container dropdown">
	<button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-bs-toggle="dropdown">
	current <!-- this text may get changed later by javascript -->
	<span class="caret"></span>
	</button>
	<div class="version-switcher__menu dropdown-menu list-group-flush py-0">
	<!-- dropdown will be populated by javascript on page load -->
	</div>
	</div>
	`);
	</script></div>

	</div>

	</div>


	<div class="navbar-persistent--mobile">
	<script>
	document.write(`
	<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
	<i class="fa-solid fa-magnifying-glass"></i>
	</button>
	`);
	</script>
	</div>



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

	</div>

	</nav>

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

	<div class="bd-sidebar-primary bd-sidebar hide-on-wide">



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




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

	<div class="navbar-item">
	<script>
	document.write(`
	<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
	<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
	<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
	<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></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-flight-sql-postgresql" 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"></i></span>
	<label class="sr-only">GitHub</label></a>
	</li>
	</ul></div>

	<div class="navbar-item">
	<script>
	document.write(`
	<div class="version-switcher__container dropdown">
	<button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-bs-toggle="dropdown">
	current <!-- this text may get changed later by javascript -->
	<span class="caret"></span>
	</button>
	<div class="version-switcher__menu dropdown-menu list-group-flush py-0">
	<!-- dropdown will be populated by javascript on page load -->
	</div>
	</div>
	`);
	</script></div>

	</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="Breadcrumbs">
	<ul class="bd-breadcrumbs" role="navigation" aria-label="Breadcrumb">

	<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 active" aria-current="page">Configuration</li>
	</ul>
	</nav>
	</div>

	</div>


	</div>
	</div>




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

	<!--
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	-->
	<section class="tex2jax_ignore mathjax_ignore" id="configuration">
	<h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading">#</a></h1>
	<section id="shared-preload-libraries">
	<h2><code class="docutils literal notranslate"><span class="pre">shared_preload_libraries</span></code><a class="headerlink" href="#shared-preload-libraries" title="Permalink to this heading">#</a></h2>
	<p>You must add <code class="docutils literal notranslate"><span class="pre">arrow_flight_sql</span></code> to
	<a class="reference external" href="https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-SHARED-PRELOAD-LIBRARIES"><code class="docutils literal notranslate"><span class="pre">shared_preload_libraries</span></code></a>.</p>
	<p>You need to restart your PostgreSQL after changing
	<code class="docutils literal notranslate"><span class="pre">shared_preload_libraries</span></code>.</p>
	</section>
	<section id="arrow-flight-sql-uri">
	<h2><code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.uri</span></code><a class="headerlink" href="#arrow-flight-sql-uri" title="Permalink to this heading">#</a></h2>
	<p>The endpoint URI for Apache Arrow Flight SQL.</p>
	<p>The default is <code class="docutils literal notranslate"><span class="pre">grpc://127.0.0.1:15432</span></code>.</p>
	<p>If you want to use TLS to connect the Apache Arrow Flight SQL
	endpoint, you need to do the followings:</p>
	<ol class="arabic simple">
	<li><p>Use <code class="docutils literal notranslate"><span class="pre">grpc+tls</span></code> schema such as <code class="docutils literal notranslate"><span class="pre">grpc+tls://127.0.0.1:15432</span></code> for
	<code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.uri</span></code></p></li>
	<li><p>Prepare the standard PostgreSQL TLS configurations such as
	<a class="reference external" href="https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-SSL"><code class="docutils literal notranslate"><span class="pre">ssl</span></code></a>,
	<a class="reference external" href="https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-SSL-CA-FILE"><code class="docutils literal notranslate"><span class="pre">ssl_ca_file</span></code></a>. Apache Arrow Flight SQL
	adapter for PostgreSQL uses the PostgreSQL’s TLS configurations. So
	you don’t need to prepare TLS related things only for Apache Arrow
	Flight SQL for PostgreSQL. See also the PostgreSQL’s <a class="reference external" href="https://www.postgresql.org/docs/current/ssl-tcp.html">Secure TCP/IP
	Connections with SSL</a> documentation.</p></li>
	</ol>
	<p>Note that you also need to setup client side. For example, see the
	following documentations for the C++ implementation of Apache Arrow
	Flight SQL client:</p>
	<ul class="simple">
	<li><p><a class="reference external" href="https://arrow.apache.org/docs/cpp/flight.html#enabling-tls">Enable TLS</a></p></li>
	</ul>
	<div class="admonition note">
	<p class="admonition-title">Note</p>
	<p>mTLS (mutual-TLS) isn’t implemented yet. If you’re interested in mTLS,
	please see the issue for it: <a class="github reference external" href="https://github.com/apache/arrow-flight-sql-postgresql/issues/79">apache/arrow-flight-sql-postgresql#79</a></p>
	</div>
	</section>
	<section id="arrow-flight-sql-session-timeout">
	<h2><code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.session_timeout</span></code><a class="headerlink" href="#arrow-flight-sql-session-timeout" title="Permalink to this heading">#</a></h2>
	<p>The maximum session duration in seconds.</p>
	<p>The default is 300 seconds.</p>
	<p>-1 means no timeout.</p>
	<p>If no query is executed during the timeout, the session is closed
	automatically.</p>
	</section>
	<section id="arrow-flight-sql-max-n-rows-per-record-batch">
	<h2><code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.max_n_rows_per_record_batch</span></code><a class="headerlink" href="#arrow-flight-sql-max-n-rows-per-record-batch" title="Permalink to this heading">#</a></h2>
	<p>The maximum number of rows per record batch.</p>
	<p>The default is 1 * 1024 * 1024 rows.</p>
	<p>If this value is small, total data exchange time will be slower.</p>
	<p>If this value is larger, latency will be larger.</p>
	</section>
	</section>


	</article>



	<footer class="bd-footer-article">

	<div class="footer-article-items footer-article__inner">

	<div class="footer-article-item"><!-- Previous / next buttons -->
	<div class="prev-next-area">
	<a class="left-prev"
	href="install.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">Install</p>
	</div>
	</a>
	<a class="right-next"
	href="client.html"
	title="next page">
	<div class="prev-next-info">
	<p class="prev-next-subtitle">next</p>
	<p class="prev-next-title">Client</p>
	</div>
	<i class="fa-solid fa-angle-right"></i>
	</a>
	</div></div>

	</div>

	</footer>

	</div>



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

	<div class="sidebar-secondary-item">
	<div class="page-toc tocsection onthispage">
	<i class="fa-solid fa-list"></i> On this page
	</div>
	<nav class="bd-toc-nav page-toc">
	<ul class="visible nav section-nav flex-column">
	<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#shared-preload-libraries"><code class="docutils literal notranslate"><span class="pre">shared_preload_libraries</span></code></a></li>
	<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#arrow-flight-sql-uri"><code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.uri</span></code></a></li>
	<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#arrow-flight-sql-session-timeout"><code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.session_timeout</span></code></a></li>
	<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#arrow-flight-sql-max-n-rows-per-record-batch"><code class="docutils literal notranslate"><span class="pre">arrow_flight_sql.max_n_rows_per_record_batch</span></code></a></li>
	</ul>
	</nav></div>

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

	<div class="tocsection editthispage">
	<a href="https://github.com/apache/arrow-flight-sql-postgresql/edit/main/docs/source/configuration.md">
	<i class="fa-solid fa-pencil"></i>



	Edit on GitHub


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

	<div class="sidebar-secondary-item">
	<div class="tocsection sourcelink">
	<a href="_sources/configuration.md.txt">
	<i class="fa-solid fa-file-lines"></i> Show Source
	</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=e353d410970836974a52"></script>
	<script src="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52"></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 2022-2023, Apache Arrow Developers.
	<br/>

	</p>
	</div>

	<div class="footer-item">
	<p class="sphinx-version">
	Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.0.1.
	<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.13.3.
	</p></div>

	</div>

	</div>

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