| |
| |
| <!DOCTYPE html> |
| |
| |
| <html lang="en" data-content_root="" > |
| |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> |
| |
| <title>Arrow Flight SQL — Apache Arrow v17.0.0.dev52</title> |
| |
| |
| |
| <script data-cfasync="false"> |
| document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; |
| document.documentElement.dataset.theme = localStorage.getItem("theme") || "light"; |
| </script> |
| |
| <!-- Loaded before other Sphinx assets --> |
| <link href="../_static/styles/theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link href="../_static/styles/bootstrap.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link href="../_static/styles/pydata-sphinx-theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| |
| |
| <link href="../_static/vendor/fontawesome/6.5.1/css/all.min.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2" /> |
| |
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/copybutton.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/theme_overrides.css" /> |
| |
| <!-- Pre-loaded scripts that we'll load fully later --> |
| <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" /> |
| <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" /> |
| <script src="../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script> |
| |
| <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> |
| <script src="../_static/doctools.js"></script> |
| <script src="../_static/sphinx_highlight.js"></script> |
| <script src="../_static/clipboard.min.js"></script> |
| <script src="../_static/copybutton.js"></script> |
| <script src="../_static/design-tabs.js"></script> |
| <script>DOCUMENTATION_OPTIONS.pagename = 'format/FlightSql';</script> |
| <script> |
| DOCUMENTATION_OPTIONS.theme_version = '0.15.2'; |
| DOCUMENTATION_OPTIONS.theme_switcher_json_url = '/docs/_static/versions.json'; |
| DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'dev/'; |
| DOCUMENTATION_OPTIONS.show_version_warning_banner = true; |
| </script> |
| <link rel="canonical" href="https://arrow.apache.org/docs/format/FlightSql.html" /> |
| <link rel="icon" href="../_static/favicon.ico"/> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="ADBC: Arrow Database Connectivity" href="ADBC.html" /> |
| <link rel="prev" title="Arrow Flight RPC" href="Flight.html" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <meta name="docsearch:language" content="en"/> |
| |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '20']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo Code --> |
| |
| </head> |
| |
| |
| <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode=""> |
| |
| |
| |
| <a id="pst-skip-link" class="skip-link" href="#main-content">Skip to main content</a> |
| |
| <div id="pst-scroll-pixel-helper"></div> |
| |
| <button type="button" class="btn rounded-pill" id="pst-back-to-top"> |
| <i class="fa-solid fa-arrow-up"></i> |
| Back to top |
| </button> |
| |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| name="__primary" |
| id="__primary"/> |
| <label class="overlay overlay-primary" for="__primary"></label> |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| name="__secondary" |
| id="__secondary"/> |
| <label class="overlay overlay-secondary" for="__secondary"></label> |
| |
| <div class="search-button__wrapper"> |
| <div class="search-button__overlay"></div> |
| <div class="search-button__search-container"> |
| <form class="bd-search d-flex align-items-center" |
| action="../search.html" |
| method="get"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <input type="search" |
| class="form-control" |
| name="q" |
| id="search-input" |
| placeholder="Search the docs ..." |
| aria-label="Search the docs ..." |
| autocomplete="off" |
| autocorrect="off" |
| autocapitalize="off" |
| spellcheck="false"/> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> |
| </form></div> |
| </div> |
| |
| <header class="bd-header navbar navbar-expand-lg bd-navbar"> |
| <div class="bd-header__inner bd-page-width"> |
| <label class="sidebar-toggle primary-toggle" for="__primary"> |
| <span class="fa-solid fa-bars"></span> |
| </label> |
| |
| |
| <div class="col-lg-3 navbar-header-items__start"> |
| |
| <div class="navbar-item"> |
| |
| |
| |
| <a class="navbar-brand logo" href="../index.html"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <img src="../_static/arrow.png" class="logo__image only-light" alt="Apache Arrow v17.0.0.dev52 - Home"/> |
| <script>document.write(`<img src="../_static/arrow-dark.png" class="logo__image only-dark" alt="Apache Arrow v17.0.0.dev52 - Home"/>`);</script> |
| |
| |
| </a></div> |
| |
| </div> |
| |
| <div class="col-lg-9 navbar-header-items"> |
| |
| <div class="me-auto navbar-header-items__center"> |
| |
| <div class="navbar-item"> |
| <nav class="navbar-nav"> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item current active"> |
| <a class="nav-link nav-internal" href="index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../cpp/index.html"> |
| C++ |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17"> |
| Go |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../java/index.html"> |
| Java |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../js/index.html"> |
| JavaScript |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/"> |
| Julia |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/"> |
| nanoarrow |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../python/index.html"> |
| Python |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../r/index.html"> |
| R |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/"> |
| C++ cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/"> |
| Java cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/"> |
| Python cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/"> |
| R cookbook |
| </a> |
| </li> |
| |
| </ul> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| </div> |
| |
| |
| <div class="navbar-header-items__end"> |
| |
| <div class="navbar-item navbar-persistent--container"> |
| |
| |
| <script> |
| document.write(` |
| <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| `); |
| </script> |
| </div> |
| |
| |
| <div class="navbar-item"> |
| <script> |
| document.write(` |
| <div class="version-switcher__container dropdown"> |
| <button id="pst-version-switcher-button-2" |
| type="button" |
| class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" |
| data-bs-toggle="dropdown" |
| aria-haspopup="listbox" |
| aria-controls="pst-version-switcher-list-2" |
| aria-label="Version switcher list" |
| > |
| Choose version <!-- this text may get changed later by javascript --> |
| <span class="caret"></span> |
| </button> |
| <div id="pst-version-switcher-list-2" |
| class="version-switcher__menu dropdown-menu list-group-flush py-0" |
| role="listbox" aria-labelledby="pst-version-switcher-button-2"> |
| <!-- dropdown will be populated by javascript on page load --> |
| </div> |
| </div> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"> |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span> |
| </button> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links navbar-nav" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">GitHub</span></a> |
| </li> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">X</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <div class="navbar-persistent--mobile"> |
| |
| <script> |
| document.write(` |
| <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| `); |
| </script> |
| </div> |
| |
| |
| |
| <label class="sidebar-toggle secondary-toggle" for="__secondary" tabindex="0"> |
| <span class="fa-solid fa-outdent"></span> |
| </label> |
| |
| </div> |
| |
| </header> |
| |
| |
| <div class="bd-container"> |
| <div class="bd-container__inner bd-page-width"> |
| |
| |
| |
| <div class="bd-sidebar-primary bd-sidebar"> |
| |
| |
| |
| <div class="sidebar-header-items sidebar-primary__section"> |
| |
| |
| <div class="sidebar-header-items__center"> |
| |
| <div class="navbar-item"> |
| <nav class="navbar-nav"> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item current active"> |
| <a class="nav-link nav-internal" href="index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links-2"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links-2" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../cpp/index.html"> |
| C++ |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17"> |
| Go |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../java/index.html"> |
| Java |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../js/index.html"> |
| JavaScript |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/"> |
| Julia |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/"> |
| nanoarrow |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../python/index.html"> |
| Python |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../r/index.html"> |
| R |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/"> |
| C++ cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/"> |
| Java cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/"> |
| Python cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/"> |
| R cookbook |
| </a> |
| </li> |
| |
| </ul> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| </div> |
| |
| |
| |
| <div class="sidebar-header-items__end"> |
| |
| <div class="navbar-item"> |
| <script> |
| document.write(` |
| <div class="version-switcher__container dropdown"> |
| <button id="pst-version-switcher-button-3" |
| type="button" |
| class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" |
| data-bs-toggle="dropdown" |
| aria-haspopup="listbox" |
| aria-controls="pst-version-switcher-list-3" |
| aria-label="Version switcher list" |
| > |
| Choose version <!-- this text may get changed later by javascript --> |
| <span class="caret"></span> |
| </button> |
| <div id="pst-version-switcher-list-3" |
| class="version-switcher__menu dropdown-menu list-group-flush py-0" |
| role="listbox" aria-labelledby="pst-version-switcher-button-3"> |
| <!-- dropdown will be populated by javascript on page load --> |
| </div> |
| </div> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"> |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span> |
| </button> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links navbar-nav" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">GitHub</span></a> |
| </li> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">X</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| <div class="sidebar-primary-items__start sidebar-primary__section"> |
| <div class="sidebar-primary-item"> |
| <nav class="bd-docs-nav bd-links" |
| aria-label="Section Navigation"> |
| <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p> |
| <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav"> |
| <li class="toctree-l1"><a class="reference internal" href="Versioning.html">Format Versioning and Stability</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="Columnar.html">Arrow Columnar Format</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="CanonicalExtensions.html">Canonical Extension Types</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="Other.html">Other Data Structures</a></li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="CDataInterface.html">The Arrow C data interface</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="CDataInterface/PyCapsuleInterface.html">The Arrow PyCapsule Interface</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="CStreamInterface.html">The Arrow C stream interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="CDeviceDataInterface.html">The Arrow C Device data interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="Flight.html">Arrow Flight RPC</a></li> |
| <li class="toctree-l1 current active"><a class="current reference internal" href="#">Arrow Flight SQL</a></li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="ADBC.html">ADBC: Arrow Database Connectivity</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="ADBC/C.html">ADBC C API Specification</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="ADBC/Go.html">ADBC Go API Specification</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="ADBC/Java.html">ADBC Java API Specification</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="Changing.html">Changing the Apache Arrow Format Specification</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="Integration.html">Integration Testing</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="Glossary.html">Glossary</a></li> |
| </ul> |
| </div> |
| </nav></div> |
| </div> |
| |
| |
| <div class="sidebar-primary-items__end sidebar-primary__section"> |
| </div> |
| |
| <div id="rtd-footer-container"></div> |
| |
| |
| </div> |
| |
| <main id="main-content" class="bd-main"> |
| |
| |
| <div class="bd-content"> |
| <div class="bd-article-container"> |
| |
| <div class="bd-header-article"> |
| <div class="header-article-items header-article__inner"> |
| |
| <div class="header-article-items__start"> |
| |
| <div class="header-article-item"> |
| |
| |
| |
| <nav aria-label="Breadcrumb"> |
| <ul class="bd-breadcrumbs"> |
| |
| <li class="breadcrumb-item breadcrumb-home"> |
| <a href="../index.html" class="nav-link" aria-label="Home"> |
| <i class="fa-solid fa-home"></i> |
| </a> |
| </li> |
| |
| <li class="breadcrumb-item"><a href="index.html" class="nav-link">Specifications</a></li> |
| |
| <li class="breadcrumb-item active" aria-current="page">Arrow Flight SQL</li> |
| </ul> |
| </nav> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| <div id="searchbox"></div> |
| <article class="bd-article"> |
| |
| <section id="arrow-flight-sql"> |
| <span id="flight-sql"></span><h1>Arrow Flight SQL<a class="headerlink" href="#arrow-flight-sql" title="Permalink to this heading">#</a></h1> |
| <p>Arrow Flight SQL is a protocol for interacting with SQL databases |
| using the Arrow in-memory format and the <a class="reference internal" href="Flight.html"><span class="doc">Flight RPC</span></a> framework.</p> |
| <p>Generally, a database will implement the RPC methods according to the |
| specification, but does not need to implement a client-side driver. A |
| database client can use the provided Flight SQL client to interact |
| with any database that supports the necessary endpoints. Flight SQL |
| clients wrap the underlying Flight client to provide methods for the |
| new RPC methods described here.</p> |
| <div class="admonition warning"> |
| <p class="admonition-title">Warning</p> |
| <p>Flight SQL is <strong>experimental</strong> and changes to the |
| protocol may still be made.</p> |
| </div> |
| <section id="rpc-methods"> |
| <h2>RPC Methods<a class="headerlink" href="#rpc-methods" title="Permalink to this heading">#</a></h2> |
| <p>Flight SQL reuses the predefined RPC methods in Arrow Flight, and |
| provides various commands that pair those methods with request/response |
| messages defined via Protobuf (see below).</p> |
| <section id="sql-metadata"> |
| <h3>SQL Metadata<a class="headerlink" href="#sql-metadata" title="Permalink to this heading">#</a></h3> |
| <p>Flight SQL provides a variety of commands to fetch catalog metadata |
| about the database server.</p> |
| <p>All of these commands can be used with the GetFlightInfo and GetSchema |
| RPC methods. The Protobuf request message should be packed into a |
| google.protobuf.Any message, then serialized and packed as the <code class="docutils literal notranslate"><span class="pre">cmd</span></code> |
| field in a CMD-type FlightDescriptor.</p> |
| <p>If the command is used with GetFlightInfo, the server will return a |
| FlightInfo response. The client should then use the Ticket(s) in the |
| FlightInfo with the DoGet RPC method to fetch a Arrow data containing |
| the results of the command. In other words, SQL metadata is returned as |
| Arrow data, just like query results themselves.</p> |
| <p>The Arrow schema returned by GetSchema or DoGet for a particular |
| command is fixed according to the specification.</p> |
| <dl class="simple"> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandGetCatalogs</span></code></dt><dd><p>List the catalogs available in the database. The definition varies |
| by vendor.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandGetCrossReference</span></code></dt><dd><p>List the foreign key columns in a given table that reference |
| columns in a given parent table.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandGetDbSchemas</span></code></dt><dd><p>List the schemas (note: a grouping of tables, <em>not</em> an Arrow |
| schema) available in the database. The definition varies by |
| vendor.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandGetExportedKeys</span></code></dt><dd><p>List foreign key columns that reference the primary key columns of |
| a given table.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandGetImportedKeys</span></code></dt><dd><p>List foreign keys of a given table.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandGetPrimaryKeys</span></code></dt><dd><p>List the primary keys of a given table.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandGetSqlInfo</span></code></dt><dd><p>Fetch metadata about the database server and its supported SQL |
| features.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandGetTables</span></code></dt><dd><p>List tables in the database.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandGetTableTypes</span></code></dt><dd><p>List table types in the database. The list of types varies by |
| vendor.</p> |
| </dd> |
| </dl> |
| </section> |
| <section id="query-execution"> |
| <h3>Query Execution<a class="headerlink" href="#query-execution" title="Permalink to this heading">#</a></h3> |
| <p>Flight SQL also provides commands to execute SQL queries and manage |
| prepared statements.</p> |
| <p>Many of these commands are also used with GetFlightInfo/GetSchema and |
| work identically to the metadata methods above. Some of these commands |
| can be used with the DoPut RPC method, but the command should still be |
| encoded in the request FlightDescriptor in the same way.</p> |
| <p>Commands beginning with “Action” are instead used with the DoAction |
| RPC method, in which case the command should be packed into a |
| google.protobuf.Any message, then serialized and packed into the |
| <code class="docutils literal notranslate"><span class="pre">body</span></code> of a Flight Action. Also, the action <code class="docutils literal notranslate"><span class="pre">type</span></code> should be set |
| to the command name (i.e. for <code class="docutils literal notranslate"><span class="pre">ActionClosePreparedStatementRequest</span></code>, |
| the <code class="docutils literal notranslate"><span class="pre">type</span></code> should be <code class="docutils literal notranslate"><span class="pre">ClosePreparedStatement</span></code>).</p> |
| <p>Commands that execute updates such as <code class="docutils literal notranslate"><span class="pre">CommandStatementUpdate</span></code> and |
| <code class="docutils literal notranslate"><span class="pre">CommandStatementIngest</span></code> return a Flight SQL <code class="docutils literal notranslate"><span class="pre">DoPutUpdateResult</span></code> |
| after consuming the entire FlightData stream. This message is encoded |
| in the <code class="docutils literal notranslate"><span class="pre">app_metadata</span></code> field of the Flight RPC <code class="docutils literal notranslate"><span class="pre">PutResult</span></code> returned.</p> |
| <dl> |
| <dt><code class="docutils literal notranslate"><span class="pre">ActionClosePreparedStatementRequest</span></code></dt><dd><p>Close a previously created prepared statement.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">ActionCreatePreparedStatementRequest</span></code></dt><dd><p>Create a new prepared statement for a SQL query.</p> |
| <p>The response will contain an opaque handle used to identify the |
| prepared statement. It may also contain two optional schemas: the |
| Arrow schema of the result set, and the Arrow schema of the bind |
| parameters (if any). Because the schema of the result set may |
| depend on the bind parameters, the schemas may not necessarily be |
| provided here as a result, or if provided, they may not be accurate. |
| Clients should not assume the schema provided here will be the |
| schema of any data actually returned by executing the prepared |
| statement.</p> |
| <p>Some statements may have bind parameters without any specific type. |
| (As a trivial example for SQL, consider <code class="docutils literal notranslate"><span class="pre">SELECT</span> <span class="pre">?</span></code>.) It is |
| not currently specified how this should be handled in the bind |
| parameter schema above. We suggest either using a union type to |
| enumerate the possible types, or using the NA (null) type as a |
| wildcard/placeholder.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandPreparedStatementQuery</span></code></dt><dd><p>Execute a previously created prepared statement and get the results.</p> |
| <p>When used with DoPut: binds parameter values to the prepared statement. |
| The server may optionally provide an updated handle in the response. |
| Updating the handle allows the client to supply all state required to |
| execute the query in an ActionPreparedStatementExecute message. |
| For example, stateless servers can encode the bound parameter values into |
| the new handle, and the client will send that new handle with parameters |
| back to the server.</p> |
| <p>Note that a handle returned from a DoPut call with |
| CommandPreparedStatementQuery can itself be passed to a subsequent DoPut |
| call with CommandPreparedStatementQuery to bind a new set of parameters. |
| The subsequent call itself may return an updated handle which again should |
| be used for subsequent requests.</p> |
| <p>The server is responsible for detecting the case where the client does not |
| use the updated handle and should return an error.</p> |
| <p>When used with GetFlightInfo: execute the prepared statement. The |
| prepared statement can be reused after fetching results.</p> |
| <p>When used with GetSchema: get the expected Arrow schema of the |
| result set. If the client has bound parameter values with DoPut |
| previously, the server should take those values into account.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandPreparedStatementUpdate</span></code></dt><dd><p>Execute a previously created prepared statement that does not |
| return results.</p> |
| <p>When used with DoPut: execute the query and return the number of |
| affected rows. The prepared statement can be reused afterwards.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandStatementQuery</span></code></dt><dd><p>Execute an ad-hoc SQL query.</p> |
| <p>When used with GetFlightInfo: execute the query (call DoGet to |
| fetch results).</p> |
| <p>When used with GetSchema: return the schema of the query results.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandStatementUpdate</span></code></dt><dd><p>Execute an ad-hoc SQL query that does not return results.</p> |
| <p>When used with DoPut: execute the query and return the number of |
| affected rows.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CommandStatementIngest</span></code></dt><dd><p>Execute a bulk ingestion.</p> |
| <p>When used with DoPut: load the stream of Arrow record batches into |
| the specified target table and return the number of rows ingested |
| via a <cite>DoPutUpdateResult</cite> message.</p> |
| </dd> |
| </dl> |
| </section> |
| <section id="flight-server-session-management"> |
| <h3>Flight Server Session Management<a class="headerlink" href="#flight-server-session-management" title="Permalink to this heading">#</a></h3> |
| <p>Flight SQL provides commands to set and update server session variables |
| which affect the server behaviour in various ways. Common options may |
| include (depending on the server implementation) <code class="docutils literal notranslate"><span class="pre">catalog</span></code> and |
| <code class="docutils literal notranslate"><span class="pre">schema</span></code>, indicating the currently-selected catalog and schema for |
| queries to be run against.</p> |
| <p>Clients should prefer, where possible, setting options prior to issuing |
| queries and other commands, as some server implementations may require |
| these options be set exactly once and prior to any other activity which |
| may trigger their implicit setting.</p> |
| <p>For compatibility with Database Connectivity drivers (JDBC, ODBC, and |
| others), it is strongly recommended that server implementations accept |
| string representations of all option values which may be provided to the |
| driver as part of a server connection string and passed through to the |
| server without further conversion. For ease of use it is also recommended |
| to accept and convert other numeric types to the preferred type for an |
| option value, however this is not required.</p> |
| <p>Sessions are persisted between the client and server using an |
| implementation-defined mechanism, which is typically RFC 6265 cookies. |
| Servers may also combine other connection state opaquely with the |
| session token: Consider that the lifespan and semantics of a session |
| should make sense for any additional uses, e.g. CloseSession would also |
| invalidate any authentication context persisted via the session context. |
| A session may be initiated upon a nonempty (or empty) SetSessionOptions |
| call, or at any other time of the server’s choosing.</p> |
| <p><code class="docutils literal notranslate"><span class="pre">SetSessionOptions</span></code> |
| Set server session option(s) by name/value.</p> |
| <p><code class="docutils literal notranslate"><span class="pre">GetSessionOptions</span></code> |
| Get the current server session options, including those set by the client |
| and any defaulted or implicitly set by the server.</p> |
| <p><code class="docutils literal notranslate"><span class="pre">CloseSession</span></code> |
| Close and invalidate the current session context.</p> |
| </section> |
| </section> |
| <section id="sequence-diagrams"> |
| <h2>Sequence Diagrams<a class="headerlink" href="#sequence-diagrams" title="Permalink to this heading">#</a></h2> |
| <figure class="align-default" id="id1"> |
| <img alt="../_images/CommandGetTables.mmd.svg" src="../_images/CommandGetTables.mmd.svg" /><figcaption> |
| <p><span class="caption-text">Listing available tables.</span><a class="headerlink" href="#id1" title="Permalink to this image">#</a></p> |
| </figcaption> |
| </figure> |
| <figure class="align-default" id="id2"> |
| <img alt="../_images/CommandStatementQuery.mmd.svg" src="../_images/CommandStatementQuery.mmd.svg" /><figcaption> |
| <p><span class="caption-text">Executing an ad-hoc query.</span><a class="headerlink" href="#id2" title="Permalink to this image">#</a></p> |
| </figcaption> |
| </figure> |
| <figure class="align-default" id="id3"> |
| <img alt="../_images/CommandPreparedStatementQuery.mmd.svg" src="../_images/CommandPreparedStatementQuery.mmd.svg" /><figcaption> |
| <p><span class="caption-text">Creating a prepared statement, then executing it.</span><a class="headerlink" href="#id3" title="Permalink to this image">#</a></p> |
| </figcaption> |
| </figure> |
| <figure class="align-default" id="id4"> |
| <img alt="../_images/CommandStatementIngest.mmd.svg" src="../_images/CommandStatementIngest.mmd.svg" /><figcaption> |
| <p><span class="caption-text">Executing a bulk ingestion.</span><a class="headerlink" href="#id4" title="Permalink to this image">#</a></p> |
| </figcaption> |
| </figure> |
| </section> |
| <section id="external-resources"> |
| <h2>External Resources<a class="headerlink" href="#external-resources" title="Permalink to this heading">#</a></h2> |
| <ul class="simple"> |
| <li><p><a class="reference external" href="https://arrow.apache.org/blog/2022/02/16/introducing-arrow-flight-sql/">Introducing Apache Arrow Flight SQL: Accelerating Database Access</a></p></li> |
| </ul> |
| </section> |
| <section id="protocol-buffer-definitions"> |
| <h2>Protocol Buffer Definitions<a class="headerlink" href="#protocol-buffer-definitions" title="Permalink to this heading">#</a></h2> |
| <div class="highlight-protobuf notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="cm">/*</span> |
| <span class="linenos"> 2</span><span class="cm"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="linenos"> 3</span><span class="cm"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="linenos"> 4</span><span class="cm"> * distributed with this work for additional information</span> |
| <span class="linenos"> 5</span><span class="cm"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="linenos"> 6</span><span class="cm"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="linenos"> 7</span><span class="cm"> * "License"); you may not use this file except in compliance</span> |
| <span class="linenos"> 8</span><span class="cm"> * with the License. You may obtain a copy of the License at</span> |
| <span class="linenos"> 9</span><span class="cm"> * <p></span> |
| <span class="linenos"> 10</span><span class="cm"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="linenos"> 11</span><span class="cm"> * <p></span> |
| <span class="linenos"> 12</span><span class="cm"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="linenos"> 13</span><span class="cm"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="linenos"> 14</span><span class="cm"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="linenos"> 15</span><span class="cm"> * See the License for the specific language governing permissions and</span> |
| <span class="linenos"> 16</span><span class="cm"> * limitations under the License.</span> |
| <span class="linenos"> 17</span><span class="cm"> */</span> |
| <span class="linenos"> 18</span> |
| <span class="linenos"> 19</span><span class="k">syntax</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"proto3"</span><span class="p">;</span> |
| <span class="linenos"> 20</span><span class="k">import</span><span class="w"> </span><span class="s">"google/protobuf/descriptor.proto"</span><span class="p">;</span> |
| <span class="linenos"> 21</span> |
| <span class="linenos"> 22</span><span class="k">option</span><span class="w"> </span><span class="na">java_package</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"org.apache.arrow.flight.sql.impl"</span><span class="p">;</span> |
| <span class="linenos"> 23</span><span class="k">option</span><span class="w"> </span><span class="na">go_package</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"github.com/apache/arrow/go/arrow/flight/gen/flight"</span><span class="p">;</span> |
| <span class="linenos"> 24</span><span class="kn">package</span><span class="w"> </span><span class="nn">arrow</span><span class="o">.</span><span class="n">flight.protocol.sql</span><span class="p">;</span> |
| <span class="linenos"> 25</span> |
| <span class="linenos"> 26</span><span class="cm">/*</span> |
| <span class="linenos"> 27</span><span class="cm"> * Represents a metadata request. Used in the command member of FlightDescriptor</span> |
| <span class="linenos"> 28</span><span class="cm"> * for the following RPC calls:</span> |
| <span class="linenos"> 29</span><span class="cm"> * - GetSchema: return the Arrow schema of the query.</span> |
| <span class="linenos"> 30</span><span class="cm"> * - GetFlightInfo: execute the metadata request.</span> |
| <span class="linenos"> 31</span><span class="cm"> *</span> |
| <span class="linenos"> 32</span><span class="cm"> * The returned Arrow schema will be:</span> |
| <span class="linenos"> 33</span><span class="cm"> * <</span> |
| <span class="linenos"> 34</span><span class="cm"> * info_name: uint32 not null,</span> |
| <span class="linenos"> 35</span><span class="cm"> * value: dense_union<</span> |
| <span class="linenos"> 36</span><span class="cm"> * string_value: utf8,</span> |
| <span class="linenos"> 37</span><span class="cm"> * bool_value: bool,</span> |
| <span class="linenos"> 38</span><span class="cm"> * bigint_value: int64,</span> |
| <span class="linenos"> 39</span><span class="cm"> * int32_bitmask: int32,</span> |
| <span class="linenos"> 40</span><span class="cm"> * string_list: list<string_data: utf8></span> |
| <span class="linenos"> 41</span><span class="cm"> * int32_to_int32_list_map: map<key: int32, value: list<$data$: int32>></span> |
| <span class="linenos"> 42</span><span class="cm"> * ></span> |
| <span class="linenos"> 43</span><span class="cm"> * where there is one row per requested piece of metadata information.</span> |
| <span class="linenos"> 44</span><span class="cm"> */</span> |
| <span class="linenos"> 45</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandGetSqlInfo</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 46</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos"> 47</span> |
| <span class="linenos"> 48</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 49</span><span class="cm"> * Values are modelled after ODBC's SQLGetInfo() function. This information is intended to provide</span> |
| <span class="linenos"> 50</span><span class="cm"> * Flight SQL clients with basic, SQL syntax and SQL functions related information.</span> |
| <span class="linenos"> 51</span><span class="cm"> * More information types can be added in future releases.</span> |
| <span class="linenos"> 52</span><span class="cm"> * E.g. more SQL syntax support types, scalar functions support, type conversion support etc.</span> |
| <span class="linenos"> 53</span><span class="cm"> *</span> |
| <span class="linenos"> 54</span><span class="cm"> * Note that the set of metadata may expand.</span> |
| <span class="linenos"> 55</span><span class="cm"> *</span> |
| <span class="linenos"> 56</span><span class="cm"> * Initially, Flight SQL will support the following information types:</span> |
| <span class="linenos"> 57</span><span class="cm"> * - Server Information - Range [0-500)</span> |
| <span class="linenos"> 58</span><span class="cm"> * - Syntax Information - Range [500-1000)</span> |
| <span class="linenos"> 59</span><span class="cm"> * Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options).</span> |
| <span class="linenos"> 60</span><span class="cm"> * Custom options should start at 10,000.</span> |
| <span class="linenos"> 61</span><span class="cm"> *</span> |
| <span class="linenos"> 62</span><span class="cm"> * If omitted, then all metadata will be retrieved.</span> |
| <span class="linenos"> 63</span><span class="cm"> * Flight SQL Servers may choose to include additional metadata above and beyond the specified set, however they must</span> |
| <span class="linenos"> 64</span><span class="cm"> * at least return the specified set. IDs ranging from 0 to 10,000 (exclusive) are reserved for future use.</span> |
| <span class="linenos"> 65</span><span class="cm"> * If additional metadata is included, the metadata IDs should start from 10,000.</span> |
| <span class="linenos"> 66</span><span class="cm"> */</span> |
| <span class="linenos"> 67</span><span class="w"> </span><span class="k">repeated</span><span class="w"> </span><span class="kt">uint32</span><span class="w"> </span><span class="na">info</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 68</span><span class="p">}</span> |
| <span class="linenos"> 69</span> |
| <span class="linenos"> 70</span><span class="c1">// Options for CommandGetSqlInfo.</span> |
| <span class="linenos"> 71</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlInfo</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 72</span> |
| <span class="linenos"> 73</span><span class="w"> </span><span class="c1">// Server Information [0-500): Provides basic information about the Flight SQL Server.</span> |
| <span class="linenos"> 74</span> |
| <span class="linenos"> 75</span><span class="w"> </span><span class="c1">// Retrieves a UTF-8 string with the name of the Flight SQL Server.</span> |
| <span class="linenos"> 76</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_NAME</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 77</span> |
| <span class="linenos"> 78</span><span class="w"> </span><span class="c1">// Retrieves a UTF-8 string with the native version of the Flight SQL Server.</span> |
| <span class="linenos"> 79</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_VERSION</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 80</span> |
| <span class="linenos"> 81</span><span class="w"> </span><span class="c1">// Retrieves a UTF-8 string with the Arrow format version of the Flight SQL Server.</span> |
| <span class="linenos"> 82</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_ARROW_VERSION</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 83</span> |
| <span class="linenos"> 84</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 85</span><span class="cm"> * Retrieves a boolean value indicating whether the Flight SQL Server is read only.</span> |
| <span class="linenos"> 86</span><span class="cm"> *</span> |
| <span class="linenos"> 87</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 88</span><span class="cm"> * - false: if read-write</span> |
| <span class="linenos"> 89</span><span class="cm"> * - true: if read only</span> |
| <span class="linenos"> 90</span><span class="cm"> */</span> |
| <span class="linenos"> 91</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_READ_ONLY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos"> 92</span> |
| <span class="linenos"> 93</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 94</span><span class="cm"> * Retrieves a boolean value indicating whether the Flight SQL Server supports executing</span> |
| <span class="linenos"> 95</span><span class="cm"> * SQL queries.</span> |
| <span class="linenos"> 96</span><span class="cm"> *</span> |
| <span class="linenos"> 97</span><span class="cm"> * Note that the absence of this info (as opposed to a false value) does not necessarily</span> |
| <span class="linenos"> 98</span><span class="cm"> * mean that SQL is not supported, as this property was not originally defined.</span> |
| <span class="linenos"> 99</span><span class="cm"> */</span> |
| <span class="linenos"> 100</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_SQL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">;</span> |
| <span class="linenos"> 101</span> |
| <span class="linenos"> 102</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 103</span><span class="cm"> * Retrieves a boolean value indicating whether the Flight SQL Server supports executing</span> |
| <span class="linenos"> 104</span><span class="cm"> * Substrait plans.</span> |
| <span class="linenos"> 105</span><span class="cm"> */</span> |
| <span class="linenos"> 106</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_SUBSTRAIT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">5</span><span class="p">;</span> |
| <span class="linenos"> 107</span> |
| <span class="linenos"> 108</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 109</span><span class="cm"> * Retrieves a string value indicating the minimum supported Substrait version, or null</span> |
| <span class="linenos"> 110</span><span class="cm"> * if Substrait is not supported.</span> |
| <span class="linenos"> 111</span><span class="cm"> */</span> |
| <span class="linenos"> 112</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_SUBSTRAIT_MIN_VERSION</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">6</span><span class="p">;</span> |
| <span class="linenos"> 113</span> |
| <span class="linenos"> 114</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 115</span><span class="cm"> * Retrieves a string value indicating the maximum supported Substrait version, or null</span> |
| <span class="linenos"> 116</span><span class="cm"> * if Substrait is not supported.</span> |
| <span class="linenos"> 117</span><span class="cm"> */</span> |
| <span class="linenos"> 118</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_SUBSTRAIT_MAX_VERSION</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">7</span><span class="p">;</span> |
| <span class="linenos"> 119</span> |
| <span class="linenos"> 120</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 121</span><span class="cm"> * Retrieves an int32 indicating whether the Flight SQL Server supports the</span> |
| <span class="linenos"> 122</span><span class="cm"> * BeginTransaction/EndTransaction/BeginSavepoint/EndSavepoint actions.</span> |
| <span class="linenos"> 123</span><span class="cm"> *</span> |
| <span class="linenos"> 124</span><span class="cm"> * Even if this is not supported, the database may still support explicit "BEGIN</span> |
| <span class="linenos"> 125</span><span class="cm"> * TRANSACTION"/"COMMIT" SQL statements (see SQL_TRANSACTIONS_SUPPORTED); this property</span> |
| <span class="linenos"> 126</span><span class="cm"> * is only about whether the server implements the Flight SQL API endpoints.</span> |
| <span class="linenos"> 127</span><span class="cm"> *</span> |
| <span class="linenos"> 128</span><span class="cm"> * The possible values are listed in `SqlSupportedTransaction`.</span> |
| <span class="linenos"> 129</span><span class="cm"> */</span> |
| <span class="linenos"> 130</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_TRANSACTION</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">8</span><span class="p">;</span> |
| <span class="linenos"> 131</span> |
| <span class="linenos"> 132</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 133</span><span class="cm"> * Retrieves a boolean value indicating whether the Flight SQL Server supports explicit</span> |
| <span class="linenos"> 134</span><span class="cm"> * query cancellation (the CancelQuery action).</span> |
| <span class="linenos"> 135</span><span class="cm"> */</span> |
| <span class="linenos"> 136</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_CANCEL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">9</span><span class="p">;</span> |
| <span class="linenos"> 137</span> |
| <span class="linenos"> 138</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 139</span><span class="cm"> * Retrieves a boolean value indicating whether the Flight SQL Server supports executing</span> |
| <span class="linenos"> 140</span><span class="cm"> * bulk ingestion.</span> |
| <span class="linenos"> 141</span><span class="cm"> */</span> |
| <span class="linenos"> 142</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_BULK_INGESTION</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">10</span><span class="p">;</span> |
| <span class="linenos"> 143</span> |
| <span class="linenos"> 144</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 145</span><span class="cm"> * Retrieves a boolean value indicating whether transactions are supported for bulk ingestion. If not, invoking</span> |
| <span class="linenos"> 146</span><span class="cm"> * the method commit in the context of a bulk ingestion is a noop, and the isolation level is</span> |
| <span class="linenos"> 147</span><span class="cm"> * `arrow.flight.protocol.sql.SqlTransactionIsolationLevel.TRANSACTION_NONE`.</span> |
| <span class="linenos"> 148</span><span class="cm"> *</span> |
| <span class="linenos"> 149</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 150</span><span class="cm"> * - false: if bulk ingestion transactions are unsupported;</span> |
| <span class="linenos"> 151</span><span class="cm"> * - true: if bulk ingestion transactions are supported.</span> |
| <span class="linenos"> 152</span><span class="cm"> */</span> |
| <span class="linenos"> 153</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_INGEST_TRANSACTIONS_SUPPORTED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">11</span><span class="p">;</span> |
| <span class="linenos"> 154</span> |
| <span class="linenos"> 155</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 156</span><span class="cm"> * Retrieves an int32 indicating the timeout (in milliseconds) for prepared statement handles.</span> |
| <span class="linenos"> 157</span><span class="cm"> *</span> |
| <span class="linenos"> 158</span><span class="cm"> * If 0, there is no timeout. Servers should reset the timeout when the handle is used in a command.</span> |
| <span class="linenos"> 159</span><span class="cm"> */</span> |
| <span class="linenos"> 160</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_STATEMENT_TIMEOUT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">100</span><span class="p">;</span> |
| <span class="linenos"> 161</span> |
| <span class="linenos"> 162</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 163</span><span class="cm"> * Retrieves an int32 indicating the timeout (in milliseconds) for transactions, since transactions are not tied to a connection.</span> |
| <span class="linenos"> 164</span><span class="cm"> *</span> |
| <span class="linenos"> 165</span><span class="cm"> * If 0, there is no timeout. Servers should reset the timeout when the handle is used in a command.</span> |
| <span class="linenos"> 166</span><span class="cm"> */</span> |
| <span class="linenos"> 167</span><span class="w"> </span><span class="na">FLIGHT_SQL_SERVER_TRANSACTION_TIMEOUT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">101</span><span class="p">;</span> |
| <span class="linenos"> 168</span> |
| <span class="linenos"> 169</span><span class="w"> </span><span class="c1">// SQL Syntax Information [500-1000): provides information about SQL syntax supported by the Flight SQL Server.</span> |
| <span class="linenos"> 170</span> |
| <span class="linenos"> 171</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 172</span><span class="cm"> * Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE and DROP of catalogs.</span> |
| <span class="linenos"> 173</span><span class="cm"> *</span> |
| <span class="linenos"> 174</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 175</span><span class="cm"> * - false: if it doesn't support CREATE and DROP of catalogs.</span> |
| <span class="linenos"> 176</span><span class="cm"> * - true: if it supports CREATE and DROP of catalogs.</span> |
| <span class="linenos"> 177</span><span class="cm"> */</span> |
| <span class="linenos"> 178</span><span class="w"> </span><span class="na">SQL_DDL_CATALOG</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">500</span><span class="p">;</span> |
| <span class="linenos"> 179</span> |
| <span class="linenos"> 180</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 181</span><span class="cm"> * Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE and DROP of schemas.</span> |
| <span class="linenos"> 182</span><span class="cm"> *</span> |
| <span class="linenos"> 183</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 184</span><span class="cm"> * - false: if it doesn't support CREATE and DROP of schemas.</span> |
| <span class="linenos"> 185</span><span class="cm"> * - true: if it supports CREATE and DROP of schemas.</span> |
| <span class="linenos"> 186</span><span class="cm"> */</span> |
| <span class="linenos"> 187</span><span class="w"> </span><span class="na">SQL_DDL_SCHEMA</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">501</span><span class="p">;</span> |
| <span class="linenos"> 188</span> |
| <span class="linenos"> 189</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 190</span><span class="cm"> * Indicates whether the Flight SQL Server supports CREATE and DROP of tables.</span> |
| <span class="linenos"> 191</span><span class="cm"> *</span> |
| <span class="linenos"> 192</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 193</span><span class="cm"> * - false: if it doesn't support CREATE and DROP of tables.</span> |
| <span class="linenos"> 194</span><span class="cm"> * - true: if it supports CREATE and DROP of tables.</span> |
| <span class="linenos"> 195</span><span class="cm"> */</span> |
| <span class="linenos"> 196</span><span class="w"> </span><span class="na">SQL_DDL_TABLE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">502</span><span class="p">;</span> |
| <span class="linenos"> 197</span> |
| <span class="linenos"> 198</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 199</span><span class="cm"> * Retrieves a int32 ordinal representing the case sensitivity of catalog, table, schema and table names.</span> |
| <span class="linenos"> 200</span><span class="cm"> *</span> |
| <span class="linenos"> 201</span><span class="cm"> * The possible values are listed in `arrow.flight.protocol.sql.SqlSupportedCaseSensitivity`.</span> |
| <span class="linenos"> 202</span><span class="cm"> */</span> |
| <span class="linenos"> 203</span><span class="w"> </span><span class="na">SQL_IDENTIFIER_CASE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">503</span><span class="p">;</span> |
| <span class="linenos"> 204</span> |
| <span class="linenos"> 205</span><span class="w"> </span><span class="c1">// Retrieves a UTF-8 string with the supported character(s) used to surround a delimited identifier.</span> |
| <span class="linenos"> 206</span><span class="w"> </span><span class="na">SQL_IDENTIFIER_QUOTE_CHAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">504</span><span class="p">;</span> |
| <span class="linenos"> 207</span> |
| <span class="linenos"> 208</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 209</span><span class="cm"> * Retrieves a int32 describing the case sensitivity of quoted identifiers.</span> |
| <span class="linenos"> 210</span><span class="cm"> *</span> |
| <span class="linenos"> 211</span><span class="cm"> * The possible values are listed in `arrow.flight.protocol.sql.SqlSupportedCaseSensitivity`.</span> |
| <span class="linenos"> 212</span><span class="cm"> */</span> |
| <span class="linenos"> 213</span><span class="w"> </span><span class="na">SQL_QUOTED_IDENTIFIER_CASE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">505</span><span class="p">;</span> |
| <span class="linenos"> 214</span> |
| <span class="linenos"> 215</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 216</span><span class="cm"> * Retrieves a boolean value indicating whether all tables are selectable.</span> |
| <span class="linenos"> 217</span><span class="cm"> *</span> |
| <span class="linenos"> 218</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 219</span><span class="cm"> * - false: if not all tables are selectable or if none are;</span> |
| <span class="linenos"> 220</span><span class="cm"> * - true: if all tables are selectable.</span> |
| <span class="linenos"> 221</span><span class="cm"> */</span> |
| <span class="linenos"> 222</span><span class="w"> </span><span class="na">SQL_ALL_TABLES_ARE_SELECTABLE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">506</span><span class="p">;</span> |
| <span class="linenos"> 223</span> |
| <span class="linenos"> 224</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 225</span><span class="cm"> * Retrieves the null ordering.</span> |
| <span class="linenos"> 226</span><span class="cm"> *</span> |
| <span class="linenos"> 227</span><span class="cm"> * Returns a int32 ordinal for the null ordering being used, as described in</span> |
| <span class="linenos"> 228</span><span class="cm"> * `arrow.flight.protocol.sql.SqlNullOrdering`.</span> |
| <span class="linenos"> 229</span><span class="cm"> */</span> |
| <span class="linenos"> 230</span><span class="w"> </span><span class="na">SQL_NULL_ORDERING</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">507</span><span class="p">;</span> |
| <span class="linenos"> 231</span> |
| <span class="linenos"> 232</span><span class="w"> </span><span class="c1">// Retrieves a UTF-8 string list with values of the supported keywords.</span> |
| <span class="linenos"> 233</span><span class="w"> </span><span class="na">SQL_KEYWORDS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">508</span><span class="p">;</span> |
| <span class="linenos"> 234</span> |
| <span class="linenos"> 235</span><span class="w"> </span><span class="c1">// Retrieves a UTF-8 string list with values of the supported numeric functions.</span> |
| <span class="linenos"> 236</span><span class="w"> </span><span class="na">SQL_NUMERIC_FUNCTIONS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">509</span><span class="p">;</span> |
| <span class="linenos"> 237</span> |
| <span class="linenos"> 238</span><span class="w"> </span><span class="c1">// Retrieves a UTF-8 string list with values of the supported string functions.</span> |
| <span class="linenos"> 239</span><span class="w"> </span><span class="na">SQL_STRING_FUNCTIONS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">510</span><span class="p">;</span> |
| <span class="linenos"> 240</span> |
| <span class="linenos"> 241</span><span class="w"> </span><span class="c1">// Retrieves a UTF-8 string list with values of the supported system functions.</span> |
| <span class="linenos"> 242</span><span class="w"> </span><span class="na">SQL_SYSTEM_FUNCTIONS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">511</span><span class="p">;</span> |
| <span class="linenos"> 243</span> |
| <span class="linenos"> 244</span><span class="w"> </span><span class="c1">// Retrieves a UTF-8 string list with values of the supported datetime functions.</span> |
| <span class="linenos"> 245</span><span class="w"> </span><span class="na">SQL_DATETIME_FUNCTIONS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">512</span><span class="p">;</span> |
| <span class="linenos"> 246</span> |
| <span class="linenos"> 247</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 248</span><span class="cm"> * Retrieves the UTF-8 string that can be used to escape wildcard characters.</span> |
| <span class="linenos"> 249</span><span class="cm"> * This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern</span> |
| <span class="linenos"> 250</span><span class="cm"> * (and therefore use one of the wildcard characters).</span> |
| <span class="linenos"> 251</span><span class="cm"> * The '_' character represents any single character; the '%' character represents any sequence of zero or more</span> |
| <span class="linenos"> 252</span><span class="cm"> * characters.</span> |
| <span class="linenos"> 253</span><span class="cm"> */</span> |
| <span class="linenos"> 254</span><span class="w"> </span><span class="na">SQL_SEARCH_STRING_ESCAPE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">513</span><span class="p">;</span> |
| <span class="linenos"> 255</span> |
| <span class="linenos"> 256</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 257</span><span class="cm"> * Retrieves a UTF-8 string with all the "extra" characters that can be used in unquoted identifier names</span> |
| <span class="linenos"> 258</span><span class="cm"> * (those beyond a-z, A-Z, 0-9 and _).</span> |
| <span class="linenos"> 259</span><span class="cm"> */</span> |
| <span class="linenos"> 260</span><span class="w"> </span><span class="na">SQL_EXTRA_NAME_CHARACTERS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">514</span><span class="p">;</span> |
| <span class="linenos"> 261</span> |
| <span class="linenos"> 262</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 263</span><span class="cm"> * Retrieves a boolean value indicating whether column aliasing is supported.</span> |
| <span class="linenos"> 264</span><span class="cm"> * If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns</span> |
| <span class="linenos"> 265</span><span class="cm"> * as required.</span> |
| <span class="linenos"> 266</span><span class="cm"> *</span> |
| <span class="linenos"> 267</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 268</span><span class="cm"> * - false: if column aliasing is unsupported;</span> |
| <span class="linenos"> 269</span><span class="cm"> * - true: if column aliasing is supported.</span> |
| <span class="linenos"> 270</span><span class="cm"> */</span> |
| <span class="linenos"> 271</span><span class="w"> </span><span class="na">SQL_SUPPORTS_COLUMN_ALIASING</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">515</span><span class="p">;</span> |
| <span class="linenos"> 272</span> |
| <span class="linenos"> 273</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 274</span><span class="cm"> * Retrieves a boolean value indicating whether concatenations between null and non-null values being</span> |
| <span class="linenos"> 275</span><span class="cm"> * null are supported.</span> |
| <span class="linenos"> 276</span><span class="cm"> *</span> |
| <span class="linenos"> 277</span><span class="cm"> * - Returns:</span> |
| <span class="linenos"> 278</span><span class="cm"> * - false: if concatenations between null and non-null values being null are unsupported;</span> |
| <span class="linenos"> 279</span><span class="cm"> * - true: if concatenations between null and non-null values being null are supported.</span> |
| <span class="linenos"> 280</span><span class="cm"> */</span> |
| <span class="linenos"> 281</span><span class="w"> </span><span class="na">SQL_NULL_PLUS_NULL_IS_NULL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">516</span><span class="p">;</span> |
| <span class="linenos"> 282</span> |
| <span class="linenos"> 283</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 284</span><span class="cm"> * Retrieves a map where the key is the type to convert from and the value is a list with the types to convert to,</span> |
| <span class="linenos"> 285</span><span class="cm"> * indicating the supported conversions. Each key and each item on the list value is a value to a predefined type on</span> |
| <span class="linenos"> 286</span><span class="cm"> * SqlSupportsConvert enum.</span> |
| <span class="linenos"> 287</span><span class="cm"> * The returned map will be: map<int32, list<int32>></span> |
| <span class="linenos"> 288</span><span class="cm"> */</span> |
| <span class="linenos"> 289</span><span class="w"> </span><span class="na">SQL_SUPPORTS_CONVERT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">517</span><span class="p">;</span> |
| <span class="linenos"> 290</span> |
| <span class="linenos"> 291</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 292</span><span class="cm"> * Retrieves a boolean value indicating whether, when table correlation names are supported,</span> |
| <span class="linenos"> 293</span><span class="cm"> * they are restricted to being different from the names of the tables.</span> |
| <span class="linenos"> 294</span><span class="cm"> *</span> |
| <span class="linenos"> 295</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 296</span><span class="cm"> * - false: if table correlation names are unsupported;</span> |
| <span class="linenos"> 297</span><span class="cm"> * - true: if table correlation names are supported.</span> |
| <span class="linenos"> 298</span><span class="cm"> */</span> |
| <span class="linenos"> 299</span><span class="w"> </span><span class="na">SQL_SUPPORTS_TABLE_CORRELATION_NAMES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">518</span><span class="p">;</span> |
| <span class="linenos"> 300</span> |
| <span class="linenos"> 301</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 302</span><span class="cm"> * Retrieves a boolean value indicating whether, when table correlation names are supported,</span> |
| <span class="linenos"> 303</span><span class="cm"> * they are restricted to being different from the names of the tables.</span> |
| <span class="linenos"> 304</span><span class="cm"> *</span> |
| <span class="linenos"> 305</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 306</span><span class="cm"> * - false: if different table correlation names are unsupported;</span> |
| <span class="linenos"> 307</span><span class="cm"> * - true: if different table correlation names are supported</span> |
| <span class="linenos"> 308</span><span class="cm"> */</span> |
| <span class="linenos"> 309</span><span class="w"> </span><span class="na">SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">519</span><span class="p">;</span> |
| <span class="linenos"> 310</span> |
| <span class="linenos"> 311</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 312</span><span class="cm"> * Retrieves a boolean value indicating whether expressions in ORDER BY lists are supported.</span> |
| <span class="linenos"> 313</span><span class="cm"> *</span> |
| <span class="linenos"> 314</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 315</span><span class="cm"> * - false: if expressions in ORDER BY are unsupported;</span> |
| <span class="linenos"> 316</span><span class="cm"> * - true: if expressions in ORDER BY are supported;</span> |
| <span class="linenos"> 317</span><span class="cm"> */</span> |
| <span class="linenos"> 318</span><span class="w"> </span><span class="na">SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">520</span><span class="p">;</span> |
| <span class="linenos"> 319</span> |
| <span class="linenos"> 320</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 321</span><span class="cm"> * Retrieves a boolean value indicating whether using a column that is not in the SELECT statement in a GROUP BY</span> |
| <span class="linenos"> 322</span><span class="cm"> * clause is supported.</span> |
| <span class="linenos"> 323</span><span class="cm"> *</span> |
| <span class="linenos"> 324</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 325</span><span class="cm"> * - false: if using a column that is not in the SELECT statement in a GROUP BY clause is unsupported;</span> |
| <span class="linenos"> 326</span><span class="cm"> * - true: if using a column that is not in the SELECT statement in a GROUP BY clause is supported.</span> |
| <span class="linenos"> 327</span><span class="cm"> */</span> |
| <span class="linenos"> 328</span><span class="w"> </span><span class="na">SQL_SUPPORTS_ORDER_BY_UNRELATED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">521</span><span class="p">;</span> |
| <span class="linenos"> 329</span> |
| <span class="linenos"> 330</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 331</span><span class="cm"> * Retrieves the supported GROUP BY commands;</span> |
| <span class="linenos"> 332</span><span class="cm"> *</span> |
| <span class="linenos"> 333</span><span class="cm"> * Returns an int32 bitmask value representing the supported commands.</span> |
| <span class="linenos"> 334</span><span class="cm"> * The returned bitmask should be parsed in order to retrieve the supported commands.</span> |
| <span class="linenos"> 335</span><span class="cm"> *</span> |
| <span class="linenos"> 336</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 337</span><span class="cm"> * - return 0 (\b0) => [] (GROUP BY is unsupported);</span> |
| <span class="linenos"> 338</span><span class="cm"> * - return 1 (\b1) => [SQL_GROUP_BY_UNRELATED];</span> |
| <span class="linenos"> 339</span><span class="cm"> * - return 2 (\b10) => [SQL_GROUP_BY_BEYOND_SELECT];</span> |
| <span class="linenos"> 340</span><span class="cm"> * - return 3 (\b11) => [SQL_GROUP_BY_UNRELATED, SQL_GROUP_BY_BEYOND_SELECT].</span> |
| <span class="linenos"> 341</span><span class="cm"> * Valid GROUP BY types are described under `arrow.flight.protocol.sql.SqlSupportedGroupBy`.</span> |
| <span class="linenos"> 342</span><span class="cm"> */</span> |
| <span class="linenos"> 343</span><span class="w"> </span><span class="na">SQL_SUPPORTED_GROUP_BY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">522</span><span class="p">;</span> |
| <span class="linenos"> 344</span> |
| <span class="linenos"> 345</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 346</span><span class="cm"> * Retrieves a boolean value indicating whether specifying a LIKE escape clause is supported.</span> |
| <span class="linenos"> 347</span><span class="cm"> *</span> |
| <span class="linenos"> 348</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 349</span><span class="cm"> * - false: if specifying a LIKE escape clause is unsupported;</span> |
| <span class="linenos"> 350</span><span class="cm"> * - true: if specifying a LIKE escape clause is supported.</span> |
| <span class="linenos"> 351</span><span class="cm"> */</span> |
| <span class="linenos"> 352</span><span class="w"> </span><span class="na">SQL_SUPPORTS_LIKE_ESCAPE_CLAUSE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">523</span><span class="p">;</span> |
| <span class="linenos"> 353</span> |
| <span class="linenos"> 354</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 355</span><span class="cm"> * Retrieves a boolean value indicating whether columns may be defined as non-nullable.</span> |
| <span class="linenos"> 356</span><span class="cm"> *</span> |
| <span class="linenos"> 357</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 358</span><span class="cm"> * - false: if columns cannot be defined as non-nullable;</span> |
| <span class="linenos"> 359</span><span class="cm"> * - true: if columns may be defined as non-nullable.</span> |
| <span class="linenos"> 360</span><span class="cm"> */</span> |
| <span class="linenos"> 361</span><span class="w"> </span><span class="na">SQL_SUPPORTS_NON_NULLABLE_COLUMNS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">524</span><span class="p">;</span> |
| <span class="linenos"> 362</span> |
| <span class="linenos"> 363</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 364</span><span class="cm"> * Retrieves the supported SQL grammar level as per the ODBC specification.</span> |
| <span class="linenos"> 365</span><span class="cm"> *</span> |
| <span class="linenos"> 366</span><span class="cm"> * Returns an int32 bitmask value representing the supported SQL grammar level.</span> |
| <span class="linenos"> 367</span><span class="cm"> * The returned bitmask should be parsed in order to retrieve the supported grammar levels.</span> |
| <span class="linenos"> 368</span><span class="cm"> *</span> |
| <span class="linenos"> 369</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 370</span><span class="cm"> * - return 0 (\b0) => [] (SQL grammar is unsupported);</span> |
| <span class="linenos"> 371</span><span class="cm"> * - return 1 (\b1) => [SQL_MINIMUM_GRAMMAR];</span> |
| <span class="linenos"> 372</span><span class="cm"> * - return 2 (\b10) => [SQL_CORE_GRAMMAR];</span> |
| <span class="linenos"> 373</span><span class="cm"> * - return 3 (\b11) => [SQL_MINIMUM_GRAMMAR, SQL_CORE_GRAMMAR];</span> |
| <span class="linenos"> 374</span><span class="cm"> * - return 4 (\b100) => [SQL_EXTENDED_GRAMMAR];</span> |
| <span class="linenos"> 375</span><span class="cm"> * - return 5 (\b101) => [SQL_MINIMUM_GRAMMAR, SQL_EXTENDED_GRAMMAR];</span> |
| <span class="linenos"> 376</span><span class="cm"> * - return 6 (\b110) => [SQL_CORE_GRAMMAR, SQL_EXTENDED_GRAMMAR];</span> |
| <span class="linenos"> 377</span><span class="cm"> * - return 7 (\b111) => [SQL_MINIMUM_GRAMMAR, SQL_CORE_GRAMMAR, SQL_EXTENDED_GRAMMAR].</span> |
| <span class="linenos"> 378</span><span class="cm"> * Valid SQL grammar levels are described under `arrow.flight.protocol.sql.SupportedSqlGrammar`.</span> |
| <span class="linenos"> 379</span><span class="cm"> */</span> |
| <span class="linenos"> 380</span><span class="w"> </span><span class="na">SQL_SUPPORTED_GRAMMAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">525</span><span class="p">;</span> |
| <span class="linenos"> 381</span> |
| <span class="linenos"> 382</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 383</span><span class="cm"> * Retrieves the supported ANSI92 SQL grammar level.</span> |
| <span class="linenos"> 384</span><span class="cm"> *</span> |
| <span class="linenos"> 385</span><span class="cm"> * Returns an int32 bitmask value representing the supported ANSI92 SQL grammar level.</span> |
| <span class="linenos"> 386</span><span class="cm"> * The returned bitmask should be parsed in order to retrieve the supported commands.</span> |
| <span class="linenos"> 387</span><span class="cm"> *</span> |
| <span class="linenos"> 388</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 389</span><span class="cm"> * - return 0 (\b0) => [] (ANSI92 SQL grammar is unsupported);</span> |
| <span class="linenos"> 390</span><span class="cm"> * - return 1 (\b1) => [ANSI92_ENTRY_SQL];</span> |
| <span class="linenos"> 391</span><span class="cm"> * - return 2 (\b10) => [ANSI92_INTERMEDIATE_SQL];</span> |
| <span class="linenos"> 392</span><span class="cm"> * - return 3 (\b11) => [ANSI92_ENTRY_SQL, ANSI92_INTERMEDIATE_SQL];</span> |
| <span class="linenos"> 393</span><span class="cm"> * - return 4 (\b100) => [ANSI92_FULL_SQL];</span> |
| <span class="linenos"> 394</span><span class="cm"> * - return 5 (\b101) => [ANSI92_ENTRY_SQL, ANSI92_FULL_SQL];</span> |
| <span class="linenos"> 395</span><span class="cm"> * - return 6 (\b110) => [ANSI92_INTERMEDIATE_SQL, ANSI92_FULL_SQL];</span> |
| <span class="linenos"> 396</span><span class="cm"> * - return 7 (\b111) => [ANSI92_ENTRY_SQL, ANSI92_INTERMEDIATE_SQL, ANSI92_FULL_SQL].</span> |
| <span class="linenos"> 397</span><span class="cm"> * Valid ANSI92 SQL grammar levels are described under `arrow.flight.protocol.sql.SupportedAnsi92SqlGrammarLevel`.</span> |
| <span class="linenos"> 398</span><span class="cm"> */</span> |
| <span class="linenos"> 399</span><span class="w"> </span><span class="na">SQL_ANSI92_SUPPORTED_LEVEL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">526</span><span class="p">;</span> |
| <span class="linenos"> 400</span> |
| <span class="linenos"> 401</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 402</span><span class="cm"> * Retrieves a boolean value indicating whether the SQL Integrity Enhancement Facility is supported.</span> |
| <span class="linenos"> 403</span><span class="cm"> *</span> |
| <span class="linenos"> 404</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 405</span><span class="cm"> * - false: if the SQL Integrity Enhancement Facility is supported;</span> |
| <span class="linenos"> 406</span><span class="cm"> * - true: if the SQL Integrity Enhancement Facility is supported.</span> |
| <span class="linenos"> 407</span><span class="cm"> */</span> |
| <span class="linenos"> 408</span><span class="w"> </span><span class="na">SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">527</span><span class="p">;</span> |
| <span class="linenos"> 409</span> |
| <span class="linenos"> 410</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 411</span><span class="cm"> * Retrieves the support level for SQL OUTER JOINs.</span> |
| <span class="linenos"> 412</span><span class="cm"> *</span> |
| <span class="linenos"> 413</span><span class="cm"> * Returns a int32 ordinal for the SQL ordering being used, as described in</span> |
| <span class="linenos"> 414</span><span class="cm"> * `arrow.flight.protocol.sql.SqlOuterJoinsSupportLevel`.</span> |
| <span class="linenos"> 415</span><span class="cm"> */</span> |
| <span class="linenos"> 416</span><span class="w"> </span><span class="na">SQL_OUTER_JOINS_SUPPORT_LEVEL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">528</span><span class="p">;</span> |
| <span class="linenos"> 417</span> |
| <span class="linenos"> 418</span><span class="w"> </span><span class="c1">// Retrieves a UTF-8 string with the preferred term for "schema".</span> |
| <span class="linenos"> 419</span><span class="w"> </span><span class="na">SQL_SCHEMA_TERM</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">529</span><span class="p">;</span> |
| <span class="linenos"> 420</span> |
| <span class="linenos"> 421</span><span class="w"> </span><span class="c1">// Retrieves a UTF-8 string with the preferred term for "procedure".</span> |
| <span class="linenos"> 422</span><span class="w"> </span><span class="na">SQL_PROCEDURE_TERM</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">530</span><span class="p">;</span> |
| <span class="linenos"> 423</span> |
| <span class="linenos"> 424</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 425</span><span class="cm"> * Retrieves a UTF-8 string with the preferred term for "catalog".</span> |
| <span class="linenos"> 426</span><span class="cm"> * If a empty string is returned its assumed that the server does NOT supports catalogs.</span> |
| <span class="linenos"> 427</span><span class="cm"> */</span> |
| <span class="linenos"> 428</span><span class="w"> </span><span class="na">SQL_CATALOG_TERM</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">531</span><span class="p">;</span> |
| <span class="linenos"> 429</span> |
| <span class="linenos"> 430</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 431</span><span class="cm"> * Retrieves a boolean value indicating whether a catalog appears at the start of a fully qualified table name.</span> |
| <span class="linenos"> 432</span><span class="cm"> *</span> |
| <span class="linenos"> 433</span><span class="cm"> * - false: if a catalog does not appear at the start of a fully qualified table name;</span> |
| <span class="linenos"> 434</span><span class="cm"> * - true: if a catalog appears at the start of a fully qualified table name.</span> |
| <span class="linenos"> 435</span><span class="cm"> */</span> |
| <span class="linenos"> 436</span><span class="w"> </span><span class="na">SQL_CATALOG_AT_START</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">532</span><span class="p">;</span> |
| <span class="linenos"> 437</span> |
| <span class="linenos"> 438</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 439</span><span class="cm"> * Retrieves the supported actions for a SQL schema.</span> |
| <span class="linenos"> 440</span><span class="cm"> *</span> |
| <span class="linenos"> 441</span><span class="cm"> * Returns an int32 bitmask value representing the supported actions for a SQL schema.</span> |
| <span class="linenos"> 442</span><span class="cm"> * The returned bitmask should be parsed in order to retrieve the supported actions for a SQL schema.</span> |
| <span class="linenos"> 443</span><span class="cm"> *</span> |
| <span class="linenos"> 444</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 445</span><span class="cm"> * - return 0 (\b0) => [] (no supported actions for SQL schema);</span> |
| <span class="linenos"> 446</span><span class="cm"> * - return 1 (\b1) => [SQL_ELEMENT_IN_PROCEDURE_CALLS];</span> |
| <span class="linenos"> 447</span><span class="cm"> * - return 2 (\b10) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS];</span> |
| <span class="linenos"> 448</span><span class="cm"> * - return 3 (\b11) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS];</span> |
| <span class="linenos"> 449</span><span class="cm"> * - return 4 (\b100) => [SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];</span> |
| <span class="linenos"> 450</span><span class="cm"> * - return 5 (\b101) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];</span> |
| <span class="linenos"> 451</span><span class="cm"> * - return 6 (\b110) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];</span> |
| <span class="linenos"> 452</span><span class="cm"> * - return 7 (\b111) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS].</span> |
| <span class="linenos"> 453</span><span class="cm"> * Valid actions for a SQL schema described under `arrow.flight.protocol.sql.SqlSupportedElementActions`.</span> |
| <span class="linenos"> 454</span><span class="cm"> */</span> |
| <span class="linenos"> 455</span><span class="w"> </span><span class="na">SQL_SCHEMAS_SUPPORTED_ACTIONS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">533</span><span class="p">;</span> |
| <span class="linenos"> 456</span> |
| <span class="linenos"> 457</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 458</span><span class="cm"> * Retrieves the supported actions for a SQL schema.</span> |
| <span class="linenos"> 459</span><span class="cm"> *</span> |
| <span class="linenos"> 460</span><span class="cm"> * Returns an int32 bitmask value representing the supported actions for a SQL catalog.</span> |
| <span class="linenos"> 461</span><span class="cm"> * The returned bitmask should be parsed in order to retrieve the supported actions for a SQL catalog.</span> |
| <span class="linenos"> 462</span><span class="cm"> *</span> |
| <span class="linenos"> 463</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 464</span><span class="cm"> * - return 0 (\b0) => [] (no supported actions for SQL catalog);</span> |
| <span class="linenos"> 465</span><span class="cm"> * - return 1 (\b1) => [SQL_ELEMENT_IN_PROCEDURE_CALLS];</span> |
| <span class="linenos"> 466</span><span class="cm"> * - return 2 (\b10) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS];</span> |
| <span class="linenos"> 467</span><span class="cm"> * - return 3 (\b11) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS];</span> |
| <span class="linenos"> 468</span><span class="cm"> * - return 4 (\b100) => [SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];</span> |
| <span class="linenos"> 469</span><span class="cm"> * - return 5 (\b101) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];</span> |
| <span class="linenos"> 470</span><span class="cm"> * - return 6 (\b110) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];</span> |
| <span class="linenos"> 471</span><span class="cm"> * - return 7 (\b111) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS].</span> |
| <span class="linenos"> 472</span><span class="cm"> * Valid actions for a SQL catalog are described under `arrow.flight.protocol.sql.SqlSupportedElementActions`.</span> |
| <span class="linenos"> 473</span><span class="cm"> */</span> |
| <span class="linenos"> 474</span><span class="w"> </span><span class="na">SQL_CATALOGS_SUPPORTED_ACTIONS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">534</span><span class="p">;</span> |
| <span class="linenos"> 475</span> |
| <span class="linenos"> 476</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 477</span><span class="cm"> * Retrieves the supported SQL positioned commands.</span> |
| <span class="linenos"> 478</span><span class="cm"> *</span> |
| <span class="linenos"> 479</span><span class="cm"> * Returns an int32 bitmask value representing the supported SQL positioned commands.</span> |
| <span class="linenos"> 480</span><span class="cm"> * The returned bitmask should be parsed in order to retrieve the supported SQL positioned commands.</span> |
| <span class="linenos"> 481</span><span class="cm"> *</span> |
| <span class="linenos"> 482</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 483</span><span class="cm"> * - return 0 (\b0) => [] (no supported SQL positioned commands);</span> |
| <span class="linenos"> 484</span><span class="cm"> * - return 1 (\b1) => [SQL_POSITIONED_DELETE];</span> |
| <span class="linenos"> 485</span><span class="cm"> * - return 2 (\b10) => [SQL_POSITIONED_UPDATE];</span> |
| <span class="linenos"> 486</span><span class="cm"> * - return 3 (\b11) => [SQL_POSITIONED_DELETE, SQL_POSITIONED_UPDATE].</span> |
| <span class="linenos"> 487</span><span class="cm"> * Valid SQL positioned commands are described under `arrow.flight.protocol.sql.SqlSupportedPositionedCommands`.</span> |
| <span class="linenos"> 488</span><span class="cm"> */</span> |
| <span class="linenos"> 489</span><span class="w"> </span><span class="na">SQL_SUPPORTED_POSITIONED_COMMANDS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">535</span><span class="p">;</span> |
| <span class="linenos"> 490</span> |
| <span class="linenos"> 491</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 492</span><span class="cm"> * Retrieves a boolean value indicating whether SELECT FOR UPDATE statements are supported.</span> |
| <span class="linenos"> 493</span><span class="cm"> *</span> |
| <span class="linenos"> 494</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 495</span><span class="cm"> * - false: if SELECT FOR UPDATE statements are unsupported;</span> |
| <span class="linenos"> 496</span><span class="cm"> * - true: if SELECT FOR UPDATE statements are supported.</span> |
| <span class="linenos"> 497</span><span class="cm"> */</span> |
| <span class="linenos"> 498</span><span class="w"> </span><span class="na">SQL_SELECT_FOR_UPDATE_SUPPORTED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">536</span><span class="p">;</span> |
| <span class="linenos"> 499</span> |
| <span class="linenos"> 500</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 501</span><span class="cm"> * Retrieves a boolean value indicating whether stored procedure calls that use the stored procedure escape syntax</span> |
| <span class="linenos"> 502</span><span class="cm"> * are supported.</span> |
| <span class="linenos"> 503</span><span class="cm"> *</span> |
| <span class="linenos"> 504</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 505</span><span class="cm"> * - false: if stored procedure calls that use the stored procedure escape syntax are unsupported;</span> |
| <span class="linenos"> 506</span><span class="cm"> * - true: if stored procedure calls that use the stored procedure escape syntax are supported.</span> |
| <span class="linenos"> 507</span><span class="cm"> */</span> |
| <span class="linenos"> 508</span><span class="w"> </span><span class="na">SQL_STORED_PROCEDURES_SUPPORTED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">537</span><span class="p">;</span> |
| <span class="linenos"> 509</span> |
| <span class="linenos"> 510</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 511</span><span class="cm"> * Retrieves the supported SQL subqueries.</span> |
| <span class="linenos"> 512</span><span class="cm"> *</span> |
| <span class="linenos"> 513</span><span class="cm"> * Returns an int32 bitmask value representing the supported SQL subqueries.</span> |
| <span class="linenos"> 514</span><span class="cm"> * The returned bitmask should be parsed in order to retrieve the supported SQL subqueries.</span> |
| <span class="linenos"> 515</span><span class="cm"> *</span> |
| <span class="linenos"> 516</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 517</span><span class="cm"> * - return 0 (\b0) => [] (no supported SQL subqueries);</span> |
| <span class="linenos"> 518</span><span class="cm"> * - return 1 (\b1) => [SQL_SUBQUERIES_IN_COMPARISONS];</span> |
| <span class="linenos"> 519</span><span class="cm"> * - return 2 (\b10) => [SQL_SUBQUERIES_IN_EXISTS];</span> |
| <span class="linenos"> 520</span><span class="cm"> * - return 3 (\b11) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS];</span> |
| <span class="linenos"> 521</span><span class="cm"> * - return 4 (\b100) => [SQL_SUBQUERIES_IN_INS];</span> |
| <span class="linenos"> 522</span><span class="cm"> * - return 5 (\b101) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_INS];</span> |
| <span class="linenos"> 523</span><span class="cm"> * - return 6 (\b110) => [SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_EXISTS];</span> |
| <span class="linenos"> 524</span><span class="cm"> * - return 7 (\b111) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS];</span> |
| <span class="linenos"> 525</span><span class="cm"> * - return 8 (\b1000) => [SQL_SUBQUERIES_IN_QUANTIFIEDS];</span> |
| <span class="linenos"> 526</span><span class="cm"> * - return 9 (\b1001) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</span> |
| <span class="linenos"> 527</span><span class="cm"> * - return 10 (\b1010) => [SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</span> |
| <span class="linenos"> 528</span><span class="cm"> * - return 11 (\b1011) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</span> |
| <span class="linenos"> 529</span><span class="cm"> * - return 12 (\b1100) => [SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</span> |
| <span class="linenos"> 530</span><span class="cm"> * - return 13 (\b1101) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</span> |
| <span class="linenos"> 531</span><span class="cm"> * - return 14 (\b1110) => [SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</span> |
| <span class="linenos"> 532</span><span class="cm"> * - return 15 (\b1111) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</span> |
| <span class="linenos"> 533</span><span class="cm"> * - ...</span> |
| <span class="linenos"> 534</span><span class="cm"> * Valid SQL subqueries are described under `arrow.flight.protocol.sql.SqlSupportedSubqueries`.</span> |
| <span class="linenos"> 535</span><span class="cm"> */</span> |
| <span class="linenos"> 536</span><span class="w"> </span><span class="na">SQL_SUPPORTED_SUBQUERIES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">538</span><span class="p">;</span> |
| <span class="linenos"> 537</span> |
| <span class="linenos"> 538</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 539</span><span class="cm"> * Retrieves a boolean value indicating whether correlated subqueries are supported.</span> |
| <span class="linenos"> 540</span><span class="cm"> *</span> |
| <span class="linenos"> 541</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 542</span><span class="cm"> * - false: if correlated subqueries are unsupported;</span> |
| <span class="linenos"> 543</span><span class="cm"> * - true: if correlated subqueries are supported.</span> |
| <span class="linenos"> 544</span><span class="cm"> */</span> |
| <span class="linenos"> 545</span><span class="w"> </span><span class="na">SQL_CORRELATED_SUBQUERIES_SUPPORTED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">539</span><span class="p">;</span> |
| <span class="linenos"> 546</span> |
| <span class="linenos"> 547</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 548</span><span class="cm"> * Retrieves the supported SQL UNIONs.</span> |
| <span class="linenos"> 549</span><span class="cm"> *</span> |
| <span class="linenos"> 550</span><span class="cm"> * Returns an int32 bitmask value representing the supported SQL UNIONs.</span> |
| <span class="linenos"> 551</span><span class="cm"> * The returned bitmask should be parsed in order to retrieve the supported SQL UNIONs.</span> |
| <span class="linenos"> 552</span><span class="cm"> *</span> |
| <span class="linenos"> 553</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 554</span><span class="cm"> * - return 0 (\b0) => [] (no supported SQL positioned commands);</span> |
| <span class="linenos"> 555</span><span class="cm"> * - return 1 (\b1) => [SQL_UNION];</span> |
| <span class="linenos"> 556</span><span class="cm"> * - return 2 (\b10) => [SQL_UNION_ALL];</span> |
| <span class="linenos"> 557</span><span class="cm"> * - return 3 (\b11) => [SQL_UNION, SQL_UNION_ALL].</span> |
| <span class="linenos"> 558</span><span class="cm"> * Valid SQL positioned commands are described under `arrow.flight.protocol.sql.SqlSupportedUnions`.</span> |
| <span class="linenos"> 559</span><span class="cm"> */</span> |
| <span class="linenos"> 560</span><span class="w"> </span><span class="na">SQL_SUPPORTED_UNIONS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">540</span><span class="p">;</span> |
| <span class="linenos"> 561</span> |
| <span class="linenos"> 562</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of hex characters allowed in an inline binary literal.</span> |
| <span class="linenos"> 563</span><span class="w"> </span><span class="na">SQL_MAX_BINARY_LITERAL_LENGTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">541</span><span class="p">;</span> |
| <span class="linenos"> 564</span> |
| <span class="linenos"> 565</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of characters allowed for a character literal.</span> |
| <span class="linenos"> 566</span><span class="w"> </span><span class="na">SQL_MAX_CHAR_LITERAL_LENGTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">542</span><span class="p">;</span> |
| <span class="linenos"> 567</span> |
| <span class="linenos"> 568</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of characters allowed for a column name.</span> |
| <span class="linenos"> 569</span><span class="w"> </span><span class="na">SQL_MAX_COLUMN_NAME_LENGTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">543</span><span class="p">;</span> |
| <span class="linenos"> 570</span> |
| <span class="linenos"> 571</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of columns allowed in a GROUP BY clause.</span> |
| <span class="linenos"> 572</span><span class="w"> </span><span class="na">SQL_MAX_COLUMNS_IN_GROUP_BY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">544</span><span class="p">;</span> |
| <span class="linenos"> 573</span> |
| <span class="linenos"> 574</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of columns allowed in an index.</span> |
| <span class="linenos"> 575</span><span class="w"> </span><span class="na">SQL_MAX_COLUMNS_IN_INDEX</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">545</span><span class="p">;</span> |
| <span class="linenos"> 576</span> |
| <span class="linenos"> 577</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of columns allowed in an ORDER BY clause.</span> |
| <span class="linenos"> 578</span><span class="w"> </span><span class="na">SQL_MAX_COLUMNS_IN_ORDER_BY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">546</span><span class="p">;</span> |
| <span class="linenos"> 579</span> |
| <span class="linenos"> 580</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of columns allowed in a SELECT list.</span> |
| <span class="linenos"> 581</span><span class="w"> </span><span class="na">SQL_MAX_COLUMNS_IN_SELECT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">547</span><span class="p">;</span> |
| <span class="linenos"> 582</span> |
| <span class="linenos"> 583</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of columns allowed in a table.</span> |
| <span class="linenos"> 584</span><span class="w"> </span><span class="na">SQL_MAX_COLUMNS_IN_TABLE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">548</span><span class="p">;</span> |
| <span class="linenos"> 585</span> |
| <span class="linenos"> 586</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of concurrent connections possible.</span> |
| <span class="linenos"> 587</span><span class="w"> </span><span class="na">SQL_MAX_CONNECTIONS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">549</span><span class="p">;</span> |
| <span class="linenos"> 588</span> |
| <span class="linenos"> 589</span><span class="w"> </span><span class="c1">// Retrieves a int64 value the maximum number of characters allowed in a cursor name.</span> |
| <span class="linenos"> 590</span><span class="w"> </span><span class="na">SQL_MAX_CURSOR_NAME_LENGTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">550</span><span class="p">;</span> |
| <span class="linenos"> 591</span> |
| <span class="linenos"> 592</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 593</span><span class="cm"> * Retrieves a int64 value representing the maximum number of bytes allowed for an index,</span> |
| <span class="linenos"> 594</span><span class="cm"> * including all of the parts of the index.</span> |
| <span class="linenos"> 595</span><span class="cm"> */</span> |
| <span class="linenos"> 596</span><span class="w"> </span><span class="na">SQL_MAX_INDEX_LENGTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">551</span><span class="p">;</span> |
| <span class="linenos"> 597</span> |
| <span class="linenos"> 598</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of characters allowed in a schema name.</span> |
| <span class="linenos"> 599</span><span class="w"> </span><span class="na">SQL_DB_SCHEMA_NAME_LENGTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">552</span><span class="p">;</span> |
| <span class="linenos"> 600</span> |
| <span class="linenos"> 601</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of characters allowed in a procedure name.</span> |
| <span class="linenos"> 602</span><span class="w"> </span><span class="na">SQL_MAX_PROCEDURE_NAME_LENGTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">553</span><span class="p">;</span> |
| <span class="linenos"> 603</span> |
| <span class="linenos"> 604</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of characters allowed in a catalog name.</span> |
| <span class="linenos"> 605</span><span class="w"> </span><span class="na">SQL_MAX_CATALOG_NAME_LENGTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">554</span><span class="p">;</span> |
| <span class="linenos"> 606</span> |
| <span class="linenos"> 607</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of bytes allowed in a single row.</span> |
| <span class="linenos"> 608</span><span class="w"> </span><span class="na">SQL_MAX_ROW_SIZE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">555</span><span class="p">;</span> |
| <span class="linenos"> 609</span> |
| <span class="linenos"> 610</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 611</span><span class="cm"> * Retrieves a boolean indicating whether the return value for the JDBC method getMaxRowSize includes the SQL</span> |
| <span class="linenos"> 612</span><span class="cm"> * data types LONGVARCHAR and LONGVARBINARY.</span> |
| <span class="linenos"> 613</span><span class="cm"> *</span> |
| <span class="linenos"> 614</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 615</span><span class="cm"> * - false: if return value for the JDBC method getMaxRowSize does</span> |
| <span class="linenos"> 616</span><span class="cm"> * not include the SQL data types LONGVARCHAR and LONGVARBINARY;</span> |
| <span class="linenos"> 617</span><span class="cm"> * - true: if return value for the JDBC method getMaxRowSize includes</span> |
| <span class="linenos"> 618</span><span class="cm"> * the SQL data types LONGVARCHAR and LONGVARBINARY.</span> |
| <span class="linenos"> 619</span><span class="cm"> */</span> |
| <span class="linenos"> 620</span><span class="w"> </span><span class="na">SQL_MAX_ROW_SIZE_INCLUDES_BLOBS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">556</span><span class="p">;</span> |
| <span class="linenos"> 621</span> |
| <span class="linenos"> 622</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 623</span><span class="cm"> * Retrieves a int64 value representing the maximum number of characters allowed for an SQL statement;</span> |
| <span class="linenos"> 624</span><span class="cm"> * a result of 0 (zero) means that there is no limit or the limit is not known.</span> |
| <span class="linenos"> 625</span><span class="cm"> */</span> |
| <span class="linenos"> 626</span><span class="w"> </span><span class="na">SQL_MAX_STATEMENT_LENGTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">557</span><span class="p">;</span> |
| <span class="linenos"> 627</span> |
| <span class="linenos"> 628</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of active statements that can be open at the same time.</span> |
| <span class="linenos"> 629</span><span class="w"> </span><span class="na">SQL_MAX_STATEMENTS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">558</span><span class="p">;</span> |
| <span class="linenos"> 630</span> |
| <span class="linenos"> 631</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of characters allowed in a table name.</span> |
| <span class="linenos"> 632</span><span class="w"> </span><span class="na">SQL_MAX_TABLE_NAME_LENGTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">559</span><span class="p">;</span> |
| <span class="linenos"> 633</span> |
| <span class="linenos"> 634</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of tables allowed in a SELECT statement.</span> |
| <span class="linenos"> 635</span><span class="w"> </span><span class="na">SQL_MAX_TABLES_IN_SELECT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">560</span><span class="p">;</span> |
| <span class="linenos"> 636</span> |
| <span class="linenos"> 637</span><span class="w"> </span><span class="c1">// Retrieves a int64 value representing the maximum number of characters allowed in a user name.</span> |
| <span class="linenos"> 638</span><span class="w"> </span><span class="na">SQL_MAX_USERNAME_LENGTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">561</span><span class="p">;</span> |
| <span class="linenos"> 639</span> |
| <span class="linenos"> 640</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 641</span><span class="cm"> * Retrieves this database's default transaction isolation level as described in</span> |
| <span class="linenos"> 642</span><span class="cm"> * `arrow.flight.protocol.sql.SqlTransactionIsolationLevel`.</span> |
| <span class="linenos"> 643</span><span class="cm"> *</span> |
| <span class="linenos"> 644</span><span class="cm"> * Returns a int32 ordinal for the SQL transaction isolation level.</span> |
| <span class="linenos"> 645</span><span class="cm"> */</span> |
| <span class="linenos"> 646</span><span class="w"> </span><span class="na">SQL_DEFAULT_TRANSACTION_ISOLATION</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">562</span><span class="p">;</span> |
| <span class="linenos"> 647</span> |
| <span class="linenos"> 648</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 649</span><span class="cm"> * Retrieves a boolean value indicating whether transactions are supported. If not, invoking the method commit is a</span> |
| <span class="linenos"> 650</span><span class="cm"> * noop, and the isolation level is `arrow.flight.protocol.sql.SqlTransactionIsolationLevel.TRANSACTION_NONE`.</span> |
| <span class="linenos"> 651</span><span class="cm"> *</span> |
| <span class="linenos"> 652</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 653</span><span class="cm"> * - false: if transactions are unsupported;</span> |
| <span class="linenos"> 654</span><span class="cm"> * - true: if transactions are supported.</span> |
| <span class="linenos"> 655</span><span class="cm"> */</span> |
| <span class="linenos"> 656</span><span class="w"> </span><span class="na">SQL_TRANSACTIONS_SUPPORTED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">563</span><span class="p">;</span> |
| <span class="linenos"> 657</span> |
| <span class="linenos"> 658</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 659</span><span class="cm"> * Retrieves the supported transactions isolation levels.</span> |
| <span class="linenos"> 660</span><span class="cm"> *</span> |
| <span class="linenos"> 661</span><span class="cm"> * Returns an int32 bitmask value representing the supported transactions isolation levels.</span> |
| <span class="linenos"> 662</span><span class="cm"> * The returned bitmask should be parsed in order to retrieve the supported transactions isolation levels.</span> |
| <span class="linenos"> 663</span><span class="cm"> *</span> |
| <span class="linenos"> 664</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 665</span><span class="cm"> * - return 0 (\b0) => [] (no supported SQL transactions isolation levels);</span> |
| <span class="linenos"> 666</span><span class="cm"> * - return 1 (\b1) => [SQL_TRANSACTION_NONE];</span> |
| <span class="linenos"> 667</span><span class="cm"> * - return 2 (\b10) => [SQL_TRANSACTION_READ_UNCOMMITTED];</span> |
| <span class="linenos"> 668</span><span class="cm"> * - return 3 (\b11) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED];</span> |
| <span class="linenos"> 669</span><span class="cm"> * - return 4 (\b100) => [SQL_TRANSACTION_REPEATABLE_READ];</span> |
| <span class="linenos"> 670</span><span class="cm"> * - return 5 (\b101) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ];</span> |
| <span class="linenos"> 671</span><span class="cm"> * - return 6 (\b110) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];</span> |
| <span class="linenos"> 672</span><span class="cm"> * - return 7 (\b111) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];</span> |
| <span class="linenos"> 673</span><span class="cm"> * - return 8 (\b1000) => [SQL_TRANSACTION_REPEATABLE_READ];</span> |
| <span class="linenos"> 674</span><span class="cm"> * - return 9 (\b1001) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ];</span> |
| <span class="linenos"> 675</span><span class="cm"> * - return 10 (\b1010) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];</span> |
| <span class="linenos"> 676</span><span class="cm"> * - return 11 (\b1011) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];</span> |
| <span class="linenos"> 677</span><span class="cm"> * - return 12 (\b1100) => [SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];</span> |
| <span class="linenos"> 678</span><span class="cm"> * - return 13 (\b1101) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];</span> |
| <span class="linenos"> 679</span><span class="cm"> * - return 14 (\b1110) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];</span> |
| <span class="linenos"> 680</span><span class="cm"> * - return 15 (\b1111) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];</span> |
| <span class="linenos"> 681</span><span class="cm"> * - return 16 (\b10000) => [SQL_TRANSACTION_SERIALIZABLE];</span> |
| <span class="linenos"> 682</span><span class="cm"> * - ...</span> |
| <span class="linenos"> 683</span><span class="cm"> * Valid SQL positioned commands are described under `arrow.flight.protocol.sql.SqlTransactionIsolationLevel`.</span> |
| <span class="linenos"> 684</span><span class="cm"> */</span> |
| <span class="linenos"> 685</span><span class="w"> </span><span class="na">SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">564</span><span class="p">;</span> |
| <span class="linenos"> 686</span> |
| <span class="linenos"> 687</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 688</span><span class="cm"> * Retrieves a boolean value indicating whether a data definition statement within a transaction forces</span> |
| <span class="linenos"> 689</span><span class="cm"> * the transaction to commit.</span> |
| <span class="linenos"> 690</span><span class="cm"> *</span> |
| <span class="linenos"> 691</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 692</span><span class="cm"> * - false: if a data definition statement within a transaction does not force the transaction to commit;</span> |
| <span class="linenos"> 693</span><span class="cm"> * - true: if a data definition statement within a transaction forces the transaction to commit.</span> |
| <span class="linenos"> 694</span><span class="cm"> */</span> |
| <span class="linenos"> 695</span><span class="w"> </span><span class="na">SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMIT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">565</span><span class="p">;</span> |
| <span class="linenos"> 696</span> |
| <span class="linenos"> 697</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 698</span><span class="cm"> * Retrieves a boolean value indicating whether a data definition statement within a transaction is ignored.</span> |
| <span class="linenos"> 699</span><span class="cm"> *</span> |
| <span class="linenos"> 700</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 701</span><span class="cm"> * - false: if a data definition statement within a transaction is taken into account;</span> |
| <span class="linenos"> 702</span><span class="cm"> * - true: a data definition statement within a transaction is ignored.</span> |
| <span class="linenos"> 703</span><span class="cm"> */</span> |
| <span class="linenos"> 704</span><span class="w"> </span><span class="na">SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNORED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">566</span><span class="p">;</span> |
| <span class="linenos"> 705</span> |
| <span class="linenos"> 706</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 707</span><span class="cm"> * Retrieves an int32 bitmask value representing the supported result set types.</span> |
| <span class="linenos"> 708</span><span class="cm"> * The returned bitmask should be parsed in order to retrieve the supported result set types.</span> |
| <span class="linenos"> 709</span><span class="cm"> *</span> |
| <span class="linenos"> 710</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 711</span><span class="cm"> * - return 0 (\b0) => [] (no supported result set types);</span> |
| <span class="linenos"> 712</span><span class="cm"> * - return 1 (\b1) => [SQL_RESULT_SET_TYPE_UNSPECIFIED];</span> |
| <span class="linenos"> 713</span><span class="cm"> * - return 2 (\b10) => [SQL_RESULT_SET_TYPE_FORWARD_ONLY];</span> |
| <span class="linenos"> 714</span><span class="cm"> * - return 3 (\b11) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_FORWARD_ONLY];</span> |
| <span class="linenos"> 715</span><span class="cm"> * - return 4 (\b100) => [SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];</span> |
| <span class="linenos"> 716</span><span class="cm"> * - return 5 (\b101) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];</span> |
| <span class="linenos"> 717</span><span class="cm"> * - return 6 (\b110) => [SQL_RESULT_SET_TYPE_FORWARD_ONLY, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];</span> |
| <span class="linenos"> 718</span><span class="cm"> * - return 7 (\b111) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_FORWARD_ONLY, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];</span> |
| <span class="linenos"> 719</span><span class="cm"> * - return 8 (\b1000) => [SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE];</span> |
| <span class="linenos"> 720</span><span class="cm"> * - ...</span> |
| <span class="linenos"> 721</span><span class="cm"> * Valid result set types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetType`.</span> |
| <span class="linenos"> 722</span><span class="cm"> */</span> |
| <span class="linenos"> 723</span><span class="w"> </span><span class="na">SQL_SUPPORTED_RESULT_SET_TYPES</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">567</span><span class="p">;</span> |
| <span class="linenos"> 724</span> |
| <span class="linenos"> 725</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 726</span><span class="cm"> * Returns an int32 bitmask value concurrency types supported for</span> |
| <span class="linenos"> 727</span><span class="cm"> * `arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_UNSPECIFIED`.</span> |
| <span class="linenos"> 728</span><span class="cm"> *</span> |
| <span class="linenos"> 729</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 730</span><span class="cm"> * - return 0 (\b0) => [] (no supported concurrency types for this result set type)</span> |
| <span class="linenos"> 731</span><span class="cm"> * - return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]</span> |
| <span class="linenos"> 732</span><span class="cm"> * - return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</span> |
| <span class="linenos"> 733</span><span class="cm"> * - return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</span> |
| <span class="linenos"> 734</span><span class="cm"> * - return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 735</span><span class="cm"> * - return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 736</span><span class="cm"> * - return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 737</span><span class="cm"> * - return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 738</span><span class="cm"> * Valid result set types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency`.</span> |
| <span class="linenos"> 739</span><span class="cm"> */</span> |
| <span class="linenos"> 740</span><span class="w"> </span><span class="na">SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">568</span><span class="p">;</span> |
| <span class="linenos"> 741</span> |
| <span class="linenos"> 742</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 743</span><span class="cm"> * Returns an int32 bitmask value concurrency types supported for</span> |
| <span class="linenos"> 744</span><span class="cm"> * `arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_FORWARD_ONLY`.</span> |
| <span class="linenos"> 745</span><span class="cm"> *</span> |
| <span class="linenos"> 746</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 747</span><span class="cm"> * - return 0 (\b0) => [] (no supported concurrency types for this result set type)</span> |
| <span class="linenos"> 748</span><span class="cm"> * - return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]</span> |
| <span class="linenos"> 749</span><span class="cm"> * - return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</span> |
| <span class="linenos"> 750</span><span class="cm"> * - return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</span> |
| <span class="linenos"> 751</span><span class="cm"> * - return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 752</span><span class="cm"> * - return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 753</span><span class="cm"> * - return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 754</span><span class="cm"> * - return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 755</span><span class="cm"> * Valid result set types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency`.</span> |
| <span class="linenos"> 756</span><span class="cm"> */</span> |
| <span class="linenos"> 757</span><span class="w"> </span><span class="na">SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">569</span><span class="p">;</span> |
| <span class="linenos"> 758</span> |
| <span class="linenos"> 759</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 760</span><span class="cm"> * Returns an int32 bitmask value concurrency types supported for</span> |
| <span class="linenos"> 761</span><span class="cm"> * `arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE`.</span> |
| <span class="linenos"> 762</span><span class="cm"> *</span> |
| <span class="linenos"> 763</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 764</span><span class="cm"> * - return 0 (\b0) => [] (no supported concurrency types for this result set type)</span> |
| <span class="linenos"> 765</span><span class="cm"> * - return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]</span> |
| <span class="linenos"> 766</span><span class="cm"> * - return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</span> |
| <span class="linenos"> 767</span><span class="cm"> * - return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</span> |
| <span class="linenos"> 768</span><span class="cm"> * - return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 769</span><span class="cm"> * - return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 770</span><span class="cm"> * - return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 771</span><span class="cm"> * - return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 772</span><span class="cm"> * Valid result set types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency`.</span> |
| <span class="linenos"> 773</span><span class="cm"> */</span> |
| <span class="linenos"> 774</span><span class="w"> </span><span class="na">SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">570</span><span class="p">;</span> |
| <span class="linenos"> 775</span> |
| <span class="linenos"> 776</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 777</span><span class="cm"> * Returns an int32 bitmask value concurrency types supported for</span> |
| <span class="linenos"> 778</span><span class="cm"> * `arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE`.</span> |
| <span class="linenos"> 779</span><span class="cm"> *</span> |
| <span class="linenos"> 780</span><span class="cm"> * For instance:</span> |
| <span class="linenos"> 781</span><span class="cm"> * - return 0 (\b0) => [] (no supported concurrency types for this result set type)</span> |
| <span class="linenos"> 782</span><span class="cm"> * - return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]</span> |
| <span class="linenos"> 783</span><span class="cm"> * - return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</span> |
| <span class="linenos"> 784</span><span class="cm"> * - return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</span> |
| <span class="linenos"> 785</span><span class="cm"> * - return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 786</span><span class="cm"> * - return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 787</span><span class="cm"> * - return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 788</span><span class="cm"> * - return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</span> |
| <span class="linenos"> 789</span><span class="cm"> * Valid result set types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency`.</span> |
| <span class="linenos"> 790</span><span class="cm"> */</span> |
| <span class="linenos"> 791</span><span class="w"> </span><span class="na">SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">571</span><span class="p">;</span> |
| <span class="linenos"> 792</span> |
| <span class="linenos"> 793</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 794</span><span class="cm"> * Retrieves a boolean value indicating whether this database supports batch updates.</span> |
| <span class="linenos"> 795</span><span class="cm"> *</span> |
| <span class="linenos"> 796</span><span class="cm"> * - false: if this database does not support batch updates;</span> |
| <span class="linenos"> 797</span><span class="cm"> * - true: if this database supports batch updates.</span> |
| <span class="linenos"> 798</span><span class="cm"> */</span> |
| <span class="linenos"> 799</span><span class="w"> </span><span class="na">SQL_BATCH_UPDATES_SUPPORTED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">572</span><span class="p">;</span> |
| <span class="linenos"> 800</span> |
| <span class="linenos"> 801</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 802</span><span class="cm"> * Retrieves a boolean value indicating whether this database supports savepoints.</span> |
| <span class="linenos"> 803</span><span class="cm"> *</span> |
| <span class="linenos"> 804</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 805</span><span class="cm"> * - false: if this database does not support savepoints;</span> |
| <span class="linenos"> 806</span><span class="cm"> * - true: if this database supports savepoints.</span> |
| <span class="linenos"> 807</span><span class="cm"> */</span> |
| <span class="linenos"> 808</span><span class="w"> </span><span class="na">SQL_SAVEPOINTS_SUPPORTED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">573</span><span class="p">;</span> |
| <span class="linenos"> 809</span> |
| <span class="linenos"> 810</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 811</span><span class="cm"> * Retrieves a boolean value indicating whether named parameters are supported in callable statements.</span> |
| <span class="linenos"> 812</span><span class="cm"> *</span> |
| <span class="linenos"> 813</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 814</span><span class="cm"> * - false: if named parameters in callable statements are unsupported;</span> |
| <span class="linenos"> 815</span><span class="cm"> * - true: if named parameters in callable statements are supported.</span> |
| <span class="linenos"> 816</span><span class="cm"> */</span> |
| <span class="linenos"> 817</span><span class="w"> </span><span class="na">SQL_NAMED_PARAMETERS_SUPPORTED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">574</span><span class="p">;</span> |
| <span class="linenos"> 818</span> |
| <span class="linenos"> 819</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 820</span><span class="cm"> * Retrieves a boolean value indicating whether updates made to a LOB are made on a copy or directly to the LOB.</span> |
| <span class="linenos"> 821</span><span class="cm"> *</span> |
| <span class="linenos"> 822</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 823</span><span class="cm"> * - false: if updates made to a LOB are made directly to the LOB;</span> |
| <span class="linenos"> 824</span><span class="cm"> * - true: if updates made to a LOB are made on a copy.</span> |
| <span class="linenos"> 825</span><span class="cm"> */</span> |
| <span class="linenos"> 826</span><span class="w"> </span><span class="na">SQL_LOCATORS_UPDATE_COPY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">575</span><span class="p">;</span> |
| <span class="linenos"> 827</span> |
| <span class="linenos"> 828</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos"> 829</span><span class="cm"> * Retrieves a boolean value indicating whether invoking user-defined or vendor functions</span> |
| <span class="linenos"> 830</span><span class="cm"> * using the stored procedure escape syntax is supported.</span> |
| <span class="linenos"> 831</span><span class="cm"> *</span> |
| <span class="linenos"> 832</span><span class="cm"> * Returns:</span> |
| <span class="linenos"> 833</span><span class="cm"> * - false: if invoking user-defined or vendor functions using the stored procedure escape syntax is unsupported;</span> |
| <span class="linenos"> 834</span><span class="cm"> * - true: if invoking user-defined or vendor functions using the stored procedure escape syntax is supported.</span> |
| <span class="linenos"> 835</span><span class="cm"> */</span> |
| <span class="linenos"> 836</span><span class="w"> </span><span class="na">SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">576</span><span class="p">;</span> |
| <span class="linenos"> 837</span><span class="p">}</span> |
| <span class="linenos"> 838</span> |
| <span class="linenos"> 839</span><span class="c1">// The level of support for Flight SQL transaction RPCs.</span> |
| <span class="linenos"> 840</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlSupportedTransaction</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 841</span><span class="w"> </span><span class="c1">// Unknown/not indicated/no support</span> |
| <span class="linenos"> 842</span><span class="w"> </span><span class="na">SQL_SUPPORTED_TRANSACTION_NONE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 843</span><span class="w"> </span><span class="c1">// Transactions, but not savepoints.</span> |
| <span class="linenos"> 844</span><span class="w"> </span><span class="c1">// A savepoint is a mark within a transaction that can be individually</span> |
| <span class="linenos"> 845</span><span class="w"> </span><span class="c1">// rolled back to. Not all databases support savepoints.</span> |
| <span class="linenos"> 846</span><span class="w"> </span><span class="na">SQL_SUPPORTED_TRANSACTION_TRANSACTION</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 847</span><span class="w"> </span><span class="c1">// Transactions and savepoints</span> |
| <span class="linenos"> 848</span><span class="w"> </span><span class="na">SQL_SUPPORTED_TRANSACTION_SAVEPOINT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 849</span><span class="p">}</span> |
| <span class="linenos"> 850</span> |
| <span class="linenos"> 851</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlSupportedCaseSensitivity</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 852</span><span class="w"> </span><span class="na">SQL_CASE_SENSITIVITY_UNKNOWN</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 853</span><span class="w"> </span><span class="na">SQL_CASE_SENSITIVITY_CASE_INSENSITIVE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 854</span><span class="w"> </span><span class="na">SQL_CASE_SENSITIVITY_UPPERCASE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 855</span><span class="w"> </span><span class="na">SQL_CASE_SENSITIVITY_LOWERCASE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos"> 856</span><span class="p">}</span> |
| <span class="linenos"> 857</span> |
| <span class="linenos"> 858</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlNullOrdering</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 859</span><span class="w"> </span><span class="na">SQL_NULLS_SORTED_HIGH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 860</span><span class="w"> </span><span class="na">SQL_NULLS_SORTED_LOW</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 861</span><span class="w"> </span><span class="na">SQL_NULLS_SORTED_AT_START</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 862</span><span class="w"> </span><span class="na">SQL_NULLS_SORTED_AT_END</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos"> 863</span><span class="p">}</span> |
| <span class="linenos"> 864</span> |
| <span class="linenos"> 865</span><span class="kd">enum</span><span class="w"> </span><span class="n">SupportedSqlGrammar</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 866</span><span class="w"> </span><span class="na">SQL_MINIMUM_GRAMMAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 867</span><span class="w"> </span><span class="na">SQL_CORE_GRAMMAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 868</span><span class="w"> </span><span class="na">SQL_EXTENDED_GRAMMAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 869</span><span class="p">}</span> |
| <span class="linenos"> 870</span> |
| <span class="linenos"> 871</span><span class="kd">enum</span><span class="w"> </span><span class="n">SupportedAnsi92SqlGrammarLevel</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 872</span><span class="w"> </span><span class="na">ANSI92_ENTRY_SQL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 873</span><span class="w"> </span><span class="na">ANSI92_INTERMEDIATE_SQL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 874</span><span class="w"> </span><span class="na">ANSI92_FULL_SQL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 875</span><span class="p">}</span> |
| <span class="linenos"> 876</span> |
| <span class="linenos"> 877</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlOuterJoinsSupportLevel</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 878</span><span class="w"> </span><span class="na">SQL_JOINS_UNSUPPORTED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 879</span><span class="w"> </span><span class="na">SQL_LIMITED_OUTER_JOINS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 880</span><span class="w"> </span><span class="na">SQL_FULL_OUTER_JOINS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 881</span><span class="p">}</span> |
| <span class="linenos"> 882</span> |
| <span class="linenos"> 883</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlSupportedGroupBy</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 884</span><span class="w"> </span><span class="na">SQL_GROUP_BY_UNRELATED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 885</span><span class="w"> </span><span class="na">SQL_GROUP_BY_BEYOND_SELECT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 886</span><span class="p">}</span> |
| <span class="linenos"> 887</span> |
| <span class="linenos"> 888</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlSupportedElementActions</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 889</span><span class="w"> </span><span class="na">SQL_ELEMENT_IN_PROCEDURE_CALLS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 890</span><span class="w"> </span><span class="na">SQL_ELEMENT_IN_INDEX_DEFINITIONS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 891</span><span class="w"> </span><span class="na">SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 892</span><span class="p">}</span> |
| <span class="linenos"> 893</span> |
| <span class="linenos"> 894</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlSupportedPositionedCommands</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 895</span><span class="w"> </span><span class="na">SQL_POSITIONED_DELETE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 896</span><span class="w"> </span><span class="na">SQL_POSITIONED_UPDATE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 897</span><span class="p">}</span> |
| <span class="linenos"> 898</span> |
| <span class="linenos"> 899</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlSupportedSubqueries</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 900</span><span class="w"> </span><span class="na">SQL_SUBQUERIES_IN_COMPARISONS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 901</span><span class="w"> </span><span class="na">SQL_SUBQUERIES_IN_EXISTS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 902</span><span class="w"> </span><span class="na">SQL_SUBQUERIES_IN_INS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 903</span><span class="w"> </span><span class="na">SQL_SUBQUERIES_IN_QUANTIFIEDS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos"> 904</span><span class="p">}</span> |
| <span class="linenos"> 905</span> |
| <span class="linenos"> 906</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlSupportedUnions</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 907</span><span class="w"> </span><span class="na">SQL_UNION</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 908</span><span class="w"> </span><span class="na">SQL_UNION_ALL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 909</span><span class="p">}</span> |
| <span class="linenos"> 910</span> |
| <span class="linenos"> 911</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlTransactionIsolationLevel</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 912</span><span class="w"> </span><span class="na">SQL_TRANSACTION_NONE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 913</span><span class="w"> </span><span class="na">SQL_TRANSACTION_READ_UNCOMMITTED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 914</span><span class="w"> </span><span class="na">SQL_TRANSACTION_READ_COMMITTED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 915</span><span class="w"> </span><span class="na">SQL_TRANSACTION_REPEATABLE_READ</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos"> 916</span><span class="w"> </span><span class="na">SQL_TRANSACTION_SERIALIZABLE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">;</span> |
| <span class="linenos"> 917</span><span class="p">}</span> |
| <span class="linenos"> 918</span> |
| <span class="linenos"> 919</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlSupportedTransactions</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 920</span><span class="w"> </span><span class="na">SQL_TRANSACTION_UNSPECIFIED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 921</span><span class="w"> </span><span class="na">SQL_DATA_DEFINITION_TRANSACTIONS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 922</span><span class="w"> </span><span class="na">SQL_DATA_MANIPULATION_TRANSACTIONS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 923</span><span class="p">}</span> |
| <span class="linenos"> 924</span> |
| <span class="linenos"> 925</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlSupportedResultSetType</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 926</span><span class="w"> </span><span class="na">SQL_RESULT_SET_TYPE_UNSPECIFIED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 927</span><span class="w"> </span><span class="na">SQL_RESULT_SET_TYPE_FORWARD_ONLY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 928</span><span class="w"> </span><span class="na">SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 929</span><span class="w"> </span><span class="na">SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos"> 930</span><span class="p">}</span> |
| <span class="linenos"> 931</span> |
| <span class="linenos"> 932</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlSupportedResultSetConcurrency</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 933</span><span class="w"> </span><span class="na">SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 934</span><span class="w"> </span><span class="na">SQL_RESULT_SET_CONCURRENCY_READ_ONLY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 935</span><span class="w"> </span><span class="na">SQL_RESULT_SET_CONCURRENCY_UPDATABLE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 936</span><span class="p">}</span> |
| <span class="linenos"> 937</span> |
| <span class="linenos"> 938</span><span class="kd">enum</span><span class="w"> </span><span class="n">SqlSupportsConvert</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 939</span><span class="w"> </span><span class="na">SQL_CONVERT_BIGINT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 940</span><span class="w"> </span><span class="na">SQL_CONVERT_BINARY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 941</span><span class="w"> </span><span class="na">SQL_CONVERT_BIT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 942</span><span class="w"> </span><span class="na">SQL_CONVERT_CHAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos"> 943</span><span class="w"> </span><span class="na">SQL_CONVERT_DATE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">;</span> |
| <span class="linenos"> 944</span><span class="w"> </span><span class="na">SQL_CONVERT_DECIMAL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">5</span><span class="p">;</span> |
| <span class="linenos"> 945</span><span class="w"> </span><span class="na">SQL_CONVERT_FLOAT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">6</span><span class="p">;</span> |
| <span class="linenos"> 946</span><span class="w"> </span><span class="na">SQL_CONVERT_INTEGER</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">7</span><span class="p">;</span> |
| <span class="linenos"> 947</span><span class="w"> </span><span class="na">SQL_CONVERT_INTERVAL_DAY_TIME</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">8</span><span class="p">;</span> |
| <span class="linenos"> 948</span><span class="w"> </span><span class="na">SQL_CONVERT_INTERVAL_YEAR_MONTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">9</span><span class="p">;</span> |
| <span class="linenos"> 949</span><span class="w"> </span><span class="na">SQL_CONVERT_LONGVARBINARY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">10</span><span class="p">;</span> |
| <span class="linenos"> 950</span><span class="w"> </span><span class="na">SQL_CONVERT_LONGVARCHAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">11</span><span class="p">;</span> |
| <span class="linenos"> 951</span><span class="w"> </span><span class="na">SQL_CONVERT_NUMERIC</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">12</span><span class="p">;</span> |
| <span class="linenos"> 952</span><span class="w"> </span><span class="na">SQL_CONVERT_REAL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">13</span><span class="p">;</span> |
| <span class="linenos"> 953</span><span class="w"> </span><span class="na">SQL_CONVERT_SMALLINT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">14</span><span class="p">;</span> |
| <span class="linenos"> 954</span><span class="w"> </span><span class="na">SQL_CONVERT_TIME</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">15</span><span class="p">;</span> |
| <span class="linenos"> 955</span><span class="w"> </span><span class="na">SQL_CONVERT_TIMESTAMP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">16</span><span class="p">;</span> |
| <span class="linenos"> 956</span><span class="w"> </span><span class="na">SQL_CONVERT_TINYINT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">17</span><span class="p">;</span> |
| <span class="linenos"> 957</span><span class="w"> </span><span class="na">SQL_CONVERT_VARBINARY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">18</span><span class="p">;</span> |
| <span class="linenos"> 958</span><span class="w"> </span><span class="na">SQL_CONVERT_VARCHAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">19</span><span class="p">;</span> |
| <span class="linenos"> 959</span><span class="p">}</span> |
| <span class="linenos"> 960</span> |
| <span class="linenos"> 961</span><span class="cm">/**</span> |
| <span class="linenos"> 962</span><span class="cm"> * The JDBC/ODBC-defined type of any object.</span> |
| <span class="linenos"> 963</span><span class="cm"> * All the values here are the same as in the JDBC and ODBC specs.</span> |
| <span class="linenos"> 964</span><span class="cm"> */</span> |
| <span class="linenos"> 965</span><span class="kd">enum</span><span class="w"> </span><span class="n">XdbcDataType</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 966</span><span class="w"> </span><span class="na">XDBC_UNKNOWN_TYPE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 967</span><span class="w"> </span><span class="na">XDBC_CHAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 968</span><span class="w"> </span><span class="na">XDBC_NUMERIC</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 969</span><span class="w"> </span><span class="na">XDBC_DECIMAL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos"> 970</span><span class="w"> </span><span class="na">XDBC_INTEGER</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">;</span> |
| <span class="linenos"> 971</span><span class="w"> </span><span class="na">XDBC_SMALLINT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">5</span><span class="p">;</span> |
| <span class="linenos"> 972</span><span class="w"> </span><span class="na">XDBC_FLOAT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">6</span><span class="p">;</span> |
| <span class="linenos"> 973</span><span class="w"> </span><span class="na">XDBC_REAL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">7</span><span class="p">;</span> |
| <span class="linenos"> 974</span><span class="w"> </span><span class="na">XDBC_DOUBLE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">8</span><span class="p">;</span> |
| <span class="linenos"> 975</span><span class="w"> </span><span class="na">XDBC_DATETIME</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">9</span><span class="p">;</span> |
| <span class="linenos"> 976</span><span class="w"> </span><span class="na">XDBC_INTERVAL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">10</span><span class="p">;</span> |
| <span class="linenos"> 977</span><span class="w"> </span><span class="na">XDBC_VARCHAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">12</span><span class="p">;</span> |
| <span class="linenos"> 978</span><span class="w"> </span><span class="na">XDBC_DATE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">91</span><span class="p">;</span> |
| <span class="linenos"> 979</span><span class="w"> </span><span class="na">XDBC_TIME</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">92</span><span class="p">;</span> |
| <span class="linenos"> 980</span><span class="w"> </span><span class="na">XDBC_TIMESTAMP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">93</span><span class="p">;</span> |
| <span class="linenos"> 981</span><span class="w"> </span><span class="na">XDBC_LONGVARCHAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">-</span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 982</span><span class="w"> </span><span class="na">XDBC_BINARY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">-</span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos"> 983</span><span class="w"> </span><span class="na">XDBC_VARBINARY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">-</span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos"> 984</span><span class="w"> </span><span class="na">XDBC_LONGVARBINARY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">-</span><span class="mi">4</span><span class="p">;</span> |
| <span class="linenos"> 985</span><span class="w"> </span><span class="na">XDBC_BIGINT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">-</span><span class="mi">5</span><span class="p">;</span> |
| <span class="linenos"> 986</span><span class="w"> </span><span class="na">XDBC_TINYINT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">-</span><span class="mi">6</span><span class="p">;</span> |
| <span class="linenos"> 987</span><span class="w"> </span><span class="na">XDBC_BIT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">-</span><span class="mi">7</span><span class="p">;</span> |
| <span class="linenos"> 988</span><span class="w"> </span><span class="na">XDBC_WCHAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">-</span><span class="mi">8</span><span class="p">;</span> |
| <span class="linenos"> 989</span><span class="w"> </span><span class="na">XDBC_WVARCHAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">-</span><span class="mi">9</span><span class="p">;</span> |
| <span class="linenos"> 990</span><span class="p">}</span> |
| <span class="linenos"> 991</span> |
| <span class="linenos"> 992</span><span class="cm">/**</span> |
| <span class="linenos"> 993</span><span class="cm"> * Detailed subtype information for XDBC_TYPE_DATETIME and XDBC_TYPE_INTERVAL.</span> |
| <span class="linenos"> 994</span><span class="cm"> */</span> |
| <span class="linenos"> 995</span><span class="kd">enum</span><span class="w"> </span><span class="n">XdbcDatetimeSubcode</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos"> 996</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="na">allow_alias</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos"> 997</span><span class="w"> </span><span class="na">XDBC_SUBCODE_UNKNOWN</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos"> 998</span><span class="w"> </span><span class="na">XDBC_SUBCODE_YEAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos"> 999</span><span class="w"> </span><span class="na">XDBC_SUBCODE_DATE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1000</span><span class="w"> </span><span class="na">XDBC_SUBCODE_TIME</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1001</span><span class="w"> </span><span class="na">XDBC_SUBCODE_MONTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1002</span><span class="w"> </span><span class="na">XDBC_SUBCODE_TIMESTAMP</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos">1003</span><span class="w"> </span><span class="na">XDBC_SUBCODE_DAY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos">1004</span><span class="w"> </span><span class="na">XDBC_SUBCODE_TIME_WITH_TIMEZONE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">;</span> |
| <span class="linenos">1005</span><span class="w"> </span><span class="na">XDBC_SUBCODE_HOUR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">;</span> |
| <span class="linenos">1006</span><span class="w"> </span><span class="na">XDBC_SUBCODE_TIMESTAMP_WITH_TIMEZONE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">5</span><span class="p">;</span> |
| <span class="linenos">1007</span><span class="w"> </span><span class="na">XDBC_SUBCODE_MINUTE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">5</span><span class="p">;</span> |
| <span class="linenos">1008</span><span class="w"> </span><span class="na">XDBC_SUBCODE_SECOND</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">6</span><span class="p">;</span> |
| <span class="linenos">1009</span><span class="w"> </span><span class="na">XDBC_SUBCODE_YEAR_TO_MONTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">7</span><span class="p">;</span> |
| <span class="linenos">1010</span><span class="w"> </span><span class="na">XDBC_SUBCODE_DAY_TO_HOUR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">8</span><span class="p">;</span> |
| <span class="linenos">1011</span><span class="w"> </span><span class="na">XDBC_SUBCODE_DAY_TO_MINUTE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">9</span><span class="p">;</span> |
| <span class="linenos">1012</span><span class="w"> </span><span class="na">XDBC_SUBCODE_DAY_TO_SECOND</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">10</span><span class="p">;</span> |
| <span class="linenos">1013</span><span class="w"> </span><span class="na">XDBC_SUBCODE_HOUR_TO_MINUTE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">11</span><span class="p">;</span> |
| <span class="linenos">1014</span><span class="w"> </span><span class="na">XDBC_SUBCODE_HOUR_TO_SECOND</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">12</span><span class="p">;</span> |
| <span class="linenos">1015</span><span class="w"> </span><span class="na">XDBC_SUBCODE_MINUTE_TO_SECOND</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">13</span><span class="p">;</span> |
| <span class="linenos">1016</span><span class="w"> </span><span class="na">XDBC_SUBCODE_INTERVAL_YEAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">101</span><span class="p">;</span> |
| <span class="linenos">1017</span><span class="w"> </span><span class="na">XDBC_SUBCODE_INTERVAL_MONTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">102</span><span class="p">;</span> |
| <span class="linenos">1018</span><span class="w"> </span><span class="na">XDBC_SUBCODE_INTERVAL_DAY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">103</span><span class="p">;</span> |
| <span class="linenos">1019</span><span class="w"> </span><span class="na">XDBC_SUBCODE_INTERVAL_HOUR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">104</span><span class="p">;</span> |
| <span class="linenos">1020</span><span class="w"> </span><span class="na">XDBC_SUBCODE_INTERVAL_MINUTE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">105</span><span class="p">;</span> |
| <span class="linenos">1021</span><span class="w"> </span><span class="na">XDBC_SUBCODE_INTERVAL_SECOND</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">106</span><span class="p">;</span> |
| <span class="linenos">1022</span><span class="w"> </span><span class="na">XDBC_SUBCODE_INTERVAL_YEAR_TO_MONTH</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">107</span><span class="p">;</span> |
| <span class="linenos">1023</span><span class="w"> </span><span class="na">XDBC_SUBCODE_INTERVAL_DAY_TO_HOUR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">108</span><span class="p">;</span> |
| <span class="linenos">1024</span><span class="w"> </span><span class="na">XDBC_SUBCODE_INTERVAL_DAY_TO_MINUTE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">109</span><span class="p">;</span> |
| <span class="linenos">1025</span><span class="w"> </span><span class="na">XDBC_SUBCODE_INTERVAL_DAY_TO_SECOND</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">110</span><span class="p">;</span> |
| <span class="linenos">1026</span><span class="w"> </span><span class="na">XDBC_SUBCODE_INTERVAL_HOUR_TO_MINUTE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">111</span><span class="p">;</span> |
| <span class="linenos">1027</span><span class="w"> </span><span class="na">XDBC_SUBCODE_INTERVAL_HOUR_TO_SECOND</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">112</span><span class="p">;</span> |
| <span class="linenos">1028</span><span class="w"> </span><span class="na">XDBC_SUBCODE_INTERVAL_MINUTE_TO_SECOND</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">113</span><span class="p">;</span> |
| <span class="linenos">1029</span><span class="p">}</span> |
| <span class="linenos">1030</span> |
| <span class="linenos">1031</span><span class="kd">enum</span><span class="w"> </span><span class="n">Nullable</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1032</span><span class="w"> </span><span class="cm">/**</span> |
| <span class="linenos">1033</span><span class="cm"> * Indicates that the fields does not allow the use of null values.</span> |
| <span class="linenos">1034</span><span class="cm"> */</span> |
| <span class="linenos">1035</span><span class="w"> </span><span class="na">NULLABILITY_NO_NULLS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos">1036</span> |
| <span class="linenos">1037</span><span class="w"> </span><span class="cm">/**</span> |
| <span class="linenos">1038</span><span class="cm"> * Indicates that the fields allow the use of null values.</span> |
| <span class="linenos">1039</span><span class="cm"> */</span> |
| <span class="linenos">1040</span><span class="w"> </span><span class="na">NULLABILITY_NULLABLE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1041</span> |
| <span class="linenos">1042</span><span class="w"> </span><span class="cm">/**</span> |
| <span class="linenos">1043</span><span class="cm"> * Indicates that nullability of the fields cannot be determined.</span> |
| <span class="linenos">1044</span><span class="cm"> */</span> |
| <span class="linenos">1045</span><span class="w"> </span><span class="na">NULLABILITY_UNKNOWN</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1046</span><span class="p">}</span> |
| <span class="linenos">1047</span> |
| <span class="linenos">1048</span><span class="kd">enum</span><span class="w"> </span><span class="n">Searchable</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1049</span><span class="w"> </span><span class="cm">/**</span> |
| <span class="linenos">1050</span><span class="cm"> * Indicates that column cannot be used in a WHERE clause.</span> |
| <span class="linenos">1051</span><span class="cm"> */</span> |
| <span class="linenos">1052</span><span class="w"> </span><span class="na">SEARCHABLE_NONE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos">1053</span> |
| <span class="linenos">1054</span><span class="w"> </span><span class="cm">/**</span> |
| <span class="linenos">1055</span><span class="cm"> * Indicates that the column can be used in a WHERE clause if it is using a</span> |
| <span class="linenos">1056</span><span class="cm"> * LIKE operator.</span> |
| <span class="linenos">1057</span><span class="cm"> */</span> |
| <span class="linenos">1058</span><span class="w"> </span><span class="na">SEARCHABLE_CHAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1059</span> |
| <span class="linenos">1060</span><span class="w"> </span><span class="cm">/**</span> |
| <span class="linenos">1061</span><span class="cm"> * Indicates that the column can be used In a WHERE clause with any</span> |
| <span class="linenos">1062</span><span class="cm"> * operator other than LIKE.</span> |
| <span class="linenos">1063</span><span class="cm"> *</span> |
| <span class="linenos">1064</span><span class="cm"> * - Allowed operators: comparison, quantified comparison, BETWEEN,</span> |
| <span class="linenos">1065</span><span class="cm"> * DISTINCT, IN, MATCH, and UNIQUE.</span> |
| <span class="linenos">1066</span><span class="cm"> */</span> |
| <span class="linenos">1067</span><span class="w"> </span><span class="na">SEARCHABLE_BASIC</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1068</span> |
| <span class="linenos">1069</span><span class="w"> </span><span class="cm">/**</span> |
| <span class="linenos">1070</span><span class="cm"> * Indicates that the column can be used in a WHERE clause using any operator.</span> |
| <span class="linenos">1071</span><span class="cm"> */</span> |
| <span class="linenos">1072</span><span class="w"> </span><span class="na">SEARCHABLE_FULL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos">1073</span><span class="p">}</span> |
| <span class="linenos">1074</span> |
| <span class="linenos">1075</span><span class="cm">/*</span> |
| <span class="linenos">1076</span><span class="cm"> * Represents a request to retrieve information about data type supported on a Flight SQL enabled backend.</span> |
| <span class="linenos">1077</span><span class="cm"> * Used in the command member of FlightDescriptor for the following RPC calls:</span> |
| <span class="linenos">1078</span><span class="cm"> * - GetSchema: return the schema of the query.</span> |
| <span class="linenos">1079</span><span class="cm"> * - GetFlightInfo: execute the catalog metadata request.</span> |
| <span class="linenos">1080</span><span class="cm"> *</span> |
| <span class="linenos">1081</span><span class="cm"> * The returned schema will be:</span> |
| <span class="linenos">1082</span><span class="cm"> * <</span> |
| <span class="linenos">1083</span><span class="cm"> * type_name: utf8 not null (The name of the data type, for example: VARCHAR, INTEGER, etc),</span> |
| <span class="linenos">1084</span><span class="cm"> * data_type: int32 not null (The SQL data type),</span> |
| <span class="linenos">1085</span><span class="cm"> * column_size: int32 (The maximum size supported by that column.</span> |
| <span class="linenos">1086</span><span class="cm"> * In case of exact numeric types, this represents the maximum precision.</span> |
| <span class="linenos">1087</span><span class="cm"> * In case of string types, this represents the character length.</span> |
| <span class="linenos">1088</span><span class="cm"> * In case of datetime data types, this represents the length in characters of the string representation.</span> |
| <span class="linenos">1089</span><span class="cm"> * NULL is returned for data types where column size is not applicable.),</span> |
| <span class="linenos">1090</span><span class="cm"> * literal_prefix: utf8 (Character or characters used to prefix a literal, NULL is returned for</span> |
| <span class="linenos">1091</span><span class="cm"> * data types where a literal prefix is not applicable.),</span> |
| <span class="linenos">1092</span><span class="cm"> * literal_suffix: utf8 (Character or characters used to terminate a literal,</span> |
| <span class="linenos">1093</span><span class="cm"> * NULL is returned for data types where a literal suffix is not applicable.),</span> |
| <span class="linenos">1094</span><span class="cm"> * create_params: list<utf8 not null></span> |
| <span class="linenos">1095</span><span class="cm"> * (A list of keywords corresponding to which parameters can be used when creating</span> |
| <span class="linenos">1096</span><span class="cm"> * a column for that specific type.</span> |
| <span class="linenos">1097</span><span class="cm"> * NULL is returned if there are no parameters for the data type definition.),</span> |
| <span class="linenos">1098</span><span class="cm"> * nullable: int32 not null (Shows if the data type accepts a NULL value. The possible values can be seen in the</span> |
| <span class="linenos">1099</span><span class="cm"> * Nullable enum.),</span> |
| <span class="linenos">1100</span><span class="cm"> * case_sensitive: bool not null (Shows if a character data type is case-sensitive in collations and comparisons),</span> |
| <span class="linenos">1101</span><span class="cm"> * searchable: int32 not null (Shows how the data type is used in a WHERE clause. The possible values can be seen in the</span> |
| <span class="linenos">1102</span><span class="cm"> * Searchable enum.),</span> |
| <span class="linenos">1103</span><span class="cm"> * unsigned_attribute: bool (Shows if the data type is unsigned. NULL is returned if the attribute is</span> |
| <span class="linenos">1104</span><span class="cm"> * not applicable to the data type or the data type is not numeric.),</span> |
| <span class="linenos">1105</span><span class="cm"> * fixed_prec_scale: bool not null (Shows if the data type has predefined fixed precision and scale.),</span> |
| <span class="linenos">1106</span><span class="cm"> * auto_increment: bool (Shows if the data type is auto incremental. NULL is returned if the attribute</span> |
| <span class="linenos">1107</span><span class="cm"> * is not applicable to the data type or the data type is not numeric.),</span> |
| <span class="linenos">1108</span><span class="cm"> * local_type_name: utf8 (Localized version of the data source-dependent name of the data type. NULL</span> |
| <span class="linenos">1109</span><span class="cm"> * is returned if a localized name is not supported by the data source),</span> |
| <span class="linenos">1110</span><span class="cm"> * minimum_scale: int32 (The minimum scale of the data type on the data source.</span> |
| <span class="linenos">1111</span><span class="cm"> * If a data type has a fixed scale, the MINIMUM_SCALE and MAXIMUM_SCALE</span> |
| <span class="linenos">1112</span><span class="cm"> * columns both contain this value. NULL is returned if scale is not applicable.),</span> |
| <span class="linenos">1113</span><span class="cm"> * maximum_scale: int32 (The maximum scale of the data type on the data source.</span> |
| <span class="linenos">1114</span><span class="cm"> * NULL is returned if scale is not applicable.),</span> |
| <span class="linenos">1115</span><span class="cm"> * sql_data_type: int32 not null (The value of the SQL DATA TYPE which has the same values</span> |
| <span class="linenos">1116</span><span class="cm"> * as data_type value. Except for interval and datetime, which</span> |
| <span class="linenos">1117</span><span class="cm"> * uses generic values. More info about those types can be</span> |
| <span class="linenos">1118</span><span class="cm"> * obtained through datetime_subcode. The possible values can be seen</span> |
| <span class="linenos">1119</span><span class="cm"> * in the XdbcDataType enum.),</span> |
| <span class="linenos">1120</span><span class="cm"> * datetime_subcode: int32 (Only used when the SQL DATA TYPE is interval or datetime. It contains</span> |
| <span class="linenos">1121</span><span class="cm"> * its sub types. For type different from interval and datetime, this value</span> |
| <span class="linenos">1122</span><span class="cm"> * is NULL. The possible values can be seen in the XdbcDatetimeSubcode enum.),</span> |
| <span class="linenos">1123</span><span class="cm"> * num_prec_radix: int32 (If the data type is an approximate numeric type, this column contains</span> |
| <span class="linenos">1124</span><span class="cm"> * the value 2 to indicate that COLUMN_SIZE specifies a number of bits. For</span> |
| <span class="linenos">1125</span><span class="cm"> * exact numeric types, this column contains the value 10 to indicate that</span> |
| <span class="linenos">1126</span><span class="cm"> * column size specifies a number of decimal digits. Otherwise, this column is NULL.),</span> |
| <span class="linenos">1127</span><span class="cm"> * interval_precision: int32 (If the data type is an interval data type, then this column contains the value</span> |
| <span class="linenos">1128</span><span class="cm"> * of the interval leading precision. Otherwise, this column is NULL. This fields</span> |
| <span class="linenos">1129</span><span class="cm"> * is only relevant to be used by ODBC).</span> |
| <span class="linenos">1130</span><span class="cm"> * ></span> |
| <span class="linenos">1131</span><span class="cm"> * The returned data should be ordered by data_type and then by type_name.</span> |
| <span class="linenos">1132</span><span class="cm"> */</span> |
| <span class="linenos">1133</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandGetXdbcTypeInfo</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1134</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1135</span> |
| <span class="linenos">1136</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1137</span><span class="cm"> * Specifies the data type to search for the info.</span> |
| <span class="linenos">1138</span><span class="cm"> */</span> |
| <span class="linenos">1139</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">int32</span><span class="w"> </span><span class="na">data_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1140</span><span class="p">}</span> |
| <span class="linenos">1141</span> |
| <span class="linenos">1142</span><span class="cm">/*</span> |
| <span class="linenos">1143</span><span class="cm"> * Represents a request to retrieve the list of catalogs on a Flight SQL enabled backend.</span> |
| <span class="linenos">1144</span><span class="cm"> * The definition of a catalog depends on vendor/implementation. It is usually the database itself</span> |
| <span class="linenos">1145</span><span class="cm"> * Used in the command member of FlightDescriptor for the following RPC calls:</span> |
| <span class="linenos">1146</span><span class="cm"> * - GetSchema: return the Arrow schema of the query.</span> |
| <span class="linenos">1147</span><span class="cm"> * - GetFlightInfo: execute the catalog metadata request.</span> |
| <span class="linenos">1148</span><span class="cm"> *</span> |
| <span class="linenos">1149</span><span class="cm"> * The returned Arrow schema will be:</span> |
| <span class="linenos">1150</span><span class="cm"> * <</span> |
| <span class="linenos">1151</span><span class="cm"> * catalog_name: utf8 not null</span> |
| <span class="linenos">1152</span><span class="cm"> * ></span> |
| <span class="linenos">1153</span><span class="cm"> * The returned data should be ordered by catalog_name.</span> |
| <span class="linenos">1154</span><span class="cm"> */</span> |
| <span class="linenos">1155</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandGetCatalogs</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1156</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1157</span><span class="p">}</span> |
| <span class="linenos">1158</span> |
| <span class="linenos">1159</span><span class="cm">/*</span> |
| <span class="linenos">1160</span><span class="cm"> * Represents a request to retrieve the list of database schemas on a Flight SQL enabled backend.</span> |
| <span class="linenos">1161</span><span class="cm"> * The definition of a database schema depends on vendor/implementation. It is usually a collection of tables.</span> |
| <span class="linenos">1162</span><span class="cm"> * Used in the command member of FlightDescriptor for the following RPC calls:</span> |
| <span class="linenos">1163</span><span class="cm"> * - GetSchema: return the Arrow schema of the query.</span> |
| <span class="linenos">1164</span><span class="cm"> * - GetFlightInfo: execute the catalog metadata request.</span> |
| <span class="linenos">1165</span><span class="cm"> *</span> |
| <span class="linenos">1166</span><span class="cm"> * The returned Arrow schema will be:</span> |
| <span class="linenos">1167</span><span class="cm"> * <</span> |
| <span class="linenos">1168</span><span class="cm"> * catalog_name: utf8,</span> |
| <span class="linenos">1169</span><span class="cm"> * db_schema_name: utf8 not null</span> |
| <span class="linenos">1170</span><span class="cm"> * ></span> |
| <span class="linenos">1171</span><span class="cm"> * The returned data should be ordered by catalog_name, then db_schema_name.</span> |
| <span class="linenos">1172</span><span class="cm"> */</span> |
| <span class="linenos">1173</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandGetDbSchemas</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1174</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1175</span> |
| <span class="linenos">1176</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1177</span><span class="cm"> * Specifies the Catalog to search for the tables.</span> |
| <span class="linenos">1178</span><span class="cm"> * An empty string retrieves those without a catalog.</span> |
| <span class="linenos">1179</span><span class="cm"> * If omitted the catalog name should not be used to narrow the search.</span> |
| <span class="linenos">1180</span><span class="cm"> */</span> |
| <span class="linenos">1181</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">catalog</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1182</span> |
| <span class="linenos">1183</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1184</span><span class="cm"> * Specifies a filter pattern for schemas to search for.</span> |
| <span class="linenos">1185</span><span class="cm"> * When no db_schema_filter_pattern is provided, the pattern will not be used to narrow the search.</span> |
| <span class="linenos">1186</span><span class="cm"> * In the pattern string, two special characters can be used to denote matching rules:</span> |
| <span class="linenos">1187</span><span class="cm"> * - "%" means to match any substring with 0 or more characters.</span> |
| <span class="linenos">1188</span><span class="cm"> * - "_" means to match any one character.</span> |
| <span class="linenos">1189</span><span class="cm"> */</span> |
| <span class="linenos">1190</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">db_schema_filter_pattern</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1191</span><span class="p">}</span> |
| <span class="linenos">1192</span> |
| <span class="linenos">1193</span><span class="cm">/*</span> |
| <span class="linenos">1194</span><span class="cm"> * Represents a request to retrieve the list of tables, and optionally their schemas, on a Flight SQL enabled backend.</span> |
| <span class="linenos">1195</span><span class="cm"> * Used in the command member of FlightDescriptor for the following RPC calls:</span> |
| <span class="linenos">1196</span><span class="cm"> * - GetSchema: return the Arrow schema of the query.</span> |
| <span class="linenos">1197</span><span class="cm"> * - GetFlightInfo: execute the catalog metadata request.</span> |
| <span class="linenos">1198</span><span class="cm"> *</span> |
| <span class="linenos">1199</span><span class="cm"> * The returned Arrow schema will be:</span> |
| <span class="linenos">1200</span><span class="cm"> * <</span> |
| <span class="linenos">1201</span><span class="cm"> * catalog_name: utf8,</span> |
| <span class="linenos">1202</span><span class="cm"> * db_schema_name: utf8,</span> |
| <span class="linenos">1203</span><span class="cm"> * table_name: utf8 not null,</span> |
| <span class="linenos">1204</span><span class="cm"> * table_type: utf8 not null,</span> |
| <span class="linenos">1205</span><span class="cm"> * [optional] table_schema: bytes not null (schema of the table as described in Schema.fbs::Schema,</span> |
| <span class="linenos">1206</span><span class="cm"> * it is serialized as an IPC message.)</span> |
| <span class="linenos">1207</span><span class="cm"> * ></span> |
| <span class="linenos">1208</span><span class="cm"> * Fields on table_schema may contain the following metadata:</span> |
| <span class="linenos">1209</span><span class="cm"> * - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name</span> |
| <span class="linenos">1210</span><span class="cm"> * - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name</span> |
| <span class="linenos">1211</span><span class="cm"> * - ARROW:FLIGHT:SQL:TABLE_NAME - Table name</span> |
| <span class="linenos">1212</span><span class="cm"> * - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.</span> |
| <span class="linenos">1213</span><span class="cm"> * - ARROW:FLIGHT:SQL:PRECISION - Column precision/size</span> |
| <span class="linenos">1214</span><span class="cm"> * - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable</span> |
| <span class="linenos">1215</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.</span> |
| <span class="linenos">1216</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.</span> |
| <span class="linenos">1217</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.</span> |
| <span class="linenos">1218</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.</span> |
| <span class="linenos">1219</span><span class="cm"> * The returned data should be ordered by catalog_name, db_schema_name, table_name, then table_type, followed by table_schema if requested.</span> |
| <span class="linenos">1220</span><span class="cm"> */</span> |
| <span class="linenos">1221</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandGetTables</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1222</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1223</span> |
| <span class="linenos">1224</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1225</span><span class="cm"> * Specifies the Catalog to search for the tables.</span> |
| <span class="linenos">1226</span><span class="cm"> * An empty string retrieves those without a catalog.</span> |
| <span class="linenos">1227</span><span class="cm"> * If omitted the catalog name should not be used to narrow the search.</span> |
| <span class="linenos">1228</span><span class="cm"> */</span> |
| <span class="linenos">1229</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">catalog</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1230</span> |
| <span class="linenos">1231</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1232</span><span class="cm"> * Specifies a filter pattern for schemas to search for.</span> |
| <span class="linenos">1233</span><span class="cm"> * When no db_schema_filter_pattern is provided, all schemas matching other filters are searched.</span> |
| <span class="linenos">1234</span><span class="cm"> * In the pattern string, two special characters can be used to denote matching rules:</span> |
| <span class="linenos">1235</span><span class="cm"> * - "%" means to match any substring with 0 or more characters.</span> |
| <span class="linenos">1236</span><span class="cm"> * - "_" means to match any one character.</span> |
| <span class="linenos">1237</span><span class="cm"> */</span> |
| <span class="linenos">1238</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">db_schema_filter_pattern</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1239</span> |
| <span class="linenos">1240</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1241</span><span class="cm"> * Specifies a filter pattern for tables to search for.</span> |
| <span class="linenos">1242</span><span class="cm"> * When no table_name_filter_pattern is provided, all tables matching other filters are searched.</span> |
| <span class="linenos">1243</span><span class="cm"> * In the pattern string, two special characters can be used to denote matching rules:</span> |
| <span class="linenos">1244</span><span class="cm"> * - "%" means to match any substring with 0 or more characters.</span> |
| <span class="linenos">1245</span><span class="cm"> * - "_" means to match any one character.</span> |
| <span class="linenos">1246</span><span class="cm"> */</span> |
| <span class="linenos">1247</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">table_name_filter_pattern</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos">1248</span> |
| <span class="linenos">1249</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1250</span><span class="cm"> * Specifies a filter of table types which must match.</span> |
| <span class="linenos">1251</span><span class="cm"> * The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables.</span> |
| <span class="linenos">1252</span><span class="cm"> * TABLE, VIEW, and SYSTEM TABLE are commonly supported.</span> |
| <span class="linenos">1253</span><span class="cm"> */</span> |
| <span class="linenos">1254</span><span class="w"> </span><span class="k">repeated</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">table_types</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">;</span> |
| <span class="linenos">1255</span> |
| <span class="linenos">1256</span><span class="w"> </span><span class="c1">// Specifies if the Arrow schema should be returned for found tables.</span> |
| <span class="linenos">1257</span><span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="na">include_schema</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">5</span><span class="p">;</span> |
| <span class="linenos">1258</span><span class="p">}</span> |
| <span class="linenos">1259</span> |
| <span class="linenos">1260</span><span class="cm">/*</span> |
| <span class="linenos">1261</span><span class="cm"> * Represents a request to retrieve the list of table types on a Flight SQL enabled backend.</span> |
| <span class="linenos">1262</span><span class="cm"> * The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables.</span> |
| <span class="linenos">1263</span><span class="cm"> * TABLE, VIEW, and SYSTEM TABLE are commonly supported.</span> |
| <span class="linenos">1264</span><span class="cm"> * Used in the command member of FlightDescriptor for the following RPC calls:</span> |
| <span class="linenos">1265</span><span class="cm"> * - GetSchema: return the Arrow schema of the query.</span> |
| <span class="linenos">1266</span><span class="cm"> * - GetFlightInfo: execute the catalog metadata request.</span> |
| <span class="linenos">1267</span><span class="cm"> *</span> |
| <span class="linenos">1268</span><span class="cm"> * The returned Arrow schema will be:</span> |
| <span class="linenos">1269</span><span class="cm"> * <</span> |
| <span class="linenos">1270</span><span class="cm"> * table_type: utf8 not null</span> |
| <span class="linenos">1271</span><span class="cm"> * ></span> |
| <span class="linenos">1272</span><span class="cm"> * The returned data should be ordered by table_type.</span> |
| <span class="linenos">1273</span><span class="cm"> */</span> |
| <span class="linenos">1274</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandGetTableTypes</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1275</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1276</span><span class="p">}</span> |
| <span class="linenos">1277</span> |
| <span class="linenos">1278</span><span class="cm">/*</span> |
| <span class="linenos">1279</span><span class="cm"> * Represents a request to retrieve the primary keys of a table on a Flight SQL enabled backend.</span> |
| <span class="linenos">1280</span><span class="cm"> * Used in the command member of FlightDescriptor for the following RPC calls:</span> |
| <span class="linenos">1281</span><span class="cm"> * - GetSchema: return the Arrow schema of the query.</span> |
| <span class="linenos">1282</span><span class="cm"> * - GetFlightInfo: execute the catalog metadata request.</span> |
| <span class="linenos">1283</span><span class="cm"> *</span> |
| <span class="linenos">1284</span><span class="cm"> * The returned Arrow schema will be:</span> |
| <span class="linenos">1285</span><span class="cm"> * <</span> |
| <span class="linenos">1286</span><span class="cm"> * catalog_name: utf8,</span> |
| <span class="linenos">1287</span><span class="cm"> * db_schema_name: utf8,</span> |
| <span class="linenos">1288</span><span class="cm"> * table_name: utf8 not null,</span> |
| <span class="linenos">1289</span><span class="cm"> * column_name: utf8 not null,</span> |
| <span class="linenos">1290</span><span class="cm"> * key_name: utf8,</span> |
| <span class="linenos">1291</span><span class="cm"> * key_sequence: int32 not null</span> |
| <span class="linenos">1292</span><span class="cm"> * ></span> |
| <span class="linenos">1293</span><span class="cm"> * The returned data should be ordered by catalog_name, db_schema_name, table_name, key_name, then key_sequence.</span> |
| <span class="linenos">1294</span><span class="cm"> */</span> |
| <span class="linenos">1295</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandGetPrimaryKeys</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1296</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1297</span> |
| <span class="linenos">1298</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1299</span><span class="cm"> * Specifies the catalog to search for the table.</span> |
| <span class="linenos">1300</span><span class="cm"> * An empty string retrieves those without a catalog.</span> |
| <span class="linenos">1301</span><span class="cm"> * If omitted the catalog name should not be used to narrow the search.</span> |
| <span class="linenos">1302</span><span class="cm"> */</span> |
| <span class="linenos">1303</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">catalog</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1304</span> |
| <span class="linenos">1305</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1306</span><span class="cm"> * Specifies the schema to search for the table.</span> |
| <span class="linenos">1307</span><span class="cm"> * An empty string retrieves those without a schema.</span> |
| <span class="linenos">1308</span><span class="cm"> * If omitted the schema name should not be used to narrow the search.</span> |
| <span class="linenos">1309</span><span class="cm"> */</span> |
| <span class="linenos">1310</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">db_schema</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1311</span> |
| <span class="linenos">1312</span><span class="w"> </span><span class="c1">// Specifies the table to get the primary keys for.</span> |
| <span class="linenos">1313</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">table</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos">1314</span><span class="p">}</span> |
| <span class="linenos">1315</span> |
| <span class="linenos">1316</span><span class="kd">enum</span><span class="w"> </span><span class="n">UpdateDeleteRules</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1317</span><span class="w"> </span><span class="na">CASCADE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos">1318</span><span class="w"> </span><span class="na">RESTRICT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1319</span><span class="w"> </span><span class="na">SET_NULL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1320</span><span class="w"> </span><span class="na">NO_ACTION</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos">1321</span><span class="w"> </span><span class="na">SET_DEFAULT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">;</span> |
| <span class="linenos">1322</span><span class="p">}</span> |
| <span class="linenos">1323</span> |
| <span class="linenos">1324</span><span class="cm">/*</span> |
| <span class="linenos">1325</span><span class="cm"> * Represents a request to retrieve a description of the foreign key columns that reference the given table's</span> |
| <span class="linenos">1326</span><span class="cm"> * primary key columns (the foreign keys exported by a table) of a table on a Flight SQL enabled backend.</span> |
| <span class="linenos">1327</span><span class="cm"> * Used in the command member of FlightDescriptor for the following RPC calls:</span> |
| <span class="linenos">1328</span><span class="cm"> * - GetSchema: return the Arrow schema of the query.</span> |
| <span class="linenos">1329</span><span class="cm"> * - GetFlightInfo: execute the catalog metadata request.</span> |
| <span class="linenos">1330</span><span class="cm"> *</span> |
| <span class="linenos">1331</span><span class="cm"> * The returned Arrow schema will be:</span> |
| <span class="linenos">1332</span><span class="cm"> * <</span> |
| <span class="linenos">1333</span><span class="cm"> * pk_catalog_name: utf8,</span> |
| <span class="linenos">1334</span><span class="cm"> * pk_db_schema_name: utf8,</span> |
| <span class="linenos">1335</span><span class="cm"> * pk_table_name: utf8 not null,</span> |
| <span class="linenos">1336</span><span class="cm"> * pk_column_name: utf8 not null,</span> |
| <span class="linenos">1337</span><span class="cm"> * fk_catalog_name: utf8,</span> |
| <span class="linenos">1338</span><span class="cm"> * fk_db_schema_name: utf8,</span> |
| <span class="linenos">1339</span><span class="cm"> * fk_table_name: utf8 not null,</span> |
| <span class="linenos">1340</span><span class="cm"> * fk_column_name: utf8 not null,</span> |
| <span class="linenos">1341</span><span class="cm"> * key_sequence: int32 not null,</span> |
| <span class="linenos">1342</span><span class="cm"> * fk_key_name: utf8,</span> |
| <span class="linenos">1343</span><span class="cm"> * pk_key_name: utf8,</span> |
| <span class="linenos">1344</span><span class="cm"> * update_rule: uint8 not null,</span> |
| <span class="linenos">1345</span><span class="cm"> * delete_rule: uint8 not null</span> |
| <span class="linenos">1346</span><span class="cm"> * ></span> |
| <span class="linenos">1347</span><span class="cm"> * The returned data should be ordered by fk_catalog_name, fk_db_schema_name, fk_table_name, fk_key_name, then key_sequence.</span> |
| <span class="linenos">1348</span><span class="cm"> * update_rule and delete_rule returns a byte that is equivalent to actions declared on UpdateDeleteRules enum.</span> |
| <span class="linenos">1349</span><span class="cm"> */</span> |
| <span class="linenos">1350</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandGetExportedKeys</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1351</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1352</span> |
| <span class="linenos">1353</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1354</span><span class="cm"> * Specifies the catalog to search for the foreign key table.</span> |
| <span class="linenos">1355</span><span class="cm"> * An empty string retrieves those without a catalog.</span> |
| <span class="linenos">1356</span><span class="cm"> * If omitted the catalog name should not be used to narrow the search.</span> |
| <span class="linenos">1357</span><span class="cm"> */</span> |
| <span class="linenos">1358</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">catalog</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1359</span> |
| <span class="linenos">1360</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1361</span><span class="cm"> * Specifies the schema to search for the foreign key table.</span> |
| <span class="linenos">1362</span><span class="cm"> * An empty string retrieves those without a schema.</span> |
| <span class="linenos">1363</span><span class="cm"> * If omitted the schema name should not be used to narrow the search.</span> |
| <span class="linenos">1364</span><span class="cm"> */</span> |
| <span class="linenos">1365</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">db_schema</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1366</span> |
| <span class="linenos">1367</span><span class="w"> </span><span class="c1">// Specifies the foreign key table to get the foreign keys for.</span> |
| <span class="linenos">1368</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">table</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos">1369</span><span class="p">}</span> |
| <span class="linenos">1370</span> |
| <span class="linenos">1371</span><span class="cm">/*</span> |
| <span class="linenos">1372</span><span class="cm"> * Represents a request to retrieve the foreign keys of a table on a Flight SQL enabled backend.</span> |
| <span class="linenos">1373</span><span class="cm"> * Used in the command member of FlightDescriptor for the following RPC calls:</span> |
| <span class="linenos">1374</span><span class="cm"> * - GetSchema: return the Arrow schema of the query.</span> |
| <span class="linenos">1375</span><span class="cm"> * - GetFlightInfo: execute the catalog metadata request.</span> |
| <span class="linenos">1376</span><span class="cm"> *</span> |
| <span class="linenos">1377</span><span class="cm"> * The returned Arrow schema will be:</span> |
| <span class="linenos">1378</span><span class="cm"> * <</span> |
| <span class="linenos">1379</span><span class="cm"> * pk_catalog_name: utf8,</span> |
| <span class="linenos">1380</span><span class="cm"> * pk_db_schema_name: utf8,</span> |
| <span class="linenos">1381</span><span class="cm"> * pk_table_name: utf8 not null,</span> |
| <span class="linenos">1382</span><span class="cm"> * pk_column_name: utf8 not null,</span> |
| <span class="linenos">1383</span><span class="cm"> * fk_catalog_name: utf8,</span> |
| <span class="linenos">1384</span><span class="cm"> * fk_db_schema_name: utf8,</span> |
| <span class="linenos">1385</span><span class="cm"> * fk_table_name: utf8 not null,</span> |
| <span class="linenos">1386</span><span class="cm"> * fk_column_name: utf8 not null,</span> |
| <span class="linenos">1387</span><span class="cm"> * key_sequence: int32 not null,</span> |
| <span class="linenos">1388</span><span class="cm"> * fk_key_name: utf8,</span> |
| <span class="linenos">1389</span><span class="cm"> * pk_key_name: utf8,</span> |
| <span class="linenos">1390</span><span class="cm"> * update_rule: uint8 not null,</span> |
| <span class="linenos">1391</span><span class="cm"> * delete_rule: uint8 not null</span> |
| <span class="linenos">1392</span><span class="cm"> * ></span> |
| <span class="linenos">1393</span><span class="cm"> * The returned data should be ordered by pk_catalog_name, pk_db_schema_name, pk_table_name, pk_key_name, then key_sequence.</span> |
| <span class="linenos">1394</span><span class="cm"> * update_rule and delete_rule returns a byte that is equivalent to actions:</span> |
| <span class="linenos">1395</span><span class="cm"> * - 0 = CASCADE</span> |
| <span class="linenos">1396</span><span class="cm"> * - 1 = RESTRICT</span> |
| <span class="linenos">1397</span><span class="cm"> * - 2 = SET NULL</span> |
| <span class="linenos">1398</span><span class="cm"> * - 3 = NO ACTION</span> |
| <span class="linenos">1399</span><span class="cm"> * - 4 = SET DEFAULT</span> |
| <span class="linenos">1400</span><span class="cm"> */</span> |
| <span class="linenos">1401</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandGetImportedKeys</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1402</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1403</span> |
| <span class="linenos">1404</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1405</span><span class="cm"> * Specifies the catalog to search for the primary key table.</span> |
| <span class="linenos">1406</span><span class="cm"> * An empty string retrieves those without a catalog.</span> |
| <span class="linenos">1407</span><span class="cm"> * If omitted the catalog name should not be used to narrow the search.</span> |
| <span class="linenos">1408</span><span class="cm"> */</span> |
| <span class="linenos">1409</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">catalog</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1410</span> |
| <span class="linenos">1411</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1412</span><span class="cm"> * Specifies the schema to search for the primary key table.</span> |
| <span class="linenos">1413</span><span class="cm"> * An empty string retrieves those without a schema.</span> |
| <span class="linenos">1414</span><span class="cm"> * If omitted the schema name should not be used to narrow the search.</span> |
| <span class="linenos">1415</span><span class="cm"> */</span> |
| <span class="linenos">1416</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">db_schema</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1417</span> |
| <span class="linenos">1418</span><span class="w"> </span><span class="c1">// Specifies the primary key table to get the foreign keys for.</span> |
| <span class="linenos">1419</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">table</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos">1420</span><span class="p">}</span> |
| <span class="linenos">1421</span> |
| <span class="linenos">1422</span><span class="cm">/*</span> |
| <span class="linenos">1423</span><span class="cm"> * Represents a request to retrieve a description of the foreign key columns in the given foreign key table that</span> |
| <span class="linenos">1424</span><span class="cm"> * reference the primary key or the columns representing a unique constraint of the parent table (could be the same</span> |
| <span class="linenos">1425</span><span class="cm"> * or a different table) on a Flight SQL enabled backend.</span> |
| <span class="linenos">1426</span><span class="cm"> * Used in the command member of FlightDescriptor for the following RPC calls:</span> |
| <span class="linenos">1427</span><span class="cm"> * - GetSchema: return the Arrow schema of the query.</span> |
| <span class="linenos">1428</span><span class="cm"> * - GetFlightInfo: execute the catalog metadata request.</span> |
| <span class="linenos">1429</span><span class="cm"> *</span> |
| <span class="linenos">1430</span><span class="cm"> * The returned Arrow schema will be:</span> |
| <span class="linenos">1431</span><span class="cm"> * <</span> |
| <span class="linenos">1432</span><span class="cm"> * pk_catalog_name: utf8,</span> |
| <span class="linenos">1433</span><span class="cm"> * pk_db_schema_name: utf8,</span> |
| <span class="linenos">1434</span><span class="cm"> * pk_table_name: utf8 not null,</span> |
| <span class="linenos">1435</span><span class="cm"> * pk_column_name: utf8 not null,</span> |
| <span class="linenos">1436</span><span class="cm"> * fk_catalog_name: utf8,</span> |
| <span class="linenos">1437</span><span class="cm"> * fk_db_schema_name: utf8,</span> |
| <span class="linenos">1438</span><span class="cm"> * fk_table_name: utf8 not null,</span> |
| <span class="linenos">1439</span><span class="cm"> * fk_column_name: utf8 not null,</span> |
| <span class="linenos">1440</span><span class="cm"> * key_sequence: int32 not null,</span> |
| <span class="linenos">1441</span><span class="cm"> * fk_key_name: utf8,</span> |
| <span class="linenos">1442</span><span class="cm"> * pk_key_name: utf8,</span> |
| <span class="linenos">1443</span><span class="cm"> * update_rule: uint8 not null,</span> |
| <span class="linenos">1444</span><span class="cm"> * delete_rule: uint8 not null</span> |
| <span class="linenos">1445</span><span class="cm"> * ></span> |
| <span class="linenos">1446</span><span class="cm"> * The returned data should be ordered by pk_catalog_name, pk_db_schema_name, pk_table_name, pk_key_name, then key_sequence.</span> |
| <span class="linenos">1447</span><span class="cm"> * update_rule and delete_rule returns a byte that is equivalent to actions:</span> |
| <span class="linenos">1448</span><span class="cm"> * - 0 = CASCADE</span> |
| <span class="linenos">1449</span><span class="cm"> * - 1 = RESTRICT</span> |
| <span class="linenos">1450</span><span class="cm"> * - 2 = SET NULL</span> |
| <span class="linenos">1451</span><span class="cm"> * - 3 = NO ACTION</span> |
| <span class="linenos">1452</span><span class="cm"> * - 4 = SET DEFAULT</span> |
| <span class="linenos">1453</span><span class="cm"> */</span> |
| <span class="linenos">1454</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandGetCrossReference</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1455</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1456</span> |
| <span class="linenos">1457</span><span class="w"> </span><span class="cm">/**</span> |
| <span class="linenos">1458</span><span class="cm"> * The catalog name where the parent table is.</span> |
| <span class="linenos">1459</span><span class="cm"> * An empty string retrieves those without a catalog.</span> |
| <span class="linenos">1460</span><span class="cm"> * If omitted the catalog name should not be used to narrow the search.</span> |
| <span class="linenos">1461</span><span class="cm"> */</span> |
| <span class="linenos">1462</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">pk_catalog</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1463</span> |
| <span class="linenos">1464</span><span class="w"> </span><span class="cm">/**</span> |
| <span class="linenos">1465</span><span class="cm"> * The Schema name where the parent table is.</span> |
| <span class="linenos">1466</span><span class="cm"> * An empty string retrieves those without a schema.</span> |
| <span class="linenos">1467</span><span class="cm"> * If omitted the schema name should not be used to narrow the search.</span> |
| <span class="linenos">1468</span><span class="cm"> */</span> |
| <span class="linenos">1469</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">pk_db_schema</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1470</span> |
| <span class="linenos">1471</span><span class="w"> </span><span class="cm">/**</span> |
| <span class="linenos">1472</span><span class="cm"> * The parent table name. It cannot be null.</span> |
| <span class="linenos">1473</span><span class="cm"> */</span> |
| <span class="linenos">1474</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">pk_table</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos">1475</span> |
| <span class="linenos">1476</span><span class="w"> </span><span class="cm">/**</span> |
| <span class="linenos">1477</span><span class="cm"> * The catalog name where the foreign table is.</span> |
| <span class="linenos">1478</span><span class="cm"> * An empty string retrieves those without a catalog.</span> |
| <span class="linenos">1479</span><span class="cm"> * If omitted the catalog name should not be used to narrow the search.</span> |
| <span class="linenos">1480</span><span class="cm"> */</span> |
| <span class="linenos">1481</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">fk_catalog</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">;</span> |
| <span class="linenos">1482</span> |
| <span class="linenos">1483</span><span class="w"> </span><span class="cm">/**</span> |
| <span class="linenos">1484</span><span class="cm"> * The schema name where the foreign table is.</span> |
| <span class="linenos">1485</span><span class="cm"> * An empty string retrieves those without a schema.</span> |
| <span class="linenos">1486</span><span class="cm"> * If omitted the schema name should not be used to narrow the search.</span> |
| <span class="linenos">1487</span><span class="cm"> */</span> |
| <span class="linenos">1488</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">fk_db_schema</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">5</span><span class="p">;</span> |
| <span class="linenos">1489</span> |
| <span class="linenos">1490</span><span class="w"> </span><span class="cm">/**</span> |
| <span class="linenos">1491</span><span class="cm"> * The foreign table name. It cannot be null.</span> |
| <span class="linenos">1492</span><span class="cm"> */</span> |
| <span class="linenos">1493</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">fk_table</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">6</span><span class="p">;</span> |
| <span class="linenos">1494</span><span class="p">}</span> |
| <span class="linenos">1495</span> |
| <span class="linenos">1496</span><span class="c1">// Query Execution Action Messages</span> |
| <span class="linenos">1497</span> |
| <span class="linenos">1498</span><span class="cm">/*</span> |
| <span class="linenos">1499</span><span class="cm"> * Request message for the "CreatePreparedStatement" action on a Flight SQL enabled backend.</span> |
| <span class="linenos">1500</span><span class="cm"> */</span> |
| <span class="linenos">1501</span><span class="kd">message</span><span class="w"> </span><span class="nc">ActionCreatePreparedStatementRequest</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1502</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1503</span> |
| <span class="linenos">1504</span><span class="w"> </span><span class="c1">// The valid SQL string to create a prepared statement for.</span> |
| <span class="linenos">1505</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">query</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1506</span><span class="w"> </span><span class="c1">// Create/execute the prepared statement as part of this transaction (if</span> |
| <span class="linenos">1507</span><span class="w"> </span><span class="c1">// unset, executions of the prepared statement will be auto-committed).</span> |
| <span class="linenos">1508</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">transaction_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1509</span><span class="p">}</span> |
| <span class="linenos">1510</span> |
| <span class="linenos">1511</span><span class="cm">/*</span> |
| <span class="linenos">1512</span><span class="cm"> * An embedded message describing a Substrait plan to execute.</span> |
| <span class="linenos">1513</span><span class="cm"> */</span> |
| <span class="linenos">1514</span><span class="kd">message</span><span class="w"> </span><span class="nc">SubstraitPlan</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1515</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1516</span> |
| <span class="linenos">1517</span><span class="w"> </span><span class="c1">// The serialized substrait.Plan to create a prepared statement for.</span> |
| <span class="linenos">1518</span><span class="w"> </span><span class="c1">// XXX(ARROW-16902): this is bytes instead of an embedded message</span> |
| <span class="linenos">1519</span><span class="w"> </span><span class="c1">// because Protobuf does not really support one DLL using Protobuf</span> |
| <span class="linenos">1520</span><span class="w"> </span><span class="c1">// definitions from another DLL.</span> |
| <span class="linenos">1521</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">plan</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1522</span><span class="w"> </span><span class="c1">// The Substrait release, e.g. "0.12.0". This information is not</span> |
| <span class="linenos">1523</span><span class="w"> </span><span class="c1">// tracked in the plan itself, so this is the only way for consumers</span> |
| <span class="linenos">1524</span><span class="w"> </span><span class="c1">// to potentially know if they can handle the plan.</span> |
| <span class="linenos">1525</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">version</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1526</span><span class="p">}</span> |
| <span class="linenos">1527</span> |
| <span class="linenos">1528</span><span class="cm">/*</span> |
| <span class="linenos">1529</span><span class="cm"> * Request message for the "CreatePreparedSubstraitPlan" action on a Flight SQL enabled backend.</span> |
| <span class="linenos">1530</span><span class="cm"> */</span> |
| <span class="linenos">1531</span><span class="kd">message</span><span class="w"> </span><span class="nc">ActionCreatePreparedSubstraitPlanRequest</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1532</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1533</span> |
| <span class="linenos">1534</span><span class="w"> </span><span class="c1">// The serialized substrait.Plan to create a prepared statement for.</span> |
| <span class="linenos">1535</span><span class="w"> </span><span class="n">SubstraitPlan</span><span class="w"> </span><span class="na">plan</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1536</span><span class="w"> </span><span class="c1">// Create/execute the prepared statement as part of this transaction (if</span> |
| <span class="linenos">1537</span><span class="w"> </span><span class="c1">// unset, executions of the prepared statement will be auto-committed).</span> |
| <span class="linenos">1538</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">transaction_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1539</span><span class="p">}</span> |
| <span class="linenos">1540</span> |
| <span class="linenos">1541</span><span class="cm">/*</span> |
| <span class="linenos">1542</span><span class="cm"> * Wrap the result of a "CreatePreparedStatement" or "CreatePreparedSubstraitPlan" action.</span> |
| <span class="linenos">1543</span><span class="cm"> *</span> |
| <span class="linenos">1544</span><span class="cm"> * The resultant PreparedStatement can be closed either:</span> |
| <span class="linenos">1545</span><span class="cm"> * - Manually, through the "ClosePreparedStatement" action;</span> |
| <span class="linenos">1546</span><span class="cm"> * - Automatically, by a server timeout.</span> |
| <span class="linenos">1547</span><span class="cm"> *</span> |
| <span class="linenos">1548</span><span class="cm"> * The result should be wrapped in a google.protobuf.Any message.</span> |
| <span class="linenos">1549</span><span class="cm"> */</span> |
| <span class="linenos">1550</span><span class="kd">message</span><span class="w"> </span><span class="nc">ActionCreatePreparedStatementResult</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1551</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1552</span> |
| <span class="linenos">1553</span><span class="w"> </span><span class="c1">// Opaque handle for the prepared statement on the server.</span> |
| <span class="linenos">1554</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">prepared_statement_handle</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1555</span> |
| <span class="linenos">1556</span><span class="w"> </span><span class="c1">// If a result set generating query was provided, dataset_schema contains the</span> |
| <span class="linenos">1557</span><span class="w"> </span><span class="c1">// schema of the result set. It should be an IPC-encapsulated Schema, as described in Schema.fbs.</span> |
| <span class="linenos">1558</span><span class="w"> </span><span class="c1">// For some queries, the schema of the results may depend on the schema of the parameters. The server</span> |
| <span class="linenos">1559</span><span class="w"> </span><span class="c1">// should provide its best guess as to the schema at this point. Clients must not assume that this</span> |
| <span class="linenos">1560</span><span class="w"> </span><span class="c1">// schema, if provided, will be accurate.</span> |
| <span class="linenos">1561</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">dataset_schema</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1562</span> |
| <span class="linenos">1563</span><span class="w"> </span><span class="c1">// If the query provided contained parameters, parameter_schema contains the</span> |
| <span class="linenos">1564</span><span class="w"> </span><span class="c1">// schema of the expected parameters. It should be an IPC-encapsulated Schema, as described in Schema.fbs.</span> |
| <span class="linenos">1565</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">parameter_schema</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos">1566</span><span class="p">}</span> |
| <span class="linenos">1567</span> |
| <span class="linenos">1568</span><span class="cm">/*</span> |
| <span class="linenos">1569</span><span class="cm"> * Request message for the "ClosePreparedStatement" action on a Flight SQL enabled backend.</span> |
| <span class="linenos">1570</span><span class="cm"> * Closes server resources associated with the prepared statement handle.</span> |
| <span class="linenos">1571</span><span class="cm"> */</span> |
| <span class="linenos">1572</span><span class="kd">message</span><span class="w"> </span><span class="nc">ActionClosePreparedStatementRequest</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1573</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1574</span> |
| <span class="linenos">1575</span><span class="w"> </span><span class="c1">// Opaque handle for the prepared statement on the server.</span> |
| <span class="linenos">1576</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">prepared_statement_handle</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1577</span><span class="p">}</span> |
| <span class="linenos">1578</span> |
| <span class="linenos">1579</span><span class="cm">/*</span> |
| <span class="linenos">1580</span><span class="cm"> * Request message for the "BeginTransaction" action.</span> |
| <span class="linenos">1581</span><span class="cm"> * Begins a transaction.</span> |
| <span class="linenos">1582</span><span class="cm"> */</span> |
| <span class="linenos">1583</span><span class="kd">message</span><span class="w"> </span><span class="nc">ActionBeginTransactionRequest</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1584</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1585</span><span class="p">}</span> |
| <span class="linenos">1586</span> |
| <span class="linenos">1587</span><span class="cm">/*</span> |
| <span class="linenos">1588</span><span class="cm"> * Request message for the "BeginSavepoint" action.</span> |
| <span class="linenos">1589</span><span class="cm"> * Creates a savepoint within a transaction.</span> |
| <span class="linenos">1590</span><span class="cm"> *</span> |
| <span class="linenos">1591</span><span class="cm"> * Only supported if FLIGHT_SQL_TRANSACTION is</span> |
| <span class="linenos">1592</span><span class="cm"> * FLIGHT_SQL_TRANSACTION_SUPPORT_SAVEPOINT.</span> |
| <span class="linenos">1593</span><span class="cm"> */</span> |
| <span class="linenos">1594</span><span class="kd">message</span><span class="w"> </span><span class="nc">ActionBeginSavepointRequest</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1595</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1596</span> |
| <span class="linenos">1597</span><span class="w"> </span><span class="c1">// The transaction to which a savepoint belongs.</span> |
| <span class="linenos">1598</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">transaction_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1599</span><span class="w"> </span><span class="c1">// Name for the savepoint.</span> |
| <span class="linenos">1600</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1601</span><span class="p">}</span> |
| <span class="linenos">1602</span> |
| <span class="linenos">1603</span><span class="cm">/*</span> |
| <span class="linenos">1604</span><span class="cm"> * The result of a "BeginTransaction" action.</span> |
| <span class="linenos">1605</span><span class="cm"> *</span> |
| <span class="linenos">1606</span><span class="cm"> * The transaction can be manipulated with the "EndTransaction" action, or</span> |
| <span class="linenos">1607</span><span class="cm"> * automatically via server timeout. If the transaction times out, then it is</span> |
| <span class="linenos">1608</span><span class="cm"> * automatically rolled back.</span> |
| <span class="linenos">1609</span><span class="cm"> *</span> |
| <span class="linenos">1610</span><span class="cm"> * The result should be wrapped in a google.protobuf.Any message.</span> |
| <span class="linenos">1611</span><span class="cm"> */</span> |
| <span class="linenos">1612</span><span class="kd">message</span><span class="w"> </span><span class="nc">ActionBeginTransactionResult</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1613</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1614</span> |
| <span class="linenos">1615</span><span class="w"> </span><span class="c1">// Opaque handle for the transaction on the server.</span> |
| <span class="linenos">1616</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">transaction_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1617</span><span class="p">}</span> |
| <span class="linenos">1618</span> |
| <span class="linenos">1619</span><span class="cm">/*</span> |
| <span class="linenos">1620</span><span class="cm"> * The result of a "BeginSavepoint" action.</span> |
| <span class="linenos">1621</span><span class="cm"> *</span> |
| <span class="linenos">1622</span><span class="cm"> * The transaction can be manipulated with the "EndSavepoint" action.</span> |
| <span class="linenos">1623</span><span class="cm"> * If the associated transaction is committed, rolled back, or times</span> |
| <span class="linenos">1624</span><span class="cm"> * out, then the savepoint is also invalidated.</span> |
| <span class="linenos">1625</span><span class="cm"> *</span> |
| <span class="linenos">1626</span><span class="cm"> * The result should be wrapped in a google.protobuf.Any message.</span> |
| <span class="linenos">1627</span><span class="cm"> */</span> |
| <span class="linenos">1628</span><span class="kd">message</span><span class="w"> </span><span class="nc">ActionBeginSavepointResult</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1629</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1630</span> |
| <span class="linenos">1631</span><span class="w"> </span><span class="c1">// Opaque handle for the savepoint on the server.</span> |
| <span class="linenos">1632</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">savepoint_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1633</span><span class="p">}</span> |
| <span class="linenos">1634</span> |
| <span class="linenos">1635</span><span class="cm">/*</span> |
| <span class="linenos">1636</span><span class="cm"> * Request message for the "EndTransaction" action.</span> |
| <span class="linenos">1637</span><span class="cm"> *</span> |
| <span class="linenos">1638</span><span class="cm"> * Commit (COMMIT) or rollback (ROLLBACK) the transaction.</span> |
| <span class="linenos">1639</span><span class="cm"> *</span> |
| <span class="linenos">1640</span><span class="cm"> * If the action completes successfully, the transaction handle is</span> |
| <span class="linenos">1641</span><span class="cm"> * invalidated, as are all associated savepoints.</span> |
| <span class="linenos">1642</span><span class="cm"> */</span> |
| <span class="linenos">1643</span><span class="kd">message</span><span class="w"> </span><span class="nc">ActionEndTransactionRequest</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1644</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1645</span> |
| <span class="linenos">1646</span><span class="w"> </span><span class="kd">enum</span><span class="w"> </span><span class="n">EndTransaction</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1647</span><span class="w"> </span><span class="na">END_TRANSACTION_UNSPECIFIED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos">1648</span><span class="w"> </span><span class="c1">// Commit the transaction.</span> |
| <span class="linenos">1649</span><span class="w"> </span><span class="na">END_TRANSACTION_COMMIT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1650</span><span class="w"> </span><span class="c1">// Roll back the transaction.</span> |
| <span class="linenos">1651</span><span class="w"> </span><span class="na">END_TRANSACTION_ROLLBACK</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1652</span><span class="w"> </span><span class="p">}</span> |
| <span class="linenos">1653</span><span class="w"> </span><span class="c1">// Opaque handle for the transaction on the server.</span> |
| <span class="linenos">1654</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">transaction_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1655</span><span class="w"> </span><span class="c1">// Whether to commit/rollback the given transaction.</span> |
| <span class="linenos">1656</span><span class="w"> </span><span class="n">EndTransaction</span><span class="w"> </span><span class="na">action</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1657</span><span class="p">}</span> |
| <span class="linenos">1658</span> |
| <span class="linenos">1659</span><span class="cm">/*</span> |
| <span class="linenos">1660</span><span class="cm"> * Request message for the "EndSavepoint" action.</span> |
| <span class="linenos">1661</span><span class="cm"> *</span> |
| <span class="linenos">1662</span><span class="cm"> * Release (RELEASE) the savepoint or rollback (ROLLBACK) to the</span> |
| <span class="linenos">1663</span><span class="cm"> * savepoint.</span> |
| <span class="linenos">1664</span><span class="cm"> *</span> |
| <span class="linenos">1665</span><span class="cm"> * Releasing a savepoint invalidates that savepoint. Rolling back to</span> |
| <span class="linenos">1666</span><span class="cm"> * a savepoint does not invalidate the savepoint, but invalidates all</span> |
| <span class="linenos">1667</span><span class="cm"> * savepoints created after the current savepoint.</span> |
| <span class="linenos">1668</span><span class="cm"> */</span> |
| <span class="linenos">1669</span><span class="kd">message</span><span class="w"> </span><span class="nc">ActionEndSavepointRequest</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1670</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1671</span> |
| <span class="linenos">1672</span><span class="w"> </span><span class="kd">enum</span><span class="w"> </span><span class="n">EndSavepoint</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1673</span><span class="w"> </span><span class="na">END_SAVEPOINT_UNSPECIFIED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos">1674</span><span class="w"> </span><span class="c1">// Release the savepoint.</span> |
| <span class="linenos">1675</span><span class="w"> </span><span class="na">END_SAVEPOINT_RELEASE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1676</span><span class="w"> </span><span class="c1">// Roll back to a savepoint.</span> |
| <span class="linenos">1677</span><span class="w"> </span><span class="na">END_SAVEPOINT_ROLLBACK</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1678</span><span class="w"> </span><span class="p">}</span> |
| <span class="linenos">1679</span><span class="w"> </span><span class="c1">// Opaque handle for the savepoint on the server.</span> |
| <span class="linenos">1680</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">savepoint_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1681</span><span class="w"> </span><span class="c1">// Whether to rollback/release the given savepoint.</span> |
| <span class="linenos">1682</span><span class="w"> </span><span class="n">EndSavepoint</span><span class="w"> </span><span class="na">action</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1683</span><span class="p">}</span> |
| <span class="linenos">1684</span> |
| <span class="linenos">1685</span><span class="c1">// Query Execution Messages.</span> |
| <span class="linenos">1686</span> |
| <span class="linenos">1687</span><span class="cm">/*</span> |
| <span class="linenos">1688</span><span class="cm"> * Represents a SQL query. Used in the command member of FlightDescriptor</span> |
| <span class="linenos">1689</span><span class="cm"> * for the following RPC calls:</span> |
| <span class="linenos">1690</span><span class="cm"> * - GetSchema: return the Arrow schema of the query.</span> |
| <span class="linenos">1691</span><span class="cm"> * Fields on this schema may contain the following metadata:</span> |
| <span class="linenos">1692</span><span class="cm"> * - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name</span> |
| <span class="linenos">1693</span><span class="cm"> * - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name</span> |
| <span class="linenos">1694</span><span class="cm"> * - ARROW:FLIGHT:SQL:TABLE_NAME - Table name</span> |
| <span class="linenos">1695</span><span class="cm"> * - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.</span> |
| <span class="linenos">1696</span><span class="cm"> * - ARROW:FLIGHT:SQL:PRECISION - Column precision/size</span> |
| <span class="linenos">1697</span><span class="cm"> * - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable</span> |
| <span class="linenos">1698</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.</span> |
| <span class="linenos">1699</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.</span> |
| <span class="linenos">1700</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.</span> |
| <span class="linenos">1701</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.</span> |
| <span class="linenos">1702</span><span class="cm"> * - GetFlightInfo: execute the query.</span> |
| <span class="linenos">1703</span><span class="cm"> */</span> |
| <span class="linenos">1704</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandStatementQuery</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1705</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1706</span> |
| <span class="linenos">1707</span><span class="w"> </span><span class="c1">// The SQL syntax.</span> |
| <span class="linenos">1708</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">query</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1709</span><span class="w"> </span><span class="c1">// Include the query as part of this transaction (if unset, the query is auto-committed).</span> |
| <span class="linenos">1710</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">transaction_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1711</span><span class="p">}</span> |
| <span class="linenos">1712</span> |
| <span class="linenos">1713</span><span class="cm">/*</span> |
| <span class="linenos">1714</span><span class="cm"> * Represents a Substrait plan. Used in the command member of FlightDescriptor</span> |
| <span class="linenos">1715</span><span class="cm"> * for the following RPC calls:</span> |
| <span class="linenos">1716</span><span class="cm"> * - GetSchema: return the Arrow schema of the query.</span> |
| <span class="linenos">1717</span><span class="cm"> * Fields on this schema may contain the following metadata:</span> |
| <span class="linenos">1718</span><span class="cm"> * - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name</span> |
| <span class="linenos">1719</span><span class="cm"> * - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name</span> |
| <span class="linenos">1720</span><span class="cm"> * - ARROW:FLIGHT:SQL:TABLE_NAME - Table name</span> |
| <span class="linenos">1721</span><span class="cm"> * - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.</span> |
| <span class="linenos">1722</span><span class="cm"> * - ARROW:FLIGHT:SQL:PRECISION - Column precision/size</span> |
| <span class="linenos">1723</span><span class="cm"> * - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable</span> |
| <span class="linenos">1724</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.</span> |
| <span class="linenos">1725</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.</span> |
| <span class="linenos">1726</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.</span> |
| <span class="linenos">1727</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.</span> |
| <span class="linenos">1728</span><span class="cm"> * - GetFlightInfo: execute the query.</span> |
| <span class="linenos">1729</span><span class="cm"> * - DoPut: execute the query.</span> |
| <span class="linenos">1730</span><span class="cm"> */</span> |
| <span class="linenos">1731</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandStatementSubstraitPlan</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1732</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1733</span> |
| <span class="linenos">1734</span><span class="w"> </span><span class="c1">// A serialized substrait.Plan</span> |
| <span class="linenos">1735</span><span class="w"> </span><span class="n">SubstraitPlan</span><span class="w"> </span><span class="na">plan</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1736</span><span class="w"> </span><span class="c1">// Include the query as part of this transaction (if unset, the query is auto-committed).</span> |
| <span class="linenos">1737</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">transaction_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1738</span><span class="p">}</span> |
| <span class="linenos">1739</span> |
| <span class="linenos">1740</span><span class="cm">/**</span> |
| <span class="linenos">1741</span><span class="cm"> * Represents a ticket resulting from GetFlightInfo with a CommandStatementQuery.</span> |
| <span class="linenos">1742</span><span class="cm"> * This should be used only once and treated as an opaque value, that is, clients should not attempt to parse this.</span> |
| <span class="linenos">1743</span><span class="cm"> */</span> |
| <span class="linenos">1744</span><span class="kd">message</span><span class="w"> </span><span class="nc">TicketStatementQuery</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1745</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1746</span> |
| <span class="linenos">1747</span><span class="w"> </span><span class="c1">// Unique identifier for the instance of the statement to execute.</span> |
| <span class="linenos">1748</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">statement_handle</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1749</span><span class="p">}</span> |
| <span class="linenos">1750</span> |
| <span class="linenos">1751</span><span class="cm">/*</span> |
| <span class="linenos">1752</span><span class="cm"> * Represents an instance of executing a prepared statement. Used in the command member of FlightDescriptor for</span> |
| <span class="linenos">1753</span><span class="cm"> * the following RPC calls:</span> |
| <span class="linenos">1754</span><span class="cm"> * - GetSchema: return the Arrow schema of the query.</span> |
| <span class="linenos">1755</span><span class="cm"> * Fields on this schema may contain the following metadata:</span> |
| <span class="linenos">1756</span><span class="cm"> * - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name</span> |
| <span class="linenos">1757</span><span class="cm"> * - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name</span> |
| <span class="linenos">1758</span><span class="cm"> * - ARROW:FLIGHT:SQL:TABLE_NAME - Table name</span> |
| <span class="linenos">1759</span><span class="cm"> * - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.</span> |
| <span class="linenos">1760</span><span class="cm"> * - ARROW:FLIGHT:SQL:PRECISION - Column precision/size</span> |
| <span class="linenos">1761</span><span class="cm"> * - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable</span> |
| <span class="linenos">1762</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.</span> |
| <span class="linenos">1763</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.</span> |
| <span class="linenos">1764</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.</span> |
| <span class="linenos">1765</span><span class="cm"> * - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.</span> |
| <span class="linenos">1766</span><span class="cm"> *</span> |
| <span class="linenos">1767</span><span class="cm"> * If the schema is retrieved after parameter values have been bound with DoPut, then the server should account</span> |
| <span class="linenos">1768</span><span class="cm"> * for the parameters when determining the schema.</span> |
| <span class="linenos">1769</span><span class="cm"> * - DoPut: bind parameter values. All of the bound parameter sets will be executed as a single atomic execution.</span> |
| <span class="linenos">1770</span><span class="cm"> * - GetFlightInfo: execute the prepared statement instance.</span> |
| <span class="linenos">1771</span><span class="cm"> */</span> |
| <span class="linenos">1772</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandPreparedStatementQuery</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1773</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1774</span> |
| <span class="linenos">1775</span><span class="w"> </span><span class="c1">// Opaque handle for the prepared statement on the server.</span> |
| <span class="linenos">1776</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">prepared_statement_handle</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1777</span><span class="p">}</span> |
| <span class="linenos">1778</span> |
| <span class="linenos">1779</span><span class="cm">/*</span> |
| <span class="linenos">1780</span><span class="cm"> * Represents a SQL update query. Used in the command member of FlightDescriptor</span> |
| <span class="linenos">1781</span><span class="cm"> * for the RPC call DoPut to cause the server to execute the included SQL update.</span> |
| <span class="linenos">1782</span><span class="cm"> */</span> |
| <span class="linenos">1783</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandStatementUpdate</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1784</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1785</span> |
| <span class="linenos">1786</span><span class="w"> </span><span class="c1">// The SQL syntax.</span> |
| <span class="linenos">1787</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">query</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1788</span><span class="w"> </span><span class="c1">// Include the query as part of this transaction (if unset, the query is auto-committed).</span> |
| <span class="linenos">1789</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">transaction_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1790</span><span class="p">}</span> |
| <span class="linenos">1791</span> |
| <span class="linenos">1792</span><span class="cm">/*</span> |
| <span class="linenos">1793</span><span class="cm"> * Represents a SQL update query. Used in the command member of FlightDescriptor</span> |
| <span class="linenos">1794</span><span class="cm"> * for the RPC call DoPut to cause the server to execute the included</span> |
| <span class="linenos">1795</span><span class="cm"> * prepared statement handle as an update.</span> |
| <span class="linenos">1796</span><span class="cm"> */</span> |
| <span class="linenos">1797</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandPreparedStatementUpdate</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1798</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1799</span> |
| <span class="linenos">1800</span><span class="w"> </span><span class="c1">// Opaque handle for the prepared statement on the server.</span> |
| <span class="linenos">1801</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">prepared_statement_handle</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1802</span><span class="p">}</span> |
| <span class="linenos">1803</span> |
| <span class="linenos">1804</span><span class="cm">/*</span> |
| <span class="linenos">1805</span><span class="cm"> * Represents a bulk ingestion request. Used in the command member of FlightDescriptor</span> |
| <span class="linenos">1806</span><span class="cm"> * for the the RPC call DoPut to cause the server load the contents of the stream's</span> |
| <span class="linenos">1807</span><span class="cm"> * FlightData into the target destination.</span> |
| <span class="linenos">1808</span><span class="cm"> */</span> |
| <span class="linenos">1809</span><span class="kd">message</span><span class="w"> </span><span class="nc">CommandStatementIngest</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1810</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1811</span> |
| <span class="linenos">1812</span><span class="w"> </span><span class="c1">// Options for table definition behavior</span> |
| <span class="linenos">1813</span><span class="w"> </span><span class="kd">message</span><span class="w"> </span><span class="nc">TableDefinitionOptions</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1814</span><span class="w"> </span><span class="c1">// The action to take if the target table does not exist</span> |
| <span class="linenos">1815</span><span class="w"> </span><span class="kd">enum</span><span class="w"> </span><span class="n">TableNotExistOption</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1816</span><span class="w"> </span><span class="c1">// Do not use. Servers should error if this is specified by a client.</span> |
| <span class="linenos">1817</span><span class="w"> </span><span class="na">TABLE_NOT_EXIST_OPTION_UNSPECIFIED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos">1818</span><span class="w"> </span><span class="c1">// Create the table if it does not exist</span> |
| <span class="linenos">1819</span><span class="w"> </span><span class="na">TABLE_NOT_EXIST_OPTION_CREATE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1820</span><span class="w"> </span><span class="c1">// Fail if the table does not exist</span> |
| <span class="linenos">1821</span><span class="w"> </span><span class="na">TABLE_NOT_EXIST_OPTION_FAIL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1822</span><span class="w"> </span><span class="p">}</span> |
| <span class="linenos">1823</span><span class="w"> </span><span class="c1">// The action to take if the target table already exists</span> |
| <span class="linenos">1824</span><span class="w"> </span><span class="kd">enum</span><span class="w"> </span><span class="n">TableExistsOption</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1825</span><span class="w"> </span><span class="c1">// Do not use. Servers should error if this is specified by a client.</span> |
| <span class="linenos">1826</span><span class="w"> </span><span class="na">TABLE_EXISTS_OPTION_UNSPECIFIED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos">1827</span><span class="w"> </span><span class="c1">// Fail if the table already exists</span> |
| <span class="linenos">1828</span><span class="w"> </span><span class="na">TABLE_EXISTS_OPTION_FAIL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1829</span><span class="w"> </span><span class="c1">// Append to the table if it already exists</span> |
| <span class="linenos">1830</span><span class="w"> </span><span class="na">TABLE_EXISTS_OPTION_APPEND</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1831</span><span class="w"> </span><span class="c1">// Drop and recreate the table if it already exists</span> |
| <span class="linenos">1832</span><span class="w"> </span><span class="na">TABLE_EXISTS_OPTION_REPLACE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos">1833</span><span class="w"> </span><span class="p">}</span> |
| <span class="linenos">1834</span> |
| <span class="linenos">1835</span><span class="w"> </span><span class="n">TableNotExistOption</span><span class="w"> </span><span class="na">if_not_exist</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1836</span><span class="w"> </span><span class="n">TableExistsOption</span><span class="w"> </span><span class="na">if_exists</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1837</span><span class="w"> </span><span class="p">}</span> |
| <span class="linenos">1838</span> |
| <span class="linenos">1839</span><span class="w"> </span><span class="c1">// The behavior for handling the table definition.</span> |
| <span class="linenos">1840</span><span class="w"> </span><span class="n">TableDefinitionOptions</span><span class="w"> </span><span class="na">table_definition_options</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1841</span><span class="w"> </span><span class="c1">// The table to load data into.</span> |
| <span class="linenos">1842</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">table</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1843</span><span class="w"> </span><span class="c1">// The db_schema of the destination table to load data into. If unset, a backend-specific default may be used.</span> |
| <span class="linenos">1844</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">schema</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos">1845</span><span class="w"> </span><span class="c1">// The catalog of the destination table to load data into. If unset, a backend-specific default may be used.</span> |
| <span class="linenos">1846</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="na">catalog</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">;</span> |
| <span class="linenos">1847</span><span class="w"> </span><span class="cm">/*</span> |
| <span class="linenos">1848</span><span class="cm"> * Store ingested data in a temporary table.</span> |
| <span class="linenos">1849</span><span class="cm"> * The effect of setting temporary is to place the table in a backend-defined namespace, and to drop the table at the end of the session.</span> |
| <span class="linenos">1850</span><span class="cm"> * The namespacing may make use of a backend-specific schema and/or catalog.</span> |
| <span class="linenos">1851</span><span class="cm"> * The server should return an error if an explicit choice of schema or catalog is incompatible with the server's namespacing decision.</span> |
| <span class="linenos">1852</span><span class="cm"> */</span> |
| <span class="linenos">1853</span><span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="na">temporary</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">5</span><span class="p">;</span> |
| <span class="linenos">1854</span><span class="w"> </span><span class="c1">// Perform the ingestion as part of this transaction. If specified, results should not be committed in the event of an error/cancellation.</span> |
| <span class="linenos">1855</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">transaction_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">6</span><span class="p">;</span> |
| <span class="linenos">1856</span> |
| <span class="linenos">1857</span><span class="w"> </span><span class="c1">// Future extensions to the parameters of CommandStatementIngest should be added here, at a lower index than the generic 'options' parameter.</span> |
| <span class="linenos">1858</span> |
| <span class="linenos">1859</span><span class="w"> </span><span class="c1">// Backend-specific options.</span> |
| <span class="linenos">1860</span><span class="w"> </span><span class="n">map</span><span class="p"><</span><span class="kt">string</span><span class="p">,</span><span class="w"> </span><span class="kt">string</span><span class="p">></span><span class="w"> </span><span class="na">options</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1000</span><span class="p">;</span> |
| <span class="linenos">1861</span><span class="p">}</span> |
| <span class="linenos">1862</span> |
| <span class="linenos">1863</span><span class="cm">/*</span> |
| <span class="linenos">1864</span><span class="cm"> * Returned from the RPC call DoPut when a CommandStatementUpdate,</span> |
| <span class="linenos">1865</span><span class="cm"> * CommandPreparedStatementUpdate, or CommandStatementIngest was</span> |
| <span class="linenos">1866</span><span class="cm"> * in the request, containing results from the update.</span> |
| <span class="linenos">1867</span><span class="cm"> */</span> |
| <span class="linenos">1868</span><span class="kd">message</span><span class="w"> </span><span class="nc">DoPutUpdateResult</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1869</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1870</span> |
| <span class="linenos">1871</span><span class="w"> </span><span class="c1">// The number of records updated. A return value of -1 represents</span> |
| <span class="linenos">1872</span><span class="w"> </span><span class="c1">// an unknown updated record count.</span> |
| <span class="linenos">1873</span><span class="w"> </span><span class="kt">int64</span><span class="w"> </span><span class="na">record_count</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1874</span><span class="p">}</span> |
| <span class="linenos">1875</span> |
| <span class="linenos">1876</span><span class="cm">/* An *optional* response returned when `DoPut` is called with `CommandPreparedStatementQuery`.</span> |
| <span class="linenos">1877</span><span class="cm"> *</span> |
| <span class="linenos">1878</span><span class="cm"> * *Note on legacy behavior*: previous versions of the protocol did not return any result for</span> |
| <span class="linenos">1879</span><span class="cm"> * this command, and that behavior should still be supported by clients. In that case, the client</span> |
| <span class="linenos">1880</span><span class="cm"> * can continue as though the fields in this message were not provided or set to sensible default values.</span> |
| <span class="linenos">1881</span><span class="cm"> */</span> |
| <span class="linenos">1882</span><span class="kd">message</span><span class="w"> </span><span class="nc">DoPutPreparedStatementResult</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1883</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1884</span> |
| <span class="linenos">1885</span><span class="w"> </span><span class="c1">// Represents a (potentially updated) opaque handle for the prepared statement on the server.</span> |
| <span class="linenos">1886</span><span class="w"> </span><span class="c1">// Because the handle could potentially be updated, any previous handles for this prepared</span> |
| <span class="linenos">1887</span><span class="w"> </span><span class="c1">// statement should be considered invalid, and all subsequent requests for this prepared</span> |
| <span class="linenos">1888</span><span class="w"> </span><span class="c1">// statement must use this new handle.</span> |
| <span class="linenos">1889</span><span class="w"> </span><span class="c1">// The updated handle allows implementing query parameters with stateless services.</span> |
| <span class="linenos">1890</span><span class="w"> </span><span class="c1">// </span> |
| <span class="linenos">1891</span><span class="w"> </span><span class="c1">// When an updated handle is not provided by the server, clients should contiue</span> |
| <span class="linenos">1892</span><span class="w"> </span><span class="c1">// using the previous handle provided by `ActionCreatePreparedStatementResonse`.</span> |
| <span class="linenos">1893</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">prepared_statement_handle</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1894</span><span class="p">}</span> |
| <span class="linenos">1895</span> |
| <span class="linenos">1896</span><span class="cm">/*</span> |
| <span class="linenos">1897</span><span class="cm"> * Request message for the "CancelQuery" action.</span> |
| <span class="linenos">1898</span><span class="cm"> *</span> |
| <span class="linenos">1899</span><span class="cm"> * Explicitly cancel a running query.</span> |
| <span class="linenos">1900</span><span class="cm"> *</span> |
| <span class="linenos">1901</span><span class="cm"> * This lets a single client explicitly cancel work, no matter how many clients</span> |
| <span class="linenos">1902</span><span class="cm"> * are involved/whether the query is distributed or not, given server support.</span> |
| <span class="linenos">1903</span><span class="cm"> * The transaction/statement is not rolled back; it is the application's job to</span> |
| <span class="linenos">1904</span><span class="cm"> * commit or rollback as appropriate. This only indicates the client no longer</span> |
| <span class="linenos">1905</span><span class="cm"> * wishes to read the remainder of the query results or continue submitting</span> |
| <span class="linenos">1906</span><span class="cm"> * data.</span> |
| <span class="linenos">1907</span><span class="cm"> *</span> |
| <span class="linenos">1908</span><span class="cm"> * This command is idempotent.</span> |
| <span class="linenos">1909</span><span class="cm"> *</span> |
| <span class="linenos">1910</span><span class="cm"> * This command is deprecated since 13.0.0. Use the "CancelFlightInfo"</span> |
| <span class="linenos">1911</span><span class="cm"> * action with DoAction instead.</span> |
| <span class="linenos">1912</span><span class="cm"> */</span> |
| <span class="linenos">1913</span><span class="kd">message</span><span class="w"> </span><span class="nc">ActionCancelQueryRequest</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1914</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="na">deprecated</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1915</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1916</span> |
| <span class="linenos">1917</span><span class="w"> </span><span class="c1">// The result of the GetFlightInfo RPC that initiated the query.</span> |
| <span class="linenos">1918</span><span class="w"> </span><span class="c1">// XXX(ARROW-16902): this must be a serialized FlightInfo, but is</span> |
| <span class="linenos">1919</span><span class="w"> </span><span class="c1">// rendered as bytes because Protobuf does not really support one</span> |
| <span class="linenos">1920</span><span class="w"> </span><span class="c1">// DLL using Protobuf definitions from another DLL.</span> |
| <span class="linenos">1921</span><span class="w"> </span><span class="kt">bytes</span><span class="w"> </span><span class="na">info</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1922</span><span class="p">}</span> |
| <span class="linenos">1923</span> |
| <span class="linenos">1924</span><span class="cm">/*</span> |
| <span class="linenos">1925</span><span class="cm"> * The result of cancelling a query.</span> |
| <span class="linenos">1926</span><span class="cm"> *</span> |
| <span class="linenos">1927</span><span class="cm"> * The result should be wrapped in a google.protobuf.Any message.</span> |
| <span class="linenos">1928</span><span class="cm"> *</span> |
| <span class="linenos">1929</span><span class="cm"> * This command is deprecated since 13.0.0. Use the "CancelFlightInfo"</span> |
| <span class="linenos">1930</span><span class="cm"> * action with DoAction instead.</span> |
| <span class="linenos">1931</span><span class="cm"> */</span> |
| <span class="linenos">1932</span><span class="kd">message</span><span class="w"> </span><span class="nc">ActionCancelQueryResult</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1933</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="na">deprecated</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1934</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="p">(</span><span class="n">experimental</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="p">;</span> |
| <span class="linenos">1935</span> |
| <span class="linenos">1936</span><span class="w"> </span><span class="kd">enum</span><span class="w"> </span><span class="n">CancelResult</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1937</span><span class="w"> </span><span class="c1">// The cancellation status is unknown. Servers should avoid using</span> |
| <span class="linenos">1938</span><span class="w"> </span><span class="c1">// this value (send a NOT_FOUND error if the requested query is</span> |
| <span class="linenos">1939</span><span class="w"> </span><span class="c1">// not known). Clients can retry the request.</span> |
| <span class="linenos">1940</span><span class="w"> </span><span class="na">CANCEL_RESULT_UNSPECIFIED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span> |
| <span class="linenos">1941</span><span class="w"> </span><span class="c1">// The cancellation request is complete. Subsequent requests with</span> |
| <span class="linenos">1942</span><span class="w"> </span><span class="c1">// the same payload may return CANCELLED or a NOT_FOUND error.</span> |
| <span class="linenos">1943</span><span class="w"> </span><span class="na">CANCEL_RESULT_CANCELLED</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1944</span><span class="w"> </span><span class="c1">// The cancellation request is in progress. The client may retry</span> |
| <span class="linenos">1945</span><span class="w"> </span><span class="c1">// the cancellation request.</span> |
| <span class="linenos">1946</span><span class="w"> </span><span class="na">CANCEL_RESULT_CANCELLING</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span> |
| <span class="linenos">1947</span><span class="w"> </span><span class="c1">// The query is not cancellable. The client should not retry the</span> |
| <span class="linenos">1948</span><span class="w"> </span><span class="c1">// cancellation request.</span> |
| <span class="linenos">1949</span><span class="w"> </span><span class="na">CANCEL_RESULT_NOT_CANCELLABLE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span> |
| <span class="linenos">1950</span><span class="w"> </span><span class="p">}</span> |
| <span class="linenos">1951</span> |
| <span class="linenos">1952</span><span class="w"> </span><span class="n">CancelResult</span><span class="w"> </span><span class="na">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span> |
| <span class="linenos">1953</span><span class="p">}</span> |
| <span class="linenos">1954</span> |
| <span class="linenos">1955</span><span class="kd">extend</span><span class="w"> </span><span class="nc">google</span><span class="o">.</span><span class="n">protobuf.MessageOptions</span><span class="w"> </span><span class="p">{</span> |
| <span class="linenos">1956</span><span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="na">experimental</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1000</span><span class="p">;</span> |
| <span class="linenos">1957</span><span class="p">}</span> |
| </pre></div> |
| </div> |
| </section> |
| </section> |
| |
| |
| </article> |
| |
| |
| |
| |
| |
| <footer class="prev-next-footer"> |
| |
| <div class="prev-next-area"> |
| <a class="left-prev" |
| href="Flight.html" |
| title="previous page"> |
| <i class="fa-solid fa-angle-left"></i> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">previous</p> |
| <p class="prev-next-title">Arrow Flight RPC</p> |
| </div> |
| </a> |
| <a class="right-next" |
| href="ADBC.html" |
| title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">ADBC: Arrow Database Connectivity</p> |
| </div> |
| <i class="fa-solid fa-angle-right"></i> |
| </a> |
| </div> |
| </footer> |
| |
| </div> |
| |
| |
| |
| <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner"> |
| |
| |
| <div class="sidebar-secondary-item"> |
| <div |
| id="pst-page-navigation-heading-2" |
| class="page-toc tocsection onthispage"> |
| <i class="fa-solid fa-list"></i> On this page |
| </div> |
| <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2"> |
| <ul class="visible nav section-nav flex-column"> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#rpc-methods">RPC Methods</a><ul class="visible nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#sql-metadata">SQL Metadata</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#query-execution">Query Execution</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#flight-server-session-management">Flight Server Session Management</a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#sequence-diagrams">Sequence Diagrams</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#external-resources">External Resources</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#protocol-buffer-definitions">Protocol Buffer Definitions</a></li> |
| </ul> |
| </nav></div> |
| |
| <div class="sidebar-secondary-item"> |
| |
| |
| <div class="tocsection editthispage"> |
| <a href="https://github.com/apache/arrow/edit/main/docs/source/format/FlightSql.rst"> |
| <i class="fa-solid fa-pencil"></i> |
| |
| |
| |
| Edit on GitHub |
| |
| |
| </a> |
| </div> |
| </div> |
| |
| </div></div> |
| |
| |
| </div> |
| <footer class="bd-footer-content"> |
| |
| </footer> |
| |
| </main> |
| </div> |
| </div> |
| |
| <!-- Scripts loaded after <body> so the DOM is not blocked --> |
| <script src="../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae"></script> |
| <script src="../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae"></script> |
| |
| <footer class="bd-footer"> |
| <div class="bd-footer__inner bd-page-width"> |
| |
| <div class="footer-items__start"> |
| |
| <div class="footer-item"> |
| |
| <p class="copyright"> |
| |
| © Copyright 2016-2024 Apache Software Foundation. |
| Apache Arrow, Arrow, Apache, the Apache feather logo, and the Apache Arrow project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries. |
| <br/> |
| |
| </p> |
| </div> |
| |
| <div class="footer-item"> |
| |
| <p class="sphinx-version"> |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0. |
| <br/> |
| </p> |
| </div> |
| |
| </div> |
| |
| |
| |
| <div class="footer-items__end"> |
| |
| <div class="footer-item"> |
| <p class="theme-version"> |
| Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.15.2. |
| </p></div> |
| |
| </div> |
| |
| </div> |
| |
| </footer> |
| </body> |
| </html> |
