current/overview.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>Overview &#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 = 'overview';</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="Install" href="install.html" />
     <link rel="prev" title="Release notes" href="release-notes.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">Overview</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="overview">
 <h1>Overview<a class="headerlink" href="#overview" title="Permalink to this heading">#</a></h1>
 <section id="what-is-this">
 <h2>What is this?<a class="headerlink" href="#what-is-this" title="Permalink to this heading">#</a></h2>
 <p>Apache Arrow Flight SQL adapter for PostgreSQL is a PostgreSQL
 extension that adds an <a class="reference external" href="https://arrow.apache.org/docs/format/FlightSql.html">Apache Arrow Flight
 SQL</a> endpoint to PostgreSQL.</p>
 <p>Apache Arrow Flight SQL is a protocol to use <a class="reference external" href="https://arrow.apache.org/docs/format/Columnar.html">Apache Arrow
 format</a> to interact with SQL databases. You can
 use Apache Arrow Flight SQL instead of <a class="reference external" href="https://www.postgresql.org/docs/current/protocol.html">the PostgreSQL wire
 protocol</a> to interact with PostgreSQL by Apache
 Arrow Flight SQL adapter for PostgreSQL.</p>
 <p>Apache Arrow format is designed for fast typed table data exchange. If
 you want to get large data by <code class="docutils literal notranslate"><span class="pre">SELECT</span></code> or <code class="docutils literal notranslate"><span class="pre">INSERT</span></code>/<code class="docutils literal notranslate"><span class="pre">UPDATE</span></code> large
 data, Apache Arrow Flight SQL will be faster than the PostgreSQL wire
 protocol.</p>
 </section>
 <section id="benchmark">
 <h2>Benchmark<a class="headerlink" href="#benchmark" title="Permalink to this heading">#</a></h2>
 <p>See also <a class="reference external" href="https://github.com/apache/arrow-flight-sql-postgresql/tree/main/benchmark/integer">a simple benchmark result</a> that just
 executes <code class="docutils literal notranslate"><span class="pre">SELECT</span> <span class="pre">*</span> <span class="pre">FROM</span> <span class="pre">integer_only_table</span></code>. It shows that Apache
 Arrow Flight SQL is faster than the PostgreSQL wire protocol when
 result data is large.</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="release-notes.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">Release notes</p>
       </div>
     </a>
     <a class="right-next"
        href="install.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
         <p class="prev-next-title">Install</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="#what-is-this">What is this?</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#benchmark">Benchmark</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/overview.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/overview.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>Overview — 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 = 'overview';</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="Install" href="install.html" />
	<link rel="prev" title="Release notes" href="release-notes.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">Overview</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="overview">
	<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this heading">#</a></h1>
	<section id="what-is-this">
	<h2>What is this?<a class="headerlink" href="#what-is-this" title="Permalink to this heading">#</a></h2>
	<p>Apache Arrow Flight SQL adapter for PostgreSQL is a PostgreSQL
	extension that adds an <a class="reference external" href="https://arrow.apache.org/docs/format/FlightSql.html">Apache Arrow Flight
	SQL</a> endpoint to PostgreSQL.</p>
	<p>Apache Arrow Flight SQL is a protocol to use <a class="reference external" href="https://arrow.apache.org/docs/format/Columnar.html">Apache Arrow
	format</a> to interact with SQL databases. You can
	use Apache Arrow Flight SQL instead of <a class="reference external" href="https://www.postgresql.org/docs/current/protocol.html">the PostgreSQL wire
	protocol</a> to interact with PostgreSQL by Apache
	Arrow Flight SQL adapter for PostgreSQL.</p>
	<p>Apache Arrow format is designed for fast typed table data exchange. If
	you want to get large data by <code class="docutils literal notranslate"><span class="pre">SELECT</span></code> or <code class="docutils literal notranslate"><span class="pre">INSERT</span></code>/<code class="docutils literal notranslate"><span class="pre">UPDATE</span></code> large
	data, Apache Arrow Flight SQL will be faster than the PostgreSQL wire
	protocol.</p>
	</section>
	<section id="benchmark">
	<h2>Benchmark<a class="headerlink" href="#benchmark" title="Permalink to this heading">#</a></h2>
	<p>See also <a class="reference external" href="https://github.com/apache/arrow-flight-sql-postgresql/tree/main/benchmark/integer">a simple benchmark result</a> that just
	executes <code class="docutils literal notranslate"><span class="pre">SELECT</span> <span class="pre">*</span> <span class="pre">FROM</span> <span class="pre">integer_only_table</span></code>. It shows that Apache
	Arrow Flight SQL is faster than the PostgreSQL wire protocol when
	result data is large.</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="release-notes.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">Release notes</p>
	</div>
	</a>
	<a class="right-next"
	href="install.html"
	title="next page">
	<div class="prev-next-info">
	<p class="prev-next-subtitle">next</p>
	<p class="prev-next-title">Install</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="#what-is-this">What is this?</a></li>
	<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#benchmark">Benchmark</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/overview.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/overview.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>