| <!doctype html> |
| <html class="no-js" lang="en" data-content_root="./"> |
| <head><meta charset="utf-8"/> |
| <meta name="viewport" content="width=device-width,initial-scale=1"/> |
| <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Arrow Flight SQL" href="flight_sql.html" /><link rel="prev" title="Java Algorithms" href="algorithm.html" /> |
| |
| <!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> |
| <title>Arrow Flight RPC - arrow-java 20.0.0-SNAPSHOT documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" /> |
| <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" /> |
| <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" /> |
| |
| |
| |
| |
| <style> |
| body { |
| --color-code-background: #f8f8f8; |
| --color-code-foreground: black; |
| |
| } |
| @media not print { |
| body[data-theme="dark"] { |
| --color-code-background: #202020; |
| --color-code-foreground: #d0d0d0; |
| |
| } |
| @media (prefers-color-scheme: dark) { |
| body:not([data-theme="light"]) { |
| --color-code-background: #202020; |
| --color-code-foreground: #d0d0d0; |
| |
| } |
| } |
| } |
| </style></head> |
| <body> |
| |
| <script> |
| document.body.dataset.theme = localStorage.getItem("theme") || "auto"; |
| </script> |
| |
| |
| <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> |
| <symbol id="svg-toc" viewBox="0 0 24 24"> |
| <title>Contents</title> |
| <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> |
| <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> |
| </svg> |
| </symbol> |
| <symbol id="svg-menu" viewBox="0 0 24 24"> |
| <title>Menu</title> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> |
| <line x1="3" y1="12" x2="21" y2="12"></line> |
| <line x1="3" y1="6" x2="21" y2="6"></line> |
| <line x1="3" y1="18" x2="21" y2="18"></line> |
| </svg> |
| </symbol> |
| <symbol id="svg-arrow-right" viewBox="0 0 24 24"> |
| <title>Expand</title> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> |
| <polyline points="9 18 15 12 9 6"></polyline> |
| </svg> |
| </symbol> |
| <symbol id="svg-sun" viewBox="0 0 24 24"> |
| <title>Light mode</title> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> |
| <circle cx="12" cy="12" r="5"></circle> |
| <line x1="12" y1="1" x2="12" y2="3"></line> |
| <line x1="12" y1="21" x2="12" y2="23"></line> |
| <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> |
| <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> |
| <line x1="1" y1="12" x2="3" y2="12"></line> |
| <line x1="21" y1="12" x2="23" y2="12"></line> |
| <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> |
| <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> |
| </svg> |
| </symbol> |
| <symbol id="svg-moon" viewBox="0 0 24 24"> |
| <title>Dark mode</title> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> |
| <path stroke="none" d="M0 0h24v24H0z" fill="none" /> |
| <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> |
| </svg> |
| </symbol> |
| <symbol id="svg-sun-with-moon" viewBox="0 0 24 24"> |
| <title>Auto light/dark, in light mode</title> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="1" stroke-linecap="round" stroke-linejoin="round" |
| class="icon-custom-derived-from-feather-sun-and-tabler-moon"> |
| <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/> |
| <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/> |
| <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/> |
| <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/> |
| <line x1="19" y1="14.05" x2="20.414" y2="15.464"/> |
| <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/> |
| <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/> |
| <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/> |
| <line x1="19" y1="5.05" x2="20.414" y2="3.636"/> |
| <circle cx="14.5" cy="9.55" r="3.6"/> |
| </svg> |
| </symbol> |
| <symbol id="svg-moon-with-sun" viewBox="0 0 24 24"> |
| <title>Auto light/dark, in dark mode</title> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="1" stroke-linecap="round" stroke-linejoin="round" |
| class="icon-custom-derived-from-feather-sun-and-tabler-moon"> |
| <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/> |
| <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/> |
| <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/> |
| <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/> |
| <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/> |
| <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/> |
| <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/> |
| <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/> |
| <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/> |
| <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/> |
| </svg> |
| </symbol> |
| <symbol id="svg-pencil" viewBox="0 0 24 24"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code"> |
| <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" /> |
| <path d="M13.5 6.5l4 4" /> |
| <path d="M20 21l2 -2l-2 -2" /> |
| <path d="M17 17l-2 2l2 2" /> |
| </svg> |
| </symbol> |
| <symbol id="svg-eye" viewBox="0 0 24 24"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" |
| stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code"> |
| <path stroke="none" d="M0 0h24v24H0z" fill="none" /> |
| <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" /> |
| <path |
| d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" /> |
| <path d="M20 21l2 -2l-2 -2" /> |
| <path d="M17 17l-2 2l2 2" /> |
| </svg> |
| </symbol> |
| </svg> |
| |
| <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> |
| <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> |
| <label class="overlay sidebar-overlay" for="__navigation"> |
| <div class="visually-hidden">Hide navigation sidebar</div> |
| </label> |
| <label class="overlay toc-overlay" for="__toc"> |
| <div class="visually-hidden">Hide table of contents sidebar</div> |
| </label> |
| |
| <a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a> |
| |
| |
| |
| <div class="page"> |
| <header class="mobile-header"> |
| <div class="header-left"> |
| <label class="nav-overlay-icon" for="__navigation"> |
| <div class="visually-hidden">Toggle site navigation sidebar</div> |
| <i class="icon"><svg><use href="#svg-menu"></use></svg></i> |
| </label> |
| </div> |
| <div class="header-center"> |
| <a href="index.html"><div class="brand">arrow-java 20.0.0-SNAPSHOT documentation</div></a> |
| </div> |
| <div class="header-right"> |
| <div class="theme-toggle-container theme-toggle-header"> |
| <button class="theme-toggle"> |
| <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> |
| <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> |
| <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> |
| <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> |
| <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> |
| </button> |
| </div> |
| <label class="toc-overlay-icon toc-header-icon" for="__toc"> |
| <div class="visually-hidden">Toggle table of contents sidebar</div> |
| <i class="icon"><svg><use href="#svg-toc"></use></svg></i> |
| </label> |
| </div> |
| </header> |
| <aside class="sidebar-drawer"> |
| <div class="sidebar-container"> |
| |
| <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> |
| |
| |
| <span class="sidebar-brand-text">arrow-java 20.0.0-SNAPSHOT documentation</span> |
| |
| </a><form class="sidebar-search-container" method="get" action="search.html" role="search"> |
| <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> |
| <input type="hidden" name="check_keywords" value="yes"> |
| <input type="hidden" name="area" value="default"> |
| </form> |
| <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="quickstartguide.html">Quick Start Guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="overview.html">High-Level Overview</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="install.html">Installing Java Modules</a></li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="developers/index.html">Java Development</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Java Development</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="developers/building.html">Building Arrow Java</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="developers/development.html">Development Guidelines</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="memory.html">Memory Management</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="vector.html">ValueVector</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="vector_schema_root.html">Tabular Data</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="table.html">Table</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="ipc.html">Reading/Writing IPC formats</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="algorithm.html">Java Algorithms</a></li> |
| <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Arrow Flight RPC</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="flight_sql.html">Arrow Flight SQL</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="flight_sql_jdbc_driver.html">Arrow Flight SQL JDBC Driver</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="dataset.html">Dataset</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="substrait.html">Substrait</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="cdata.html">C Data Interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="jdbc.html">Arrow JDBC Adapter</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="reference/index.html">Reference (javadoc)</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/cookbook/java/">Cookbook</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| </div> |
| </aside> |
| <div class="main"> |
| <div class="content"> |
| <div class="article-container"> |
| <a href="#" class="back-to-top muted-link"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> |
| <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> |
| </svg> |
| <span>Back to top</span> |
| </a> |
| <div class="content-icon-container"> |
| <div class="view-this-page"> |
| <a class="muted-link" href="_sources/flight.rst.txt" title="View this page"> |
| <svg><use href="#svg-eye"></use></svg> |
| <span class="visually-hidden">View this page</span> |
| </a> |
| </div> |
| <div class="theme-toggle-container theme-toggle-content"> |
| <button class="theme-toggle"> |
| <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> |
| <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> |
| <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> |
| <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> |
| <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> |
| </button> |
| </div> |
| <label class="toc-overlay-icon toc-content-icon" for="__toc"> |
| <div class="visually-hidden">Toggle table of contents sidebar</div> |
| <i class="icon"><svg><use href="#svg-toc"></use></svg></i> |
| </label> |
| </div> |
| <article role="main" id="furo-main-content"> |
| <section id="arrow-flight-rpc"> |
| <h1>Arrow Flight RPC<a class="headerlink" href="#arrow-flight-rpc" title="Link to this heading">¶</a></h1> |
| <p>Arrow Flight is an RPC framework for efficient transfer of Arrow data |
| over the network.</p> |
| <div class="admonition seealso"> |
| <p class="admonition-title">See also</p> |
| <dl class="simple"> |
| <dt><a class="reference external" href="https://arrow.apache.org/docs/format/Flight.html" title="(in Apache Arrow v23.0.1)"><span class="xref std std-doc">Flight protocol documentation</span></a></dt><dd><p>Documentation of the Flight protocol, including how to use |
| Flight conceptually.</p> |
| </dd> |
| <dt><a class="reference external" href="https://arrow.apache.org/cookbook/java/flight.html" title="(in Apache Arrow Java Cookbook v14.0.0)"><span class="xref std std-doc">Java Cookbook</span></a></dt><dd><p>Recipes for using Arrow Flight in Java.</p> |
| </dd> |
| </dl> |
| </div> |
| <section id="writing-a-flight-service"> |
| <h2>Writing a Flight Service<a class="headerlink" href="#writing-a-flight-service" title="Link to this heading">¶</a></h2> |
| <p>Flight servers implement the <a class="reference external" href="https://arrow.apache.org/java/current/reference/org.apache.arrow.flight.core/org/apache/arrow/flight/FlightProducer.html">FlightProducer</a> interface. For convenience, |
| they can subclass <a class="reference external" href="https://arrow.apache.org/java/current/reference/org.apache.arrow.flight.core/org/apache/arrow/flight/NoOpFlightProducer.html">NoOpFlightProducer</a> instead, which offers default |
| implementations of all the RPC methods.</p> |
| <div class="highlight-Java notranslate"><div class="highlight"><pre><span></span><span class="kd">public</span><span class="w"> </span><span class="kd">class</span> <span class="nc">TutorialFlightProducer</span><span class="w"> </span><span class="kd">implements</span><span class="w"> </span><span class="n">FlightProducer</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="nd">@Override</span> |
| <span class="w"> </span><span class="c1">// Override methods or use NoOpFlightProducer for only methods needed</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| <p>Each RPC method always takes a <code class="docutils literal notranslate"><span class="pre">CallContext</span></code> for common parameters. To indicate |
| failure, pass an exception to the “listener” if present, or else raise an |
| exception.</p> |
| <div class="highlight-Java notranslate"><div class="highlight"><pre><span></span><span class="c1">// Server</span> |
| <span class="nd">@Override</span> |
| <span class="kd">public</span><span class="w"> </span><span class="kt">void</span><span class="w"> </span><span class="nf">listFlights</span><span class="p">(</span><span class="n">CallContext</span><span class="w"> </span><span class="n">context</span><span class="p">,</span><span class="w"> </span><span class="n">Criteria</span><span class="w"> </span><span class="n">criteria</span><span class="p">,</span><span class="w"> </span><span class="n">StreamListener</span><span class="o"><</span><span class="n">FlightInfo</span><span class="o">></span><span class="w"> </span><span class="n">listener</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="c1">// ...</span> |
| <span class="w"> </span><span class="n">listener</span><span class="p">.</span><span class="na">onError</span><span class="p">(</span> |
| <span class="w"> </span><span class="n">CallStatus</span><span class="p">.</span><span class="na">UNAUTHENTICATED</span><span class="p">.</span><span class="na">withDescription</span><span class="p">(</span> |
| <span class="w"> </span><span class="s">"Custom UNAUTHENTICATED description message."</span><span class="p">).</span><span class="na">toRuntimeException</span><span class="p">());</span> |
| <span class="w"> </span><span class="c1">// ...</span> |
| <span class="p">}</span> |
| |
| <span class="c1">// Client</span> |
| <span class="k">try</span><span class="p">{</span> |
| <span class="w"> </span><span class="n">Iterable</span><span class="o"><</span><span class="n">FlightInfo</span><span class="o">></span><span class="w"> </span><span class="n">flightInfosBefore</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">flightClient</span><span class="p">.</span><span class="na">listFlights</span><span class="p">(</span><span class="n">Criteria</span><span class="p">.</span><span class="na">ALL</span><span class="p">);</span> |
| <span class="w"> </span><span class="c1">// ...</span> |
| <span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="n">FlightRuntimeException</span><span class="w"> </span><span class="n">e</span><span class="p">){</span> |
| <span class="w"> </span><span class="c1">// Catch UNAUTHENTICATED exception</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| <p>To start a server, create a <a class="reference external" href="https://arrow.apache.org/java/current/reference/org.apache.arrow.flight.core/org/apache/arrow/flight/Location.html">Location</a> to specify where to listen, and then create |
| a <a class="reference external" href="https://arrow.apache.org/java/current/reference/org.apache.arrow.flight.core/org/apache/arrow/flight/FlightServer.html">FlightServer</a> with an instance of a producer. This will start the server, but |
| won’t block the rest of the program. Call <code class="docutils literal notranslate"><span class="pre">FlightServer.awaitTermination</span></code> |
| to block until the server stops.</p> |
| <div class="highlight-Java notranslate"><div class="highlight"><pre><span></span><span class="kd">class</span> <span class="nc">TutorialFlightProducer</span><span class="w"> </span><span class="kd">implements</span><span class="w"> </span><span class="n">FlightProducer</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="nd">@Override</span> |
| <span class="w"> </span><span class="c1">// Override methods or use NoOpFlightProducer for only methods needed</span> |
| <span class="p">}</span> |
| |
| <span class="n">Location</span><span class="w"> </span><span class="n">location</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Location</span><span class="p">.</span><span class="na">forGrpcInsecure</span><span class="p">(</span><span class="s">"0.0.0.0"</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">);</span> |
| <span class="k">try</span><span class="p">(</span> |
| <span class="w"> </span><span class="n">BufferAllocator</span><span class="w"> </span><span class="n">allocator</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="n">RootAllocator</span><span class="p">();</span> |
| <span class="w"> </span><span class="n">FlightServer</span><span class="w"> </span><span class="n">server</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">FlightServer</span><span class="p">.</span><span class="na">builder</span><span class="p">(</span> |
| <span class="w"> </span><span class="n">allocator</span><span class="p">,</span> |
| <span class="w"> </span><span class="n">location</span><span class="p">,</span> |
| <span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="n">TutorialFlightProducer</span><span class="p">()</span> |
| <span class="w"> </span><span class="p">).</span><span class="na">build</span><span class="p">();</span> |
| <span class="p">){</span> |
| <span class="w"> </span><span class="n">server</span><span class="p">.</span><span class="na">start</span><span class="p">();</span> |
| <span class="w"> </span><span class="n">System</span><span class="p">.</span><span class="na">out</span><span class="p">.</span><span class="na">println</span><span class="p">(</span><span class="s">"Server listening on port "</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">server</span><span class="p">.</span><span class="na">getPort</span><span class="p">());</span> |
| <span class="w"> </span><span class="n">server</span><span class="p">.</span><span class="na">awaitTermination</span><span class="p">();</span> |
| <span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="n">Exception</span><span class="w"> </span><span class="n">e</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="n">e</span><span class="p">.</span><span class="na">printStackTrace</span><span class="p">();</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>Server<span class="w"> </span>listening<span class="w"> </span>on<span class="w"> </span>port<span class="w"> </span><span class="m">58104</span> |
| </pre></div> |
| </div> |
| </section> |
| <section id="using-the-flight-client"> |
| <h2>Using the Flight Client<a class="headerlink" href="#using-the-flight-client" title="Link to this heading">¶</a></h2> |
| <p>To connect to a Flight service, create a <a class="reference external" href="https://arrow.apache.org/java/current/reference/org.apache.arrow.flight.core/org/apache/arrow/flight/FlightClient.html">FlightClient</a> with a location.</p> |
| <div class="highlight-Java notranslate"><div class="highlight"><pre><span></span><span class="n">Location</span><span class="w"> </span><span class="n">location</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Location</span><span class="p">.</span><span class="na">forGrpcInsecure</span><span class="p">(</span><span class="s">"0.0.0.0"</span><span class="p">,</span><span class="w"> </span><span class="mi">58104</span><span class="p">);</span> |
| |
| <span class="k">try</span><span class="p">(</span><span class="n">BufferAllocator</span><span class="w"> </span><span class="n">allocator</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="n">RootAllocator</span><span class="p">();</span> |
| <span class="w"> </span><span class="n">FlightClient</span><span class="w"> </span><span class="n">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">FlightClient</span><span class="p">.</span><span class="na">builder</span><span class="p">(</span><span class="n">allocator</span><span class="p">,</span><span class="w"> </span><span class="n">location</span><span class="p">).</span><span class="na">build</span><span class="p">()){</span> |
| <span class="w"> </span><span class="c1">// ... Consume operations exposed by Flight server</span> |
| <span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="n">Exception</span><span class="w"> </span><span class="n">e</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="n">e</span><span class="p">.</span><span class="na">printStackTrace</span><span class="p">();</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </section> |
| <section id="cancellation-and-timeouts"> |
| <h2>Cancellation and Timeouts<a class="headerlink" href="#cancellation-and-timeouts" title="Link to this heading">¶</a></h2> |
| <p>When making a call, clients can optionally provide <code class="docutils literal notranslate"><span class="pre">CallOptions</span></code>. This allows |
| clients to set a timeout on calls. Also, some objects returned by client RPC calls |
| expose a cancel method which allows terminating a call early.</p> |
| <div class="highlight-Java notranslate"><div class="highlight"><pre><span></span><span class="n">Location</span><span class="w"> </span><span class="n">location</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Location</span><span class="p">.</span><span class="na">forGrpcInsecure</span><span class="p">(</span><span class="s">"0.0.0.0"</span><span class="p">,</span><span class="w"> </span><span class="mi">58609</span><span class="p">);</span> |
| |
| <span class="k">try</span><span class="p">(</span><span class="n">BufferAllocator</span><span class="w"> </span><span class="n">allocator</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="n">RootAllocator</span><span class="p">();</span> |
| <span class="w"> </span><span class="n">FlightClient</span><span class="w"> </span><span class="n">tutorialFlightClient</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">FlightClient</span><span class="p">.</span><span class="na">builder</span><span class="p">(</span><span class="n">allocator</span><span class="p">,</span><span class="w"> </span><span class="n">location</span><span class="p">).</span><span class="na">build</span><span class="p">()){</span> |
| |
| <span class="w"> </span><span class="n">Iterator</span><span class="o"><</span><span class="n">Result</span><span class="o">></span><span class="w"> </span><span class="n">resultIterator</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">tutorialFlightClient</span><span class="p">.</span><span class="na">doAction</span><span class="p">(</span> |
| <span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="n">Action</span><span class="p">(</span><span class="s">"test-timeout"</span><span class="p">),</span> |
| <span class="w"> </span><span class="n">CallOptions</span><span class="p">.</span><span class="na">timeout</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="n">TimeUnit</span><span class="p">.</span><span class="na">SECONDS</span><span class="p">)</span> |
| <span class="w"> </span><span class="p">);</span> |
| <span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="n">Exception</span><span class="w"> </span><span class="n">e</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="n">e</span><span class="p">.</span><span class="na">printStackTrace</span><span class="p">();</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| <p>On the server side, timeouts are transparent. For cancellation, the server needs to manually poll |
| <code class="docutils literal notranslate"><span class="pre">setOnCancelHandler</span></code> or <code class="docutils literal notranslate"><span class="pre">isCancelled</span></code> to check if the client has cancelled the call, |
| and if so, break out of any processing the server is currently doing.</p> |
| <div class="highlight-Java notranslate"><div class="highlight"><pre><span></span><span class="c1">// Client</span> |
| <span class="n">Location</span><span class="w"> </span><span class="n">location</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Location</span><span class="p">.</span><span class="na">forGrpcInsecure</span><span class="p">(</span><span class="s">"0.0.0.0"</span><span class="p">,</span><span class="w"> </span><span class="mi">58609</span><span class="p">);</span> |
| <span class="k">try</span><span class="p">(</span><span class="n">BufferAllocator</span><span class="w"> </span><span class="n">allocator</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="n">RootAllocator</span><span class="p">();</span> |
| <span class="w"> </span><span class="n">FlightClient</span><span class="w"> </span><span class="n">tutorialFlightClient</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">FlightClient</span><span class="p">.</span><span class="na">builder</span><span class="p">(</span><span class="n">allocator</span><span class="p">,</span><span class="w"> </span><span class="n">location</span><span class="p">).</span><span class="na">build</span><span class="p">()){</span> |
| <span class="w"> </span><span class="k">try</span><span class="p">(</span><span class="n">FlightStream</span><span class="w"> </span><span class="n">flightStream</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">flightClient</span><span class="p">.</span><span class="na">getStream</span><span class="p">(</span><span class="k">new</span><span class="w"> </span><span class="n">Ticket</span><span class="p">(</span><span class="k">new</span><span class="w"> </span><span class="kt">byte</span><span class="o">[]</span><span class="p">{})))</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="c1">// ...</span> |
| <span class="w"> </span><span class="n">flightStream</span><span class="p">.</span><span class="na">cancel</span><span class="p">(</span><span class="s">"tutorial-cancel"</span><span class="p">,</span><span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="n">Exception</span><span class="p">(</span><span class="s">"Testing cancellation option!"</span><span class="p">));</span> |
| <span class="w"> </span><span class="p">}</span> |
| <span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="n">Exception</span><span class="w"> </span><span class="n">e</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="n">e</span><span class="p">.</span><span class="na">printStackTrace</span><span class="p">();</span> |
| <span class="p">}</span> |
| <span class="c1">// Server</span> |
| <span class="nd">@Override</span> |
| <span class="kd">public</span><span class="w"> </span><span class="kt">void</span><span class="w"> </span><span class="nf">getStream</span><span class="p">(</span><span class="n">CallContext</span><span class="w"> </span><span class="n">context</span><span class="p">,</span><span class="w"> </span><span class="n">Ticket</span><span class="w"> </span><span class="n">ticket</span><span class="p">,</span><span class="w"> </span><span class="n">ServerStreamListener</span><span class="w"> </span><span class="n">listener</span><span class="p">)</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="c1">// ...</span> |
| <span class="w"> </span><span class="n">listener</span><span class="p">.</span><span class="na">setOnCancelHandler</span><span class="p">(()</span><span class="o">-></span><span class="p">{</span> |
| <span class="w"> </span><span class="c1">// Implement logic to handle cancellation option</span> |
| <span class="w"> </span><span class="p">});</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </section> |
| <section id="enabling-tls"> |
| <h2>Enabling TLS<a class="headerlink" href="#enabling-tls" title="Link to this heading">¶</a></h2> |
| <p>TLS can be enabled when setting up a server by providing a |
| certificate and key pair to <code class="docutils literal notranslate"><span class="pre">FlightServer.Builder.useTls</span></code>.</p> |
| <p>On the client side, use <code class="docutils literal notranslate"><span class="pre">Location.forGrpcTls</span></code> to create the Location for the client.</p> |
| </section> |
| <section id="enabling-authentication"> |
| <h2>Enabling Authentication<a class="headerlink" href="#enabling-authentication" title="Link to this heading">¶</a></h2> |
| <div class="admonition warning"> |
| <p class="admonition-title">Warning</p> |
| <p>Authentication is insecure without enabling TLS.</p> |
| </div> |
| <p>Handshake-based authentication can be enabled by implementing |
| <code class="docutils literal notranslate"><span class="pre">ServerAuthHandler</span></code>. Authentication consists of two parts: on |
| initial client connection, the server and client authentication |
| implementations can perform any negotiation needed. The client authentication |
| handler then provides a token that will be attached to future calls.</p> |
| <p>The client send data to be validated through <code class="docutils literal notranslate"><span class="pre">ClientAuthHandler.authenticate</span></code> |
| The server validate data received through <code class="docutils literal notranslate"><span class="pre">ServerAuthHandler.authenticate</span></code>.</p> |
| </section> |
| <section id="custom-middleware"> |
| <h2>Custom Middleware<a class="headerlink" href="#custom-middleware" title="Link to this heading">¶</a></h2> |
| <p>Servers and clients support custom middleware (or interceptors) that are called on every |
| request and can modify the request in a limited fashion. These can be implemented by implementing the |
| <code class="docutils literal notranslate"><span class="pre">FlightServerMiddleware</span></code> and <code class="docutils literal notranslate"><span class="pre">FlightClientMiddleware</span></code> interfaces.</p> |
| <p>Middleware are fairly limited, but they can add headers to a |
| request/response. On the server, they can inspect incoming headers and |
| fail the request; hence, they can be used to implement custom |
| authentication methods.</p> |
| </section> |
| <section id="adding-services"> |
| <h2>Adding Services<a class="headerlink" href="#adding-services" title="Link to this heading">¶</a></h2> |
| <p>Servers can add other gRPC services. For example, to add the <a class="reference external" href="https://github.com/grpc/grpc/blob/master/doc/health-checking.md">Health Check service</a>:</p> |
| <div class="highlight-Java notranslate"><div class="highlight"><pre><span></span><span class="kd">final</span><span class="w"> </span><span class="n">HealthStatusManager</span><span class="w"> </span><span class="n">statusManager</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="n">HealthStatusManager</span><span class="p">();</span> |
| <span class="kd">final</span><span class="w"> </span><span class="n">Consumer</span><span class="o"><</span><span class="n">NettyServerBuilder</span><span class="o">></span><span class="w"> </span><span class="n">consumer</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">builder</span><span class="p">)</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="n">builder</span><span class="p">.</span><span class="na">addService</span><span class="p">(</span><span class="n">statusManager</span><span class="p">.</span><span class="na">getHealthService</span><span class="p">());</span> |
| <span class="p">};</span> |
| <span class="kd">final</span><span class="w"> </span><span class="n">Location</span><span class="w"> </span><span class="n">location</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">forGrpcInsecure</span><span class="p">(</span><span class="n">LOCALHOST</span><span class="p">,</span><span class="w"> </span><span class="mi">5555</span><span class="p">);</span> |
| <span class="k">try</span><span class="w"> </span><span class="p">(</span> |
| <span class="w"> </span><span class="n">BufferAllocator</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="n">RootAllocator</span><span class="p">(</span><span class="n">Long</span><span class="p">.</span><span class="na">MAX_VALUE</span><span class="p">);</span> |
| <span class="w"> </span><span class="n">Producer</span><span class="w"> </span><span class="n">producer</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="n">Producer</span><span class="p">(</span><span class="n">a</span><span class="p">);</span> |
| <span class="w"> </span><span class="n">FlightServer</span><span class="w"> </span><span class="n">s</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">FlightServer</span><span class="p">.</span><span class="na">builder</span><span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">location</span><span class="p">,</span><span class="w"> </span><span class="n">producer</span><span class="p">)</span> |
| <span class="w"> </span><span class="p">.</span><span class="na">transportHint</span><span class="p">(</span><span class="s">"grpc.builderConsumer"</span><span class="p">,</span><span class="w"> </span><span class="n">consumer</span><span class="p">).</span><span class="na">build</span><span class="p">().</span><span class="na">start</span><span class="p">();</span> |
| <span class="p">)</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="n">Channel</span><span class="w"> </span><span class="n">channel</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">NettyChannelBuilder</span><span class="p">.</span><span class="na">forAddress</span><span class="p">(</span><span class="n">location</span><span class="p">.</span><span class="na">toSocketAddress</span><span class="p">()).</span><span class="na">usePlaintext</span><span class="p">().</span><span class="na">build</span><span class="p">();</span> |
| <span class="w"> </span><span class="n">HealthCheckResponse</span><span class="w"> </span><span class="n">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">HealthGrpc</span> |
| <span class="w"> </span><span class="p">.</span><span class="na">newBlockingStub</span><span class="p">(</span><span class="n">channel</span><span class="p">)</span> |
| <span class="w"> </span><span class="p">.</span><span class="na">check</span><span class="p">(</span><span class="n">HealthCheckRequest</span><span class="p">.</span><span class="na">getDefaultInstance</span><span class="p">());</span> |
| |
| <span class="w"> </span><span class="n">System</span><span class="p">.</span><span class="na">out</span><span class="p">.</span><span class="na">println</span><span class="p">(</span><span class="n">response</span><span class="p">.</span><span class="na">getStatus</span><span class="p">());</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </section> |
| <section id="flight-best-practices"> |
| <h2><a class="reference external" href="https://arrow.apache.org/docs/cpp/flight.html#flight-best-practices" title="(in Apache Arrow v23.0.1)"><span class="xref std std-ref">Flight best practices</span></a><a class="headerlink" href="#flight-best-practices" title="Link to this heading">¶</a></h2> |
| <p>See the <a class="reference external" href="https://arrow.apache.org/docs/cpp/flight.html#flight-best-practices" title="(in Apache Arrow v23.0.1)"><span class="xref std std-ref">best practices for C++</span></a>.</p> |
| </section> |
| </section> |
| |
| </article> |
| </div> |
| <footer> |
| |
| <div class="related-pages"> |
| <a class="next-page" href="flight_sql.html"> |
| <div class="page-info"> |
| <div class="context"> |
| <span>Next</span> |
| </div> |
| <div class="title">Arrow Flight SQL</div> |
| </div> |
| <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> |
| </a> |
| <a class="prev-page" href="algorithm.html"> |
| <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> |
| <div class="page-info"> |
| <div class="context"> |
| <span>Previous</span> |
| </div> |
| |
| <div class="title">Java Algorithms</div> |
| |
| </div> |
| </a> |
| </div> |
| <div class="bottom-of-page"> |
| <div class="left-details"> |
| <div class="copyright"> |
| Copyright © 2025, Apache Arrow Developers |
| </div> |
| Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s |
| |
| <a href="https://github.com/pradyunsg/furo">Furo</a> |
| |
| </div> |
| <div class="right-details"> |
| |
| </div> |
| </div> |
| |
| </footer> |
| </div> |
| <aside class="toc-drawer"> |
| |
| |
| <div class="toc-sticky toc-scroll"> |
| <div class="toc-title-container"> |
| <span class="toc-title"> |
| On this page |
| </span> |
| </div> |
| <div class="toc-tree-container"> |
| <div class="toc-tree"> |
| <ul> |
| <li><a class="reference internal" href="#">Arrow Flight RPC</a><ul> |
| <li><a class="reference internal" href="#writing-a-flight-service">Writing a Flight Service</a></li> |
| <li><a class="reference internal" href="#using-the-flight-client">Using the Flight Client</a></li> |
| <li><a class="reference internal" href="#cancellation-and-timeouts">Cancellation and Timeouts</a></li> |
| <li><a class="reference internal" href="#enabling-tls">Enabling TLS</a></li> |
| <li><a class="reference internal" href="#enabling-authentication">Enabling Authentication</a></li> |
| <li><a class="reference internal" href="#custom-middleware">Custom Middleware</a></li> |
| <li><a class="reference internal" href="#adding-services">Adding Services</a></li> |
| <li><a class="reference internal" href="#flight-best-practices"><span class="xref std std-ref">Flight best practices</span></a></li> |
| </ul> |
| </li> |
| </ul> |
| |
| </div> |
| </div> |
| </div> |
| |
| |
| </aside> |
| </div> |
| </div><script src="_static/documentation_options.js?v=a103329b"></script> |
| <script src="_static/doctools.js?v=9bcbadda"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/scripts/furo.js?v=5fa4622c"></script> |
| </body> |
| </html> |
