| |
| |
| <!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 = 'cpp/api/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/cpp/api/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="Filesystems" href="filesystem.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"> |
| <a class="nav-link nav-internal" href="../../format/index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item current active"> |
| <a class="nav-link dropdown-item nav-internal" href="../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"> |
| <a class="nav-link nav-internal" href="../../format/index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links-2"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links-2" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item current active"> |
| <a class="nav-link dropdown-item nav-internal" href="../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 has-children"><a class="reference internal" href="../getting_started.html">Getting Started</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="../build_system.html">Using Arrow C++ in your own project</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../conventions.html">Conventions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/basic_arrow.html">Basic Arrow Data Structures</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/io_tutorial.html">Arrow File I/O</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/compute_tutorial.html">Arrow Compute</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/datasets_tutorial.html">Arrow Datasets</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="../user_guide.html">User Guide</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="../overview.html">High-Level Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../memory.html">Memory Management</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../arrays.html">Arrays</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../datatypes.html">Data Types</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tables.html">Tabular Data</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../compute.html">Compute Functions</a></li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../gandiva.html">The Gandiva Expression Compiler</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../gandiva/expr_projector_filter.html">Gandiva Expression, Projector, and Filter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../gandiva/external_func.html">Gandiva External Functions Development Guide</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../streaming_execution.html">Acero: A C++ streaming execution engine</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/overview.html">Acero Overview</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/user_guide.html">Acero User’s Guide</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/substrait.html">Using Acero with Substrait</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/developer_guide.html">Developer’s Guide</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../io.html">Input / output and filesystems</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../ipc.html">Reading and writing the Arrow IPC format</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../orc.html">Reading and Writing ORC files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../parquet.html">Reading and writing Parquet files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../csv.html">Reading and Writing CSV files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../json.html">Reading JSON files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../dataset.html">Tabular Datasets</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../flight.html">Arrow Flight RPC</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../gdb.html">Debugging code using Arrow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../threading.html">Thread Management</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../opentelemetry.html">OpenTelemetry</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../env_vars.html">Environment Variables</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="../examples/index.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/cmake_minimal_build.html">Minimal build using CMake</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/compute_and_write_example.html">Compute and Write CSV Example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/dataset_documentation_example.html">Arrow Datasets example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/dataset_skyhook_scan_example.html">Arrow Skyhook example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/row_columnar_conversion.html">Row to columnar conversion</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/tuple_range_conversion.html">std::tuple-like ranges to Arrow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/converting_recordbatch_to_tensor.html">Converting RecordBatch to Tensor</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1 current active has-children"><a class="reference internal" href="../api.html">API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="support.html">Programming Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="memory.html">Memory (management)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="thread.html">Thread (management)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="datatype.html">Data Types</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="array.html">Arrays</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="scalar.html">Scalars</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="builder.html">Array Builders</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="table.html">Two-dimensional Datasets</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="c_abi.html">C Interfaces</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="compute.html">Compute Functions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="acero.html">Streaming Execution (Acero)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="gandiva.html">Gandiva Expression Compiler</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="tensor.html">Tensors</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="utilities.html">Utilities</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="async.html">Asynchronous programming</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="io.html">Input / output</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="ipc.html">Arrow IPC</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="formats.html">File Formats</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cuda.html">CUDA support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="flight.html">Arrow Flight RPC</a></li> |
| <li class="toctree-l2 current active"><a class="current reference internal" href="#">Arrow Flight SQL</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="filesystem.html">Filesystems</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="dataset.html">Dataset</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/cookbook/cpp/">C++ cookbook</a></li> |
| </ul> |
| </div> |
| </nav></div> |
| </div> |
| |
| |
| <div class="sidebar-primary-items__end sidebar-primary__section"> |
| </div> |
| |
| <div id="rtd-footer-container"></div> |
| |
| |
| </div> |
| |
| <main id="main-content" class="bd-main"> |
| |
| |
| <div class="bd-content"> |
| <div class="bd-article-container"> |
| |
| <div class="bd-header-article"> |
| <div class="header-article-items header-article__inner"> |
| |
| <div class="header-article-items__start"> |
| |
| <div class="header-article-item"> |
| |
| |
| |
| <nav aria-label="Breadcrumb"> |
| <ul class="bd-breadcrumbs"> |
| |
| <li class="breadcrumb-item breadcrumb-home"> |
| <a href="../../index.html" class="nav-link" aria-label="Home"> |
| <i class="fa-solid fa-home"></i> |
| </a> |
| </li> |
| |
| <li class="breadcrumb-item"><a href="../index.html" class="nav-link">C++ Implementation</a></li> |
| |
| |
| <li class="breadcrumb-item"><a href="../api.html" class="nav-link">API Reference</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"> |
| <h1>Arrow Flight SQL<a class="headerlink" href="#arrow-flight-sql" title="Permalink to this heading">#</a></h1> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Flight SQL is currently experimental and APIs are subject to change.</p> |
| </div> |
| <section id="common-types"> |
| <h2>Common Types<a class="headerlink" href="#common-types" title="Permalink to this heading">#</a></h2> |
| <dl> |
| <dt class="sig sig-object cpp"> |
| <span class="target" id="group__flight-sql-common-types"></span><em><span class="pre">group</span></em> <span class="sig-name descname"><span class="pre">flight-sql-common-types</span></span></dt> |
| <dd><div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-typedefs">Typedefs</p> |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv413SqlInfoResult"> |
| <span id="_CPPv313SqlInfoResult"></span><span id="_CPPv213SqlInfoResult"></span><span class="target" id="group__flight-sql-common-types_1ga697f5c5cd2453ee1301a9c2b7f525393"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SqlInfoResult</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">variant</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">int32_t</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unordered_map</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int32_t</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int32_t</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv413SqlInfoResult" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Variant supporting all possible types on SQL info. </p> |
| </dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv416SqlInfoResultMap"> |
| <span id="_CPPv316SqlInfoResultMap"></span><span id="_CPPv216SqlInfoResultMap"></span><span class="target" id="group__flight-sql-common-types_1gae375985b2beaf7a445a80adc4315d463"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SqlInfoResultMap</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unordered_map</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int32_t</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv413SqlInfoResult" title="SqlInfoResult"><span class="n"><span class="pre">SqlInfoResult</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv416SqlInfoResultMap" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Map SQL info identifier to its value. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-enums">Enums</p> |
| <dl class="cpp enum-class"> |
| <dt class="sig sig-object cpp" id="_CPPv412CancelResult"> |
| <span id="_CPPv312CancelResult"></span><span id="_CPPv212CancelResult"></span><span class="target" id="group__flight-sql-common-types_1gacf78c950d2019578bebdf8620ee7899d"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CancelResult</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int8_t</span></span><a class="headerlink" href="#_CPPv412CancelResult" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The result of cancelling a query. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CancelResult12kUnspecifiedE"> |
| <span id="_CPPv3N12CancelResult12kUnspecifiedE"></span><span id="_CPPv2N12CancelResult12kUnspecifiedE"></span><span class="target" id="group__flight-sql-common-types_1ggacf78c950d2019578bebdf8620ee7899da8536661e94a42d4d95dcb9058b9936b5"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kUnspecified</span></span></span><a class="headerlink" href="#_CPPv4N12CancelResult12kUnspecifiedE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CancelResult10kCancelledE"> |
| <span id="_CPPv3N12CancelResult10kCancelledE"></span><span id="_CPPv2N12CancelResult10kCancelledE"></span><span class="target" id="group__flight-sql-common-types_1ggacf78c950d2019578bebdf8620ee7899da971493a769ad0aed23946733ede4a8f1"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kCancelled</span></span></span><a class="headerlink" href="#_CPPv4N12CancelResult10kCancelledE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CancelResult11kCancellingE"> |
| <span id="_CPPv3N12CancelResult11kCancellingE"></span><span id="_CPPv2N12CancelResult11kCancellingE"></span><span class="target" id="group__flight-sql-common-types_1ggacf78c950d2019578bebdf8620ee7899da084df2fe9d4b3fcc3f6505d14bd640a9"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kCancelling</span></span></span><a class="headerlink" href="#_CPPv4N12CancelResult11kCancellingE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N12CancelResult15kNotCancellableE"> |
| <span id="_CPPv3N12CancelResult15kNotCancellableE"></span><span id="_CPPv2N12CancelResult15kNotCancellableE"></span><span class="target" id="group__flight-sql-common-types_1ggacf78c950d2019578bebdf8620ee7899da07a805cc97708b2fdb9058f9da88e00e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kNotCancellable</span></span></span><a class="headerlink" href="#_CPPv4N12CancelResult15kNotCancellableE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp enum-class"> |
| <dt class="sig sig-object cpp" id="_CPPv441TableDefinitionOptionsTableNotExistOption"> |
| <span id="_CPPv341TableDefinitionOptionsTableNotExistOption"></span><span id="_CPPv241TableDefinitionOptionsTableNotExistOption"></span><span class="target" id="group__flight-sql-common-types_1gabc91534fed19afc005ea52b4f2de0934"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TableDefinitionOptionsTableNotExistOption</span></span></span><a class="headerlink" href="#_CPPv441TableDefinitionOptionsTableNotExistOption" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The action to take if the target table of an ingestion does not exist. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N41TableDefinitionOptionsTableNotExistOption12kUnspecifiedE"> |
| <span id="_CPPv3N41TableDefinitionOptionsTableNotExistOption12kUnspecifiedE"></span><span id="_CPPv2N41TableDefinitionOptionsTableNotExistOption12kUnspecifiedE"></span><span class="target" id="group__flight-sql-common-types_1ggabc91534fed19afc005ea52b4f2de0934a8536661e94a42d4d95dcb9058b9936b5"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kUnspecified</span></span></span><a class="headerlink" href="#_CPPv4N41TableDefinitionOptionsTableNotExistOption12kUnspecifiedE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N41TableDefinitionOptionsTableNotExistOption7kCreateE"> |
| <span id="_CPPv3N41TableDefinitionOptionsTableNotExistOption7kCreateE"></span><span id="_CPPv2N41TableDefinitionOptionsTableNotExistOption7kCreateE"></span><span class="target" id="group__flight-sql-common-types_1ggabc91534fed19afc005ea52b4f2de0934ab9bd4b7bbc4fbe61cec6edd5bad6496d"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kCreate</span></span></span><a class="headerlink" href="#_CPPv4N41TableDefinitionOptionsTableNotExistOption7kCreateE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N41TableDefinitionOptionsTableNotExistOption5kFailE"> |
| <span id="_CPPv3N41TableDefinitionOptionsTableNotExistOption5kFailE"></span><span id="_CPPv2N41TableDefinitionOptionsTableNotExistOption5kFailE"></span><span class="target" id="group__flight-sql-common-types_1ggabc91534fed19afc005ea52b4f2de0934a36f2a6ba7a5a19d5ab451e08bc7a7745"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kFail</span></span></span><a class="headerlink" href="#_CPPv4N41TableDefinitionOptionsTableNotExistOption5kFailE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp enum-class"> |
| <dt class="sig sig-object cpp" id="_CPPv439TableDefinitionOptionsTableExistsOption"> |
| <span id="_CPPv339TableDefinitionOptionsTableExistsOption"></span><span id="_CPPv239TableDefinitionOptionsTableExistsOption"></span><span class="target" id="group__flight-sql-common-types_1ga9f2be5271cdbf282dbbf4736c8694fa1"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TableDefinitionOptionsTableExistsOption</span></span></span><a class="headerlink" href="#_CPPv439TableDefinitionOptionsTableExistsOption" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The action to take if the target table of an ingestion already exists. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N39TableDefinitionOptionsTableExistsOption12kUnspecifiedE"> |
| <span id="_CPPv3N39TableDefinitionOptionsTableExistsOption12kUnspecifiedE"></span><span id="_CPPv2N39TableDefinitionOptionsTableExistsOption12kUnspecifiedE"></span><span class="target" id="group__flight-sql-common-types_1gga9f2be5271cdbf282dbbf4736c8694fa1a8536661e94a42d4d95dcb9058b9936b5"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kUnspecified</span></span></span><a class="headerlink" href="#_CPPv4N39TableDefinitionOptionsTableExistsOption12kUnspecifiedE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N39TableDefinitionOptionsTableExistsOption5kFailE"> |
| <span id="_CPPv3N39TableDefinitionOptionsTableExistsOption5kFailE"></span><span id="_CPPv2N39TableDefinitionOptionsTableExistsOption5kFailE"></span><span class="target" id="group__flight-sql-common-types_1gga9f2be5271cdbf282dbbf4736c8694fa1a36f2a6ba7a5a19d5ab451e08bc7a7745"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kFail</span></span></span><a class="headerlink" href="#_CPPv4N39TableDefinitionOptionsTableExistsOption5kFailE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N39TableDefinitionOptionsTableExistsOption7kAppendE"> |
| <span id="_CPPv3N39TableDefinitionOptionsTableExistsOption7kAppendE"></span><span id="_CPPv2N39TableDefinitionOptionsTableExistsOption7kAppendE"></span><span class="target" id="group__flight-sql-common-types_1gga9f2be5271cdbf282dbbf4736c8694fa1aed5658e329d7469d2f08b7362619ffef"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kAppend</span></span></span><a class="headerlink" href="#_CPPv4N39TableDefinitionOptionsTableExistsOption7kAppendE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N39TableDefinitionOptionsTableExistsOption8kReplaceE"> |
| <span id="_CPPv3N39TableDefinitionOptionsTableExistsOption8kReplaceE"></span><span id="_CPPv2N39TableDefinitionOptionsTableExistsOption8kReplaceE"></span><span class="target" id="group__flight-sql-common-types_1gga9f2be5271cdbf282dbbf4736c8694fa1a8ba1782ca7c04c255b3d69d6d2411d90"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">kReplace</span></span></span><a class="headerlink" href="#_CPPv4N39TableDefinitionOptionsTableExistsOption8kReplaceE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4lsRNSt7ostreamE12CancelResult"> |
| <span id="_CPPv3lsRNSt7ostreamE12CancelResult"></span><span id="_CPPv2lsRNSt7ostreamE12CancelResult"></span><span id="lshift-operator__osR.CancelResult"></span><span class="target" id="group__flight-sql-common-types_1ga0bbbad1dd0efe4220f47d99bf87bc3a0"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ostream</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre"><<</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ostream</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">os</span></span>, <a class="reference internal" href="#_CPPv412CancelResult" title="CancelResult"><span class="n"><span class="pre">CancelResult</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">result</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4lsRNSt7ostreamE12CancelResult" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptionsE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptionsE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptionsE"></span><span id="arrow::flight::sql::SqlInfoOptions"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SqlInfoOptions</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/types.h></em></div> |
| <p>Options to be set in the SqlInfo. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-types">Public Types</p> |
| <dl class="cpp enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfoE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfoE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfoE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbd"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SqlInfo</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfoE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Predefined info values for <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_sql_info"><span class="std std-ref">GetSqlInfo</span></a>. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo22FLIGHT_SQL_SERVER_NAMEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo22FLIGHT_SQL_SERVER_NAMEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo22FLIGHT_SQL_SERVER_NAMEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaff7a22bdc4634dbe159a0e99094271e0"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_NAME</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo22FLIGHT_SQL_SERVER_NAMEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a UTF-8 string with the name of the Flight SQL Server. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo25FLIGHT_SQL_SERVER_VERSIONE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo25FLIGHT_SQL_SERVER_VERSIONE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo25FLIGHT_SQL_SERVER_VERSIONE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda5f5c8c27ee981d3b165fbbe25442ff4f"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_VERSION</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo25FLIGHT_SQL_SERVER_VERSIONE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a UTF-8 string with the native version of the Flight SQL Server. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo31FLIGHT_SQL_SERVER_ARROW_VERSIONE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo31FLIGHT_SQL_SERVER_ARROW_VERSIONE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo31FLIGHT_SQL_SERVER_ARROW_VERSIONE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdae3d4e5a4bc19623e2efa914b690269c0"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_ARROW_VERSION</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo31FLIGHT_SQL_SERVER_ARROW_VERSIONE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a UTF-8 string with the Arrow format version of the Flight SQL Server. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27FLIGHT_SQL_SERVER_READ_ONLYE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo27FLIGHT_SQL_SERVER_READ_ONLYE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo27FLIGHT_SQL_SERVER_READ_ONLYE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda0751a2f16d6ab27858a50f33b21d1238"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_READ_ONLY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27FLIGHT_SQL_SERVER_READ_ONLYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether the Flight SQL Server is read only. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if read-write</p></li> |
| <li><p>true: if read only </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo21FLIGHT_SQL_SERVER_SQLE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo21FLIGHT_SQL_SERVER_SQLE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo21FLIGHT_SQL_SERVER_SQLE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda26b4f9907bc7e0fecbe8b2529b2dd3b1"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_SQL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo21FLIGHT_SQL_SERVER_SQLE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether the Flight SQL Server supports executing SQL queries. </p> |
| <p>Note that the absence of this info (as opposed to a false value) does not necessarily mean that SQL is not supported, as this property was not originally defined. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27FLIGHT_SQL_SERVER_SUBSTRAITE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo27FLIGHT_SQL_SERVER_SUBSTRAITE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo27FLIGHT_SQL_SERVER_SUBSTRAITE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda04547f4fd3d4572f3cfb38158dd17409"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_SUBSTRAIT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27FLIGHT_SQL_SERVER_SUBSTRAITE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether the Flight SQL Server supports executing Substrait plans. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo39FLIGHT_SQL_SERVER_SUBSTRAIT_MIN_VERSIONE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo39FLIGHT_SQL_SERVER_SUBSTRAIT_MIN_VERSIONE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo39FLIGHT_SQL_SERVER_SUBSTRAIT_MIN_VERSIONE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdae87d8ed155e8f345015f6daa8ffaabf4"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_SUBSTRAIT_MIN_VERSION</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo39FLIGHT_SQL_SERVER_SUBSTRAIT_MIN_VERSIONE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a string value indicating the minimum supported Substrait version, or null if Substrait is not supported. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo39FLIGHT_SQL_SERVER_SUBSTRAIT_MAX_VERSIONE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo39FLIGHT_SQL_SERVER_SUBSTRAIT_MAX_VERSIONE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo39FLIGHT_SQL_SERVER_SUBSTRAIT_MAX_VERSIONE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdad38936e926dc02f1a703775da33bdec3"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_SUBSTRAIT_MAX_VERSION</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo39FLIGHT_SQL_SERVER_SUBSTRAIT_MAX_VERSIONE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a string value indicating the maximum supported Substrait version, or null if Substrait is not supported. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo29FLIGHT_SQL_SERVER_TRANSACTIONE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo29FLIGHT_SQL_SERVER_TRANSACTIONE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo29FLIGHT_SQL_SERVER_TRANSACTIONE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda4d4e3ab0e5ffbad5bbadce93e08e6e4c"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_TRANSACTION</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo29FLIGHT_SQL_SERVER_TRANSACTIONE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves an int32 indicating whether the Flight SQL Server supports the BeginTransaction, EndTransaction, BeginSavepoint, and EndSavepoint actions. </p> |
| <p>Even if this is not supported, the database may still support explicit “BEGIN TRANSACTION”/”COMMIT” SQL statements (see SQL_TRANSACTIONS_SUPPORTED); this property is only about whether the server implements the Flight SQL API endpoints.</p> |
| <p>The possible values are listed in <code class="docutils literal notranslate"><span class="pre">SqlSupportedTransaction</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24FLIGHT_SQL_SERVER_CANCELE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo24FLIGHT_SQL_SERVER_CANCELE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo24FLIGHT_SQL_SERVER_CANCELE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdad66d5ae3b83a68639f045211be7870a2"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_CANCEL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24FLIGHT_SQL_SERVER_CANCELE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether the Flight SQL Server supports explicit query cancellation (the CancelQuery action). </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo32FLIGHT_SQL_SERVER_BULK_INGESTIONE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo32FLIGHT_SQL_SERVER_BULK_INGESTIONE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo32FLIGHT_SQL_SERVER_BULK_INGESTIONE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda30f124ed3decf5b863979ec86ab5f85b"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_BULK_INGESTION</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo32FLIGHT_SQL_SERVER_BULK_INGESTIONE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether the Flight SQL Server supports executing bulk ingestion. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo47FLIGHT_SQL_SERVER_INGEST_TRANSACTIONS_SUPPORTEDE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo47FLIGHT_SQL_SERVER_INGEST_TRANSACTIONS_SUPPORTEDE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo47FLIGHT_SQL_SERVER_INGEST_TRANSACTIONS_SUPPORTEDE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaaa27e69f96b68ce24a44c374dd63fa62"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_INGEST_TRANSACTIONS_SUPPORTED</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo47FLIGHT_SQL_SERVER_INGEST_TRANSACTIONS_SUPPORTEDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether the Flight SQL Server supports transactions for bulk ingestion. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo35FLIGHT_SQL_SERVER_STATEMENT_TIMEOUTE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo35FLIGHT_SQL_SERVER_STATEMENT_TIMEOUTE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo35FLIGHT_SQL_SERVER_STATEMENT_TIMEOUTE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda8ab02183b2415b77d125cbc51c7977e6"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_STATEMENT_TIMEOUT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo35FLIGHT_SQL_SERVER_STATEMENT_TIMEOUTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves an int32 value indicating the timeout (in milliseconds) for prepared statement handles. </p> |
| <p>If 0, there is no timeout. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo37FLIGHT_SQL_SERVER_TRANSACTION_TIMEOUTE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo37FLIGHT_SQL_SERVER_TRANSACTION_TIMEOUTE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo37FLIGHT_SQL_SERVER_TRANSACTION_TIMEOUTE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdad3745f3fcc2cc71b822ba612a671e8fe"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLIGHT_SQL_SERVER_TRANSACTION_TIMEOUT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo37FLIGHT_SQL_SERVER_TRANSACTION_TIMEOUTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves an int32 value indicating the timeout (in milliseconds) for transactions, since transactions are not tied to a connection. </p> |
| <p>If 0, there is no timeout. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo15SQL_DDL_CATALOGE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo15SQL_DDL_CATALOGE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo15SQL_DDL_CATALOGE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaad739b7edd311647a495d29cb336cdf2"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_DDL_CATALOG</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo15SQL_DDL_CATALOGE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE and DROP of catalogs. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if it doesn’t support CREATE and DROP of catalogs.</p></li> |
| <li><p>true: if it supports CREATE and DROP of catalogs. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo14SQL_DDL_SCHEMAE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo14SQL_DDL_SCHEMAE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo14SQL_DDL_SCHEMAE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda018499e369a19b9f8942806b45c4f640"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_DDL_SCHEMA</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo14SQL_DDL_SCHEMAE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE and DROP of schemas. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if it doesn’t support CREATE and DROP of schemas.</p></li> |
| <li><p>true: if it supports CREATE and DROP of schemas. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo13SQL_DDL_TABLEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo13SQL_DDL_TABLEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo13SQL_DDL_TABLEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaf11dd4af92c701e146e9fdb476d9890e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_DDL_TABLE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo13SQL_DDL_TABLEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Indicates whether the Flight SQL Server supports CREATE and DROP of tables. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if it doesn’t support CREATE and DROP of tables.</p></li> |
| <li><p>true: if it supports CREATE and DROP of tables. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo19SQL_IDENTIFIER_CASEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo19SQL_IDENTIFIER_CASEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo19SQL_IDENTIFIER_CASEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda5264ad94f6bd9d1de9542510b7267554"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_IDENTIFIER_CASE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo19SQL_IDENTIFIER_CASEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int32 value representing the enum ordinal for the case sensitivity of catalog, table and schema names. </p> |
| <p>The possible values are listed in <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlSupportedCaseSensitivity</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_IDENTIFIER_QUOTE_CHARE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_IDENTIFIER_QUOTE_CHARE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_IDENTIFIER_QUOTE_CHARE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda7d557880d1c1a9298a21b04cbf41bc44"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_IDENTIFIER_QUOTE_CHAR</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_IDENTIFIER_QUOTE_CHARE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a UTF-8 string with the supported character(s) used to surround a delimited identifier. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_QUOTED_IDENTIFIER_CASEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_QUOTED_IDENTIFIER_CASEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_QUOTED_IDENTIFIER_CASEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdabfe13dae89c9f3d7bf475acb5792ee35"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_QUOTED_IDENTIFIER_CASE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_QUOTED_IDENTIFIER_CASEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int32 value representing the enum ordinal for the case sensitivity of quoted identifiers. </p> |
| <p>The possible values are listed in <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlSupportedCaseSensitivity</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_ALL_TABLES_ARE_SELECTABLEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_ALL_TABLES_ARE_SELECTABLEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_ALL_TABLES_ARE_SELECTABLEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda8e255c05a5cff700744e946fb1af9df2"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_ALL_TABLES_ARE_SELECTABLE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_ALL_TABLES_ARE_SELECTABLEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether all tables are selectable. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if not all tables are selectable or if none are;</p></li> |
| <li><p>true: if all tables are selectable. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo17SQL_NULL_ORDERINGE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo17SQL_NULL_ORDERINGE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo17SQL_NULL_ORDERINGE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda969bc0236b8f892ed3feb2553a3dc87d"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_NULL_ORDERING</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo17SQL_NULL_ORDERINGE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the null ordering used by the database as a int32 ordinal value. </p> |
| <p>Returns a int32 ordinal for the null ordering being used, as described in <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlNullOrdering</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo12SQL_KEYWORDSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo12SQL_KEYWORDSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo12SQL_KEYWORDSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda938d090f0cee7ab1e31a89dcfe463965"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_KEYWORDS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo12SQL_KEYWORDSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a UTF-8 string list with values of the supported keywords. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo21SQL_NUMERIC_FUNCTIONSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo21SQL_NUMERIC_FUNCTIONSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo21SQL_NUMERIC_FUNCTIONSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda75d6ab96c9fb0a8c6f9c23e4df7f2882"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_NUMERIC_FUNCTIONS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo21SQL_NUMERIC_FUNCTIONSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a UTF-8 string list with values of the supported numeric functions. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_STRING_FUNCTIONSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_STRING_FUNCTIONSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_STRING_FUNCTIONSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda2bac48e408017ff0df19eae4c66f4ff5"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_STRING_FUNCTIONS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_STRING_FUNCTIONSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a UTF-8 string list with values of the supported string functions. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_SYSTEM_FUNCTIONSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_SYSTEM_FUNCTIONSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_SYSTEM_FUNCTIONSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaa50a7be401bda5c41b90229f6d440a6e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SYSTEM_FUNCTIONS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_SYSTEM_FUNCTIONSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a UTF-8 string list with values of the supported system functions. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo22SQL_DATETIME_FUNCTIONSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo22SQL_DATETIME_FUNCTIONSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo22SQL_DATETIME_FUNCTIONSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaec89317c27f66495f9ad9ccf888dc309"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_DATETIME_FUNCTIONS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo22SQL_DATETIME_FUNCTIONSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a UTF-8 string list with values of the supported datetime functions. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_SEARCH_STRING_ESCAPEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_SEARCH_STRING_ESCAPEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_SEARCH_STRING_ESCAPEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda378e100762638b32da1bd49e38532e19"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SEARCH_STRING_ESCAPE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_SEARCH_STRING_ESCAPEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the UTF-8 string that can be used to escape wildcard characters. </p> |
| <p>This is the string that can be used to escape ‘_’ or ‘’ in the catalog search parameters that are a pattern (and therefore use one of the wildcard characters). The ‘_’ character represents any single character; the ‘’ character represents any sequence of zero or more characters. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_EXTRA_NAME_CHARACTERSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_EXTRA_NAME_CHARACTERSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_EXTRA_NAME_CHARACTERSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaf60026170afaebe349f165f44807d270"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_EXTRA_NAME_CHARACTERS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_EXTRA_NAME_CHARACTERSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a UTF-8 string with all the “extra” characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _). </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo28SQL_SUPPORTS_COLUMN_ALIASINGE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo28SQL_SUPPORTS_COLUMN_ALIASINGE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo28SQL_SUPPORTS_COLUMN_ALIASINGE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdabf9303677e7d4ca339ab7d6b9ae54a1e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTS_COLUMN_ALIASING</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo28SQL_SUPPORTS_COLUMN_ALIASINGE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether column aliasing is supported. </p> |
| <p>If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.</p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if column aliasing is unsupported;</p></li> |
| <li><p>true: if column aliasing is supported. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_NULL_PLUS_NULL_IS_NULLE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_NULL_PLUS_NULL_IS_NULLE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_NULL_PLUS_NULL_IS_NULLE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaf4830c281bc23cafcf159bf2e0c8d06c"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_NULL_PLUS_NULL_IS_NULL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_NULL_PLUS_NULL_IS_NULLE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether concatenations between null and non-null values being null are supported. </p> |
| <p><ul class="simple"> |
| <li><p>Returns:</p></li> |
| <li><p>false: if concatenations between null and non-null values being null are unsupported;</p></li> |
| <li><p>true: if concatenations between null and non-null values being null are supported. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_SUPPORTS_CONVERTE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_SUPPORTS_CONVERTE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_SUPPORTS_CONVERTE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdad54c8b3708e444ddb2c03a1215bc8a27"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTS_CONVERT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_SUPPORTS_CONVERTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a map where the key is the type to convert from and the value is a list with the types to convert to, indicating the supported conversions. </p> |
| <p>Each key and each item on the list value is a value to a predefined type on SqlSupportsConvert enum. The returned map will be: map<int32, list<int32>> </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo36SQL_SUPPORTS_TABLE_CORRELATION_NAMESE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo36SQL_SUPPORTS_TABLE_CORRELATION_NAMESE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo36SQL_SUPPORTS_TABLE_CORRELATION_NAMESE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda6d55a010b03d9831ea3ec552bd0a3a0e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTS_TABLE_CORRELATION_NAMES</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo36SQL_SUPPORTS_TABLE_CORRELATION_NAMESE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether, when table correlation names are supported, they are restricted to being different from the names of the tables. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if table correlation names are unsupported;</p></li> |
| <li><p>true: if table correlation names are supported. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo46SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMESE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo46SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMESE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo46SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMESE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda8be66949bc6e0650f4b039caa7aa16cb"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo46SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMESE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether, when table correlation names are supported, they are restricted to being different from the names of the tables. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if different table correlation names are unsupported;</p></li> |
| <li><p>true: if different table correlation names are supported </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo36SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BYE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo36SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BYE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo36SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BYE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdae7dffc0029157313fce420b35a8d644d"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo36SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether expressions in ORDER BY lists are supported. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if expressions in ORDER BY are unsupported;</p></li> |
| <li><p>true: if expressions in ORDER BY are supported; </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_SUPPORTS_ORDER_BY_UNRELATEDE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_SUPPORTS_ORDER_BY_UNRELATEDE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_SUPPORTS_ORDER_BY_UNRELATEDE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdae43de41e7c4825266a62e910eca530cd"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTS_ORDER_BY_UNRELATED</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_SUPPORTS_ORDER_BY_UNRELATEDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether using a column that is not in the SELECT statement in a GROUP BY clause is supported. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if using a column that is not in the SELECT statement in a GROUP BY clause is unsupported;</p></li> |
| <li><p>true: if using a column that is not in the SELECT statement in a GROUP BY clause is supported. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo22SQL_SUPPORTED_GROUP_BYE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo22SQL_SUPPORTED_GROUP_BYE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo22SQL_SUPPORTED_GROUP_BYE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda12dfbaa53e2f6a2897fe1a79bb6c4d22"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_GROUP_BY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo22SQL_SUPPORTED_GROUP_BYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the supported GROUP BY commands as an int32 bitmask. </p> |
| <p>The returned bitmask should be parsed in order to retrieve the supported commands.</p> |
| <p><ul class="simple"> |
| <li><p>return 0 (0b0) => [] (GROUP BY is unsupported);</p></li> |
| <li><p>return 1 (0b1) => [SQL_GROUP_BY_UNRELATED];</p></li> |
| <li><p>return 2 (0b10) => [SQL_GROUP_BY_BEYOND_SELECT];</p></li> |
| <li><p>return 3 (0b11) => [SQL_GROUP_BY_UNRELATED, SQL_GROUP_BY_BEYOND_SELECT].</p></li> |
| </ul> |
| </p> |
| <p>Valid GROUP BY types are described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlSupportedGroupBy</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_SUPPORTS_LIKE_ESCAPE_CLAUSEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_SUPPORTS_LIKE_ESCAPE_CLAUSEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_SUPPORTS_LIKE_ESCAPE_CLAUSEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda445e2c1c8611f62acd77e8bae6ccd40f"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTS_LIKE_ESCAPE_CLAUSE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_SUPPORTS_LIKE_ESCAPE_CLAUSEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether specifying a LIKE escape clause is supported. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if specifying a LIKE escape clause is unsupported;</p></li> |
| <li><p>true: if specifying a LIKE escape clause is supported. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo33SQL_SUPPORTS_NON_NULLABLE_COLUMNSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo33SQL_SUPPORTS_NON_NULLABLE_COLUMNSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo33SQL_SUPPORTS_NON_NULLABLE_COLUMNSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda00150760235c7c44a1dd3a121aae0ccc"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTS_NON_NULLABLE_COLUMNS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo33SQL_SUPPORTS_NON_NULLABLE_COLUMNSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether columns may be defined as non-nullable. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if columns cannot be defined as non-nullable;</p></li> |
| <li><p>true: if columns may be defined as non-nullable. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo21SQL_SUPPORTED_GRAMMARE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo21SQL_SUPPORTED_GRAMMARE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo21SQL_SUPPORTED_GRAMMARE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda2caa491f9e0b91be9899b9a251b4e914"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_GRAMMAR</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo21SQL_SUPPORTED_GRAMMARE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the supported SQL grammar level as per the ODBC specification. </p> |
| <p>Returns an int32 bitmask value representing the supported SQL grammar level. The returned bitmask should be parsed in order to retrieve the supported grammar levels.</p> |
| <p>For instance:<ul class="simple"> |
| <li><p>return 0 (0b0) => [] (SQL grammar is unsupported);</p></li> |
| <li><p>return 1 (0b1) => [SQL_MINIMUM_GRAMMAR];</p></li> |
| <li><p>return 2 (0b10) => [SQL_CORE_GRAMMAR];</p></li> |
| <li><p>return 3 (0b11) => [SQL_MINIMUM_GRAMMAR, SQL_CORE_GRAMMAR];</p></li> |
| <li><p>return 4 (0b100) => [SQL_EXTENDED_GRAMMAR];</p></li> |
| <li><p>return 5 (0b101) => [SQL_MINIMUM_GRAMMAR, SQL_EXTENDED_GRAMMAR];</p></li> |
| <li><p>return 6 (0b110) => [SQL_CORE_GRAMMAR, SQL_EXTENDED_GRAMMAR];</p></li> |
| <li><p>return 7 (0b111) => [SQL_MINIMUM_GRAMMAR, SQL_CORE_GRAMMAR, SQL_EXTENDED_GRAMMAR].</p></li> |
| </ul> |
| </p> |
| <p>Valid SQL grammar levels are described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SupportedSqlGrammar</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_ANSI92_SUPPORTED_LEVELE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_ANSI92_SUPPORTED_LEVELE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_ANSI92_SUPPORTED_LEVELE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda6e80a597470283fc62c491ec466c53e4"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_ANSI92_SUPPORTED_LEVEL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_ANSI92_SUPPORTED_LEVELE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the supported ANSI92 SQL grammar level as per the ODBC specification. </p> |
| <p>Returns an int32 bitmask value representing the supported ANSI92 SQL grammar level. The returned bitmask should be parsed in order to retrieve the supported grammar levels.</p> |
| <p>For instance:<ul class="simple"> |
| <li><p>return 0 (0b0) => [] (ANSI92 SQL grammar is unsupported);</p></li> |
| <li><p>return 1 (0b1) => [ANSI92_ENTRY_SQL];</p></li> |
| <li><p>return 2 (0b10) => [ANSI92_INTERMEDIATE_SQL];</p></li> |
| <li><p>return 3 (0b11) => [ANSI92_ENTRY_SQL, ANSI92_INTERMEDIATE_SQL];</p></li> |
| <li><p>return 4 (0b100) => [ANSI92_FULL_SQL];</p></li> |
| <li><p>return 5 (0b101) => [ANSI92_ENTRY_SQL, ANSI92_FULL_SQL];</p></li> |
| <li><p>return 6 (0b110) => [ANSI92_INTERMEDIATE_SQL, ANSI92_FULL_SQL];</p></li> |
| <li><p>return 7 (0b111) => [ANSI92_ENTRY_SQL, ANSI92_INTERMEDIATE_SQL, ANSI92_FULL_SQL].</p></li> |
| </ul> |
| </p> |
| <p>Valid ANSI92 SQL grammar levels are described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SupportedAnsi92SqlGrammarLevel</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo43SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITYE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo43SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITYE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo43SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITYE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda0acb362c11fe7f7f7da2cc81747765b9"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo43SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether the SQL Integrity Enhancement Facility is supported. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if the SQL Integrity Enhancement Facility is supported;</p></li> |
| <li><p>true: if the SQL Integrity Enhancement Facility is supported. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_OUTER_JOINS_SUPPORT_LEVELE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_OUTER_JOINS_SUPPORT_LEVELE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_OUTER_JOINS_SUPPORT_LEVELE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda628c32f28616116fffcb8c4cc88e7f8a"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_OUTER_JOINS_SUPPORT_LEVEL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_OUTER_JOINS_SUPPORT_LEVELE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the support level for SQL OUTER JOINs as an int32 ordinal, as described in <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlOuterJoinsSupportLevel</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo15SQL_SCHEMA_TERME"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo15SQL_SCHEMA_TERME"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo15SQL_SCHEMA_TERME"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda8ada24833807be737715bd4c6660c7c2"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SCHEMA_TERM</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo15SQL_SCHEMA_TERME" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a UTF-8 string with the preferred term for “schema”. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo18SQL_PROCEDURE_TERME"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo18SQL_PROCEDURE_TERME"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo18SQL_PROCEDURE_TERME"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaf2ff804188347bd85cb30c13910e4a1c"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_PROCEDURE_TERM</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo18SQL_PROCEDURE_TERME" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a UTF-8 string with the preferred term for “procedure”. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo16SQL_CATALOG_TERME"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo16SQL_CATALOG_TERME"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo16SQL_CATALOG_TERME"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaa7660093f88c2fc3ee168a3521fb842f"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CATALOG_TERM</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo16SQL_CATALOG_TERME" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a UTF-8 string with the preferred term for “catalog”. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_CATALOG_AT_STARTE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_CATALOG_AT_STARTE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_CATALOG_AT_STARTE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda274f61974b33a624a41ed57a84352d8a"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CATALOG_AT_START</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_CATALOG_AT_STARTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether a catalog appears at the start of a fully qualified table name. </p> |
| <p><ul class="simple"> |
| <li><p>false: if a catalog does not appear at the start of a fully qualified table name;</p></li> |
| <li><p>true: if a catalog appears at the start of a fully qualified table name. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_SCHEMAS_SUPPORTED_ACTIONSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_SCHEMAS_SUPPORTED_ACTIONSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_SCHEMAS_SUPPORTED_ACTIONSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda7212f7200ba7a925296f3854caf98ec3"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SCHEMAS_SUPPORTED_ACTIONS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_SCHEMAS_SUPPORTED_ACTIONSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the supported actions for a SQL database schema as an int32 bitmask value. </p> |
| <p>Returns an int32 bitmask value representing the supported actions for a SQL schema. The returned bitmask should be parsed in order to retrieve the supported actions for a SQL schema.</p> |
| <p>For instance:<ul class="simple"> |
| <li><p>return 0 (0b0) => [] (no supported actions for SQL schema);</p></li> |
| <li><p>return 1 (0b1) => [SQL_ELEMENT_IN_PROCEDURE_CALLS];</p></li> |
| <li><p>return 2 (0b10) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS];</p></li> |
| <li><p>return 3 (0b11) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS];</p></li> |
| <li><p>return 4 (0b100) => [SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];</p></li> |
| <li><p>return 5 (0b101) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];</p></li> |
| <li><p>return 6 (0b110) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];</p></li> |
| <li><p>return 7 (0b111) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS].</p></li> |
| </ul> |
| </p> |
| <p>Valid actions for a SQL schema described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlSupportedElementActions</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo30SQL_CATALOGS_SUPPORTED_ACTIONSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo30SQL_CATALOGS_SUPPORTED_ACTIONSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo30SQL_CATALOGS_SUPPORTED_ACTIONSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda9b6ba691f5506f8d715b26b15a37f7c3"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CATALOGS_SUPPORTED_ACTIONS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo30SQL_CATALOGS_SUPPORTED_ACTIONSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the supported actions for a SQL catalog as an int32 bitmask value. </p> |
| <p>Returns an int32 bitmask value representing the supported actions for a SQL catalog. The returned bitmask should be parsed in order to retrieve the supported actions for a SQL catalog.</p> |
| <p>For instance:<ul class="simple"> |
| <li><p>return 0 (0b0) => [] (no supported actions for SQL catalog);</p></li> |
| <li><p>return 1 (0b1) => [SQL_ELEMENT_IN_PROCEDURE_CALLS];</p></li> |
| <li><p>return 2 (0b10) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS];</p></li> |
| <li><p>return 3 (0b11) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS];</p></li> |
| <li><p>return 4 (0b100) => [SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];</p></li> |
| <li><p>return 5 (0b101) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];</p></li> |
| <li><p>return 6 (0b110) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];</p></li> |
| <li><p>return 7 (0b111) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS].</p></li> |
| </ul> |
| </p> |
| <p>Valid actions for a SQL catalog are described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlSupportedElementActions</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo33SQL_SUPPORTED_POSITIONED_COMMANDSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo33SQL_SUPPORTED_POSITIONED_COMMANDSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo33SQL_SUPPORTED_POSITIONED_COMMANDSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda3708d702cdef83f9757935e2e1c97471"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_POSITIONED_COMMANDS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo33SQL_SUPPORTED_POSITIONED_COMMANDSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the supported SQL positioned commands as an int32 bitmask value. </p> |
| <p>Returns an int32 bitmask value representing the supported SQL positioned commands. The returned bitmask should be parsed in order to retrieve the supported SQL positioned commands.</p> |
| <p>For instance:<ul class="simple"> |
| <li><p>return 0 (0b0) => [] (no supported SQL positioned commands);</p></li> |
| <li><p>return 1 (0b1) => [SQL_POSITIONED_DELETE];</p></li> |
| <li><p>return 2 (0b10) => [SQL_POSITIONED_UPDATE];</p></li> |
| <li><p>return 3 (0b11) => [SQL_POSITIONED_DELETE, SQL_POSITIONED_UPDATE].</p></li> |
| </ul> |
| </p> |
| <p>Valid SQL positioned commands are described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlSupportedPositionedCommands</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_SELECT_FOR_UPDATE_SUPPORTEDE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_SELECT_FOR_UPDATE_SUPPORTEDE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_SELECT_FOR_UPDATE_SUPPORTEDE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdafb7ab6bfcf9cc4ad0b12df24e49c7777"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SELECT_FOR_UPDATE_SUPPORTED</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_SELECT_FOR_UPDATE_SUPPORTEDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether SELECT FOR UPDATE statements are supported. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if SELECT FOR UPDATE statements are unsupported;</p></li> |
| <li><p>true: if SELECT FOR UPDATE statements are supported. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_STORED_PROCEDURES_SUPPORTEDE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_STORED_PROCEDURES_SUPPORTEDE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_STORED_PROCEDURES_SUPPORTEDE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda3abc258c2a0a472b16c6e2e015dbbd1e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_STORED_PROCEDURES_SUPPORTED</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_STORED_PROCEDURES_SUPPORTEDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether stored procedure calls that use the stored procedure escape syntax are supported. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if stored procedure calls that use the stored procedure escape syntax are unsupported;</p></li> |
| <li><p>true: if stored procedure calls that use the stored procedure escape syntax are supported. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_SUPPORTED_SUBQUERIESE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_SUPPORTED_SUBQUERIESE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_SUPPORTED_SUBQUERIESE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaf0eba27643972c92fc55078c05c4719d"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_SUBQUERIES</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_SUPPORTED_SUBQUERIESE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the types of supported SQL subqueries as an int32 bitmask value. </p> |
| <p>Returns an int32 bitmask value representing the supported SQL subqueries. The returned bitmask should be parsed in order to retrieve the supported SQL subqueries.</p> |
| <p>For instance:<ul class="simple"> |
| <li><p>return 0 (0b0) => [] (no supported SQL subqueries);</p></li> |
| <li><p>return 1 (0b1) => [SQL_SUBQUERIES_IN_COMPARISONS];</p></li> |
| <li><p>return 2 (0b10) => [SQL_SUBQUERIES_IN_EXISTS];</p></li> |
| <li><p>return 3 (0b11) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS];</p></li> |
| <li><p>return 4 (0b100) => [SQL_SUBQUERIES_IN_INS];</p></li> |
| <li><p>return 5 (0b101) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_INS];</p></li> |
| <li><p>return 6 (0b110) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS];</p></li> |
| <li><p>return 7 (0b111) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS];</p></li> |
| <li><p>return 8 (0b1000) => [SQL_SUBQUERIES_IN_QUANTIFIEDS];</p></li> |
| <li><p>return 9 (0b1001) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</p></li> |
| <li><p>return 10 (0b1010) => [SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</p></li> |
| <li><p>return 11 (0b1011) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</p></li> |
| <li><p>return 12 (0b1100) => [SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</p></li> |
| <li><p>return 13 (0b1101) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</p></li> |
| <li><p>return 14 (0b1110) => [SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</p></li> |
| <li><p>return 15 (0b1111) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];</p></li> |
| <li><p>…</p></li> |
| </ul> |
| </p> |
| <p>Valid SQL subqueries are described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlSupportedSubqueries</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo35SQL_CORRELATED_SUBQUERIES_SUPPORTEDE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo35SQL_CORRELATED_SUBQUERIES_SUPPORTEDE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo35SQL_CORRELATED_SUBQUERIES_SUPPORTEDE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdab2196bc95b1615d9d8aa579301282578"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CORRELATED_SUBQUERIES_SUPPORTED</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo35SQL_CORRELATED_SUBQUERIES_SUPPORTEDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether correlated subqueries are supported. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if correlated subqueries are unsupported;</p></li> |
| <li><p>true: if correlated subqueries are supported. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_SUPPORTED_UNIONSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_SUPPORTED_UNIONSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_SUPPORTED_UNIONSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda5d650489f421c4271ea572e17e6c6ce5"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_UNIONS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_SUPPORTED_UNIONSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the supported SQL UNION features as an int32 bitmask value. </p> |
| <p>Returns an int32 bitmask value representing the supported SQL UNIONs. The returned bitmask should be parsed in order to retrieve the supported SQL UNIONs.</p> |
| <p>For instance:<ul class="simple"> |
| <li><p>return 0 (0b0) => [] (no supported SQL positioned commands);</p></li> |
| <li><p>return 1 (0b1) => [SQL_UNION];</p></li> |
| <li><p>return 2 (0b10) => [SQL_UNION_ALL];</p></li> |
| <li><p>return 3 (0b11) => [SQL_UNION, SQL_UNION_ALL].</p></li> |
| </ul> |
| </p> |
| <p>Valid SQL union operators are described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlSupportedUnions</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_MAX_BINARY_LITERAL_LENGTHE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_MAX_BINARY_LITERAL_LENGTHE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_MAX_BINARY_LITERAL_LENGTHE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdad2f34765626761c96839bc6b2d51a04e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_BINARY_LITERAL_LENGTH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_MAX_BINARY_LITERAL_LENGTHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of hex characters allowed in an inline binary literal. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_CHAR_LITERAL_LENGTHE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_CHAR_LITERAL_LENGTHE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_CHAR_LITERAL_LENGTHE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda5ee814372ff235a7667ed4ce53911fff"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_CHAR_LITERAL_LENGTH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_CHAR_LITERAL_LENGTHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of characters allowed for a character literal. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_MAX_COLUMN_NAME_LENGTHE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_MAX_COLUMN_NAME_LENGTHE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_MAX_COLUMN_NAME_LENGTHE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaee0ce859ba95f889d29c105513e39098"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_COLUMN_NAME_LENGTH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_MAX_COLUMN_NAME_LENGTHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of characters allowed for a column name. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_COLUMNS_IN_GROUP_BYE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_COLUMNS_IN_GROUP_BYE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_COLUMNS_IN_GROUP_BYE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdad9d21ab8cf944dbf1d4348a5e858d58e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_COLUMNS_IN_GROUP_BY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_COLUMNS_IN_GROUP_BYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of columns allowed in a GROUP BY clause. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_COLUMNS_IN_INDEXE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_COLUMNS_IN_INDEXE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_COLUMNS_IN_INDEXE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda49e9dd17b9617755f13565a12fdd2d84"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_COLUMNS_IN_INDEX</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_COLUMNS_IN_INDEXE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of columns allowed in an index. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_COLUMNS_IN_ORDER_BYE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_COLUMNS_IN_ORDER_BYE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_COLUMNS_IN_ORDER_BYE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda2c00e10ab43aa984a397954f2e79315c"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_COLUMNS_IN_ORDER_BY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_COLUMNS_IN_ORDER_BYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of columns allowed in an ORDER BY clause. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_MAX_COLUMNS_IN_SELECTE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_MAX_COLUMNS_IN_SELECTE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_MAX_COLUMNS_IN_SELECTE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda6c3c69ef02423993e8e2229523a38d2a"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_COLUMNS_IN_SELECT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_MAX_COLUMNS_IN_SELECTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of columns allowed in a SELECT list. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_COLUMNS_IN_TABLEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_COLUMNS_IN_TABLEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_COLUMNS_IN_TABLEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdac7a5d08fcba993b16e8d666fef2f41b7"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_COLUMNS_IN_TABLE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_COLUMNS_IN_TABLEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of columns allowed in a table. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo19SQL_MAX_CONNECTIONSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo19SQL_MAX_CONNECTIONSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo19SQL_MAX_CONNECTIONSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda332e87b9aff0903161c9cc4341128fa4"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_CONNECTIONS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo19SQL_MAX_CONNECTIONSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of concurrent connections possible. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_MAX_CURSOR_NAME_LENGTHE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_MAX_CURSOR_NAME_LENGTHE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_MAX_CURSOR_NAME_LENGTHE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda786e2409337c68de43c3676c55d7f18c"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_CURSOR_NAME_LENGTH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_MAX_CURSOR_NAME_LENGTHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value the maximum number of characters allowed in a cursor name. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_MAX_INDEX_LENGTHE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_MAX_INDEX_LENGTHE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_MAX_INDEX_LENGTHE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda2b5025d34d8c873286778b30fc26ffdc"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_INDEX_LENGTH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo20SQL_MAX_INDEX_LENGTHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of bytes allowed for an index, including all of the parts of the index. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo22SQL_SCHEMA_NAME_LENGTHE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo22SQL_SCHEMA_NAME_LENGTHE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo22SQL_SCHEMA_NAME_LENGTHE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda487bb48de1a8f6b955f3c13a21b7e75f"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SCHEMA_NAME_LENGTH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo22SQL_SCHEMA_NAME_LENGTHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of characters allowed in a procedure name. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_MAX_PROCEDURE_NAME_LENGTHE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_MAX_PROCEDURE_NAME_LENGTHE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_MAX_PROCEDURE_NAME_LENGTHE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda50a730b1f9c159e8447e766fd888a126"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_PROCEDURE_NAME_LENGTH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo29SQL_MAX_PROCEDURE_NAME_LENGTHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of bytes allowed in a single row. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_CATALOG_NAME_LENGTHE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_CATALOG_NAME_LENGTHE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_CATALOG_NAME_LENGTHE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda214f75d856455f737554b73f21f0b1ef"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_CATALOG_NAME_LENGTH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_MAX_CATALOG_NAME_LENGTHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of characters allowed in a catalog name. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo16SQL_MAX_ROW_SIZEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo16SQL_MAX_ROW_SIZEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo16SQL_MAX_ROW_SIZEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaadc59e6589bf848ff08b6f15f052b814"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_ROW_SIZE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo16SQL_MAX_ROW_SIZEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int64 value representing the maximum number of bytes allowed in a single row. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_MAX_ROW_SIZE_INCLUDES_BLOBSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_MAX_ROW_SIZE_INCLUDES_BLOBSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_MAX_ROW_SIZE_INCLUDES_BLOBSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda4a9d3a6a56fbe33be4ae4894d14a2bbe"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_ROW_SIZE_INCLUDES_BLOBS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo31SQL_MAX_ROW_SIZE_INCLUDES_BLOBSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean indicating whether the return value for the JDBC method getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if return value for the JDBC method getMaxRowSize does not include the SQL data types LONGVARCHAR and LONGVARBINARY;</p></li> |
| <li><p>true: if return value for the JDBC method getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_STATEMENT_LENGTHE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_STATEMENT_LENGTHE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_STATEMENT_LENGTHE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda38e3f225be59922fff967e321f7513b2"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_STATEMENT_LENGTH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_STATEMENT_LENGTHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int32 value representing the maximum number of characters allowed for an SQL statement; a result of 0 (zero) means that there is no limit or the limit is not known. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo18SQL_MAX_STATEMENTSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo18SQL_MAX_STATEMENTSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo18SQL_MAX_STATEMENTSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaee1ee672a364ac936132fedf284995c3"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_STATEMENTS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo18SQL_MAX_STATEMENTSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int32 value representing the maximum number of active statements that can be open at the same time. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_MAX_TABLE_NAME_LENGTHE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_MAX_TABLE_NAME_LENGTHE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_MAX_TABLE_NAME_LENGTHE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdace155dca34ee8d0c3d6fd755fd9fe852"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_TABLE_NAME_LENGTH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo25SQL_MAX_TABLE_NAME_LENGTHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int32 value representing the maximum number of characters allowed in a table name. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_TABLES_IN_SELECTE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_TABLES_IN_SELECTE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_TABLES_IN_SELECTE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaed77dce59cc33586f76dc8f08c14d932"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_TABLES_IN_SELECT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_MAX_TABLES_IN_SELECTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int32 value representing the maximum number of tables allowed in a SELECT statement. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo23SQL_MAX_USERNAME_LENGTHE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo23SQL_MAX_USERNAME_LENGTHE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo23SQL_MAX_USERNAME_LENGTHE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaeb402432ba0c12de431c073e4fc01acb"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_MAX_USERNAME_LENGTH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo23SQL_MAX_USERNAME_LENGTHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a int32 value representing the maximum number of characters allowed in a user name. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo33SQL_DEFAULT_TRANSACTION_ISOLATIONE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo33SQL_DEFAULT_TRANSACTION_ISOLATIONE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo33SQL_DEFAULT_TRANSACTION_ISOLATIONE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda200542f45251f4d8481a601afc7fd9e3"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_DEFAULT_TRANSACTION_ISOLATION</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo33SQL_DEFAULT_TRANSACTION_ISOLATIONE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves this database’s default transaction isolation level as described in <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlTransactionIsolationLevel</span></code>. </p> |
| <p>Returns a int32 ordinal for the SQL transaction isolation level. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_TRANSACTIONS_SUPPORTEDE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_TRANSACTIONS_SUPPORTEDE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_TRANSACTIONS_SUPPORTEDE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdafcc9c672cb31295cf4ba8e76f2790577"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_TRANSACTIONS_SUPPORTED</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo26SQL_TRANSACTIONS_SUPPORTEDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether transactions are supported. </p> |
| <p>If not, invoking the method commit is a noop, and the isolation level is <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlTransactionIsolationLevel.TRANSACTION_NONE</span></code>.</p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if transactions are unsupported;</p></li> |
| <li><p>true: if transactions are supported. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo43SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELSE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo43SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELSE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo43SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELSE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda014f5da493d0ac648028cb95fca74b1f"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo43SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the supported transactions isolation levels, if transactions are supported. </p> |
| <p>Returns an int32 bitmask value representing the supported transactions isolation levels. The returned bitmask should be parsed in order to retrieve the supported transactions isolation levels.</p> |
| <p>For instance:<ul class="simple"> |
| <li><p>return 0 (0b0) => [] (no supported SQL transactions isolation levels);</p></li> |
| <li><p>return 1 (0b1) => [SQL_TRANSACTION_NONE];</p></li> |
| <li><p>return 2 (0b10) => [SQL_TRANSACTION_READ_UNCOMMITTED];</p></li> |
| <li><p>return 3 (0b11) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED];</p></li> |
| <li><p>return 4 (0b100) => [SQL_TRANSACTION_REPEATABLE_READ];</p></li> |
| <li><p>return 5 (0b101) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ];</p></li> |
| <li><p>return 6 (0b110) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];</p></li> |
| <li><p>return 7 (0b111) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];</p></li> |
| <li><p>return 8 (0b1000) => [SQL_TRANSACTION_REPEATABLE_READ];</p></li> |
| <li><p>return 9 (0b1001) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ];</p></li> |
| <li><p>return 10 (0b1010) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];</p></li> |
| <li><p>return 11 (0b1011) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];</p></li> |
| <li><p>return 12 (0b1100) => [SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];</p></li> |
| <li><p>return 13 (0b1101) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];</p></li> |
| <li><p>return 14 (0b1110) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];</p></li> |
| <li><p>return 15 (0b1111) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];</p></li> |
| <li><p>return 16 (0b10000) => [SQL_TRANSACTION_SERIALIZABLE];</p></li> |
| <li><p>…</p></li> |
| </ul> |
| </p> |
| <p>Valid SQL positioned commands are described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlTransactionIsolationLevel</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo45SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMITE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo45SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMITE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo45SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMITE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaf56189688b38f5297433695cfa768e8f"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMIT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo45SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMITE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether a data definition statement within a transaction forces the transaction to commit. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if a data definition statement within a transaction does not force the transaction to commit;</p></li> |
| <li><p>true: if a data definition statement within a transaction forces the transaction to commit. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo44SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNOREDE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo44SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNOREDE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo44SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNOREDE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaf359804ed2b479ffd27226c2adc4f061"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNORED</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo44SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNOREDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether a data definition statement within a transaction is ignored. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if a data definition statement within a transaction is taken into account;</p></li> |
| <li><p>true: a data definition statement within a transaction is ignored. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo30SQL_SUPPORTED_RESULT_SET_TYPESE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo30SQL_SUPPORTED_RESULT_SET_TYPESE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo30SQL_SUPPORTED_RESULT_SET_TYPESE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdafc002fd1b705ea1a07e8c8eb042a0e25"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_RESULT_SET_TYPES</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo30SQL_SUPPORTED_RESULT_SET_TYPESE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves an int32 bitmask value representing the supported result set types. </p> |
| <p>The returned bitmask should be parsed in order to retrieve the supported result set types.</p> |
| <p>For instance:<ul class="simple"> |
| <li><p>return 0 (0b0) => [] (no supported result set types);</p></li> |
| <li><p>return 1 (0b1) => [SQL_RESULT_SET_TYPE_UNSPECIFIED];</p></li> |
| <li><p>return 2 (0b10) => [SQL_RESULT_SET_TYPE_FORWARD_ONLY];</p></li> |
| <li><p>return 3 (0b11) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_FORWARD_ONLY];</p></li> |
| <li><p>return 4 (0b100) => [SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];</p></li> |
| <li><p>return 5 (0b101) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];</p></li> |
| <li><p>return 6 (0b110) => [SQL_RESULT_SET_TYPE_FORWARD_ONLY, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];</p></li> |
| <li><p>return 7 (0b111) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_FORWARD_ONLY, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];</p></li> |
| <li><p>return 8 (0b1000) => [SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE];</p></li> |
| <li><p>…</p></li> |
| </ul> |
| </p> |
| <p>Valid result set types are described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlSupportedResultSetType</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo54SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIEDE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo54SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIEDE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo54SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIEDE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdaa5035a720b6c181a281807e01dde6612"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIED</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo54SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIEDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns an int32 bitmask value representing the concurrency types supported by the server for <code class="docutils literal notranslate"><span class="pre">SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_UNSPECIFIED</span></code>. </p> |
| <p>For instance:<ul class="simple"> |
| <li><p>return 0 (0b0) => [] (no supported concurrency types for this result set type)</p></li> |
| <li><p>return 1 (0b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]</p></li> |
| <li><p>return 2 (0b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</p></li> |
| <li><p>return 3 (0b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</p></li> |
| <li><p>return 4 (0b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| <li><p>return 5 (0b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| <li><p>return 6 (0b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| <li><p>return 7 (0b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| </ul> |
| </p> |
| <p>Valid result set types are described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo55SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLYE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo55SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLYE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo55SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLYE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda463445060902423f095e338d8adb7fe9"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo55SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns an int32 bitmask value representing the concurrency types supported by the server for <code class="docutils literal notranslate"><span class="pre">SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_FORWARD_ONLY</span></code>. </p> |
| <p>For instance:<ul class="simple"> |
| <li><p>return 0 (0b0) => [] (no supported concurrency types for this result set type)</p></li> |
| <li><p>return 1 (0b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]</p></li> |
| <li><p>return 2 (0b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</p></li> |
| <li><p>return 3 (0b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</p></li> |
| <li><p>return 4 (0b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| <li><p>return 5 (0b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| <li><p>return 6 (0b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| <li><p>return 7 (0b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| </ul> |
| </p> |
| <p>Valid result set types are described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo59SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo59SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo59SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda74f42779e796af64b9a0f2d5ac8a8bd3"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo59SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns an int32 bitmask value representing the concurrency types supported by the server for <code class="docutils literal notranslate"><span class="pre">SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE</span></code>. </p> |
| <p>For instance:<ul class="simple"> |
| <li><p>return 0 (0b0) => [] (no supported concurrency types for this result set type)</p></li> |
| <li><p>return 1 (0b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]</p></li> |
| <li><p>return 2 (0b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</p></li> |
| <li><p>return 3 (0b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</p></li> |
| <li><p>return 4 (0b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| <li><p>return 5 (0b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| <li><p>return 6 (0b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| <li><p>return 7 (0b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| </ul> |
| </p> |
| <p>Valid result set types are described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo61SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo61SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo61SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdac390745a33b29b0abb5c7a2e9be4dc2c"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo61SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns an int32 bitmask value representing concurrency types supported by the server for <code class="docutils literal notranslate"><span class="pre">SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE</span></code>. </p> |
| <p>For instance:<ul class="simple"> |
| <li><p>return 0 (0b0) => [] (no supported concurrency types for this result set type)</p></li> |
| <li><p>return 1 (0b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]</p></li> |
| <li><p>return 2 (0b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</p></li> |
| <li><p>return 3 (0b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]</p></li> |
| <li><p>return 4 (0b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| <li><p>return 5 (0b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| <li><p>return 6 (0b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| <li><p>return 7 (0b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]</p></li> |
| </ul> |
| </p> |
| <p>Valid result set types are described under <code class="docutils literal notranslate"><span class="pre">arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency</span></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_BATCH_UPDATES_SUPPORTEDE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_BATCH_UPDATES_SUPPORTEDE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_BATCH_UPDATES_SUPPORTEDE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbdae572875fe73f94f575e410d6e7d1313d"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_BATCH_UPDATES_SUPPORTED</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo27SQL_BATCH_UPDATES_SUPPORTEDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether this database supports batch updates. </p> |
| <div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="o">-</span><span class="w"> </span><span class="nb">false</span><span class="o">:</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="k">this</span><span class="w"> </span><span class="n">database</span><span class="w"> </span><span class="n">does</span><span class="w"> </span><span class="k">not</span><span class="w"> </span><span class="n">support</span><span class="w"> </span><span class="n">batch</span><span class="w"> </span><span class="n">updates</span><span class="p">;</span> |
| <span class="o">-</span><span class="w"> </span><span class="nb">true</span><span class="o">:</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="k">this</span><span class="w"> </span><span class="n">database</span><span class="w"> </span><span class="n">supports</span><span class="w"> </span><span class="n">batch</span><span class="w"> </span><span class="n">updates</span><span class="p">.</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_SAVEPOINTS_SUPPORTEDE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_SAVEPOINTS_SUPPORTEDE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_SAVEPOINTS_SUPPORTEDE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda937e98659324f3a5175fffe485321091"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SAVEPOINTS_SUPPORTED</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_SAVEPOINTS_SUPPORTEDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether this database supports savepoints. </p> |
| <div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="nl">Returns</span><span class="p">:</span> |
| <span class="o">-</span><span class="w"> </span><span class="nb">false</span><span class="o">:</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="k">this</span><span class="w"> </span><span class="n">database</span><span class="w"> </span><span class="n">does</span><span class="w"> </span><span class="k">not</span><span class="w"> </span><span class="n">support</span><span class="w"> </span><span class="n">savepoints</span><span class="p">;</span> |
| <span class="o">-</span><span class="w"> </span><span class="nb">true</span><span class="o">:</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="k">this</span><span class="w"> </span><span class="n">database</span><span class="w"> </span><span class="n">supports</span><span class="w"> </span><span class="n">savepoints</span><span class="p">.</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo30SQL_NAMED_PARAMETERS_SUPPORTEDE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo30SQL_NAMED_PARAMETERS_SUPPORTEDE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo30SQL_NAMED_PARAMETERS_SUPPORTEDE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda45b7292db12be6ccda318ad63ed34f17"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_NAMED_PARAMETERS_SUPPORTED</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo30SQL_NAMED_PARAMETERS_SUPPORTEDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether named parameters are supported in callable statements. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if named parameters in callable statements are unsupported;</p></li> |
| <li><p>true: if named parameters in callable statements are supported. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_LOCATORS_UPDATE_COPYE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_LOCATORS_UPDATE_COPYE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_LOCATORS_UPDATE_COPYE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda49638912f5694d81f5f46d1e3992802b"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_LOCATORS_UPDATE_COPY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo24SQL_LOCATORS_UPDATE_COPYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether updates made to a LOB are made on a copy or directly to the LOB. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if updates made to a LOB are made directly to the LOB;</p></li> |
| <li><p>true: if updates made to a LOB are made on a copy. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo48SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTEDE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions7SqlInfo48SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTEDE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions7SqlInfo48SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTEDE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a51c70cff81c5e2d061541de83e869fbda242d3010fbf080a21b384ad3db60411a"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTED</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions7SqlInfo48SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTEDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a boolean value indicating whether invoking user-defined or vendor functions using the stored procedure escape syntax is supported. </p> |
| <p>Returns:<ul class="simple"> |
| <li><p>false: if invoking user-defined or vendor functions using the stored procedure escape syntax is unsupported;</p></li> |
| <li><p>true: if invoking user-defined or vendor functions using the stored procedure escape syntax is supported. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransactionE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransactionE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransactionE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9dd674e412af32dce7bc24aa0ead737d"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SqlSupportedTransaction</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransactionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The level of support for Flight SQL transaction RPCs. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransaction30SQL_SUPPORTED_TRANSACTION_NONEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransaction30SQL_SUPPORTED_TRANSACTION_NONEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransaction30SQL_SUPPORTED_TRANSACTION_NONEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9dd674e412af32dce7bc24aa0ead737dab40bec739d17048d20ae9dbb6d29a3e8"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_TRANSACTION_NONE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransaction30SQL_SUPPORTED_TRANSACTION_NONEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Unknown/not indicated/no support. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransaction37SQL_SUPPORTED_TRANSACTION_TRANSACTIONE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransaction37SQL_SUPPORTED_TRANSACTION_TRANSACTIONE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransaction37SQL_SUPPORTED_TRANSACTION_TRANSACTIONE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9dd674e412af32dce7bc24aa0ead737da2e3a823c0bc1dd797b30f8529762bfc8"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_TRANSACTION_TRANSACTION</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransaction37SQL_SUPPORTED_TRANSACTION_TRANSACTIONE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Transactions, but not savepoints. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransaction35SQL_SUPPORTED_TRANSACTION_SAVEPOINTE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransaction35SQL_SUPPORTED_TRANSACTION_SAVEPOINTE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransaction35SQL_SUPPORTED_TRANSACTION_SAVEPOINTE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9dd674e412af32dce7bc24aa0ead737da134a4f7fea42aa854cfa8a5314c7e37e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_SUPPORTED_TRANSACTION_SAVEPOINT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions23SqlSupportedTransaction35SQL_SUPPORTED_TRANSACTION_SAVEPOINTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Transactions and savepoints. </p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivityE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivityE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivityE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a2de5c60c3f6bf659e7784f6d07c3cc5e"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SqlSupportedCaseSensitivity</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivityE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Indicate whether something (e.g. an identifier) is case-sensitive. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivity28SQL_CASE_SENSITIVITY_UNKNOWNE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivity28SQL_CASE_SENSITIVITY_UNKNOWNE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivity28SQL_CASE_SENSITIVITY_UNKNOWNE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a2de5c60c3f6bf659e7784f6d07c3cc5eada2064fa3ac569cd14b967cd400a0fec"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CASE_SENSITIVITY_UNKNOWN</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivity28SQL_CASE_SENSITIVITY_UNKNOWNE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivity37SQL_CASE_SENSITIVITY_CASE_INSENSITIVEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivity37SQL_CASE_SENSITIVITY_CASE_INSENSITIVEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivity37SQL_CASE_SENSITIVITY_CASE_INSENSITIVEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a2de5c60c3f6bf659e7784f6d07c3cc5ea6506de364398d33f0ab6b54c07d3434f"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CASE_SENSITIVITY_CASE_INSENSITIVE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivity37SQL_CASE_SENSITIVITY_CASE_INSENSITIVEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivity30SQL_CASE_SENSITIVITY_UPPERCASEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivity30SQL_CASE_SENSITIVITY_UPPERCASEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivity30SQL_CASE_SENSITIVITY_UPPERCASEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a2de5c60c3f6bf659e7784f6d07c3cc5ea6b4382d6df6fba61d2a17999f6742157"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CASE_SENSITIVITY_UPPERCASE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions27SqlSupportedCaseSensitivity30SQL_CASE_SENSITIVITY_UPPERCASEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions15SqlNullOrderingE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions15SqlNullOrderingE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions15SqlNullOrderingE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1aac30a5ca13e41c939f7ce8e444c37539"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SqlNullOrdering</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions15SqlNullOrderingE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Indicate how nulls are sorted. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering21SQL_NULLS_SORTED_HIGHE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering21SQL_NULLS_SORTED_HIGHE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering21SQL_NULLS_SORTED_HIGHE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1aac30a5ca13e41c939f7ce8e444c37539a6da06a4b8e6a1b758891e0302aea657a"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_NULLS_SORTED_HIGH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering21SQL_NULLS_SORTED_HIGHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering20SQL_NULLS_SORTED_LOWE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering20SQL_NULLS_SORTED_LOWE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering20SQL_NULLS_SORTED_LOWE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1aac30a5ca13e41c939f7ce8e444c37539a8ffd91f042fbc6de396c10ff2fc5381a"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_NULLS_SORTED_LOW</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering20SQL_NULLS_SORTED_LOWE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering25SQL_NULLS_SORTED_AT_STARTE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering25SQL_NULLS_SORTED_AT_STARTE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering25SQL_NULLS_SORTED_AT_STARTE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1aac30a5ca13e41c939f7ce8e444c37539a1a29fb3634858f23900fb00a60353e56"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_NULLS_SORTED_AT_START</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering25SQL_NULLS_SORTED_AT_STARTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering23SQL_NULLS_SORTED_AT_ENDE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering23SQL_NULLS_SORTED_AT_ENDE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering23SQL_NULLS_SORTED_AT_ENDE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1aac30a5ca13e41c939f7ce8e444c37539aa29396e456d26be9f43e1161a0368cbc"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_NULLS_SORTED_AT_END</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions15SqlNullOrdering23SQL_NULLS_SORTED_AT_ENDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvertE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvertE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvertE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SqlSupportsConvert</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvertE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Type identifiers used to indicate support for converting between types. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert18SQL_CONVERT_BIGINTE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert18SQL_CONVERT_BIGINTE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert18SQL_CONVERT_BIGINTE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187a89e9282d92add8ecfad19243d1a581d0"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_BIGINT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert18SQL_CONVERT_BIGINTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert18SQL_CONVERT_BINARYE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert18SQL_CONVERT_BINARYE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert18SQL_CONVERT_BINARYE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187a15f47673810cfacc607455fedb04dc62"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_BINARY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert18SQL_CONVERT_BINARYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert15SQL_CONVERT_BITE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert15SQL_CONVERT_BITE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert15SQL_CONVERT_BITE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187aa980713c30fb8e707ed2b2da038ac4dc"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_BIT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert15SQL_CONVERT_BITE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_CHARE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_CHARE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_CHARE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187afda23e8844e4c59375df962b346b7a2a"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_CHAR</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_CHARE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_DATEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_DATEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_DATEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187a6202f90a74c413fd1afaa70409b6e4af"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_DATE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_DATEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_DECIMALE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_DECIMALE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_DECIMALE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187acc5a9d7361420cdaf3fd77b2d88eaff5"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_DECIMAL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_DECIMALE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert17SQL_CONVERT_FLOATE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert17SQL_CONVERT_FLOATE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert17SQL_CONVERT_FLOATE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187af11ef2cf8b669bb85f2e0f686e739d47"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_FLOAT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert17SQL_CONVERT_FLOATE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_INTEGERE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_INTEGERE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_INTEGERE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187a68666d1ca8c665c41b8f2711363379ae"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_INTEGER</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_INTEGERE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert29SQL_CONVERT_INTERVAL_DAY_TIMEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert29SQL_CONVERT_INTERVAL_DAY_TIMEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert29SQL_CONVERT_INTERVAL_DAY_TIMEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187a338830df276d933be530adefbf18f6d0"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_INTERVAL_DAY_TIME</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert29SQL_CONVERT_INTERVAL_DAY_TIMEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert31SQL_CONVERT_INTERVAL_YEAR_MONTHE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert31SQL_CONVERT_INTERVAL_YEAR_MONTHE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert31SQL_CONVERT_INTERVAL_YEAR_MONTHE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187afcdd424a7f0f1ba16952c396473bbba8"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_INTERVAL_YEAR_MONTH</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert31SQL_CONVERT_INTERVAL_YEAR_MONTHE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert25SQL_CONVERT_LONGVARBINARYE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert25SQL_CONVERT_LONGVARBINARYE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert25SQL_CONVERT_LONGVARBINARYE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187a613225e0ca5cf86e6dcdb35b47975777"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_LONGVARBINARY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert25SQL_CONVERT_LONGVARBINARYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert23SQL_CONVERT_LONGVARCHARE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert23SQL_CONVERT_LONGVARCHARE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert23SQL_CONVERT_LONGVARCHARE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187af924a66473d617bb21072c4f4aaf9ec1"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_LONGVARCHAR</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert23SQL_CONVERT_LONGVARCHARE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_NUMERICE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_NUMERICE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_NUMERICE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187a8708f7608004398568d45cdfdfaed2f1"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_NUMERIC</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_NUMERICE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_REALE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_REALE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_REALE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187abf12ff40a7cf50fa1f4f5c94bb0fd34c"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_REAL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_REALE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert20SQL_CONVERT_SMALLINTE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert20SQL_CONVERT_SMALLINTE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert20SQL_CONVERT_SMALLINTE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187a214a693e624ed0b7f215011b6bd2e0c1"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_SMALLINT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert20SQL_CONVERT_SMALLINTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_TIMEE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_TIMEE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_TIMEE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187ae69f33d35674de00f77fee798f5f4f41"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_TIME</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert16SQL_CONVERT_TIMEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert21SQL_CONVERT_TIMESTAMPE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert21SQL_CONVERT_TIMESTAMPE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert21SQL_CONVERT_TIMESTAMPE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187a796a24d6c5bccf88426c4825f927f32e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_TIMESTAMP</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert21SQL_CONVERT_TIMESTAMPE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_TINYINTE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_TINYINTE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_TINYINTE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187a9986d89345a5e8dab3d2fd005ac7902d"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_TINYINT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_TINYINTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert21SQL_CONVERT_VARBINARYE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert21SQL_CONVERT_VARBINARYE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert21SQL_CONVERT_VARBINARYE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187a06fa0684195c2438da6201ebd99027f6"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_VARBINARY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert21SQL_CONVERT_VARBINARYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_VARCHARE"> |
| <span id="_CPPv3N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_VARCHARE"></span><span id="_CPPv2N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_VARCHARE"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_sql_info_options_1a9b2bb60b98ec347eb5d171a055358187a2cf850afd59361ddd93062d264174e69"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SQL_CONVERT_VARCHAR</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14SqlInfoOptions18SqlSupportsConvert19SQL_CONVERT_VARCHARE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql8TableRefE"> |
| <span id="_CPPv3N5arrow6flight3sql8TableRefE"></span><span id="_CPPv2N5arrow6flight3sql8TableRefE"></span><span id="arrow::flight::sql::TableRef"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_table_ref"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TableRef</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql8TableRefE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/types.h></em></div> |
| <p>A SQL table reference, optionally containing table’s catalog and db_schema. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql8TableRef7catalogE"> |
| <span id="_CPPv3N5arrow6flight3sql8TableRef7catalogE"></span><span id="_CPPv2N5arrow6flight3sql8TableRef7catalogE"></span><span id="arrow::flight::sql::TableRef::catalog__std::optional:ss:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_table_ref_1a5dd0ee8ecdd3ca9eb9316989e49975af"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">catalog</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql8TableRef7catalogE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The table’s catalog. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql8TableRef9db_schemaE"> |
| <span id="_CPPv3N5arrow6flight3sql8TableRef9db_schemaE"></span><span id="_CPPv2N5arrow6flight3sql8TableRef9db_schemaE"></span><span id="arrow::flight::sql::TableRef::db_schema__std::optional:ss:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_table_ref_1adc30f1c3f180be02f7a5c5b33b61d02b"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">db_schema</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql8TableRef9db_schemaE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The table’s database schema. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql8TableRef5tableE"> |
| <span id="_CPPv3N5arrow6flight3sql8TableRef5tableE"></span><span id="_CPPv2N5arrow6flight3sql8TableRef5tableE"></span><span id="arrow::flight::sql::TableRef::table__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_table_ref_1ac94f3544c0b2fd4a6daf26f6f7b4c1a4"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">table</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql8TableRef5tableE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The table name. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql13SubstraitPlanE"> |
| <span id="_CPPv3N5arrow6flight3sql13SubstraitPlanE"></span><span id="_CPPv2N5arrow6flight3sql13SubstraitPlanE"></span><span id="arrow::flight::sql::SubstraitPlan"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_substrait_plan"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SubstraitPlan</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql13SubstraitPlanE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/types.h></em></div> |
| <p>A Substrait plan to be executed, along with associated metadata. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql13SubstraitPlan4planE"> |
| <span id="_CPPv3N5arrow6flight3sql13SubstraitPlan4planE"></span><span id="_CPPv2N5arrow6flight3sql13SubstraitPlan4planE"></span><span id="arrow::flight::sql::SubstraitPlan::plan__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_substrait_plan_1a0ad83aaf816cadc035e40fae4bd80c8f"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">plan</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql13SubstraitPlan4planE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The serialized plan. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql13SubstraitPlan7versionE"> |
| <span id="_CPPv3N5arrow6flight3sql13SubstraitPlan7versionE"></span><span id="_CPPv2N5arrow6flight3sql13SubstraitPlan7versionE"></span><span id="arrow::flight::sql::SubstraitPlan::version__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_substrait_plan_1a0d7f5cc9d2ba2b3c5a87bf8be66375ba"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">version</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql13SubstraitPlan7versionE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The Substrait release, e.g. “0.12.0”. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql22TableDefinitionOptionsE"> |
| <span id="_CPPv3N5arrow6flight3sql22TableDefinitionOptionsE"></span><span id="_CPPv2N5arrow6flight3sql22TableDefinitionOptionsE"></span><span id="arrow::flight::sql::TableDefinitionOptions"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_table_definition_options"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TableDefinitionOptions</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql22TableDefinitionOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/types.h></em></div> |
| <p>Options for table definition behavior of bulk ingestion. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql22TableDefinitionOptions12if_not_existE"> |
| <span id="_CPPv3N5arrow6flight3sql22TableDefinitionOptions12if_not_existE"></span><span id="_CPPv2N5arrow6flight3sql22TableDefinitionOptions12if_not_existE"></span><span id="arrow::flight::sql::TableDefinitionOptions::if_not_exist__TableDefinitionOptionsTableNotExistOption"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_table_definition_options_1a5015b9c66db6bbdedff7c3d59c3a6689"></span><a class="reference internal" href="#_CPPv441TableDefinitionOptionsTableNotExistOption" title="TableDefinitionOptionsTableNotExistOption"><span class="n"><span class="pre">TableDefinitionOptionsTableNotExistOption</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">if_not_exist</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql22TableDefinitionOptions12if_not_existE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Behavior when the table does not exist. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql22TableDefinitionOptions9if_existsE"> |
| <span id="_CPPv3N5arrow6flight3sql22TableDefinitionOptions9if_existsE"></span><span id="_CPPv2N5arrow6flight3sql22TableDefinitionOptions9if_existsE"></span><span id="arrow::flight::sql::TableDefinitionOptions::if_exists__TableDefinitionOptionsTableExistsOption"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_table_definition_options_1af57482ee0b0a14b77abc604465de8e61"></span><a class="reference internal" href="#_CPPv439TableDefinitionOptionsTableExistsOption" title="TableDefinitionOptionsTableExistsOption"><span class="n"><span class="pre">TableDefinitionOptionsTableExistsOption</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">if_exists</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql22TableDefinitionOptions9if_existsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Behavior when the table exists. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="client"> |
| <h2>Client<a class="headerlink" href="#client" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClientE"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClientE"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClientE"></span><span id="arrow::flight::sql::FlightSqlClient"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightSqlClient</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClientE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Flight client with Flight SQL semantics. </p> |
| <p>Wraps a Flight client to provide the Flight SQL RPC calls. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient7ExecuteERK17FlightCallOptionsRKNSt6stringERK11Transaction"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient7ExecuteERK17FlightCallOptionsRKNSt6stringERK11Transaction"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient7ExecuteERK17FlightCallOptionsRKNSt6stringERK11Transaction"></span><span id="arrow::flight::sql::FlightSqlClient::Execute__FlightCallOptionsCR.ssCR.TransactionCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a85ed221495ac4a31bd7bc906171e5d96"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Execute</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">query</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Transaction</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">transaction</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">no_transaction</span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient7ExecuteERK17FlightCallOptionsRKNSt6stringERK11Transaction" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute a SQL query on the server. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>query</strong> – <strong>[in]</strong> The UTF8-encoded SQL query to be executed. </p></li> |
| <li><p><strong>transaction</strong> – <strong>[in]</strong> A transaction to associate this query with. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient16ExecuteSubstraitERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient16ExecuteSubstraitERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient16ExecuteSubstraitERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction"></span><span id="arrow::flight::sql::FlightSqlClient::ExecuteSubstrait__FlightCallOptionsCR.SubstraitPlanCR.TransactionCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1abc6482131dc7a21424998ce83217cc82"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ExecuteSubstrait</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql13SubstraitPlanE" title="arrow::flight::sql::SubstraitPlan"><span class="n"><span class="pre">SubstraitPlan</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">plan</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Transaction</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">transaction</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">no_transaction</span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient16ExecuteSubstraitERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute a Substrait plan that returns a result set on the server. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>plan</strong> – <strong>[in]</strong> The plan to be executed. </p></li> |
| <li><p><strong>transaction</strong> – <strong>[in]</strong> A transaction to associate this query with. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient16GetExecuteSchemaERK17FlightCallOptionsRKNSt6stringERK11Transaction"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient16GetExecuteSchemaERK17FlightCallOptionsRKNSt6stringERK11Transaction"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient16GetExecuteSchemaERK17FlightCallOptionsRKNSt6stringERK11Transaction"></span><span id="arrow::flight::sql::FlightSqlClient::GetExecuteSchema__FlightCallOptionsCR.ssCR.TransactionCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a40d99fbe0766c8c8c5d8f2fa4b9f63dd"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetExecuteSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">query</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Transaction</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">transaction</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">no_transaction</span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient16GetExecuteSchemaERK17FlightCallOptionsRKNSt6stringERK11Transaction" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the result set schema from the server. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient25GetExecuteSubstraitSchemaERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient25GetExecuteSubstraitSchemaERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient25GetExecuteSubstraitSchemaERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction"></span><span id="arrow::flight::sql::FlightSqlClient::GetExecuteSubstraitSchema__FlightCallOptionsCR.SubstraitPlanCR.TransactionCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a13f1376c22948728c1824fda8850b941"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetExecuteSubstraitSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql13SubstraitPlanE" title="arrow::flight::sql::SubstraitPlan"><span class="n"><span class="pre">SubstraitPlan</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">plan</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Transaction</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">transaction</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">no_transaction</span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient25GetExecuteSubstraitSchemaERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the result set schema from the server. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient13ExecuteUpdateERK17FlightCallOptionsRKNSt6stringERK11Transaction"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient13ExecuteUpdateERK17FlightCallOptionsRKNSt6stringERK11Transaction"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient13ExecuteUpdateERK17FlightCallOptionsRKNSt6stringERK11Transaction"></span><span id="arrow::flight::sql::FlightSqlClient::ExecuteUpdate__FlightCallOptionsCR.ssCR.TransactionCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1ac8f624379ea848e5c99853e3122795df"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ExecuteUpdate</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">query</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Transaction</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">transaction</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">no_transaction</span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient13ExecuteUpdateERK17FlightCallOptionsRKNSt6stringERK11Transaction" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute an update query on the server. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>query</strong> – <strong>[in]</strong> The UTF8-encoded SQL query to be executed. </p></li> |
| <li><p><strong>transaction</strong> – <strong>[in]</strong> A transaction to associate this query with. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The quantity of rows affected by the operation. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient22ExecuteSubstraitUpdateERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient22ExecuteSubstraitUpdateERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient22ExecuteSubstraitUpdateERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction"></span><span id="arrow::flight::sql::FlightSqlClient::ExecuteSubstraitUpdate__FlightCallOptionsCR.SubstraitPlanCR.TransactionCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1af8b8493fc7f5cb806776bfd30728ba30"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ExecuteSubstraitUpdate</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql13SubstraitPlanE" title="arrow::flight::sql::SubstraitPlan"><span class="n"><span class="pre">SubstraitPlan</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">plan</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Transaction</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">transaction</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">no_transaction</span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient22ExecuteSubstraitUpdateERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute a Substrait plan that does not return a result set on the server. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>plan</strong> – <strong>[in]</strong> The plan to be executed. </p></li> |
| <li><p><strong>transaction</strong> – <strong>[in]</strong> A transaction to associate this query with. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient13ExecuteIngestERK17FlightCallOptionsRKNSt10shared_ptrI17RecordBatchReaderEERK22TableDefinitionOptionsRKNSt6stringERKNSt8optionalINSt6stringEEERKNSt8optionalINSt6stringEEEKbRK11TransactionRKNSt13unordered_mapINSt6stringENSt6stringEEE"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient13ExecuteIngestERK17FlightCallOptionsRKNSt10shared_ptrI17RecordBatchReaderEERK22TableDefinitionOptionsRKNSt6stringERKNSt8optionalINSt6stringEEERKNSt8optionalINSt6stringEEEKbRK11TransactionRKNSt13unordered_mapINSt6stringENSt6stringEEE"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient13ExecuteIngestERK17FlightCallOptionsRKNSt10shared_ptrI17RecordBatchReaderEERK22TableDefinitionOptionsRKNSt6stringERKNSt8optionalINSt6stringEEERKNSt8optionalINSt6stringEEEKbRK11TransactionRKNSt13unordered_mapINSt6stringENSt6stringEEE"></span><span id="arrow::flight::sql::FlightSqlClient::ExecuteIngest__FlightCallOptionsCR.std::shared_ptr:RecordBatchReader:CR.TableDefinitionOptionsCR.ssCR.std::optional:ss:CR.std::optional:ss:CR.bC.TransactionCR.std::unordered_map:ss.ss:CR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a851035520254e00e9c087edf96bc3137"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ExecuteIngest</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow17RecordBatchReaderE" title="arrow::RecordBatchReader"><span class="n"><span class="pre">RecordBatchReader</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">reader</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql22TableDefinitionOptionsE" title="arrow::flight::sql::TableDefinitionOptions"><span class="n"><span class="pre">TableDefinitionOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">table_definition_options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">table</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">schema</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">catalog</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">temporary</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Transaction</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">transaction</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">no_transaction</span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unordered_map</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">ingest_options</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient13ExecuteIngestERK17FlightCallOptionsRKNSt10shared_ptrI17RecordBatchReaderEERK22TableDefinitionOptionsRKNSt6stringERKNSt8optionalINSt6stringEEERKNSt8optionalINSt6stringEEEKbRK11TransactionRKNSt13unordered_mapINSt6stringENSt6stringEEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute a bulk ingestion to the server. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>reader</strong> – <strong>[in]</strong> The records to ingest. </p></li> |
| <li><p><strong>table_definition_options</strong> – <strong>[in]</strong> The behavior for handling the table definition. </p></li> |
| <li><p><strong>table</strong> – <strong>[in]</strong> The destination table to load into. </p></li> |
| <li><p><strong>schema</strong> – <strong>[in]</strong> The DB schema of the destination table. </p></li> |
| <li><p><strong>catalog</strong> – <strong>[in]</strong> The catalog of the destination table. </p></li> |
| <li><p><strong>temporary</strong> – <strong>[in]</strong> Use a temporary table. </p></li> |
| <li><p><strong>transaction</strong> – <strong>[in]</strong> Ingest as part of this transaction. </p></li> |
| <li><p><strong>ingest_options</strong> – <strong>[in]</strong> Additional, backend-specific options. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The number of rows ingested to the server. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient11GetCatalogsERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient11GetCatalogsERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient11GetCatalogsERK17FlightCallOptions"></span><span id="arrow::flight::sql::FlightSqlClient::GetCatalogs__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1aa188f246e974facb1f296f0e85db5144"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetCatalogs</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient11GetCatalogsERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Request a list of catalogs. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient17GetCatalogsSchemaERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient17GetCatalogsSchemaERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient17GetCatalogsSchemaERK17FlightCallOptions"></span><span id="arrow::flight::sql::FlightSqlClient::GetCatalogsSchema__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a5fe5041563ceb1f7736592a28376057d"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetCatalogsSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient17GetCatalogsSchemaERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the catalogs schema from the server (should be identical to <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_sql_schema_1aa34d478c8e48bbc5356c2bcc973a1dec"><span class="std std-ref">SqlSchema::GetCatalogsSchema</span></a>). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient12GetDbSchemasERK17FlightCallOptionsPKNSt6stringEPKNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient12GetDbSchemasERK17FlightCallOptionsPKNSt6stringEPKNSt6stringE"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient12GetDbSchemasERK17FlightCallOptionsPKNSt6stringEPKNSt6stringE"></span><span id="arrow::flight::sql::FlightSqlClient::GetDbSchemas__FlightCallOptionsCR.ssCP.ssCP"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1ad2e580762c227c16290c18ee2f506620"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetDbSchemas</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">catalog</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">db_schema_filter_pattern</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient12GetDbSchemasERK17FlightCallOptionsPKNSt6stringEPKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Request a list of database schemas. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>catalog</strong> – <strong>[in]</strong> The catalog. </p></li> |
| <li><p><strong>db_schema_filter_pattern</strong> – <strong>[in]</strong> The schema filter pattern. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient18GetDbSchemasSchemaERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient18GetDbSchemasSchemaERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient18GetDbSchemasSchemaERK17FlightCallOptions"></span><span id="arrow::flight::sql::FlightSqlClient::GetDbSchemasSchema__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a4183ee7469f30732cae9b32a7c74f047"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetDbSchemasSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient18GetDbSchemasSchemaERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the database schemas schema from the server (should be identical to <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_sql_schema_1abc88d6c61539735528d6649c39bfbd74"><span class="std std-ref">SqlSchema::GetDbSchemasSchema</span></a>). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient5DoGetERK17FlightCallOptionsRK6Ticket"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient5DoGetERK17FlightCallOptionsRK6Ticket"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient5DoGetERK17FlightCallOptionsRK6Ticket"></span><span id="arrow::flight::sql::FlightSqlClient::DoGet__FlightCallOptionsCR.TicketCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1acc77665923c5e67bddb3d9f8a9a7453f"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight18FlightStreamReaderE" title="arrow::flight::FlightStreamReader"><span class="n"><span class="pre">FlightStreamReader</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGet</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight6TicketE" title="arrow::flight::Ticket"><span class="n"><span class="pre">Ticket</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">ticket</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient5DoGetERK17FlightCallOptionsRK6Ticket" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Given a flight ticket and schema, request to be sent the stream. </p> |
| <p>Returns record batch stream reader </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>ticket</strong> – <strong>[in]</strong> The flight ticket to use </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The returned <a class="reference internal" href="table.html#classarrow_1_1_record_batch_reader"><span class="std std-ref">RecordBatchReader</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient9GetTablesERK17FlightCallOptionsPKNSt6stringEPKNSt6stringEPKNSt6stringEbPKNSt6vectorINSt6stringEEE"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient9GetTablesERK17FlightCallOptionsPKNSt6stringEPKNSt6stringEPKNSt6stringEbPKNSt6vectorINSt6stringEEE"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient9GetTablesERK17FlightCallOptionsPKNSt6stringEPKNSt6stringEPKNSt6stringEbPKNSt6vectorINSt6stringEEE"></span><span id="arrow::flight::sql::FlightSqlClient::GetTables__FlightCallOptionsCR.ssCP.ssCP.ssCP.b.std::vector:ss:CP"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a50f13ef85af87734ebacc29ef0083cf9"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetTables</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">catalog</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">db_schema_filter_pattern</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">table_filter_pattern</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">include_schema</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">table_types</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient9GetTablesERK17FlightCallOptionsPKNSt6stringEPKNSt6stringEPKNSt6stringEbPKNSt6vectorINSt6stringEEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Request a list of tables. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>catalog</strong> – <strong>[in]</strong> The catalog. </p></li> |
| <li><p><strong>db_schema_filter_pattern</strong> – <strong>[in]</strong> The schema filter pattern. </p></li> |
| <li><p><strong>table_filter_pattern</strong> – <strong>[in]</strong> The table filter pattern. </p></li> |
| <li><p><strong>include_schema</strong> – <strong>[in]</strong> True to include the schema upon return, false to not include the schema. </p></li> |
| <li><p><strong>table_types</strong> – <strong>[in]</strong> The table types to include. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient15GetTablesSchemaERK17FlightCallOptionsb"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient15GetTablesSchemaERK17FlightCallOptionsb"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient15GetTablesSchemaERK17FlightCallOptionsb"></span><span id="arrow::flight::sql::FlightSqlClient::GetTablesSchema__FlightCallOptionsCR.b"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a506ac878215d7e6ea502f0ac568ce60a"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetTablesSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">include_schema</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient15GetTablesSchemaERK17FlightCallOptionsb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the tables schema from the server (should be identical to <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_sql_schema_1aafc5800779e2d58dda19f739e977d2c9"><span class="std std-ref">SqlSchema::GetTablesSchema</span></a>). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient14GetPrimaryKeysERK17FlightCallOptionsRK8TableRef"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient14GetPrimaryKeysERK17FlightCallOptionsRK8TableRef"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient14GetPrimaryKeysERK17FlightCallOptionsRK8TableRef"></span><span id="arrow::flight::sql::FlightSqlClient::GetPrimaryKeys__FlightCallOptionsCR.TableRefCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a232465ead7a35a9a1ae26006721c1202"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetPrimaryKeys</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql8TableRefE" title="arrow::flight::sql::TableRef"><span class="n"><span class="pre">TableRef</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">table_ref</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient14GetPrimaryKeysERK17FlightCallOptionsRK8TableRef" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Request the primary keys for a table. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>table_ref</strong> – <strong>[in]</strong> The table reference. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient20GetPrimaryKeysSchemaERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient20GetPrimaryKeysSchemaERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient20GetPrimaryKeysSchemaERK17FlightCallOptions"></span><span id="arrow::flight::sql::FlightSqlClient::GetPrimaryKeysSchema__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1ab9a3146c3800ccf60ff76f92162805a1"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetPrimaryKeysSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient20GetPrimaryKeysSchemaERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the primary keys schema from the server (should be identical to <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_sql_schema_1a9fe36d26ef1a00b3d69e2870051af9a4"><span class="std std-ref">SqlSchema::GetPrimaryKeysSchema</span></a>). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient15GetExportedKeysERK17FlightCallOptionsRK8TableRef"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient15GetExportedKeysERK17FlightCallOptionsRK8TableRef"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient15GetExportedKeysERK17FlightCallOptionsRK8TableRef"></span><span id="arrow::flight::sql::FlightSqlClient::GetExportedKeys__FlightCallOptionsCR.TableRefCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a9b9b23052934285875a6b48600301da7"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetExportedKeys</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql8TableRefE" title="arrow::flight::sql::TableRef"><span class="n"><span class="pre">TableRef</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">table_ref</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient15GetExportedKeysERK17FlightCallOptionsRK8TableRef" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a description about the foreign key columns that reference the primary key columns of the given table. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>table_ref</strong> – <strong>[in]</strong> The table reference. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient21GetExportedKeysSchemaERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient21GetExportedKeysSchemaERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient21GetExportedKeysSchemaERK17FlightCallOptions"></span><span id="arrow::flight::sql::FlightSqlClient::GetExportedKeysSchema__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a27dfb73512257437b5df0b0a5a09157d"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetExportedKeysSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient21GetExportedKeysSchemaERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the exported keys schema from the server (should be identical to <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_sql_schema_1ac677d44f2daab913263c03f23123caf3"><span class="std std-ref">SqlSchema::GetExportedKeysSchema</span></a>). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient15GetImportedKeysERK17FlightCallOptionsRK8TableRef"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient15GetImportedKeysERK17FlightCallOptionsRK8TableRef"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient15GetImportedKeysERK17FlightCallOptionsRK8TableRef"></span><span id="arrow::flight::sql::FlightSqlClient::GetImportedKeys__FlightCallOptionsCR.TableRefCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a82c26075a2cc42e3f459acc99eb7b417"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetImportedKeys</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql8TableRefE" title="arrow::flight::sql::TableRef"><span class="n"><span class="pre">TableRef</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">table_ref</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient15GetImportedKeysERK17FlightCallOptionsRK8TableRef" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the foreign key columns for the given table. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>table_ref</strong> – <strong>[in]</strong> The table reference. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient21GetImportedKeysSchemaERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient21GetImportedKeysSchemaERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient21GetImportedKeysSchemaERK17FlightCallOptions"></span><span id="arrow::flight::sql::FlightSqlClient::GetImportedKeysSchema__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1aa8273b89cb7389be026312445ac3e9a1"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetImportedKeysSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient21GetImportedKeysSchemaERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the imported keys schema from the server (should be identical to <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_sql_schema_1a0804bda68ea44f57a0f17738d7451268"><span class="std std-ref">SqlSchema::GetImportedKeysSchema</span></a>). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient17GetCrossReferenceERK17FlightCallOptionsRK8TableRefRK8TableRef"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient17GetCrossReferenceERK17FlightCallOptionsRK8TableRefRK8TableRef"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient17GetCrossReferenceERK17FlightCallOptionsRK8TableRefRK8TableRef"></span><span id="arrow::flight::sql::FlightSqlClient::GetCrossReference__FlightCallOptionsCR.TableRefCR.TableRefCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a0e3946f64e3dbd524666a3386b15a97b"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetCrossReference</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql8TableRefE" title="arrow::flight::sql::TableRef"><span class="n"><span class="pre">TableRef</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">pk_table_ref</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql8TableRefE" title="arrow::flight::sql::TableRef"><span class="n"><span class="pre">TableRef</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">fk_table_ref</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient17GetCrossReferenceERK17FlightCallOptionsRK8TableRefRK8TableRef" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieves a description of the foreign key columns in the given foreign key table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different table). </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>pk_table_ref</strong> – <strong>[in]</strong> The table reference that exports the key. </p></li> |
| <li><p><strong>fk_table_ref</strong> – <strong>[in]</strong> The table reference that imports the key. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient23GetCrossReferenceSchemaERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient23GetCrossReferenceSchemaERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient23GetCrossReferenceSchemaERK17FlightCallOptions"></span><span id="arrow::flight::sql::FlightSqlClient::GetCrossReferenceSchema__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1aee8c1f2077732caac31039c8febd2f56"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetCrossReferenceSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient23GetCrossReferenceSchemaERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the cross reference schema from the server (should be identical to <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_sql_schema_1ad642230ecb235c96e4b8a57b187900e4"><span class="std std-ref">SqlSchema::GetCrossReferenceSchema</span></a>). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient13GetTableTypesERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient13GetTableTypesERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient13GetTableTypesERK17FlightCallOptions"></span><span id="arrow::flight::sql::FlightSqlClient::GetTableTypes__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1af3b29e1ba1a98cc7beb8755c505f2d9b"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetTableTypes</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient13GetTableTypesERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Request a list of table types. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient19GetTableTypesSchemaERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient19GetTableTypesSchemaERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient19GetTableTypesSchemaERK17FlightCallOptions"></span><span id="arrow::flight::sql::FlightSqlClient::GetTableTypesSchema__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a95c123f19e6ed59172cc3ee305f4d25a"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetTableTypesSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient19GetTableTypesSchemaERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the table types schema from the server (should be identical to <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_sql_schema_1a798b30ec4b38dff27965703279c4baf9"><span class="std std-ref">SqlSchema::GetTableTypesSchema</span></a>). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient15GetXdbcTypeInfoERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient15GetXdbcTypeInfoERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient15GetXdbcTypeInfoERK17FlightCallOptions"></span><span id="arrow::flight::sql::FlightSqlClient::GetXdbcTypeInfo__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1aac02355b4eb447daab620bcb80c53bf9"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetXdbcTypeInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient15GetXdbcTypeInfoERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Request the information about all the data types supported. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient15GetXdbcTypeInfoERK17FlightCallOptionsi"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient15GetXdbcTypeInfoERK17FlightCallOptionsi"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient15GetXdbcTypeInfoERK17FlightCallOptionsi"></span><span id="arrow::flight::sql::FlightSqlClient::GetXdbcTypeInfo__FlightCallOptionsCR.i"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a6aeba416dea7481d9be0c4f042dc1d16"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetXdbcTypeInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">data_type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient15GetXdbcTypeInfoERK17FlightCallOptionsi" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Request the information about all the data types supported. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>data_type</strong> – <strong>[in]</strong> The data type to search for as filtering. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient21GetXdbcTypeInfoSchemaERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient21GetXdbcTypeInfoSchemaERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient21GetXdbcTypeInfoSchemaERK17FlightCallOptions"></span><span id="arrow::flight::sql::FlightSqlClient::GetXdbcTypeInfoSchema__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a4c9865260e7e2db12f43e374d94fd552"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetXdbcTypeInfoSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient21GetXdbcTypeInfoSchemaERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the type info schema from the server (should be identical to <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_sql_schema_1a41a6883345024d623829a67fbc3a207e"><span class="std std-ref">SqlSchema::GetXdbcTypeInfoSchema</span></a>). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient10GetSqlInfoERK17FlightCallOptionsRKNSt6vectorIiEE"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient10GetSqlInfoERK17FlightCallOptionsRKNSt6vectorIiEE"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient10GetSqlInfoERK17FlightCallOptionsRKNSt6vectorIiEE"></span><span id="arrow::flight::sql::FlightSqlClient::GetSqlInfo__FlightCallOptionsCR.std::vector:i:CR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a6d340719c2eda91d2f4e61b995b69e54"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSqlInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">sql_info</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient10GetSqlInfoERK17FlightCallOptionsRKNSt6vectorIiEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Request a list of SQL information. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>sql_info</strong> – <strong>[in]</strong> the SQL info required. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient16GetSqlInfoSchemaERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient16GetSqlInfoSchemaERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient16GetSqlInfoSchemaERK17FlightCallOptions"></span><span id="arrow::flight::sql::FlightSqlClient::GetSqlInfoSchema__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a5e92cb863295a19fc6074d54d6f24c5a"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSqlInfoSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient16GetSqlInfoSchemaERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the SQL information schema from the server (should be identical to <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_sql_schema_1a8625ba48271ec11597a19aded56b1714"><span class="std std-ref">SqlSchema::GetSqlInfoSchema</span></a>). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient7PrepareERK17FlightCallOptionsRKNSt6stringERK11Transaction"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient7PrepareERK17FlightCallOptionsRKNSt6stringERK11Transaction"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient7PrepareERK17FlightCallOptionsRKNSt6stringERK11Transaction"></span><span id="arrow::flight::sql::FlightSqlClient::Prepare__FlightCallOptionsCR.ssCR.TransactionCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a974912cf8a9c6622b54e74d9e29c09d7"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql17PreparedStatementE" title="arrow::flight::sql::PreparedStatement"><span class="n"><span class="pre">PreparedStatement</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Prepare</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">query</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Transaction</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">transaction</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">no_transaction</span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient7PrepareERK17FlightCallOptionsRKNSt6stringERK11Transaction" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a prepared statement object. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>query</strong> – <strong>[in]</strong> The query that will be executed. </p></li> |
| <li><p><strong>transaction</strong> – <strong>[in]</strong> A transaction to associate this query with. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The created prepared statement. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient16PrepareSubstraitERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient16PrepareSubstraitERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient16PrepareSubstraitERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction"></span><span id="arrow::flight::sql::FlightSqlClient::PrepareSubstrait__FlightCallOptionsCR.SubstraitPlanCR.TransactionCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1af9beee1ce2cbf03e01371b893afeb1c8"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql17PreparedStatementE" title="arrow::flight::sql::PreparedStatement"><span class="n"><span class="pre">PreparedStatement</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PrepareSubstrait</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql13SubstraitPlanE" title="arrow::flight::sql::SubstraitPlan"><span class="n"><span class="pre">SubstraitPlan</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">plan</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Transaction</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">transaction</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">no_transaction</span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient16PrepareSubstraitERK17FlightCallOptionsRK13SubstraitPlanRK11Transaction" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a prepared statement object. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>plan</strong> – <strong>[in]</strong> The Substrait plan that will be executed. </p></li> |
| <li><p><strong>transaction</strong> – <strong>[in]</strong> A transaction to associate this query with. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The created prepared statement. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient13GetFlightInfoERK17FlightCallOptionsRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient13GetFlightInfoERK17FlightCallOptionsRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient13GetFlightInfoERK17FlightCallOptionsRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlClient::GetFlightInfo__FlightCallOptionsCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a4e5f2565047800b61bdf83e942518d73"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient13GetFlightInfoERK17FlightCallOptionsRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Call the underlying Flight client’s GetFlightInfo. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient9GetSchemaERK17FlightCallOptionsRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient9GetSchemaERK17FlightCallOptionsRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient9GetSchemaERK17FlightCallOptionsRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlClient::GetSchema__FlightCallOptionsCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1aedb71d9ed73d7df30eb5e759eb3a6ff4"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient9GetSchemaERK17FlightCallOptionsRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Call the underlying Flight client’s GetSchema. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient16BeginTransactionERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient16BeginTransactionERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient16BeginTransactionERK17FlightCallOptions"></span><span id="arrow::flight::sql::FlightSqlClient::BeginTransaction__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1ac5a680066b010633eb71693440af52c3"></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Transaction</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BeginTransaction</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient16BeginTransactionERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Begin a new transaction. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient14BeginSavepointERK17FlightCallOptionsRK11TransactionRKNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient14BeginSavepointERK17FlightCallOptionsRK11TransactionRKNSt6stringE"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient14BeginSavepointERK17FlightCallOptionsRK11TransactionRKNSt6stringE"></span><span id="arrow::flight::sql::FlightSqlClient::BeginSavepoint__FlightCallOptionsCR.TransactionCR.ssCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a0dfd9576f280d4aa0b264f46db8ce64f"></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Savepoint</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BeginSavepoint</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Transaction</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">transaction</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient14BeginSavepointERK17FlightCallOptionsRK11TransactionRKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a new savepoint within a transaction. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>transaction</strong> – <strong>[in]</strong> The parent transaction. </p></li> |
| <li><p><strong>name</strong> – <strong>[in]</strong> A friendly name for the savepoint. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient6CommitERK17FlightCallOptionsRK11Transaction"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient6CommitERK17FlightCallOptionsRK11Transaction"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient6CommitERK17FlightCallOptionsRK11Transaction"></span><span id="arrow::flight::sql::FlightSqlClient::Commit__FlightCallOptionsCR.TransactionCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a5c49f27db053ba04ba0dbd76f6990320"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Commit</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Transaction</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">transaction</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient6CommitERK17FlightCallOptionsRK11Transaction" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Commit a transaction. </p> |
| <p>After this, the transaction and all associated savepoints will be invalidated.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>transaction</strong> – <strong>[in]</strong> The transaction. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient7ReleaseERK17FlightCallOptionsRK9Savepoint"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient7ReleaseERK17FlightCallOptionsRK9Savepoint"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient7ReleaseERK17FlightCallOptionsRK9Savepoint"></span><span id="arrow::flight::sql::FlightSqlClient::Release__FlightCallOptionsCR.SavepointCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1ae88ec480f2c093fe172d0e35c0acada7"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Release</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Savepoint</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">savepoint</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient7ReleaseERK17FlightCallOptionsRK9Savepoint" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Release a savepoint. </p> |
| <p>After this, the savepoint (and all savepoints created after it) will be invalidated.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>savepoint</strong> – <strong>[in]</strong> The savepoint. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient8RollbackERK17FlightCallOptionsRK11Transaction"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient8RollbackERK17FlightCallOptionsRK11Transaction"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient8RollbackERK17FlightCallOptionsRK11Transaction"></span><span id="arrow::flight::sql::FlightSqlClient::Rollback__FlightCallOptionsCR.TransactionCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a1ea5401e7faadfa57d2130cd4ecd75f6"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Rollback</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Transaction</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">transaction</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient8RollbackERK17FlightCallOptionsRK11Transaction" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Rollback a transaction. </p> |
| <p>After this, the transaction and all associated savepoints will be invalidated.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>transaction</strong> – <strong>[in]</strong> The transaction. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient8RollbackERK17FlightCallOptionsRK9Savepoint"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient8RollbackERK17FlightCallOptionsRK9Savepoint"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient8RollbackERK17FlightCallOptionsRK9Savepoint"></span><span id="arrow::flight::sql::FlightSqlClient::Rollback__FlightCallOptionsCR.SavepointCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1ac60de07af58b662313d136de7ad8d0af"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Rollback</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">Savepoint</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">savepoint</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient8RollbackERK17FlightCallOptionsRK9Savepoint" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Rollback a savepoint. </p> |
| <p>After this, the savepoint will still be valid, but all savepoints created after it will be invalidated.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>savepoint</strong> – <strong>[in]</strong> The savepoint. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient16CancelFlightInfoERK17FlightCallOptionsRK23CancelFlightInfoRequest"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient16CancelFlightInfoERK17FlightCallOptionsRK23CancelFlightInfoRequest"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient16CancelFlightInfoERK17FlightCallOptionsRK23CancelFlightInfoRequest"></span><span id="arrow::flight::sql::FlightSqlClient::CancelFlightInfo__FlightCallOptionsCR.CancelFlightInfoRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a61062fb1ef920a272934387197833cbf"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">CancelFlightInfoResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CancelFlightInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">CancelFlightInfoRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient16CancelFlightInfoERK17FlightCallOptionsRK23CancelFlightInfoRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Explicitly cancel a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a>. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The CancelFlightInfoRequest. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with a canceled result. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient11CancelQueryERK17FlightCallOptionsRK10FlightInfo"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient11CancelQueryERK17FlightCallOptionsRK10FlightInfo"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient11CancelQueryERK17FlightCallOptionsRK10FlightInfo"></span><span id="arrow::flight::sql::FlightSqlClient::CancelQuery__FlightCallOptionsCR.FlightInfoCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a41c68035941948a25ae59d2355cbfce4"></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv412CancelResult" title="CancelResult"><span class="n"><span class="pre">CancelResult</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CancelQuery</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">info</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient11CancelQueryERK17FlightCallOptionsRK10FlightInfo" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Explicitly cancel a query. </p> |
| <p><dl> |
| <dt class="sig sig-object cpp"> |
| <em><span class="pre">Deprecated:</span></em></dt> |
| <dd><p>Deprecated since 13.0.0. Use <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a61062fb1ef920a272934387197833cbf"><span class="std std-ref">CancelFlightInfo()</span></a> instead. If you can assume that a server requires 13.0.0 or later, you can always use <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a61062fb1ef920a272934387197833cbf"><span class="std std-ref">CancelFlightInfo()</span></a>. Otherwise, you may need to use <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a41c68035941948a25ae59d2355cbfce4"><span class="std std-ref">CancelQuery()</span></a> and/or <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a61062fb1ef920a272934387197833cbf"><span class="std std-ref">CancelFlightInfo()</span></a>. </p> |
| </dd></dl> |
| |
| </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>info</strong> – <strong>[in]</strong> The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> of the query to cancel.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient17SetSessionOptionsERK17FlightCallOptionsRK24SetSessionOptionsRequest"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient17SetSessionOptionsERK17FlightCallOptionsRK24SetSessionOptionsRequest"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient17SetSessionOptionsERK17FlightCallOptionsRK24SetSessionOptionsRequest"></span><span id="arrow::flight::sql::FlightSqlClient::SetSessionOptions__FlightCallOptionsCR.SetSessionOptionsRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1ab681418ddbb9ba2ca3a96f2df1e3cabe"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SetSessionOptionsResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SetSessionOptions</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">SetSessionOptionsRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient17SetSessionOptionsERK17FlightCallOptionsRK24SetSessionOptionsRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Sets session options. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The session options to set. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient17GetSessionOptionsERK17FlightCallOptionsRK24GetSessionOptionsRequest"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient17GetSessionOptionsERK17FlightCallOptionsRK24GetSessionOptionsRequest"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient17GetSessionOptionsERK17FlightCallOptionsRK24GetSessionOptionsRequest"></span><span id="arrow::flight::sql::FlightSqlClient::GetSessionOptions__FlightCallOptionsCR.GetSessionOptionsRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a28bbb9ecd188af5c5ab48a62c481a415"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">GetSessionOptionsResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSessionOptions</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">GetSessionOptionsRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient17GetSessionOptionsERK17FlightCallOptionsRK24GetSessionOptionsRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Gets current session options. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The (empty) GetSessionOptions request object. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient12CloseSessionERK17FlightCallOptionsRK19CloseSessionRequest"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient12CloseSessionERK17FlightCallOptionsRK19CloseSessionRequest"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient12CloseSessionERK17FlightCallOptionsRK19CloseSessionRequest"></span><span id="arrow::flight::sql::FlightSqlClient::CloseSession__FlightCallOptionsCR.CloseSessionRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1aef737d4646f74be54424db1381cd4970"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">CloseSessionResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CloseSession</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">CloseSessionRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient12CloseSessionERK17FlightCallOptionsRK19CloseSessionRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Explicitly closes the session if applicable. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The (empty) CloseSession request object. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient19RenewFlightEndpointERK17FlightCallOptionsRK26RenewFlightEndpointRequest"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient19RenewFlightEndpointERK17FlightCallOptionsRK26RenewFlightEndpointRequest"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient19RenewFlightEndpointERK17FlightCallOptionsRK26RenewFlightEndpointRequest"></span><span id="arrow::flight::sql::FlightSqlClient::RenewFlightEndpoint__FlightCallOptionsCR.RenewFlightEndpointRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1ac674d6e39cdb73c646a8763deaee01f6"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight14FlightEndpointE" title="arrow::flight::FlightEndpoint"><span class="n"><span class="pre">FlightEndpoint</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">RenewFlightEndpoint</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">RenewFlightEndpointRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient19RenewFlightEndpointERK17FlightCallOptionsRK26RenewFlightEndpointRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Extends the expiration of a <a class="reference internal" href="flight.html#structarrow_1_1flight_1_1_flight_endpoint"><span class="std std-ref">FlightEndpoint</span></a>. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> RPC-layer hints for this call. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The RenewFlightEndpointRequest. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Arrow result with a renewed <a class="reference internal" href="flight.html#structarrow_1_1flight_1_1_flight_endpoint"><span class="std std-ref">FlightEndpoint</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15FlightSqlClient5CloseEv"> |
| <span id="_CPPv3N5arrow6flight3sql15FlightSqlClient5CloseEv"></span><span id="_CPPv2N5arrow6flight3sql15FlightSqlClient5CloseEv"></span><span id="arrow::flight::sql::FlightSqlClient::Close"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a641d406439c4007d23118be2e63c87c0"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Close</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15FlightSqlClient5CloseEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Explicitly shut down and clean up the client. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql17PreparedStatementE"> |
| <span id="_CPPv3N5arrow6flight3sql17PreparedStatementE"></span><span id="_CPPv2N5arrow6flight3sql17PreparedStatementE"></span><span id="arrow::flight::sql::PreparedStatement"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_prepared_statement"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PreparedStatement</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql17PreparedStatementE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A prepared statement that can be executed. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql17PreparedStatement17PreparedStatementEP15FlightSqlClientNSt6stringENSt10shared_ptrI6SchemaEENSt10shared_ptrI6SchemaEE"> |
| <span id="_CPPv3N5arrow6flight3sql17PreparedStatement17PreparedStatementEP15FlightSqlClientNSt6stringENSt10shared_ptrI6SchemaEENSt10shared_ptrI6SchemaEE"></span><span id="_CPPv2N5arrow6flight3sql17PreparedStatement17PreparedStatementEP15FlightSqlClientNSt6stringENSt10shared_ptrI6SchemaEENSt10shared_ptrI6SchemaEE"></span><span id="arrow::flight::sql::PreparedStatement::PreparedStatement__FlightSqlClientP.ss.std::shared_ptr:Schema:.std::shared_ptr:Schema:"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_prepared_statement_1aa060008f4d49e4ecef02e5655718076c"></span><span class="sig-name descname"><span class="n"><span class="pre">PreparedStatement</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql15FlightSqlClientE" title="arrow::flight::sql::FlightSqlClient"><span class="n"><span class="pre">FlightSqlClient</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">client</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">handle</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">dataset_schema</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">parameter_schema</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql17PreparedStatement17PreparedStatementEP15FlightSqlClientNSt6stringENSt10shared_ptrI6SchemaEENSt10shared_ptrI6SchemaEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a new prepared statement. </p> |
| <p>However, applications should generally use <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_flight_sql_client_1a974912cf8a9c6622b54e74d9e29c09d7"><span class="std std-ref">FlightSqlClient::Prepare</span></a>.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>client</strong> – <strong>[in]</strong> Client object used to make the RPC requests. </p></li> |
| <li><p><strong>handle</strong> – <strong>[in]</strong> Handle for this prepared statement. </p></li> |
| <li><p><strong>dataset_schema</strong> – <strong>[in]</strong> <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> of the resulting dataset. </p></li> |
| <li><p><strong>parameter_schema</strong> – <strong>[in]</strong> <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> of the parameters (if any). </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql17PreparedStatementD0Ev"> |
| <span id="_CPPv3N5arrow6flight3sql17PreparedStatementD0Ev"></span><span id="_CPPv2N5arrow6flight3sql17PreparedStatementD0Ev"></span><span id="arrow::flight::sql::PreparedStatement::~PreparedStatement"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_prepared_statement_1a41cc8525c61c0dbe80dc46febb1d0127"></span><span class="sig-name descname"><span class="n"><span class="pre">~PreparedStatement</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql17PreparedStatementD0Ev" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Default destructor for the <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_prepared_statement"><span class="std std-ref">PreparedStatement</span></a> class. </p> |
| <p>The destructor will call the Close method from the class in order, to send a request to close the <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_prepared_statement"><span class="std std-ref">PreparedStatement</span></a>. NOTE: It is best to explicitly close the <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_prepared_statement"><span class="std std-ref">PreparedStatement</span></a>, otherwise errors can’t be caught. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql17PreparedStatement7ExecuteERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql17PreparedStatement7ExecuteERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql17PreparedStatement7ExecuteERK17FlightCallOptions"></span><span id="arrow::flight::sql::PreparedStatement::Execute__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_prepared_statement_1a8d703e8b3a40bcd98758a381d40eb81f"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Execute</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql17PreparedStatement7ExecuteERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Executes the prepared statement query on the server. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> object representing the stream(s) to fetch. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql17PreparedStatement13ExecuteUpdateERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql17PreparedStatement13ExecuteUpdateERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql17PreparedStatement13ExecuteUpdateERK17FlightCallOptions"></span><span id="arrow::flight::sql::PreparedStatement::ExecuteUpdate__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_prepared_statement_1a44a5202daa2f486bcc8ab6af56af7a53"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ExecuteUpdate</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql17PreparedStatement13ExecuteUpdateERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Executes the prepared statement update query on the server. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The number of rows affected. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight3sql17PreparedStatement16parameter_schemaEv"> |
| <span id="_CPPv3NK5arrow6flight3sql17PreparedStatement16parameter_schemaEv"></span><span id="_CPPv2NK5arrow6flight3sql17PreparedStatement16parameter_schemaEv"></span><span id="arrow::flight::sql::PreparedStatement::parameter_schemaC"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_prepared_statement_1a71293dcfdf6f9c48f4988f9f35145b7a"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">parameter_schema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight3sql17PreparedStatement16parameter_schemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the parameter schema from the query. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The parameter schema from the query. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight3sql17PreparedStatement14dataset_schemaEv"> |
| <span id="_CPPv3NK5arrow6flight3sql17PreparedStatement14dataset_schemaEv"></span><span id="_CPPv2NK5arrow6flight3sql17PreparedStatement14dataset_schemaEv"></span><span id="arrow::flight::sql::PreparedStatement::dataset_schemaC"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_prepared_statement_1a83d9ba47cc0339c045109f218d4446c4"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">dataset_schema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight3sql17PreparedStatement14dataset_schemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the ResultSet schema from the query. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The ResultSet schema from the query. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql17PreparedStatement13SetParametersENSt10shared_ptrI11RecordBatchEE"> |
| <span id="_CPPv3N5arrow6flight3sql17PreparedStatement13SetParametersENSt10shared_ptrI11RecordBatchEE"></span><span id="_CPPv2N5arrow6flight3sql17PreparedStatement13SetParametersENSt10shared_ptrI11RecordBatchEE"></span><span id="arrow::flight::sql::PreparedStatement::SetParameters__std::shared_ptr:RecordBatch:"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_prepared_statement_1a01b0a4cb52e17aad5639253176ca4f34"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SetParameters</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow11RecordBatchE" title="arrow::RecordBatch"><span class="n"><span class="pre">RecordBatch</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">parameter_binding</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql17PreparedStatement13SetParametersENSt10shared_ptrI11RecordBatchEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Set a <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a> that contains the parameters that will be bound. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql17PreparedStatement13SetParametersENSt10shared_ptrI17RecordBatchReaderEE"> |
| <span id="_CPPv3N5arrow6flight3sql17PreparedStatement13SetParametersENSt10shared_ptrI17RecordBatchReaderEE"></span><span id="_CPPv2N5arrow6flight3sql17PreparedStatement13SetParametersENSt10shared_ptrI17RecordBatchReaderEE"></span><span id="arrow::flight::sql::PreparedStatement::SetParameters__std::shared_ptr:RecordBatchReader:"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_prepared_statement_1ab358bbb1a5cb9426403102407f5c7db8"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SetParameters</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow17RecordBatchReaderE" title="arrow::RecordBatchReader"><span class="n"><span class="pre">RecordBatchReader</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">parameter_binding</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql17PreparedStatement13SetParametersENSt10shared_ptrI17RecordBatchReaderEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Set a <a class="reference internal" href="table.html#classarrow_1_1_record_batch_reader"><span class="std std-ref">RecordBatchReader</span></a> that contains the parameters that will be bound. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql17PreparedStatement9GetSchemaERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql17PreparedStatement9GetSchemaERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql17PreparedStatement9GetSchemaERK17FlightCallOptions"></span><span id="arrow::flight::sql::PreparedStatement::GetSchema__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_prepared_statement_1a2c4329aac7d84bf5b5063bfc1177856a"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql17PreparedStatement9GetSchemaERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Re-request the result set schema from the server (should be identical to dataset_schema). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql17PreparedStatement5CloseERK17FlightCallOptions"> |
| <span id="_CPPv3N5arrow6flight3sql17PreparedStatement5CloseERK17FlightCallOptions"></span><span id="_CPPv2N5arrow6flight3sql17PreparedStatement5CloseERK17FlightCallOptions"></span><span id="arrow::flight::sql::PreparedStatement::Close__FlightCallOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_prepared_statement_1a1e15e5e395045afa34c525aa7a9495e0"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Close</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17FlightCallOptionsE" title="arrow::flight::FlightCallOptions"><span class="n"><span class="pre">FlightCallOptions</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql17PreparedStatement5CloseERK17FlightCallOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Close the prepared statement so the server can free up any resources. </p> |
| <p>After this, the prepared statement may not be used anymore. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight3sql17PreparedStatement8IsClosedEv"> |
| <span id="_CPPv3NK5arrow6flight3sql17PreparedStatement8IsClosedEv"></span><span id="_CPPv2NK5arrow6flight3sql17PreparedStatement8IsClosedEv"></span><span id="arrow::flight::sql::PreparedStatement::IsClosedC"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_prepared_statement_1a3bfb54b1963cfe925cc9ce62bd13b829"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsClosed</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight3sql17PreparedStatement8IsClosedEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Check if the prepared statement is closed. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The state of the prepared statement. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql17PreparedStatement13ParseResponseEP15FlightSqlClientNSt10unique_ptrI12ResultStreamEE"> |
| <span id="_CPPv3N5arrow6flight3sql17PreparedStatement13ParseResponseEP15FlightSqlClientNSt10unique_ptrI12ResultStreamEE"></span><span id="_CPPv2N5arrow6flight3sql17PreparedStatement13ParseResponseEP15FlightSqlClientNSt10unique_ptrI12ResultStreamEE"></span><span id="arrow::flight::sql::PreparedStatement::ParseResponse__FlightSqlClientP.std::unique_ptr:ResultStream:"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_prepared_statement_1ae2f5c73e1e3dc06184f3dcc7b70e088e"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql17PreparedStatementE" title="arrow::flight::sql::PreparedStatement"><span class="n"><span class="pre">PreparedStatement</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ParseResponse</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql15FlightSqlClientE" title="arrow::flight::sql::FlightSqlClient"><span class="n"><span class="pre">FlightSqlClient</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">client</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight12ResultStreamE" title="arrow::flight::ResultStream"><span class="n"><span class="pre">ResultStream</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">results</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql17PreparedStatement13ParseResponseEP15FlightSqlClientNSt10unique_ptrI12ResultStreamEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_prepared_statement"><span class="std std-ref">PreparedStatement</span></a> by parsing the server response. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| <section id="server"> |
| <h2>Server<a class="headerlink" href="#server" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBaseE"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBaseE"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBaseE"></span><span id="arrow::flight::sql::FlightSqlServerBase"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FlightSqlServerBase</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">flight</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightServerBaseE" title="arrow::flight::FlightServerBase"><span class="n"><span class="pre">FlightServerBase</span></span></a><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBaseE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The base class for Flight SQL servers. </p> |
| <p>Applications should subclass this class and override the virtual methods declared on this class. </p> |
| <p>Subclassed by arrow::flight::sql::example::SQLiteFlightSqlServer</p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-flight-rpc-handlers">Flight RPC handlers</p> |
| <p>Applications should not override these methods; they implement the Flight SQL protocol. </p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase13GetFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase13GetFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase13GetFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfo__ServerCallContextCR.FlightDescriptorCR.std::unique_ptr:FlightInfo:P"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a1f4d503b3a557335d7405d3d734684fc"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">info</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase13GetFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the schema and an access plan for the indicated descriptor. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> the dataset request, whether a named dataset or command </p></li> |
| <li><p><strong>info</strong> – <strong>[out]</strong> the returned flight info provider </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase9GetSchemaERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase9GetSchemaERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase9GetSchemaERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetSchema__ServerCallContextCR.FlightDescriptorCR.std::unique_ptr:SchemaResult:P"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a6a415aa98c39f3bdbd6de1b7e57773b3"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">schema</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase9GetSchemaERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the schema for the indicated descriptor. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> the dataset request, whether a named dataset or command </p></li> |
| <li><p><strong>schema</strong> – <strong>[out]</strong> the returned flight schema provider </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase5DoGetERK17ServerCallContextRK6TicketPNSt10unique_ptrI16FlightDataStreamEE"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase5DoGetERK17ServerCallContextRK6TicketPNSt10unique_ptrI16FlightDataStreamEE"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase5DoGetERK17ServerCallContextRK6TicketPNSt10unique_ptrI16FlightDataStreamEE"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoGet__ServerCallContextCR.TicketCR.std::unique_ptr:FlightDataStream:P"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1acae682f1c4ae1478bc8a6fe6e4234245"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGet</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight6TicketE" title="arrow::flight::Ticket"><span class="n"><span class="pre">Ticket</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">stream</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase5DoGetERK17ServerCallContextRK6TicketPNSt10unique_ptrI16FlightDataStreamEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a stream of IPC payloads to put on the wire. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> an opaque ticket </p></li> |
| <li><p><strong>stream</strong> – <strong>[out]</strong> the returned stream provider </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase5DoPutERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI20FlightMetadataWriterEE"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase5DoPutERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI20FlightMetadataWriterEE"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase5DoPutERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI20FlightMetadataWriterEE"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoPut__ServerCallContextCR.std::unique_ptr:FlightMessageReader:.std::unique_ptr:FlightMetadataWriter:"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a26499726844e4d7384959cf57e36181b"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoPut</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight19FlightMessageReaderE" title="arrow::flight::FlightMessageReader"><span class="n"><span class="pre">FlightMessageReader</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">reader</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight20FlightMetadataWriterE" title="arrow::flight::FlightMetadataWriter"><span class="n"><span class="pre">FlightMetadataWriter</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">writer</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase5DoPutERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI20FlightMetadataWriterEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Process a stream of IPC payloads sent from a client. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>reader</strong> – <strong>[in]</strong> a sequence of uploaded record batches </p></li> |
| <li><p><strong>writer</strong> – <strong>[in]</strong> send metadata back to the client </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase11ListActionsERK17ServerCallContextPNSt6vectorI10ActionTypeEE"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase11ListActionsERK17ServerCallContextPNSt6vectorI10ActionTypeEE"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase11ListActionsERK17ServerCallContextPNSt6vectorI10ActionTypeEE"></span><span id="arrow::flight::sql::FlightSqlServerBase::ListActions__ServerCallContextCR.std::vector:ActionType:P"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a76ba2299017b6cf51a25734ccb19d869"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ListActions</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10ActionTypeE" title="arrow::flight::ActionType"><span class="n"><span class="pre">ActionType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">actions</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase11ListActionsERK17ServerCallContextPNSt6vectorI10ActionTypeEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the list of available actions. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>actions</strong> – <strong>[out]</strong> a vector of available action types </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase8DoActionERK17ServerCallContextRK6ActionPNSt10unique_ptrI12ResultStreamEE"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase8DoActionERK17ServerCallContextRK6ActionPNSt10unique_ptrI12ResultStreamEE"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase8DoActionERK17ServerCallContextRK6ActionPNSt10unique_ptrI12ResultStreamEE"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoAction__ServerCallContextCR.ActionCR.std::unique_ptr:ResultStream:P"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1ae0107f515185a0b99bda6d75e3a8c5aa"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoAction</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight6ActionE" title="arrow::flight::Action"><span class="n"><span class="pre">Action</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">action</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight12ResultStreamE" title="arrow::flight::ResultStream"><span class="n"><span class="pre">ResultStream</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">result</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase8DoActionERK17ServerCallContextRK6ActionPNSt10unique_ptrI12ResultStreamEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute an action, return stream of zero or more results. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>action</strong> – <strong>[in]</strong> the action to execute, with type and body </p></li> |
| <li><p><strong>result</strong> – <strong>[out]</strong> the result iterator </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-flight-sql-methods">Flight SQL methods</p> |
| <p>Applications should override these methods to implement the Flight SQL endpoints. </p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase22GetFlightInfoStatementERK17ServerCallContextRK14StatementQueryRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase22GetFlightInfoStatementERK17ServerCallContextRK14StatementQueryRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase22GetFlightInfoStatementERK17ServerCallContextRK14StatementQueryRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfoStatement__ServerCallContextCR.StatementQueryCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a6e24d9aaeaa9c8e7a968d15bc199c8de"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoStatement</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql14StatementQueryE" title="arrow::flight::sql::StatementQuery"><span class="n"><span class="pre">StatementQuery</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase22GetFlightInfoStatementERK17ServerCallContextRK14StatementQueryRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> for executing a SQL query. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_statement_query"><span class="std std-ref">StatementQuery</span></a> object containing the SQL statement. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase26GetFlightInfoSubstraitPlanERK17ServerCallContextRK22StatementSubstraitPlanRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase26GetFlightInfoSubstraitPlanERK17ServerCallContextRK22StatementSubstraitPlanRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase26GetFlightInfoSubstraitPlanERK17ServerCallContextRK22StatementSubstraitPlanRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfoSubstraitPlan__ServerCallContextCR.StatementSubstraitPlanCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a3cfcbae20b59b7a52415ce1d351e2429"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoSubstraitPlan</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql22StatementSubstraitPlanE" title="arrow::flight::sql::StatementSubstraitPlan"><span class="n"><span class="pre">StatementSubstraitPlan</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase26GetFlightInfoSubstraitPlanERK17ServerCallContextRK22StatementSubstraitPlanRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> for executing a Substrait plan. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_statement_substrait_plan"><span class="std std-ref">StatementSubstraitPlan</span></a> object containing the plan. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase14DoGetStatementERK17ServerCallContextRK20StatementQueryTicket"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase14DoGetStatementERK17ServerCallContextRK20StatementQueryTicket"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase14DoGetStatementERK17ServerCallContextRK20StatementQueryTicket"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoGetStatement__ServerCallContextCR.StatementQueryTicketCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a1107f422d252b99018dc052b1682c6c0"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGetStatement</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql20StatementQueryTicketE" title="arrow::flight::sql::StatementQueryTicket"><span class="n"><span class="pre">StatementQueryTicket</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase14DoGetStatementERK17ServerCallContextRK20StatementQueryTicket" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the query results. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_statement_query_ticket"><span class="std std-ref">StatementQueryTicket</span></a> containing the statement handle. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the results. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase30GetFlightInfoPreparedStatementERK17ServerCallContextRK22PreparedStatementQueryRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase30GetFlightInfoPreparedStatementERK17ServerCallContextRK22PreparedStatementQueryRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase30GetFlightInfoPreparedStatementERK17ServerCallContextRK22PreparedStatementQueryRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfoPreparedStatement__ServerCallContextCR.PreparedStatementQueryCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1af5c2025c151abaaa25f5e0ceb503ac55"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoPreparedStatement</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql22PreparedStatementQueryE" title="arrow::flight::sql::PreparedStatementQuery"><span class="n"><span class="pre">PreparedStatementQuery</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase30GetFlightInfoPreparedStatementERK17ServerCallContextRK22PreparedStatementQueryRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> for executing an already created prepared statement. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_prepared_statement_query"><span class="std std-ref">PreparedStatementQuery</span></a> object containing the prepared statement handle. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase22DoGetPreparedStatementERK17ServerCallContextRK22PreparedStatementQuery"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase22DoGetPreparedStatementERK17ServerCallContextRK22PreparedStatementQuery"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase22DoGetPreparedStatementERK17ServerCallContextRK22PreparedStatementQuery"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoGetPreparedStatement__ServerCallContextCR.PreparedStatementQueryCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a5a758030857a80e1d8755587e06ee447"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGetPreparedStatement</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql22PreparedStatementQueryE" title="arrow::flight::sql::PreparedStatementQuery"><span class="n"><span class="pre">PreparedStatementQuery</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase22DoGetPreparedStatementERK17ServerCallContextRK22PreparedStatementQuery" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the prepared statement query results. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_prepared_statement_query"><span class="std std-ref">PreparedStatementQuery</span></a> object containing the prepared statement handle. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the results. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase21GetFlightInfoCatalogsERK17ServerCallContextRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase21GetFlightInfoCatalogsERK17ServerCallContextRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase21GetFlightInfoCatalogsERK17ServerCallContextRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfoCatalogs__ServerCallContextCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1aa84e3033665e98d3a9d6ce04af4d53e4"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoCatalogs</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase21GetFlightInfoCatalogsERK17ServerCallContextRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> for listing catalogs. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase18GetSchemaStatementERK17ServerCallContextRK14StatementQueryRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase18GetSchemaStatementERK17ServerCallContextRK14StatementQueryRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase18GetSchemaStatementERK17ServerCallContextRK14StatementQueryRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetSchemaStatement__ServerCallContextCR.StatementQueryCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a6b47a3c4653208b252469b49626a9e5e"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchemaStatement</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql14StatementQueryE" title="arrow::flight::sql::StatementQuery"><span class="n"><span class="pre">StatementQuery</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase18GetSchemaStatementERK17ServerCallContextRK14StatementQueryRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the schema of the result set of a query. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_statement_query"><span class="std std-ref">StatementQuery</span></a> containing the SQL query. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The schema of the result set. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase22GetSchemaSubstraitPlanERK17ServerCallContextRK22StatementSubstraitPlanRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase22GetSchemaSubstraitPlanERK17ServerCallContextRK22StatementSubstraitPlanRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase22GetSchemaSubstraitPlanERK17ServerCallContextRK22StatementSubstraitPlanRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetSchemaSubstraitPlan__ServerCallContextCR.StatementSubstraitPlanCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a3e47d78e53492f3760791eaa843d18eb"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchemaSubstraitPlan</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql22StatementSubstraitPlanE" title="arrow::flight::sql::StatementSubstraitPlan"><span class="n"><span class="pre">StatementSubstraitPlan</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase22GetSchemaSubstraitPlanERK17ServerCallContextRK22StatementSubstraitPlanRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the schema of the result set of a Substrait plan. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_statement_query"><span class="std std-ref">StatementQuery</span></a> containing the plan. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The schema of the result set. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase26GetSchemaPreparedStatementERK17ServerCallContextRK22PreparedStatementQueryRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase26GetSchemaPreparedStatementERK17ServerCallContextRK22PreparedStatementQueryRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase26GetSchemaPreparedStatementERK17ServerCallContextRK22PreparedStatementQueryRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetSchemaPreparedStatement__ServerCallContextCR.PreparedStatementQueryCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1ab8ccc9eae496a659639a94d6ad3008a8"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SchemaResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSchemaPreparedStatement</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql22PreparedStatementQueryE" title="arrow::flight::sql::PreparedStatementQuery"><span class="n"><span class="pre">PreparedStatementQuery</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase26GetSchemaPreparedStatementERK17ServerCallContextRK22PreparedStatementQueryRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the schema of the result set of a prepared statement. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_prepared_statement_query"><span class="std std-ref">PreparedStatementQuery</span></a> containing the prepared statement handle. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The schema of the result set. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase13DoGetCatalogsERK17ServerCallContext"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase13DoGetCatalogsERK17ServerCallContext"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase13DoGetCatalogsERK17ServerCallContext"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoGetCatalogs__ServerCallContextCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a6de9ff90bc744f92425d6e858c9e3811"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGetCatalogs</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase13DoGetCatalogsERK17ServerCallContext" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the list of catalogs. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>An interface for sending data back to the client. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase25GetFlightInfoXdbcTypeInfoERK17ServerCallContextRK15GetXdbcTypeInfoRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase25GetFlightInfoXdbcTypeInfoERK17ServerCallContextRK15GetXdbcTypeInfoRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase25GetFlightInfoXdbcTypeInfoERK17ServerCallContextRK15GetXdbcTypeInfoRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfoXdbcTypeInfo__ServerCallContextCR.GetXdbcTypeInfoCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1afe9c8ca995505e0f996edae74f461992"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoXdbcTypeInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql15GetXdbcTypeInfoE" title="arrow::flight::sql::GetXdbcTypeInfo"><span class="n"><span class="pre">GetXdbcTypeInfo</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase25GetFlightInfoXdbcTypeInfoERK17ServerCallContextRK15GetXdbcTypeInfoRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Gets a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> for retrieving other information (See TypeInfo). </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> An optional filter for on the data type. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a>. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase17DoGetXdbcTypeInfoERK17ServerCallContextRK15GetXdbcTypeInfo"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase17DoGetXdbcTypeInfoERK17ServerCallContextRK15GetXdbcTypeInfo"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase17DoGetXdbcTypeInfoERK17ServerCallContextRK15GetXdbcTypeInfo"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoGetXdbcTypeInfo__ServerCallContextCR.GetXdbcTypeInfoCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a15c711bdaaa0b1b85db36c22819bdfda"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGetXdbcTypeInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql15GetXdbcTypeInfoE" title="arrow::flight::sql::GetXdbcTypeInfo"><span class="n"><span class="pre">GetXdbcTypeInfo</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase17DoGetXdbcTypeInfoERK17ServerCallContextRK15GetXdbcTypeInfo" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Gets a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing information about the data types supported. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_xdbc_type_info"><span class="std std-ref">GetXdbcTypeInfo</span></a> object which may contain filter for the date type to be search for. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a>. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase20GetFlightInfoSqlInfoERK17ServerCallContextRK10GetSqlInfoRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase20GetFlightInfoSqlInfoERK17ServerCallContextRK10GetSqlInfoRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase20GetFlightInfoSqlInfoERK17ServerCallContextRK10GetSqlInfoRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfoSqlInfo__ServerCallContextCR.GetSqlInfoCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a3558f7a74ab803a08a9f696912439352"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoSqlInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql10GetSqlInfoE" title="arrow::flight::sql::GetSqlInfo"><span class="n"><span class="pre">GetSqlInfo</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase20GetFlightInfoSqlInfoERK17ServerCallContextRK10GetSqlInfoRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> for retrieving other information (See SqlInfo). </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_sql_info"><span class="std std-ref">GetSqlInfo</span></a> object containing the list of SqlInfo to be returned. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase12DoGetSqlInfoERK17ServerCallContextRK10GetSqlInfo"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase12DoGetSqlInfoERK17ServerCallContextRK10GetSqlInfo"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase12DoGetSqlInfoERK17ServerCallContextRK10GetSqlInfo"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoGetSqlInfo__ServerCallContextCR.GetSqlInfoCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1ac3c96fb328c3c668feb3e68ac7ff800c"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGetSqlInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql10GetSqlInfoE" title="arrow::flight::sql::GetSqlInfo"><span class="n"><span class="pre">GetSqlInfo</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase12DoGetSqlInfoERK17ServerCallContextRK10GetSqlInfo" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the list of SqlInfo results. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_sql_info"><span class="std std-ref">GetSqlInfo</span></a> object containing the list of SqlInfo to be returned. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the results. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase20GetFlightInfoSchemasERK17ServerCallContextRK12GetDbSchemasRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase20GetFlightInfoSchemasERK17ServerCallContextRK12GetDbSchemasRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase20GetFlightInfoSchemasERK17ServerCallContextRK12GetDbSchemasRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfoSchemas__ServerCallContextCR.GetDbSchemasCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1ab2e202a25089c729d89e77b4adbe863d"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoSchemas</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql12GetDbSchemasE" title="arrow::flight::sql::GetDbSchemas"><span class="n"><span class="pre">GetDbSchemas</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase20GetFlightInfoSchemasERK17ServerCallContextRK12GetDbSchemasRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> for listing schemas. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_db_schemas"><span class="std std-ref">GetDbSchemas</span></a> object which may contain filters for catalog and schema name. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase14DoGetDbSchemasERK17ServerCallContextRK12GetDbSchemas"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase14DoGetDbSchemasERK17ServerCallContextRK12GetDbSchemas"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase14DoGetDbSchemasERK17ServerCallContextRK12GetDbSchemas"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoGetDbSchemas__ServerCallContextCR.GetDbSchemasCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1aaa696b8ed37d8fa641d6d06c35378081"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGetDbSchemas</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql12GetDbSchemasE" title="arrow::flight::sql::GetDbSchemas"><span class="n"><span class="pre">GetDbSchemas</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase14DoGetDbSchemasERK17ServerCallContextRK12GetDbSchemas" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the list of schemas. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_db_schemas"><span class="std std-ref">GetDbSchemas</span></a> object which may contain filters for catalog and schema name. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the results. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase19GetFlightInfoTablesERK17ServerCallContextRK9GetTablesRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase19GetFlightInfoTablesERK17ServerCallContextRK9GetTablesRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase19GetFlightInfoTablesERK17ServerCallContextRK9GetTablesRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfoTables__ServerCallContextCR.GetTablesCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a0d5fdffaeb6dda96c7e151f8d80b5a3f"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoTables</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql9GetTablesE" title="arrow::flight::sql::GetTables"><span class="n"><span class="pre">GetTables</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase19GetFlightInfoTablesERK17ServerCallContextRK9GetTablesRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> for listing tables. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_tables"><span class="std std-ref">GetTables</span></a> object which may contain filters for catalog, schema and table names. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase11DoGetTablesERK17ServerCallContextRK9GetTables"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase11DoGetTablesERK17ServerCallContextRK9GetTables"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase11DoGetTablesERK17ServerCallContextRK9GetTables"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoGetTables__ServerCallContextCR.GetTablesCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a6253d39b6437f595ebc1b30844f28140"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGetTables</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql9GetTablesE" title="arrow::flight::sql::GetTables"><span class="n"><span class="pre">GetTables</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase11DoGetTablesERK17ServerCallContextRK9GetTables" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the list of tables. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_tables"><span class="std std-ref">GetTables</span></a> object which may contain filters for catalog, schema and table names. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the results. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase23GetFlightInfoTableTypesERK17ServerCallContextRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase23GetFlightInfoTableTypesERK17ServerCallContextRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase23GetFlightInfoTableTypesERK17ServerCallContextRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfoTableTypes__ServerCallContextCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a8f88983184f7fa9a6da076940e34b4c7"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoTableTypes</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase23GetFlightInfoTableTypesERK17ServerCallContextRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> to extract information about the table types. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase15DoGetTableTypesERK17ServerCallContext"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase15DoGetTableTypesERK17ServerCallContext"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase15DoGetTableTypesERK17ServerCallContext"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoGetTableTypes__ServerCallContextCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1afeae5db2d5206487f52c7485c0a90609"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGetTableTypes</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase15DoGetTableTypesERK17ServerCallContext" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the data related to the table types. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the results. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase24GetFlightInfoPrimaryKeysERK17ServerCallContextRK14GetPrimaryKeysRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase24GetFlightInfoPrimaryKeysERK17ServerCallContextRK14GetPrimaryKeysRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase24GetFlightInfoPrimaryKeysERK17ServerCallContextRK14GetPrimaryKeysRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfoPrimaryKeys__ServerCallContextCR.GetPrimaryKeysCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a61c06092af555c801f23afe684aa1bc0"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoPrimaryKeys</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql14GetPrimaryKeysE" title="arrow::flight::sql::GetPrimaryKeys"><span class="n"><span class="pre">GetPrimaryKeys</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase24GetFlightInfoPrimaryKeysERK17ServerCallContextRK14GetPrimaryKeysRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> to extract information about primary and foreign keys. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_primary_keys"><span class="std std-ref">GetPrimaryKeys</span></a> object with necessary information to execute the request. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase16DoGetPrimaryKeysERK17ServerCallContextRK14GetPrimaryKeys"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase16DoGetPrimaryKeysERK17ServerCallContextRK14GetPrimaryKeys"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase16DoGetPrimaryKeysERK17ServerCallContextRK14GetPrimaryKeys"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoGetPrimaryKeys__ServerCallContextCR.GetPrimaryKeysCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a49db78cc0c9a752eb9559757a90e090b"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGetPrimaryKeys</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql14GetPrimaryKeysE" title="arrow::flight::sql::GetPrimaryKeys"><span class="n"><span class="pre">GetPrimaryKeys</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase16DoGetPrimaryKeysERK17ServerCallContextRK14GetPrimaryKeys" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the data related to the primary and foreign keys. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_primary_keys"><span class="std std-ref">GetPrimaryKeys</span></a> object with necessary information to execute the request. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the results. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase25GetFlightInfoExportedKeysERK17ServerCallContextRK15GetExportedKeysRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase25GetFlightInfoExportedKeysERK17ServerCallContextRK15GetExportedKeysRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase25GetFlightInfoExportedKeysERK17ServerCallContextRK15GetExportedKeysRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfoExportedKeys__ServerCallContextCR.GetExportedKeysCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a879ffe2b3b7e436c41967fe4f7425c64"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoExportedKeys</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql15GetExportedKeysE" title="arrow::flight::sql::GetExportedKeys"><span class="n"><span class="pre">GetExportedKeys</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase25GetFlightInfoExportedKeysERK17ServerCallContextRK15GetExportedKeysRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> to extract information about foreign and primary keys. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_exported_keys"><span class="std std-ref">GetExportedKeys</span></a> object with necessary information to execute the request. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase17DoGetExportedKeysERK17ServerCallContextRK15GetExportedKeys"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase17DoGetExportedKeysERK17ServerCallContextRK15GetExportedKeys"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase17DoGetExportedKeysERK17ServerCallContextRK15GetExportedKeys"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoGetExportedKeys__ServerCallContextCR.GetExportedKeysCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1ab9b428a168260de288c27e8012b86683"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGetExportedKeys</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql15GetExportedKeysE" title="arrow::flight::sql::GetExportedKeys"><span class="n"><span class="pre">GetExportedKeys</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase17DoGetExportedKeysERK17ServerCallContextRK15GetExportedKeys" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the data related to the foreign and primary keys. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_exported_keys"><span class="std std-ref">GetExportedKeys</span></a> object with necessary information to execute the request. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the results. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase25GetFlightInfoImportedKeysERK17ServerCallContextRK15GetImportedKeysRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase25GetFlightInfoImportedKeysERK17ServerCallContextRK15GetImportedKeysRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase25GetFlightInfoImportedKeysERK17ServerCallContextRK15GetImportedKeysRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfoImportedKeys__ServerCallContextCR.GetImportedKeysCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a9d3bc150616c3959f6671b498091e573"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoImportedKeys</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql15GetImportedKeysE" title="arrow::flight::sql::GetImportedKeys"><span class="n"><span class="pre">GetImportedKeys</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase25GetFlightInfoImportedKeysERK17ServerCallContextRK15GetImportedKeysRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> to extract information about foreign and primary keys. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_imported_keys"><span class="std std-ref">GetImportedKeys</span></a> object with necessary information to execute the request. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase17DoGetImportedKeysERK17ServerCallContextRK15GetImportedKeys"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase17DoGetImportedKeysERK17ServerCallContextRK15GetImportedKeys"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase17DoGetImportedKeysERK17ServerCallContextRK15GetImportedKeys"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoGetImportedKeys__ServerCallContextCR.GetImportedKeysCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a69ef55003f1d8d5e1d9c56562cd47143"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGetImportedKeys</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql15GetImportedKeysE" title="arrow::flight::sql::GetImportedKeys"><span class="n"><span class="pre">GetImportedKeys</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase17DoGetImportedKeysERK17ServerCallContextRK15GetImportedKeys" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the data related to the foreign and primary keys. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_imported_keys"><span class="std std-ref">GetImportedKeys</span></a> object with necessary information to execute the request. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the results. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase27GetFlightInfoCrossReferenceERK17ServerCallContextRK17GetCrossReferenceRK16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase27GetFlightInfoCrossReferenceERK17ServerCallContextRK17GetCrossReferenceRK16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase27GetFlightInfoCrossReferenceERK17ServerCallContextRK17GetCrossReferenceRK16FlightDescriptor"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetFlightInfoCrossReference__ServerCallContextCR.GetCrossReferenceCR.FlightDescriptorCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a9f47d1497b536334aa84c2b4afdccbb1"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight10FlightInfoE" title="arrow::flight::FlightInfo"><span class="n"><span class="pre">FlightInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFlightInfoCrossReference</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql17GetCrossReferenceE" title="arrow::flight::sql::GetCrossReference"><span class="n"><span class="pre">GetCrossReference</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDescriptorE" title="arrow::flight::FlightDescriptor"><span class="n"><span class="pre">FlightDescriptor</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">descriptor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase27GetFlightInfoCrossReferenceERK17ServerCallContextRK17GetCrossReferenceRK16FlightDescriptor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> to extract information about foreign and primary keys. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_cross_reference"><span class="std std-ref">GetCrossReference</span></a> object with necessary information to execute the request. </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> The descriptor identifying the data stream. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase19DoGetCrossReferenceERK17ServerCallContextRK17GetCrossReference"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase19DoGetCrossReferenceERK17ServerCallContextRK17GetCrossReference"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase19DoGetCrossReferenceERK17ServerCallContextRK17GetCrossReference"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoGetCrossReference__ServerCallContextCR.GetCrossReferenceCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a6d643e3f224a3002157100e1f481fd74"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoGetCrossReference</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql17GetCrossReferenceE" title="arrow::flight::sql::GetCrossReference"><span class="n"><span class="pre">GetCrossReference</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase19DoGetCrossReferenceERK17ServerCallContextRK17GetCrossReference" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the data related to the foreign and primary keys. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> Per-call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_cross_reference"><span class="std std-ref">GetCrossReference</span></a> object with necessary information to execute the request. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> containing the results. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase27DoPutCommandStatementUpdateERK17ServerCallContextRK15StatementUpdate"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase27DoPutCommandStatementUpdateERK17ServerCallContextRK15StatementUpdate"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase27DoPutCommandStatementUpdateERK17ServerCallContextRK15StatementUpdate"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoPutCommandStatementUpdate__ServerCallContextCR.StatementUpdateCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1aa315fe1c853a2c203d4c6507deacfbef"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoPutCommandStatementUpdate</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql15StatementUpdateE" title="arrow::flight::sql::StatementUpdate"><span class="n"><span class="pre">StatementUpdate</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase27DoPutCommandStatementUpdateERK17ServerCallContextRK15StatementUpdate" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute an update SQL statement. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_statement_update"><span class="std std-ref">StatementUpdate</span></a> object containing the SQL statement. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The changed record count. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase25DoPutCommandSubstraitPlanERK17ServerCallContextRK22StatementSubstraitPlan"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase25DoPutCommandSubstraitPlanERK17ServerCallContextRK22StatementSubstraitPlan"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase25DoPutCommandSubstraitPlanERK17ServerCallContextRK22StatementSubstraitPlan"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoPutCommandSubstraitPlan__ServerCallContextCR.StatementSubstraitPlanCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1ad2d0f771208b1b58a2313eda5bf8d4cd"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoPutCommandSubstraitPlan</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql22StatementSubstraitPlanE" title="arrow::flight::sql::StatementSubstraitPlan"><span class="n"><span class="pre">StatementSubstraitPlan</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase25DoPutCommandSubstraitPlanERK17ServerCallContextRK22StatementSubstraitPlan" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute an update Substrait plan. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_statement_substrait_plan"><span class="std std-ref">StatementSubstraitPlan</span></a> object containing the plan. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The changed record count. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase23CreatePreparedStatementERK17ServerCallContextRK36ActionCreatePreparedStatementRequest"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase23CreatePreparedStatementERK17ServerCallContextRK36ActionCreatePreparedStatementRequest"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase23CreatePreparedStatementERK17ServerCallContextRK36ActionCreatePreparedStatementRequest"></span><span id="arrow::flight::sql::FlightSqlServerBase::CreatePreparedStatement__ServerCallContextCR.ActionCreatePreparedStatementRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a70c91f5c5ef291b86eee4ea22b794f44"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql35ActionCreatePreparedStatementResultE" title="arrow::flight::sql::ActionCreatePreparedStatementResult"><span class="n"><span class="pre">ActionCreatePreparedStatementResult</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CreatePreparedStatement</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql36ActionCreatePreparedStatementRequestE" title="arrow::flight::sql::ActionCreatePreparedStatementRequest"><span class="n"><span class="pre">ActionCreatePreparedStatementRequest</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase23CreatePreparedStatementERK17ServerCallContextRK36ActionCreatePreparedStatementRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a prepared statement from a given SQL statement. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_action_create_prepared_statement_request"><span class="std std-ref">ActionCreatePreparedStatementRequest</span></a> object containing the SQL statement. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_action_create_prepared_statement_result"><span class="std std-ref">ActionCreatePreparedStatementResult</span></a> containing the dataset and parameter schemas and a handle for created statement. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase27CreatePreparedSubstraitPlanERK17ServerCallContextRK40ActionCreatePreparedSubstraitPlanRequest"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase27CreatePreparedSubstraitPlanERK17ServerCallContextRK40ActionCreatePreparedSubstraitPlanRequest"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase27CreatePreparedSubstraitPlanERK17ServerCallContextRK40ActionCreatePreparedSubstraitPlanRequest"></span><span id="arrow::flight::sql::FlightSqlServerBase::CreatePreparedSubstraitPlan__ServerCallContextCR.ActionCreatePreparedSubstraitPlanRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1afc8c960d8b531e730e7f9df515476a8d"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql35ActionCreatePreparedStatementResultE" title="arrow::flight::sql::ActionCreatePreparedStatementResult"><span class="n"><span class="pre">ActionCreatePreparedStatementResult</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CreatePreparedSubstraitPlan</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql40ActionCreatePreparedSubstraitPlanRequestE" title="arrow::flight::sql::ActionCreatePreparedSubstraitPlanRequest"><span class="n"><span class="pre">ActionCreatePreparedSubstraitPlanRequest</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase27CreatePreparedSubstraitPlanERK17ServerCallContextRK40ActionCreatePreparedSubstraitPlanRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a prepared statement from a Substrait plan. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_action_create_prepared_substrait_plan_request"><span class="std std-ref">ActionCreatePreparedSubstraitPlanRequest</span></a> object containing the Substrait plan. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_action_create_prepared_statement_result"><span class="std std-ref">ActionCreatePreparedStatementResult</span></a> containing the dataset and parameter schemas and a handle for created statement. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase22ClosePreparedStatementERK17ServerCallContextRK35ActionClosePreparedStatementRequest"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase22ClosePreparedStatementERK17ServerCallContextRK35ActionClosePreparedStatementRequest"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase22ClosePreparedStatementERK17ServerCallContextRK35ActionClosePreparedStatementRequest"></span><span id="arrow::flight::sql::FlightSqlServerBase::ClosePreparedStatement__ServerCallContextCR.ActionClosePreparedStatementRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1aa10fa3fab519a6d3d02e1e5a75a55d0b"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ClosePreparedStatement</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql35ActionClosePreparedStatementRequestE" title="arrow::flight::sql::ActionClosePreparedStatementRequest"><span class="n"><span class="pre">ActionClosePreparedStatementRequest</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase22ClosePreparedStatementERK17ServerCallContextRK35ActionClosePreparedStatementRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Close a prepared statement. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_action_close_prepared_statement_request"><span class="std std-ref">ActionClosePreparedStatementRequest</span></a> object containing the prepared statement handle. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase27DoPutPreparedStatementQueryERK17ServerCallContextRK22PreparedStatementQueryP19FlightMessageReaderP20FlightMetadataWriter"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase27DoPutPreparedStatementQueryERK17ServerCallContextRK22PreparedStatementQueryP19FlightMessageReaderP20FlightMetadataWriter"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase27DoPutPreparedStatementQueryERK17ServerCallContextRK22PreparedStatementQueryP19FlightMessageReaderP20FlightMetadataWriter"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoPutPreparedStatementQuery__ServerCallContextCR.PreparedStatementQueryCR.FlightMessageReaderP.FlightMetadataWriterP"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1ad744ae52a653377a2c05bc3ef703d7d9"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoPutPreparedStatementQuery</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql22PreparedStatementQueryE" title="arrow::flight::sql::PreparedStatementQuery"><span class="n"><span class="pre">PreparedStatementQuery</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <a class="reference internal" href="flight.html#_CPPv4N5arrow6flight19FlightMessageReaderE" title="arrow::flight::FlightMessageReader"><span class="n"><span class="pre">FlightMessageReader</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">reader</span></span>, <a class="reference internal" href="flight.html#_CPPv4N5arrow6flight20FlightMetadataWriterE" title="arrow::flight::FlightMetadataWriter"><span class="n"><span class="pre">FlightMetadataWriter</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">writer</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase27DoPutPreparedStatementQueryERK17ServerCallContextRK22PreparedStatementQueryP19FlightMessageReaderP20FlightMetadataWriter" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Bind parameters to given prepared statement. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_prepared_statement_query"><span class="std std-ref">PreparedStatementQuery</span></a> object containing the prepared statement handle. </p></li> |
| <li><p><strong>reader</strong> – <strong>[in]</strong> A sequence of uploaded record batches. </p></li> |
| <li><p><strong>writer</strong> – <strong>[in]</strong> Send metadata back to the client. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase28DoPutPreparedStatementUpdateERK17ServerCallContextRK23PreparedStatementUpdateP19FlightMessageReader"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase28DoPutPreparedStatementUpdateERK17ServerCallContextRK23PreparedStatementUpdateP19FlightMessageReader"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase28DoPutPreparedStatementUpdateERK17ServerCallContextRK23PreparedStatementUpdateP19FlightMessageReader"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoPutPreparedStatementUpdate__ServerCallContextCR.PreparedStatementUpdateCR.FlightMessageReaderP"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a03c897467caff9a698354e70fc37e3b8"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoPutPreparedStatementUpdate</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql23PreparedStatementUpdateE" title="arrow::flight::sql::PreparedStatementUpdate"><span class="n"><span class="pre">PreparedStatementUpdate</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <a class="reference internal" href="flight.html#_CPPv4N5arrow6flight19FlightMessageReaderE" title="arrow::flight::FlightMessageReader"><span class="n"><span class="pre">FlightMessageReader</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">reader</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase28DoPutPreparedStatementUpdateERK17ServerCallContextRK23PreparedStatementUpdateP19FlightMessageReader" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute an update SQL prepared statement. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_prepared_statement_update"><span class="std std-ref">PreparedStatementUpdate</span></a> object containing the prepared statement handle. </p></li> |
| <li><p><strong>reader</strong> – <strong>[in]</strong> a sequence of uploaded record batches. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The changed record count. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase27DoPutCommandStatementIngestERK17ServerCallContextRK15StatementIngestP19FlightMessageReader"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase27DoPutCommandStatementIngestERK17ServerCallContextRK15StatementIngestP19FlightMessageReader"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase27DoPutCommandStatementIngestERK17ServerCallContextRK15StatementIngestP19FlightMessageReader"></span><span id="arrow::flight::sql::FlightSqlServerBase::DoPutCommandStatementIngest__ServerCallContextCR.StatementIngestCR.FlightMessageReaderP"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a214e9284d5ad2de870c07851a8d2b132"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoPutCommandStatementIngest</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql15StatementIngestE" title="arrow::flight::sql::StatementIngest"><span class="n"><span class="pre">StatementIngest</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">command</span></span>, <a class="reference internal" href="flight.html#_CPPv4N5arrow6flight19FlightMessageReaderE" title="arrow::flight::FlightMessageReader"><span class="n"><span class="pre">FlightMessageReader</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">reader</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase27DoPutCommandStatementIngestERK17ServerCallContextRK15StatementIngestP19FlightMessageReader" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Execute a bulk ingestion. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>command</strong> – <strong>[in]</strong> The <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_statement_ingest"><span class="std std-ref">StatementIngest</span></a> object containing the ingestion request. </p></li> |
| <li><p><strong>reader</strong> – <strong>[in]</strong> a sequence of uploaded record batches. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The changed record count. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase16BeginTransactionERK17ServerCallContextRK29ActionBeginTransactionRequest"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase16BeginTransactionERK17ServerCallContextRK29ActionBeginTransactionRequest"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase16BeginTransactionERK17ServerCallContextRK29ActionBeginTransactionRequest"></span><span id="arrow::flight::sql::FlightSqlServerBase::BeginTransaction__ServerCallContextCR.ActionBeginTransactionRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1af58c02bde30813c48a721ea1e938613d"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql28ActionBeginTransactionResultE" title="arrow::flight::sql::ActionBeginTransactionResult"><span class="n"><span class="pre">ActionBeginTransactionResult</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BeginTransaction</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql29ActionBeginTransactionRequestE" title="arrow::flight::sql::ActionBeginTransactionRequest"><span class="n"><span class="pre">ActionBeginTransactionRequest</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase16BeginTransactionERK17ServerCallContextRK29ActionBeginTransactionRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Begin a new transaction. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> Request parameters. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The transaction ID. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase14BeginSavepointERK17ServerCallContextRK27ActionBeginSavepointRequest"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase14BeginSavepointERK17ServerCallContextRK27ActionBeginSavepointRequest"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase14BeginSavepointERK17ServerCallContextRK27ActionBeginSavepointRequest"></span><span id="arrow::flight::sql::FlightSqlServerBase::BeginSavepoint__ServerCallContextCR.ActionBeginSavepointRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1ad6d681c50da3b54b73a19316d08adab8"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql26ActionBeginSavepointResultE" title="arrow::flight::sql::ActionBeginSavepointResult"><span class="n"><span class="pre">ActionBeginSavepointResult</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BeginSavepoint</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql27ActionBeginSavepointRequestE" title="arrow::flight::sql::ActionBeginSavepointRequest"><span class="n"><span class="pre">ActionBeginSavepointRequest</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase14BeginSavepointERK17ServerCallContextRK27ActionBeginSavepointRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a new savepoint. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> Request parameters. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The savepoint ID. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase12EndSavepointERK17ServerCallContextRK25ActionEndSavepointRequest"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase12EndSavepointERK17ServerCallContextRK25ActionEndSavepointRequest"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase12EndSavepointERK17ServerCallContextRK25ActionEndSavepointRequest"></span><span id="arrow::flight::sql::FlightSqlServerBase::EndSavepoint__ServerCallContextCR.ActionEndSavepointRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1af02ccebe929ad8500d165bb489b2e789"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">EndSavepoint</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql25ActionEndSavepointRequestE" title="arrow::flight::sql::ActionEndSavepointRequest"><span class="n"><span class="pre">ActionEndSavepointRequest</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase12EndSavepointERK17ServerCallContextRK25ActionEndSavepointRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Release/rollback a savepoint. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The savepoint. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase14EndTransactionERK17ServerCallContextRK27ActionEndTransactionRequest"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase14EndTransactionERK17ServerCallContextRK27ActionEndTransactionRequest"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase14EndTransactionERK17ServerCallContextRK27ActionEndTransactionRequest"></span><span id="arrow::flight::sql::FlightSqlServerBase::EndTransaction__ServerCallContextCR.ActionEndTransactionRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1afae6f6f229fcd93435276d868766f5e5"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">EndTransaction</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql27ActionEndTransactionRequestE" title="arrow::flight::sql::ActionEndTransactionRequest"><span class="n"><span class="pre">ActionEndTransactionRequest</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase14EndTransactionERK17ServerCallContextRK27ActionEndTransactionRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Commit/rollback a transaction. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The transaction. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase16CancelFlightInfoERK17ServerCallContextRK23CancelFlightInfoRequest"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase16CancelFlightInfoERK17ServerCallContextRK23CancelFlightInfoRequest"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase16CancelFlightInfoERK17ServerCallContextRK23CancelFlightInfoRequest"></span><span id="arrow::flight::sql::FlightSqlServerBase::CancelFlightInfo__ServerCallContextCR.CancelFlightInfoRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a55169f4e6e46d906015de2bee6c0de54"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">CancelFlightInfoResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CancelFlightInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">CancelFlightInfoRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase16CancelFlightInfoERK17ServerCallContextRK23CancelFlightInfoRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Attempt to explicitly cancel a <a class="reference internal" href="flight.html#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a>. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The CancelFlightInfoRequest. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The cancellation result. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase17SetSessionOptionsERK17ServerCallContextRK24SetSessionOptionsRequest"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase17SetSessionOptionsERK17ServerCallContextRK24SetSessionOptionsRequest"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase17SetSessionOptionsERK17ServerCallContextRK24SetSessionOptionsRequest"></span><span id="arrow::flight::sql::FlightSqlServerBase::SetSessionOptions__ServerCallContextCR.SetSessionOptionsRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1ab18ed7b437ccf6aacb091864ed405b85"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">SetSessionOptionsResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SetSessionOptions</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">SetSessionOptionsRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase17SetSessionOptionsERK17ServerCallContextRK24SetSessionOptionsRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Set server session option(s). </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The session options to set. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase17GetSessionOptionsERK17ServerCallContextRK24GetSessionOptionsRequest"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase17GetSessionOptionsERK17ServerCallContextRK24GetSessionOptionsRequest"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase17GetSessionOptionsERK17ServerCallContextRK24GetSessionOptionsRequest"></span><span id="arrow::flight::sql::FlightSqlServerBase::GetSessionOptions__ServerCallContextCR.GetSessionOptionsRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a9b071baf24a3a6f5f0b75549db3571b3"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">GetSessionOptionsResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSessionOptions</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">GetSessionOptionsRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase17GetSessionOptionsERK17ServerCallContextRK24GetSessionOptionsRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get server session option(s). </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> Request object. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase12CloseSessionERK17ServerCallContextRK19CloseSessionRequest"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase12CloseSessionERK17ServerCallContextRK19CloseSessionRequest"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase12CloseSessionERK17ServerCallContextRK19CloseSessionRequest"></span><span id="arrow::flight::sql::FlightSqlServerBase::CloseSession__ServerCallContextCR.CloseSessionRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1afc3e24f8d044091a2ea29c8b2b3d45a7"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">CloseSessionResult</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CloseSession</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">CloseSessionRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase12CloseSessionERK17ServerCallContextRK19CloseSessionRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Close/invalidate the session. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> Request object. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase11CancelQueryERK17ServerCallContextRK24ActionCancelQueryRequest"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase11CancelQueryERK17ServerCallContextRK24ActionCancelQueryRequest"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase11CancelQueryERK17ServerCallContextRK24ActionCancelQueryRequest"></span><span id="arrow::flight::sql::FlightSqlServerBase::CancelQuery__ServerCallContextCR.ActionCancelQueryRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1ac0b416705018663d31ad30e08fbab503"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv412CancelResult" title="CancelResult"><span class="n"><span class="pre">CancelResult</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CancelQuery</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql24ActionCancelQueryRequestE" title="arrow::flight::sql::ActionCancelQueryRequest"><span class="n"><span class="pre">ActionCancelQueryRequest</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase11CancelQueryERK17ServerCallContextRK24ActionCancelQueryRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Attempt to explicitly cancel a query. </p> |
| <p><dl> |
| <dt class="sig sig-object cpp"> |
| <em><span class="pre">Deprecated:</span></em></dt> |
| <dd><p>Deprecated in 13.0.0. You just need to implement <a class="reference internal" href="#classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a55169f4e6e46d906015de2bee6c0de54"><span class="std std-ref">CancelFlightInfo()</span></a> to support both the CancelFlightInfo action (for newer clients) and the CancelQuery action (for older clients). </p> |
| </dd></dl> |
| |
| </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The query to cancel. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The cancellation result. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase19RenewFlightEndpointERK17ServerCallContextRK26RenewFlightEndpointRequest"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase19RenewFlightEndpointERK17ServerCallContextRK26RenewFlightEndpointRequest"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase19RenewFlightEndpointERK17ServerCallContextRK26RenewFlightEndpointRequest"></span><span id="arrow::flight::sql::FlightSqlServerBase::RenewFlightEndpoint__ServerCallContextCR.RenewFlightEndpointRequestCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a69977412d79d903376b1e5d31c9654c8"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight14FlightEndpointE" title="arrow::flight::FlightEndpoint"><span class="n"><span class="pre">FlightEndpoint</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">RenewFlightEndpoint</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="flight.html#_CPPv4N5arrow6flight17ServerCallContextE" title="arrow::flight::ServerCallContext"><span class="n"><span class="pre">ServerCallContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">RenewFlightEndpointRequest</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">request</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase19RenewFlightEndpointERK17ServerCallContextRK26RenewFlightEndpointRequest" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Attempt to explicitly renew a <a class="reference internal" href="flight.html#structarrow_1_1flight_1_1_flight_endpoint"><span class="std std-ref">FlightEndpoint</span></a>. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>request</strong> – <strong>[in]</strong> The RenewFlightEndpointRequest. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The renew result. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-utility-methods">Utility methods</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql19FlightSqlServerBase15RegisterSqlInfoE7int32_tRK13SqlInfoResult"> |
| <span id="_CPPv3N5arrow6flight3sql19FlightSqlServerBase15RegisterSqlInfoE7int32_tRK13SqlInfoResult"></span><span id="_CPPv2N5arrow6flight3sql19FlightSqlServerBase15RegisterSqlInfoE7int32_tRK13SqlInfoResult"></span><span id="arrow::flight::sql::FlightSqlServerBase::RegisterSqlInfo__int32_t.SqlInfoResultCR"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_flight_sql_server_base_1a65ee668ae9a1675c11792cb3bc2ea3db"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">RegisterSqlInfo</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">id</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv413SqlInfoResult" title="SqlInfoResult"><span class="n"><span class="pre">SqlInfoResult</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">result</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql19FlightSqlServerBase15RegisterSqlInfoE7int32_tRK13SqlInfoResult" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Register a new SqlInfo result, making it available when calling <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_sql_info"><span class="std std-ref">GetSqlInfo</span></a>. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>id</strong> – <strong>[in]</strong> the SqlInfo identifier. </p></li> |
| <li><p><strong>result</strong> – <strong>[in]</strong> the result. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql26CreateStatementQueryTicketERKNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight3sql26CreateStatementQueryTicketERKNSt6stringE"></span><span id="_CPPv2N5arrow6flight3sql26CreateStatementQueryTicketERKNSt6stringE"></span><span id="arrow::flight::sql::CreateStatementQueryTicket__ssCR"></span><span class="target" id="namespacearrow_1_1flight_1_1sql_1ab60ebe374f1b7e0c11496d25e0138a14"></span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">flight</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">sql</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">CreateStatementQueryTicket</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">statement_handle</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql26CreateStatementQueryTicketERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A utility function to create a ticket (a opaque binary token that the server uses to identify this query) for a statement query. </p> |
| <p>Intended for Flight SQL server implementations.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>statement_handle</strong> – <strong>[in]</strong> The statement handle that will originate the ticket. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The parsed ticket as an string. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9SqlSchemaE"> |
| <span id="_CPPv3N5arrow6flight3sql9SqlSchemaE"></span><span id="_CPPv2N5arrow6flight3sql9SqlSchemaE"></span><span id="arrow::flight::sql::SqlSchema"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_sql_schema"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SqlSchema</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9SqlSchemaE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Auxiliary class containing all Schemas used on Flight SQL. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9SqlSchema17GetCatalogsSchemaEv"> |
| <span id="_CPPv3N5arrow6flight3sql9SqlSchema17GetCatalogsSchemaEv"></span><span id="_CPPv2N5arrow6flight3sql9SqlSchema17GetCatalogsSchemaEv"></span><span id="arrow::flight::sql::SqlSchema::GetCatalogsSchema"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_sql_schema_1aa34d478c8e48bbc5356c2bcc973a1dec"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetCatalogsSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9SqlSchema17GetCatalogsSchemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> used on GetCatalogs response. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The default schema template. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9SqlSchema18GetDbSchemasSchemaEv"> |
| <span id="_CPPv3N5arrow6flight3sql9SqlSchema18GetDbSchemasSchemaEv"></span><span id="_CPPv2N5arrow6flight3sql9SqlSchema18GetDbSchemasSchemaEv"></span><span id="arrow::flight::sql::SqlSchema::GetDbSchemasSchema"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_sql_schema_1abc88d6c61539735528d6649c39bfbd74"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetDbSchemasSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9SqlSchema18GetDbSchemasSchemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> used on <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_db_schemas"><span class="std std-ref">GetDbSchemas</span></a> response. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The default schema template. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9SqlSchema15GetTablesSchemaEv"> |
| <span id="_CPPv3N5arrow6flight3sql9SqlSchema15GetTablesSchemaEv"></span><span id="_CPPv2N5arrow6flight3sql9SqlSchema15GetTablesSchemaEv"></span><span id="arrow::flight::sql::SqlSchema::GetTablesSchema"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_sql_schema_1aafc5800779e2d58dda19f739e977d2c9"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetTablesSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9SqlSchema15GetTablesSchemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> used on <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_tables"><span class="std std-ref">GetTables</span></a> response when included schema flags is set to false. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The default schema template. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9SqlSchema33GetTablesSchemaWithIncludedSchemaEv"> |
| <span id="_CPPv3N5arrow6flight3sql9SqlSchema33GetTablesSchemaWithIncludedSchemaEv"></span><span id="_CPPv2N5arrow6flight3sql9SqlSchema33GetTablesSchemaWithIncludedSchemaEv"></span><span id="arrow::flight::sql::SqlSchema::GetTablesSchemaWithIncludedSchema"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_sql_schema_1a890f967c196387a3096cb34128b04110"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetTablesSchemaWithIncludedSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9SqlSchema33GetTablesSchemaWithIncludedSchemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> used on <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_tables"><span class="std std-ref">GetTables</span></a> response when included schema flags is set to true. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The default schema template. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9SqlSchema19GetTableTypesSchemaEv"> |
| <span id="_CPPv3N5arrow6flight3sql9SqlSchema19GetTableTypesSchemaEv"></span><span id="_CPPv2N5arrow6flight3sql9SqlSchema19GetTableTypesSchemaEv"></span><span id="arrow::flight::sql::SqlSchema::GetTableTypesSchema"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_sql_schema_1a798b30ec4b38dff27965703279c4baf9"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetTableTypesSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9SqlSchema19GetTableTypesSchemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> used on GetTableTypes response. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The default schema template. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9SqlSchema20GetPrimaryKeysSchemaEv"> |
| <span id="_CPPv3N5arrow6flight3sql9SqlSchema20GetPrimaryKeysSchemaEv"></span><span id="_CPPv2N5arrow6flight3sql9SqlSchema20GetPrimaryKeysSchemaEv"></span><span id="arrow::flight::sql::SqlSchema::GetPrimaryKeysSchema"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_sql_schema_1a9fe36d26ef1a00b3d69e2870051af9a4"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetPrimaryKeysSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9SqlSchema20GetPrimaryKeysSchemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> used on <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_primary_keys"><span class="std std-ref">GetPrimaryKeys</span></a> response when included schema flags is set to true. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The default schema template. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9SqlSchema21GetExportedKeysSchemaEv"> |
| <span id="_CPPv3N5arrow6flight3sql9SqlSchema21GetExportedKeysSchemaEv"></span><span id="_CPPv2N5arrow6flight3sql9SqlSchema21GetExportedKeysSchemaEv"></span><span id="arrow::flight::sql::SqlSchema::GetExportedKeysSchema"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_sql_schema_1ac677d44f2daab913263c03f23123caf3"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetExportedKeysSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9SqlSchema21GetExportedKeysSchemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> used on <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_imported_keys"><span class="std std-ref">GetImportedKeys</span></a> response. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The default schema template. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9SqlSchema21GetImportedKeysSchemaEv"> |
| <span id="_CPPv3N5arrow6flight3sql9SqlSchema21GetImportedKeysSchemaEv"></span><span id="_CPPv2N5arrow6flight3sql9SqlSchema21GetImportedKeysSchemaEv"></span><span id="arrow::flight::sql::SqlSchema::GetImportedKeysSchema"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_sql_schema_1a0804bda68ea44f57a0f17738d7451268"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetImportedKeysSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9SqlSchema21GetImportedKeysSchemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> used on <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_imported_keys"><span class="std std-ref">GetImportedKeys</span></a> response. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The default schema template. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9SqlSchema23GetCrossReferenceSchemaEv"> |
| <span id="_CPPv3N5arrow6flight3sql9SqlSchema23GetCrossReferenceSchemaEv"></span><span id="_CPPv2N5arrow6flight3sql9SqlSchema23GetCrossReferenceSchemaEv"></span><span id="arrow::flight::sql::SqlSchema::GetCrossReferenceSchema"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_sql_schema_1ad642230ecb235c96e4b8a57b187900e4"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetCrossReferenceSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9SqlSchema23GetCrossReferenceSchemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> used on <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_cross_reference"><span class="std std-ref">GetCrossReference</span></a> response. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The default schema template. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9SqlSchema21GetXdbcTypeInfoSchemaEv"> |
| <span id="_CPPv3N5arrow6flight3sql9SqlSchema21GetXdbcTypeInfoSchemaEv"></span><span id="_CPPv2N5arrow6flight3sql9SqlSchema21GetXdbcTypeInfoSchemaEv"></span><span id="arrow::flight::sql::SqlSchema::GetXdbcTypeInfoSchema"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_sql_schema_1a41a6883345024d623829a67fbc3a207e"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetXdbcTypeInfoSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9SqlSchema21GetXdbcTypeInfoSchemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> used on <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_xdbc_type_info"><span class="std std-ref">GetXdbcTypeInfo</span></a> response. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The default schema template. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9SqlSchema16GetSqlInfoSchemaEv"> |
| <span id="_CPPv3N5arrow6flight3sql9SqlSchema16GetSqlInfoSchemaEv"></span><span id="_CPPv2N5arrow6flight3sql9SqlSchema16GetSqlInfoSchemaEv"></span><span id="arrow::flight::sql::SqlSchema::GetSqlInfoSchema"></span><span class="target" id="classarrow_1_1flight_1_1sql_1_1_sql_schema_1a8625ba48271ec11597a19aded56b1714"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetSqlInfoSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9SqlSchema16GetSqlInfoSchemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> used on <a class="reference internal" href="#structarrow_1_1flight_1_1sql_1_1_get_sql_info"><span class="std std-ref">GetSqlInfo</span></a> response. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The default schema template. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl> |
| <dt class="sig sig-object cpp"> |
| <span class="target" id="group__flight-sql-protocol-messages"></span><em><span class="pre">group</span></em> <span class="sig-name descname"><span class="pre">flight-sql-protocol-messages</span></span></dt> |
| <dd><p>Simple struct wrappers for various protocol messages, used to avoid exposing Protobuf types in the API. </p> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14StatementQueryE"> |
| <span id="_CPPv3N5arrow6flight3sql14StatementQueryE"></span><span id="_CPPv2N5arrow6flight3sql14StatementQueryE"></span><span id="arrow::flight::sql::StatementQuery"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_query"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StatementQuery</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14StatementQueryE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A SQL query. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14StatementQuery5queryE"> |
| <span id="_CPPv3N5arrow6flight3sql14StatementQuery5queryE"></span><span id="_CPPv2N5arrow6flight3sql14StatementQuery5queryE"></span><span id="arrow::flight::sql::StatementQuery::query__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_query_1acc5463a7f5627c5e40492f26865d5f71"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">query</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14StatementQuery5queryE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The SQL query. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14StatementQuery14transaction_idE"> |
| <span id="_CPPv3N5arrow6flight3sql14StatementQuery14transaction_idE"></span><span id="_CPPv2N5arrow6flight3sql14StatementQuery14transaction_idE"></span><span id="arrow::flight::sql::StatementQuery::transaction_id__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_query_1a89a7afe207c6d5b5447e7600811b61ed"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">transaction_id</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14StatementQuery14transaction_idE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The transaction ID, if specified (else a blank string). </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql22StatementSubstraitPlanE"> |
| <span id="_CPPv3N5arrow6flight3sql22StatementSubstraitPlanE"></span><span id="_CPPv2N5arrow6flight3sql22StatementSubstraitPlanE"></span><span id="arrow::flight::sql::StatementSubstraitPlan"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_substrait_plan"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StatementSubstraitPlan</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql22StatementSubstraitPlanE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A Substrait plan to execute. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql22StatementSubstraitPlan4planE"> |
| <span id="_CPPv3N5arrow6flight3sql22StatementSubstraitPlan4planE"></span><span id="_CPPv2N5arrow6flight3sql22StatementSubstraitPlan4planE"></span><span id="arrow::flight::sql::StatementSubstraitPlan::plan__SubstraitPlan"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_substrait_plan_1aa96aa26b05cfbea2165e5739c636bdd7"></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql13SubstraitPlanE" title="arrow::flight::sql::SubstraitPlan"><span class="n"><span class="pre">SubstraitPlan</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">plan</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql22StatementSubstraitPlan4planE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The Substrait plan. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql22StatementSubstraitPlan14transaction_idE"> |
| <span id="_CPPv3N5arrow6flight3sql22StatementSubstraitPlan14transaction_idE"></span><span id="_CPPv2N5arrow6flight3sql22StatementSubstraitPlan14transaction_idE"></span><span id="arrow::flight::sql::StatementSubstraitPlan::transaction_id__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_substrait_plan_1ae11297f439b7fc2a0d694895d1973457"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">transaction_id</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql22StatementSubstraitPlan14transaction_idE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The transaction ID, if specified (else a blank string). </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15StatementUpdateE"> |
| <span id="_CPPv3N5arrow6flight3sql15StatementUpdateE"></span><span id="_CPPv2N5arrow6flight3sql15StatementUpdateE"></span><span id="arrow::flight::sql::StatementUpdate"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_update"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StatementUpdate</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15StatementUpdateE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A SQL update query. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15StatementUpdate5queryE"> |
| <span id="_CPPv3N5arrow6flight3sql15StatementUpdate5queryE"></span><span id="_CPPv2N5arrow6flight3sql15StatementUpdate5queryE"></span><span id="arrow::flight::sql::StatementUpdate::query__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_update_1a12257250737aea4b1356f125e031bfc3"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">query</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15StatementUpdate5queryE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The SQL query. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15StatementUpdate14transaction_idE"> |
| <span id="_CPPv3N5arrow6flight3sql15StatementUpdate14transaction_idE"></span><span id="_CPPv2N5arrow6flight3sql15StatementUpdate14transaction_idE"></span><span id="arrow::flight::sql::StatementUpdate::transaction_id__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_update_1a4004ac83288c0803fa4bec484b041038"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">transaction_id</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15StatementUpdate14transaction_idE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The transaction ID, if specified (else a blank string). </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql20StatementQueryTicketE"> |
| <span id="_CPPv3N5arrow6flight3sql20StatementQueryTicketE"></span><span id="_CPPv2N5arrow6flight3sql20StatementQueryTicketE"></span><span id="arrow::flight::sql::StatementQueryTicket"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_query_ticket"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StatementQueryTicket</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql20StatementQueryTicketE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to execute a query. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql20StatementQueryTicket16statement_handleE"> |
| <span id="_CPPv3N5arrow6flight3sql20StatementQueryTicket16statement_handleE"></span><span id="_CPPv2N5arrow6flight3sql20StatementQueryTicket16statement_handleE"></span><span id="arrow::flight::sql::StatementQueryTicket::statement_handle__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_query_ticket_1af90935b8a9fabefc30a5319949fcc0b5"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">statement_handle</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql20StatementQueryTicket16statement_handleE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The server-generated opaque identifier for the query. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql22PreparedStatementQueryE"> |
| <span id="_CPPv3N5arrow6flight3sql22PreparedStatementQueryE"></span><span id="_CPPv2N5arrow6flight3sql22PreparedStatementQueryE"></span><span id="arrow::flight::sql::PreparedStatementQuery"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_prepared_statement_query"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PreparedStatementQuery</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql22PreparedStatementQueryE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A prepared query statement. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql22PreparedStatementQuery25prepared_statement_handleE"> |
| <span id="_CPPv3N5arrow6flight3sql22PreparedStatementQuery25prepared_statement_handleE"></span><span id="_CPPv2N5arrow6flight3sql22PreparedStatementQuery25prepared_statement_handleE"></span><span id="arrow::flight::sql::PreparedStatementQuery::prepared_statement_handle__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_prepared_statement_query_1a6d7d6760c31cf87d3592079134fe08e5"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">prepared_statement_handle</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql22PreparedStatementQuery25prepared_statement_handleE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The server-generated opaque identifier for the statement. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql23PreparedStatementUpdateE"> |
| <span id="_CPPv3N5arrow6flight3sql23PreparedStatementUpdateE"></span><span id="_CPPv2N5arrow6flight3sql23PreparedStatementUpdateE"></span><span id="arrow::flight::sql::PreparedStatementUpdate"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_prepared_statement_update"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PreparedStatementUpdate</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql23PreparedStatementUpdateE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A prepared update statement. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql23PreparedStatementUpdate25prepared_statement_handleE"> |
| <span id="_CPPv3N5arrow6flight3sql23PreparedStatementUpdate25prepared_statement_handleE"></span><span id="_CPPv2N5arrow6flight3sql23PreparedStatementUpdate25prepared_statement_handleE"></span><span id="arrow::flight::sql::PreparedStatementUpdate::prepared_statement_handle__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_prepared_statement_update_1a64ac554d63a006ab7b771cf69554c96b"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">prepared_statement_handle</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql23PreparedStatementUpdate25prepared_statement_handleE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The server-generated opaque identifier for the statement. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15StatementIngestE"> |
| <span id="_CPPv3N5arrow6flight3sql15StatementIngestE"></span><span id="_CPPv2N5arrow6flight3sql15StatementIngestE"></span><span id="arrow::flight::sql::StatementIngest"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_ingest"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StatementIngest</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15StatementIngestE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A bulk ingestion request. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15StatementIngest24table_definition_optionsE"> |
| <span id="_CPPv3N5arrow6flight3sql15StatementIngest24table_definition_optionsE"></span><span id="_CPPv2N5arrow6flight3sql15StatementIngest24table_definition_optionsE"></span><span id="arrow::flight::sql::StatementIngest::table_definition_options__TableDefinitionOptions"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_ingest_1ac175bf1daa55c8f766159e35b406fd10"></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql22TableDefinitionOptionsE" title="arrow::flight::sql::TableDefinitionOptions"><span class="n"><span class="pre">TableDefinitionOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">table_definition_options</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15StatementIngest24table_definition_optionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The behavior for handling the table definition. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15StatementIngest5tableE"> |
| <span id="_CPPv3N5arrow6flight3sql15StatementIngest5tableE"></span><span id="_CPPv2N5arrow6flight3sql15StatementIngest5tableE"></span><span id="arrow::flight::sql::StatementIngest::table__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_ingest_1aba037fb3d052ee60bd8e6123cc1d7b73"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">table</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15StatementIngest5tableE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The destination table to load into. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15StatementIngest6schemaE"> |
| <span id="_CPPv3N5arrow6flight3sql15StatementIngest6schemaE"></span><span id="_CPPv2N5arrow6flight3sql15StatementIngest6schemaE"></span><span id="arrow::flight::sql::StatementIngest::schema__std::optional:ss:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_ingest_1afe841d889cf737c082c0818d7012b6c6"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">schema</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15StatementIngest6schemaE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The DB schema of the destination table. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15StatementIngest7catalogE"> |
| <span id="_CPPv3N5arrow6flight3sql15StatementIngest7catalogE"></span><span id="_CPPv2N5arrow6flight3sql15StatementIngest7catalogE"></span><span id="arrow::flight::sql::StatementIngest::catalog__std::optional:ss:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_ingest_1a526a3b2b77908ae6e7902975fab4c010"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">catalog</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15StatementIngest7catalogE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>: </p> |
| <p>The catalog of the destination table. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15StatementIngest9temporaryE"> |
| <span id="_CPPv3N5arrow6flight3sql15StatementIngest9temporaryE"></span><span id="_CPPv2N5arrow6flight3sql15StatementIngest9temporaryE"></span><span id="arrow::flight::sql::StatementIngest::temporary__b"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_ingest_1a7aa5a1b7e8d8afc1bf325f82e38920a8"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">temporary</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15StatementIngest9temporaryE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Use a temporary table. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15StatementIngest14transaction_idE"> |
| <span id="_CPPv3N5arrow6flight3sql15StatementIngest14transaction_idE"></span><span id="_CPPv2N5arrow6flight3sql15StatementIngest14transaction_idE"></span><span id="arrow::flight::sql::StatementIngest::transaction_id__std::optional:ss:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_ingest_1acb3d2849e2766b3085a7599fa42f9503"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">transaction_id</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15StatementIngest14transaction_idE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ingest as part of this transaction. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15StatementIngest7optionsE"> |
| <span id="_CPPv3N5arrow6flight3sql15StatementIngest7optionsE"></span><span id="_CPPv2N5arrow6flight3sql15StatementIngest7optionsE"></span><span id="arrow::flight::sql::StatementIngest::options__std::unordered_map:ss.ss:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_statement_ingest_1ab8e52bd88305f580c0013066b767ab9f"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unordered_map</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">options</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15StatementIngest7optionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Additional, backend-specific options. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql10GetSqlInfoE"> |
| <span id="_CPPv3N5arrow6flight3sql10GetSqlInfoE"></span><span id="_CPPv2N5arrow6flight3sql10GetSqlInfoE"></span><span id="arrow::flight::sql::GetSqlInfo"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_sql_info"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSqlInfo</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql10GetSqlInfoE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to fetch server metadata. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql10GetSqlInfo4infoE"> |
| <span id="_CPPv3N5arrow6flight3sql10GetSqlInfo4infoE"></span><span id="_CPPv2N5arrow6flight3sql10GetSqlInfo4infoE"></span><span id="arrow::flight::sql::GetSqlInfo::info__std::vector:int32_t:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_sql_info_1ad526dbc158d4ee6d6c08dd198b2fb714"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int32_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">info</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql10GetSqlInfo4infoE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A list of metadata IDs to fetch. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql12GetDbSchemasE"> |
| <span id="_CPPv3N5arrow6flight3sql12GetDbSchemasE"></span><span id="_CPPv2N5arrow6flight3sql12GetDbSchemasE"></span><span id="arrow::flight::sql::GetDbSchemas"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_db_schemas"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetDbSchemas</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql12GetDbSchemasE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to list database schemas. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql12GetDbSchemas7catalogE"> |
| <span id="_CPPv3N5arrow6flight3sql12GetDbSchemas7catalogE"></span><span id="_CPPv2N5arrow6flight3sql12GetDbSchemas7catalogE"></span><span id="arrow::flight::sql::GetDbSchemas::catalog__std::optional:ss:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_db_schemas_1a98a91c3ac5977227bddb53a2f8ee0601"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">catalog</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql12GetDbSchemas7catalogE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An optional database catalog to filter on. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql12GetDbSchemas24db_schema_filter_patternE"> |
| <span id="_CPPv3N5arrow6flight3sql12GetDbSchemas24db_schema_filter_patternE"></span><span id="_CPPv2N5arrow6flight3sql12GetDbSchemas24db_schema_filter_patternE"></span><span id="arrow::flight::sql::GetDbSchemas::db_schema_filter_pattern__std::optional:ss:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_db_schemas_1a128b27c5973ec5b39a52658c1150f4ea"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">db_schema_filter_pattern</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql12GetDbSchemas24db_schema_filter_patternE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An optional database schema to filter on. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9GetTablesE"> |
| <span id="_CPPv3N5arrow6flight3sql9GetTablesE"></span><span id="_CPPv2N5arrow6flight3sql9GetTablesE"></span><span id="arrow::flight::sql::GetTables"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_tables"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetTables</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9GetTablesE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to list database tables. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9GetTables7catalogE"> |
| <span id="_CPPv3N5arrow6flight3sql9GetTables7catalogE"></span><span id="_CPPv2N5arrow6flight3sql9GetTables7catalogE"></span><span id="arrow::flight::sql::GetTables::catalog__std::optional:ss:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_tables_1a83d37a68a7cdcb2b993a898750968bac"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">catalog</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9GetTables7catalogE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An optional database catalog to filter on. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9GetTables24db_schema_filter_patternE"> |
| <span id="_CPPv3N5arrow6flight3sql9GetTables24db_schema_filter_patternE"></span><span id="_CPPv2N5arrow6flight3sql9GetTables24db_schema_filter_patternE"></span><span id="arrow::flight::sql::GetTables::db_schema_filter_pattern__std::optional:ss:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_tables_1abe639e721358d5d6e5935c5ee615cffc"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">db_schema_filter_pattern</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9GetTables24db_schema_filter_patternE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An optional database schema to filter on. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9GetTables25table_name_filter_patternE"> |
| <span id="_CPPv3N5arrow6flight3sql9GetTables25table_name_filter_patternE"></span><span id="_CPPv2N5arrow6flight3sql9GetTables25table_name_filter_patternE"></span><span id="arrow::flight::sql::GetTables::table_name_filter_pattern__std::optional:ss:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_tables_1aa68211d8bec2ca483cdbcd1b2cc8acdf"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">table_name_filter_pattern</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9GetTables25table_name_filter_patternE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An optional table name to filter on. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9GetTables11table_typesE"> |
| <span id="_CPPv3N5arrow6flight3sql9GetTables11table_typesE"></span><span id="_CPPv2N5arrow6flight3sql9GetTables11table_typesE"></span><span id="arrow::flight::sql::GetTables::table_types__std::vector:ss:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_tables_1a7453d84185a2e16351046e0e124a124e"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">table_types</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9GetTables11table_typesE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A list of table types to filter on. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql9GetTables14include_schemaE"> |
| <span id="_CPPv3N5arrow6flight3sql9GetTables14include_schemaE"></span><span id="_CPPv2N5arrow6flight3sql9GetTables14include_schemaE"></span><span id="arrow::flight::sql::GetTables::include_schema__b"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_tables_1a9ae09e03d9be6760427077fd1b93d9e1"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">include_schema</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql9GetTables14include_schemaE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Whether to include the Arrow schema in the response. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15GetXdbcTypeInfoE"> |
| <span id="_CPPv3N5arrow6flight3sql15GetXdbcTypeInfoE"></span><span id="_CPPv2N5arrow6flight3sql15GetXdbcTypeInfoE"></span><span id="arrow::flight::sql::GetXdbcTypeInfo"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_xdbc_type_info"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetXdbcTypeInfo</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15GetXdbcTypeInfoE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to get SQL data type information. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15GetXdbcTypeInfo9data_typeE"> |
| <span id="_CPPv3N5arrow6flight3sql15GetXdbcTypeInfo9data_typeE"></span><span id="_CPPv2N5arrow6flight3sql15GetXdbcTypeInfo9data_typeE"></span><span id="arrow::flight::sql::GetXdbcTypeInfo::data_type__std::optional:i:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_xdbc_type_info_1afa7babbb813079c8e03ced3489ebf3ff"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">data_type</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15GetXdbcTypeInfo9data_typeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A specific SQL type ID to fetch information about. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14GetPrimaryKeysE"> |
| <span id="_CPPv3N5arrow6flight3sql14GetPrimaryKeysE"></span><span id="_CPPv2N5arrow6flight3sql14GetPrimaryKeysE"></span><span id="arrow::flight::sql::GetPrimaryKeys"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_primary_keys"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetPrimaryKeys</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14GetPrimaryKeysE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to list primary keys of a table. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql14GetPrimaryKeys9table_refE"> |
| <span id="_CPPv3N5arrow6flight3sql14GetPrimaryKeys9table_refE"></span><span id="_CPPv2N5arrow6flight3sql14GetPrimaryKeys9table_refE"></span><span id="arrow::flight::sql::GetPrimaryKeys::table_ref__TableRef"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_primary_keys_1adaec51ebc24844818c0229d9efe6e829"></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql8TableRefE" title="arrow::flight::sql::TableRef"><span class="n"><span class="pre">TableRef</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">table_ref</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql14GetPrimaryKeys9table_refE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The given table. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15GetExportedKeysE"> |
| <span id="_CPPv3N5arrow6flight3sql15GetExportedKeysE"></span><span id="_CPPv2N5arrow6flight3sql15GetExportedKeysE"></span><span id="arrow::flight::sql::GetExportedKeys"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_exported_keys"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetExportedKeys</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15GetExportedKeysE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to list foreign key columns referencing primary key columns of a table. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15GetExportedKeys9table_refE"> |
| <span id="_CPPv3N5arrow6flight3sql15GetExportedKeys9table_refE"></span><span id="_CPPv2N5arrow6flight3sql15GetExportedKeys9table_refE"></span><span id="arrow::flight::sql::GetExportedKeys::table_ref__TableRef"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_exported_keys_1a22b975f1cf5f4fda6369a20683a13ec6"></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql8TableRefE" title="arrow::flight::sql::TableRef"><span class="n"><span class="pre">TableRef</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">table_ref</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15GetExportedKeys9table_refE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The given table. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15GetImportedKeysE"> |
| <span id="_CPPv3N5arrow6flight3sql15GetImportedKeysE"></span><span id="_CPPv2N5arrow6flight3sql15GetImportedKeysE"></span><span id="arrow::flight::sql::GetImportedKeys"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_imported_keys"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetImportedKeys</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15GetImportedKeysE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to list foreign keys of a table. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql15GetImportedKeys9table_refE"> |
| <span id="_CPPv3N5arrow6flight3sql15GetImportedKeys9table_refE"></span><span id="_CPPv2N5arrow6flight3sql15GetImportedKeys9table_refE"></span><span id="arrow::flight::sql::GetImportedKeys::table_ref__TableRef"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_imported_keys_1afee5cc17f17504c5431f44ed91a4483f"></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql8TableRefE" title="arrow::flight::sql::TableRef"><span class="n"><span class="pre">TableRef</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">table_ref</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql15GetImportedKeys9table_refE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The given table. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql17GetCrossReferenceE"> |
| <span id="_CPPv3N5arrow6flight3sql17GetCrossReferenceE"></span><span id="_CPPv2N5arrow6flight3sql17GetCrossReferenceE"></span><span id="arrow::flight::sql::GetCrossReference"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_cross_reference"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetCrossReference</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql17GetCrossReferenceE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to list foreign key columns of a table that reference columns in a given parent table. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql17GetCrossReference12pk_table_refE"> |
| <span id="_CPPv3N5arrow6flight3sql17GetCrossReference12pk_table_refE"></span><span id="_CPPv2N5arrow6flight3sql17GetCrossReference12pk_table_refE"></span><span id="arrow::flight::sql::GetCrossReference::pk_table_ref__TableRef"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_cross_reference_1a833ac849342be07f6dc1630fe3aa45fb"></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql8TableRefE" title="arrow::flight::sql::TableRef"><span class="n"><span class="pre">TableRef</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">pk_table_ref</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql17GetCrossReference12pk_table_refE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The parent table (the one containing referenced columns). </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql17GetCrossReference12fk_table_refE"> |
| <span id="_CPPv3N5arrow6flight3sql17GetCrossReference12fk_table_refE"></span><span id="_CPPv2N5arrow6flight3sql17GetCrossReference12fk_table_refE"></span><span id="arrow::flight::sql::GetCrossReference::fk_table_ref__TableRef"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_get_cross_reference_1add0d2272ec495b05e4f94e10fcb92f3c"></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql8TableRefE" title="arrow::flight::sql::TableRef"><span class="n"><span class="pre">TableRef</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">fk_table_ref</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql17GetCrossReference12fk_table_refE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The foreign table (for which foreign key columns will be listed). </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql29ActionBeginTransactionRequestE"> |
| <span id="_CPPv3N5arrow6flight3sql29ActionBeginTransactionRequestE"></span><span id="_CPPv2N5arrow6flight3sql29ActionBeginTransactionRequestE"></span><span id="arrow::flight::sql::ActionBeginTransactionRequest"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_begin_transaction_request"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ActionBeginTransactionRequest</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql29ActionBeginTransactionRequestE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to start a new transaction. </p> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql27ActionBeginSavepointRequestE"> |
| <span id="_CPPv3N5arrow6flight3sql27ActionBeginSavepointRequestE"></span><span id="_CPPv2N5arrow6flight3sql27ActionBeginSavepointRequestE"></span><span id="arrow::flight::sql::ActionBeginSavepointRequest"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_begin_savepoint_request"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ActionBeginSavepointRequest</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql27ActionBeginSavepointRequestE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to create a new savepoint. </p> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql26ActionBeginSavepointResultE"> |
| <span id="_CPPv3N5arrow6flight3sql26ActionBeginSavepointResultE"></span><span id="_CPPv2N5arrow6flight3sql26ActionBeginSavepointResultE"></span><span id="arrow::flight::sql::ActionBeginSavepointResult"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_begin_savepoint_result"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ActionBeginSavepointResult</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql26ActionBeginSavepointResultE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>The result of starting a new savepoint. </p> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql28ActionBeginTransactionResultE"> |
| <span id="_CPPv3N5arrow6flight3sql28ActionBeginTransactionResultE"></span><span id="_CPPv2N5arrow6flight3sql28ActionBeginTransactionResultE"></span><span id="arrow::flight::sql::ActionBeginTransactionResult"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_begin_transaction_result"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ActionBeginTransactionResult</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql28ActionBeginTransactionResultE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>The result of starting a new transaction. </p> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql25ActionEndSavepointRequestE"> |
| <span id="_CPPv3N5arrow6flight3sql25ActionEndSavepointRequestE"></span><span id="_CPPv2N5arrow6flight3sql25ActionEndSavepointRequestE"></span><span id="arrow::flight::sql::ActionEndSavepointRequest"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_end_savepoint_request"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ActionEndSavepointRequest</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql25ActionEndSavepointRequestE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to end a savepoint. </p> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql27ActionEndTransactionRequestE"> |
| <span id="_CPPv3N5arrow6flight3sql27ActionEndTransactionRequestE"></span><span id="_CPPv2N5arrow6flight3sql27ActionEndTransactionRequestE"></span><span id="arrow::flight::sql::ActionEndTransactionRequest"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_end_transaction_request"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ActionEndTransactionRequest</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql27ActionEndTransactionRequestE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to end a transaction. </p> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql24ActionCancelQueryRequestE"> |
| <span id="_CPPv3N5arrow6flight3sql24ActionCancelQueryRequestE"></span><span id="_CPPv2N5arrow6flight3sql24ActionCancelQueryRequestE"></span><span id="arrow::flight::sql::ActionCancelQueryRequest"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_cancel_query_request"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ActionCancelQueryRequest</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql24ActionCancelQueryRequestE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>An explicit request to cancel a running query. </p> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql36ActionCreatePreparedStatementRequestE"> |
| <span id="_CPPv3N5arrow6flight3sql36ActionCreatePreparedStatementRequestE"></span><span id="_CPPv2N5arrow6flight3sql36ActionCreatePreparedStatementRequestE"></span><span id="arrow::flight::sql::ActionCreatePreparedStatementRequest"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_create_prepared_statement_request"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ActionCreatePreparedStatementRequest</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql36ActionCreatePreparedStatementRequestE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to create a new prepared statement. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql36ActionCreatePreparedStatementRequest5queryE"> |
| <span id="_CPPv3N5arrow6flight3sql36ActionCreatePreparedStatementRequest5queryE"></span><span id="_CPPv2N5arrow6flight3sql36ActionCreatePreparedStatementRequest5queryE"></span><span id="arrow::flight::sql::ActionCreatePreparedStatementRequest::query__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_create_prepared_statement_request_1a9688162fcb68e4ffbfb300d280d2e1e5"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">query</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql36ActionCreatePreparedStatementRequest5queryE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The SQL query. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql36ActionCreatePreparedStatementRequest14transaction_idE"> |
| <span id="_CPPv3N5arrow6flight3sql36ActionCreatePreparedStatementRequest14transaction_idE"></span><span id="_CPPv2N5arrow6flight3sql36ActionCreatePreparedStatementRequest14transaction_idE"></span><span id="arrow::flight::sql::ActionCreatePreparedStatementRequest::transaction_id__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_create_prepared_statement_request_1ace57d46f7dc19910b532bdc4574c011c"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">transaction_id</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql36ActionCreatePreparedStatementRequest14transaction_idE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The transaction ID, if specified (else a blank string). </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql40ActionCreatePreparedSubstraitPlanRequestE"> |
| <span id="_CPPv3N5arrow6flight3sql40ActionCreatePreparedSubstraitPlanRequestE"></span><span id="_CPPv2N5arrow6flight3sql40ActionCreatePreparedSubstraitPlanRequestE"></span><span id="arrow::flight::sql::ActionCreatePreparedSubstraitPlanRequest"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_create_prepared_substrait_plan_request"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ActionCreatePreparedSubstraitPlanRequest</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql40ActionCreatePreparedSubstraitPlanRequestE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to create a new prepared statement with a Substrait plan. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql40ActionCreatePreparedSubstraitPlanRequest4planE"> |
| <span id="_CPPv3N5arrow6flight3sql40ActionCreatePreparedSubstraitPlanRequest4planE"></span><span id="_CPPv2N5arrow6flight3sql40ActionCreatePreparedSubstraitPlanRequest4planE"></span><span id="arrow::flight::sql::ActionCreatePreparedSubstraitPlanRequest::plan__SubstraitPlan"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_create_prepared_substrait_plan_request_1a7e5e897e0b6e96fb30342e1d86ea90d6"></span><a class="reference internal" href="#_CPPv4N5arrow6flight3sql13SubstraitPlanE" title="arrow::flight::sql::SubstraitPlan"><span class="n"><span class="pre">SubstraitPlan</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">plan</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql40ActionCreatePreparedSubstraitPlanRequest4planE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The serialized Substrait plan. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql40ActionCreatePreparedSubstraitPlanRequest14transaction_idE"> |
| <span id="_CPPv3N5arrow6flight3sql40ActionCreatePreparedSubstraitPlanRequest14transaction_idE"></span><span id="_CPPv2N5arrow6flight3sql40ActionCreatePreparedSubstraitPlanRequest14transaction_idE"></span><span id="arrow::flight::sql::ActionCreatePreparedSubstraitPlanRequest::transaction_id__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_create_prepared_substrait_plan_request_1acdaaf43ef7831d9d4783fd4aab6f2c99"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">transaction_id</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql40ActionCreatePreparedSubstraitPlanRequest14transaction_idE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The transaction ID, if specified (else a blank string). </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql35ActionClosePreparedStatementRequestE"> |
| <span id="_CPPv3N5arrow6flight3sql35ActionClosePreparedStatementRequestE"></span><span id="_CPPv2N5arrow6flight3sql35ActionClosePreparedStatementRequestE"></span><span id="arrow::flight::sql::ActionClosePreparedStatementRequest"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_close_prepared_statement_request"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ActionClosePreparedStatementRequest</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql35ActionClosePreparedStatementRequestE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>A request to close a prepared statement. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql35ActionClosePreparedStatementRequest25prepared_statement_handleE"> |
| <span id="_CPPv3N5arrow6flight3sql35ActionClosePreparedStatementRequest25prepared_statement_handleE"></span><span id="_CPPv2N5arrow6flight3sql35ActionClosePreparedStatementRequest25prepared_statement_handleE"></span><span id="arrow::flight::sql::ActionClosePreparedStatementRequest::prepared_statement_handle__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_close_prepared_statement_request_1ac4d6321a5156e54ae4347fda3e8a79f0"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">prepared_statement_handle</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql35ActionClosePreparedStatementRequest25prepared_statement_handleE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The server-generated opaque identifier for the statement. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql35ActionCreatePreparedStatementResultE"> |
| <span id="_CPPv3N5arrow6flight3sql35ActionCreatePreparedStatementResultE"></span><span id="_CPPv2N5arrow6flight3sql35ActionCreatePreparedStatementResultE"></span><span id="arrow::flight::sql::ActionCreatePreparedStatementResult"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_create_prepared_statement_result"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ActionCreatePreparedStatementResult</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql35ActionCreatePreparedStatementResultE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/flight/sql/server.h></em></div> |
| <p>The result of creating a new prepared statement. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql35ActionCreatePreparedStatementResult14dataset_schemaE"> |
| <span id="_CPPv3N5arrow6flight3sql35ActionCreatePreparedStatementResult14dataset_schemaE"></span><span id="_CPPv2N5arrow6flight3sql35ActionCreatePreparedStatementResult14dataset_schemaE"></span><span id="arrow::flight::sql::ActionCreatePreparedStatementResult::dataset_schema__std::shared_ptr:Schema:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_create_prepared_statement_result_1acf119e14a358b0ee1c876af117d36eb7"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">dataset_schema</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql35ActionCreatePreparedStatementResult14dataset_schemaE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The schema of the query results, if applicable. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql35ActionCreatePreparedStatementResult16parameter_schemaE"> |
| <span id="_CPPv3N5arrow6flight3sql35ActionCreatePreparedStatementResult16parameter_schemaE"></span><span id="_CPPv2N5arrow6flight3sql35ActionCreatePreparedStatementResult16parameter_schemaE"></span><span id="arrow::flight::sql::ActionCreatePreparedStatementResult::parameter_schema__std::shared_ptr:Schema:"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_create_prepared_statement_result_1af6e785fe64b4d77c9d76288024042595"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">parameter_schema</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql35ActionCreatePreparedStatementResult16parameter_schemaE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The schema of the query parameters, if applicable. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight3sql35ActionCreatePreparedStatementResult25prepared_statement_handleE"> |
| <span id="_CPPv3N5arrow6flight3sql35ActionCreatePreparedStatementResult25prepared_statement_handleE"></span><span id="_CPPv2N5arrow6flight3sql35ActionCreatePreparedStatementResult25prepared_statement_handleE"></span><span id="arrow::flight::sql::ActionCreatePreparedStatementResult::prepared_statement_handle__ss"></span><span class="target" id="structarrow_1_1flight_1_1sql_1_1_action_create_prepared_statement_result_1a2186cf6680e71cb034b22983dab9bdc9"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">prepared_statement_handle</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight3sql35ActionCreatePreparedStatementResult25prepared_statement_handleE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The server-generated opaque identifier for the statement. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </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="filesystem.html" |
| title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">Filesystems</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="#common-types">Common Types</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#client">Client</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#server">Server</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/cpp/api/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> |
