| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>Arrow Flight RPC — Apache Arrow v4.0.1</title> |
| |
| <link href="../../_static/css/theme.css" rel="stylesheet" /> |
| <link href="../../_static/css/index.c5995385ac14fb8791e8eb36b4908be2.css" rel="stylesheet" /> |
| |
| |
| <link rel="stylesheet" |
| href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> |
| <link rel="preload" as="font" type="font/woff2" crossorigin |
| href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> |
| <link rel="preload" as="font" type="font/woff2" crossorigin |
| href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> |
| |
| |
| |
| |
| |
| <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/basic.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/theme_overrides.css" /> |
| |
| <link rel="preload" as="script" href="../../_static/js/index.1c5a1a01449ed65a7b51.js"> |
| |
| <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/jquery.js"></script> |
| <script src="../../_static/underscore.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <link rel="canonical" href="https://arrow.apache.org/docs/cpp/api/flight.html" /> |
| <link rel="shortcut icon" href="../../_static/favicon.ico"/> |
| <link rel="canonical" href="https://arrow.apache.org/docs/cpp/api/flight.html" /> |
| <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="CUDA support" href="cuda.html" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="docsearch:language" content="en" /> |
| |
| </head> |
| <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80"> |
| |
| <div class="container-fluid" id="banner"></div> |
| |
| |
| |
| |
| <div class="container-xl"> |
| <div class="row"> |
| |
| |
| <!-- Only show if we have sidebars configured, else just a small margin --> |
| <div class="col-12 col-md-3 bd-sidebar"> |
| <a class="navbar-brand" href="../../index.html"> |
| <img src="../../_static/arrow.png" class="logo" alt="logo"> |
| </a> |
| |
| <form class="bd-search d-flex align-items-center" action="../../search.html" method="get"> |
| <i class="icon fas fa-search"></i> |
| <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" > |
| </form> |
| |
| <nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation"> |
| <div class="bd-toc-item active"> |
| |
| <p class="caption"> |
| <span class="caption-text"> |
| Specifications and Protocols |
| </span> |
| </p> |
| <ul class="nav bd-sidenav"> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/Versioning.html"> |
| Format Versioning and Stability |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/Columnar.html"> |
| Arrow Columnar Format |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/Flight.html"> |
| Arrow Flight RPC |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/Integration.html"> |
| Integration Testing |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/CDataInterface.html"> |
| The Arrow C data interface |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/CStreamInterface.html"> |
| The Arrow C stream interface |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../format/Other.html"> |
| Other Data Structures |
| </a> |
| </li> |
| </ul> |
| <p class="caption"> |
| <span class="caption-text"> |
| Libraries |
| </span> |
| </p> |
| <ul class="current nav bd-sidenav"> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://arrow.apache.org/docs/c_glib/"> |
| C/GLib |
| </a> |
| </li> |
| <li class="toctree-l1 current active has-children"> |
| <a class="reference internal" href="../index.html"> |
| C++ |
| </a> |
| <input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/> |
| <label for="toctree-checkbox-1"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul class="current"> |
| <li class="toctree-l2 has-children"> |
| <a class="reference internal" href="../getting_started.html"> |
| User Guide |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/> |
| <label for="toctree-checkbox-2"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../overview.html"> |
| High-Level Overview |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../conventions.html"> |
| Conventions |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../cmake.html"> |
| Using Arrow C++ in your own project |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../memory.html"> |
| Memory Management |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../arrays.html"> |
| Arrays |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../datatypes.html"> |
| Data Types |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../tables.html"> |
| Tabular Data |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../compute.html"> |
| Compute Functions |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../io.html"> |
| Input / output and filesystems |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../ipc.html"> |
| Reading and writing the Arrow IPC format |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../parquet.html"> |
| Reading and writing Parquet files |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../csv.html"> |
| Reading CSV files |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../json.html"> |
| Reading JSON files |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../dataset.html"> |
| Tabular Datasets |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../flight.html"> |
| Arrow Flight RPC |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"> |
| <a class="reference internal" href="../examples/index.html"> |
| Examples |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/> |
| <label for="toctree-checkbox-3"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../examples/cmake_minimal_build.html"> |
| Minimal build using CMake |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../examples/dataset_documentation_example.html"> |
| Arrow Datasets example |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../examples/row_columnar_conversion.html"> |
| Row to columnar conversion |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../examples/tuple_range_conversion.html"> |
| std::tuple-like ranges to Arrow |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2 current active has-children"> |
| <a class="reference internal" href="../api.html"> |
| API Reference |
| </a> |
| <input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/> |
| <label for="toctree-checkbox-4"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul class="current"> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="support.html"> |
| Programming Support |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="memory.html"> |
| Memory (management) |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="datatype.html"> |
| Data Types |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="array.html"> |
| Arrays |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="scalar.html"> |
| Scalars |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="builder.html"> |
| Array Builders |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="table.html"> |
| Two-dimensional Datasets |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="c_abi.html"> |
| C Interfaces |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="compute.html"> |
| Compute Functions |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="tensor.html"> |
| Tensors |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="utilities.html"> |
| Utilities |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="io.html"> |
| Input / output |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="ipc.html"> |
| Arrow IPC |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="formats.html"> |
| File Formats |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="cuda.html"> |
| CUDA support |
| </a> |
| </li> |
| <li class="toctree-l3 current active"> |
| <a class="current reference internal" href="#"> |
| Arrow Flight RPC |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="filesystem.html"> |
| Filesystems |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="dataset.html"> |
| Dataset |
| </a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://github.com/apache/arrow/blob/master/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://godoc.org/github.com/apache/arrow/go/arrow"> |
| Go |
| </a> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../../java/index.html"> |
| Java |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/> |
| <label for="toctree-checkbox-5"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../java/vector.html"> |
| ValueVector |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../java/vector_schema_root.html"> |
| VectorSchemaRoot |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../java/ipc.html"> |
| Reading/Writing IPC formats |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference external" href="https://arrow.apache.org/docs/java/reference/"> |
| Reference (javadoc) |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://arrow.apache.org/docs/js/"> |
| JavaScript |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://github.com/apache/arrow/blob/master/julia/Arrow/README.md"> |
| Julia |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://github.com/apache/arrow/blob/master/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../../python/index.html"> |
| Python |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/> |
| <label for="toctree-checkbox-6"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/install.html"> |
| Installing PyArrow |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/memory.html"> |
| Memory and IO Interfaces |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/data.html"> |
| Data Types and In-Memory Data Model |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/compute.html"> |
| Compute Functions |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/ipc.html"> |
| Streaming, Serialization, and IPC |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/filesystems.html"> |
| Filesystem Interface |
| </a> |
| </li> |
| <li class="toctree-l2 has-children"> |
| <a class="reference internal" href="../../python/filesystems_deprecated.html"> |
| Filesystem Interface (legacy) |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/> |
| <label for="toctree-checkbox-7"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.hdfs.connect.html"> |
| pyarrow.hdfs.connect |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.cat.html"> |
| pyarrow.HadoopFileSystem.cat |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.chmod.html"> |
| pyarrow.HadoopFileSystem.chmod |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.chown.html"> |
| pyarrow.HadoopFileSystem.chown |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.delete.html"> |
| pyarrow.HadoopFileSystem.delete |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.df.html"> |
| pyarrow.HadoopFileSystem.df |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.disk_usage.html"> |
| pyarrow.HadoopFileSystem.disk_usage |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.download.html"> |
| pyarrow.HadoopFileSystem.download |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.exists.html"> |
| pyarrow.HadoopFileSystem.exists |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.get_capacity.html"> |
| pyarrow.HadoopFileSystem.get_capacity |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.get_space_used.html"> |
| pyarrow.HadoopFileSystem.get_space_used |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.info.html"> |
| pyarrow.HadoopFileSystem.info |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.ls.html"> |
| pyarrow.HadoopFileSystem.ls |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.mkdir.html"> |
| pyarrow.HadoopFileSystem.mkdir |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.open.html"> |
| pyarrow.HadoopFileSystem.open |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.rename.html"> |
| pyarrow.HadoopFileSystem.rename |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.rm.html"> |
| pyarrow.HadoopFileSystem.rm |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HadoopFileSystem.upload.html"> |
| pyarrow.HadoopFileSystem.upload |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../../python/generated/pyarrow.HdfsFile.html"> |
| pyarrow.HdfsFile |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/plasma.html"> |
| The Plasma In-Memory Object Store |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/numpy.html"> |
| NumPy Integration |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/pandas.html"> |
| Pandas Integration |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/timestamps.html"> |
| Timestamps |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/csv.html"> |
| Reading CSV files |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/feather.html"> |
| Feather File Format |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/json.html"> |
| Reading JSON files |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/parquet.html"> |
| Reading and Writing the Apache Parquet Format |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/dataset.html"> |
| Tabular Datasets |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/cuda.html"> |
| CUDA Integration |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/extending_types.html"> |
| Extending pyarrow |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/extending.html"> |
| Using pyarrow from C++ and Cython Code |
| </a> |
| </li> |
| <li class="toctree-l2 has-children"> |
| <a class="reference internal" href="../../python/api.html"> |
| API Reference |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/> |
| <label for="toctree-checkbox-8"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/datatypes.html"> |
| Data Types and Schemas |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/> |
| <label for="toctree-checkbox-9"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.null.html"> |
| pyarrow.null |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.bool_.html"> |
| pyarrow.bool_ |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.int8.html"> |
| pyarrow.int8 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.int16.html"> |
| pyarrow.int16 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.int32.html"> |
| pyarrow.int32 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.int64.html"> |
| pyarrow.int64 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.uint8.html"> |
| pyarrow.uint8 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.uint16.html"> |
| pyarrow.uint16 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.uint32.html"> |
| pyarrow.uint32 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.uint64.html"> |
| pyarrow.uint64 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.float16.html"> |
| pyarrow.float16 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.float32.html"> |
| pyarrow.float32 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.float64.html"> |
| pyarrow.float64 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.time32.html"> |
| pyarrow.time32 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.time64.html"> |
| pyarrow.time64 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.timestamp.html"> |
| pyarrow.timestamp |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.date32.html"> |
| pyarrow.date32 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.date64.html"> |
| pyarrow.date64 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.binary.html"> |
| pyarrow.binary |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.string.html"> |
| pyarrow.string |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.utf8.html"> |
| pyarrow.utf8 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.large_binary.html"> |
| pyarrow.large_binary |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.large_string.html"> |
| pyarrow.large_string |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.large_utf8.html"> |
| pyarrow.large_utf8 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.decimal128.html"> |
| pyarrow.decimal128 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.list_.html"> |
| pyarrow.list_ |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.large_list.html"> |
| pyarrow.large_list |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.map_.html"> |
| pyarrow.map_ |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.struct.html"> |
| pyarrow.struct |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dictionary.html"> |
| pyarrow.dictionary |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.field.html"> |
| pyarrow.field |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.schema.html"> |
| pyarrow.schema |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.from_numpy_dtype.html"> |
| pyarrow.from_numpy_dtype |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.DataType.html"> |
| pyarrow.DataType |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.DictionaryType.html"> |
| pyarrow.DictionaryType |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ListType.html"> |
| pyarrow.ListType |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.MapType.html"> |
| pyarrow.MapType |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.StructType.html"> |
| pyarrow.StructType |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.UnionType.html"> |
| pyarrow.UnionType |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.TimestampType.html"> |
| pyarrow.TimestampType |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Time32Type.html"> |
| pyarrow.Time32Type |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Time64Type.html"> |
| pyarrow.Time64Type |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.FixedSizeBinaryType.html"> |
| pyarrow.FixedSizeBinaryType |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Decimal128Type.html"> |
| pyarrow.Decimal128Type |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Field.html"> |
| pyarrow.Field |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Schema.html"> |
| pyarrow.Schema |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ExtensionType.html"> |
| pyarrow.ExtensionType |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.PyExtensionType.html"> |
| pyarrow.PyExtensionType |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.register_extension_type.html"> |
| pyarrow.register_extension_type |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.unregister_extension_type.html"> |
| pyarrow.unregister_extension_type |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_boolean.html"> |
| pyarrow.types.is_boolean |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_integer.html"> |
| pyarrow.types.is_integer |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_signed_integer.html"> |
| pyarrow.types.is_signed_integer |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_unsigned_integer.html"> |
| pyarrow.types.is_unsigned_integer |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_int8.html"> |
| pyarrow.types.is_int8 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_int16.html"> |
| pyarrow.types.is_int16 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_int32.html"> |
| pyarrow.types.is_int32 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_int64.html"> |
| pyarrow.types.is_int64 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_uint8.html"> |
| pyarrow.types.is_uint8 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_uint16.html"> |
| pyarrow.types.is_uint16 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_uint32.html"> |
| pyarrow.types.is_uint32 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_uint64.html"> |
| pyarrow.types.is_uint64 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_floating.html"> |
| pyarrow.types.is_floating |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_float16.html"> |
| pyarrow.types.is_float16 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_float32.html"> |
| pyarrow.types.is_float32 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_float64.html"> |
| pyarrow.types.is_float64 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_decimal.html"> |
| pyarrow.types.is_decimal |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_list.html"> |
| pyarrow.types.is_list |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_large_list.html"> |
| pyarrow.types.is_large_list |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_struct.html"> |
| pyarrow.types.is_struct |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_union.html"> |
| pyarrow.types.is_union |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_nested.html"> |
| pyarrow.types.is_nested |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_temporal.html"> |
| pyarrow.types.is_temporal |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_timestamp.html"> |
| pyarrow.types.is_timestamp |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_date.html"> |
| pyarrow.types.is_date |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_date32.html"> |
| pyarrow.types.is_date32 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_date64.html"> |
| pyarrow.types.is_date64 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_time.html"> |
| pyarrow.types.is_time |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_time32.html"> |
| pyarrow.types.is_time32 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_time64.html"> |
| pyarrow.types.is_time64 |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_null.html"> |
| pyarrow.types.is_null |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_binary.html"> |
| pyarrow.types.is_binary |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_unicode.html"> |
| pyarrow.types.is_unicode |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_string.html"> |
| pyarrow.types.is_string |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_large_binary.html"> |
| pyarrow.types.is_large_binary |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_large_unicode.html"> |
| pyarrow.types.is_large_unicode |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_large_string.html"> |
| pyarrow.types.is_large_string |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_fixed_size_binary.html"> |
| pyarrow.types.is_fixed_size_binary |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_map.html"> |
| pyarrow.types.is_map |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.types.is_dictionary.html"> |
| pyarrow.types.is_dictionary |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/arrays.html"> |
| Arrays and Scalars |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/> |
| <label for="toctree-checkbox-10"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.array.html"> |
| pyarrow.array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.nulls.html"> |
| pyarrow.nulls |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Array.html"> |
| pyarrow.Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.BooleanArray.html"> |
| pyarrow.BooleanArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.FloatingPointArray.html"> |
| pyarrow.FloatingPointArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.IntegerArray.html"> |
| pyarrow.IntegerArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Int8Array.html"> |
| pyarrow.Int8Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Int16Array.html"> |
| pyarrow.Int16Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Int32Array.html"> |
| pyarrow.Int32Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Int64Array.html"> |
| pyarrow.Int64Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.NullArray.html"> |
| pyarrow.NullArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.NumericArray.html"> |
| pyarrow.NumericArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.UInt8Array.html"> |
| pyarrow.UInt8Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.UInt16Array.html"> |
| pyarrow.UInt16Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.UInt32Array.html"> |
| pyarrow.UInt32Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.UInt64Array.html"> |
| pyarrow.UInt64Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.BinaryArray.html"> |
| pyarrow.BinaryArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.StringArray.html"> |
| pyarrow.StringArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.FixedSizeBinaryArray.html"> |
| pyarrow.FixedSizeBinaryArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.LargeBinaryArray.html"> |
| pyarrow.LargeBinaryArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.LargeStringArray.html"> |
| pyarrow.LargeStringArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Time32Array.html"> |
| pyarrow.Time32Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Time64Array.html"> |
| pyarrow.Time64Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Date32Array.html"> |
| pyarrow.Date32Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Date64Array.html"> |
| pyarrow.Date64Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.TimestampArray.html"> |
| pyarrow.TimestampArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Decimal128Array.html"> |
| pyarrow.Decimal128Array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.DictionaryArray.html"> |
| pyarrow.DictionaryArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ListArray.html"> |
| pyarrow.ListArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.LargeListArray.html"> |
| pyarrow.LargeListArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.StructArray.html"> |
| pyarrow.StructArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.UnionArray.html"> |
| pyarrow.UnionArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ExtensionArray.html"> |
| pyarrow.ExtensionArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.scalar.html"> |
| pyarrow.scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.NA.html"> |
| pyarrow.NA |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Scalar.html"> |
| pyarrow.Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.BooleanScalar.html"> |
| pyarrow.BooleanScalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Int8Scalar.html"> |
| pyarrow.Int8Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Int16Scalar.html"> |
| pyarrow.Int16Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Int32Scalar.html"> |
| pyarrow.Int32Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Int64Scalar.html"> |
| pyarrow.Int64Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.UInt8Scalar.html"> |
| pyarrow.UInt8Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.UInt16Scalar.html"> |
| pyarrow.UInt16Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.UInt32Scalar.html"> |
| pyarrow.UInt32Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.UInt64Scalar.html"> |
| pyarrow.UInt64Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.FloatScalar.html"> |
| pyarrow.FloatScalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.DoubleScalar.html"> |
| pyarrow.DoubleScalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.BinaryScalar.html"> |
| pyarrow.BinaryScalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.StringScalar.html"> |
| pyarrow.StringScalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.FixedSizeBinaryScalar.html"> |
| pyarrow.FixedSizeBinaryScalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.LargeBinaryScalar.html"> |
| pyarrow.LargeBinaryScalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.LargeStringScalar.html"> |
| pyarrow.LargeStringScalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Time32Scalar.html"> |
| pyarrow.Time32Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Time64Scalar.html"> |
| pyarrow.Time64Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Date32Scalar.html"> |
| pyarrow.Date32Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Date64Scalar.html"> |
| pyarrow.Date64Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.TimestampScalar.html"> |
| pyarrow.TimestampScalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Decimal128Scalar.html"> |
| pyarrow.Decimal128Scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.DictionaryScalar.html"> |
| pyarrow.DictionaryScalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ListScalar.html"> |
| pyarrow.ListScalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.LargeListScalar.html"> |
| pyarrow.LargeListScalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.StructScalar.html"> |
| pyarrow.StructScalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.UnionScalar.html"> |
| pyarrow.UnionScalar |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/memory.html"> |
| Buffers and Memory |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"/> |
| <label for="toctree-checkbox-11"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.allocate_buffer.html"> |
| pyarrow.allocate_buffer |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.py_buffer.html"> |
| pyarrow.py_buffer |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.foreign_buffer.html"> |
| pyarrow.foreign_buffer |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Buffer.html"> |
| pyarrow.Buffer |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ResizableBuffer.html"> |
| pyarrow.ResizableBuffer |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compress.html"> |
| pyarrow.compress |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.decompress.html"> |
| pyarrow.decompress |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.MemoryPool.html"> |
| pyarrow.MemoryPool |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.default_memory_pool.html"> |
| pyarrow.default_memory_pool |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.jemalloc_memory_pool.html"> |
| pyarrow.jemalloc_memory_pool |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.mimalloc_memory_pool.html"> |
| pyarrow.mimalloc_memory_pool |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.system_memory_pool.html"> |
| pyarrow.system_memory_pool |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.jemalloc_set_decay_ms.html"> |
| pyarrow.jemalloc_set_decay_ms |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.set_memory_pool.html"> |
| pyarrow.set_memory_pool |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.log_memory_allocations.html"> |
| pyarrow.log_memory_allocations |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.total_allocated_bytes.html"> |
| pyarrow.total_allocated_bytes |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/compute.html"> |
| Compute Functions |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"/> |
| <label for="toctree-checkbox-12"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.count.html"> |
| pyarrow.compute.count |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.mean.html"> |
| pyarrow.compute.mean |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.min_max.html"> |
| pyarrow.compute.min_max |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.mode.html"> |
| pyarrow.compute.mode |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.stddev.html"> |
| pyarrow.compute.stddev |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.sum.html"> |
| pyarrow.compute.sum |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.variance.html"> |
| pyarrow.compute.variance |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.add.html"> |
| pyarrow.compute.add |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.add_checked.html"> |
| pyarrow.compute.add_checked |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.divide.html"> |
| pyarrow.compute.divide |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.divide_checked.html"> |
| pyarrow.compute.divide_checked |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.multiply.html"> |
| pyarrow.compute.multiply |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.multiply_checked.html"> |
| pyarrow.compute.multiply_checked |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.subtract.html"> |
| pyarrow.compute.subtract |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.subtract_checked.html"> |
| pyarrow.compute.subtract_checked |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.power.html"> |
| pyarrow.compute.power |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.power_checked.html"> |
| pyarrow.compute.power_checked |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.equal.html"> |
| pyarrow.compute.equal |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.greater.html"> |
| pyarrow.compute.greater |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.greater_equal.html"> |
| pyarrow.compute.greater_equal |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.less.html"> |
| pyarrow.compute.less |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.less_equal.html"> |
| pyarrow.compute.less_equal |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.not_equal.html"> |
| pyarrow.compute.not_equal |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.and_.html"> |
| pyarrow.compute.and_ |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.and_kleene.html"> |
| pyarrow.compute.and_kleene |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.all.html"> |
| pyarrow.compute.all |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.any.html"> |
| pyarrow.compute.any |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.invert.html"> |
| pyarrow.compute.invert |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.or_.html"> |
| pyarrow.compute.or_ |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.or_kleene.html"> |
| pyarrow.compute.or_kleene |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.xor.html"> |
| pyarrow.compute.xor |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.ascii_is_alnum.html"> |
| pyarrow.compute.ascii_is_alnum |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.ascii_is_alpha.html"> |
| pyarrow.compute.ascii_is_alpha |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.ascii_is_decimal.html"> |
| pyarrow.compute.ascii_is_decimal |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.ascii_is_lower.html"> |
| pyarrow.compute.ascii_is_lower |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.ascii_is_printable.html"> |
| pyarrow.compute.ascii_is_printable |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.ascii_is_space.html"> |
| pyarrow.compute.ascii_is_space |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.ascii_is_upper.html"> |
| pyarrow.compute.ascii_is_upper |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.utf8_is_alnum.html"> |
| pyarrow.compute.utf8_is_alnum |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.utf8_is_alpha.html"> |
| pyarrow.compute.utf8_is_alpha |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.utf8_is_decimal.html"> |
| pyarrow.compute.utf8_is_decimal |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.utf8_is_digit.html"> |
| pyarrow.compute.utf8_is_digit |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.utf8_is_lower.html"> |
| pyarrow.compute.utf8_is_lower |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.utf8_is_numeric.html"> |
| pyarrow.compute.utf8_is_numeric |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.utf8_is_printable.html"> |
| pyarrow.compute.utf8_is_printable |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.utf8_is_space.html"> |
| pyarrow.compute.utf8_is_space |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.utf8_is_upper.html"> |
| pyarrow.compute.utf8_is_upper |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.ascii_is_title.html"> |
| pyarrow.compute.ascii_is_title |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.utf8_is_title.html"> |
| pyarrow.compute.utf8_is_title |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.string_is_ascii.html"> |
| pyarrow.compute.string_is_ascii |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.ascii_lower.html"> |
| pyarrow.compute.ascii_lower |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.ascii_upper.html"> |
| pyarrow.compute.ascii_upper |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.utf8_lower.html"> |
| pyarrow.compute.utf8_lower |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.utf8_upper.html"> |
| pyarrow.compute.utf8_upper |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.index_in.html"> |
| pyarrow.compute.index_in |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.is_in.html"> |
| pyarrow.compute.is_in |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.match_substring.html"> |
| pyarrow.compute.match_substring |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.match_substring_regex.html"> |
| pyarrow.compute.match_substring_regex |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.cast.html"> |
| pyarrow.compute.cast |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.strptime.html"> |
| pyarrow.compute.strptime |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.filter.html"> |
| pyarrow.compute.filter |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.take.html"> |
| pyarrow.compute.take |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.dictionary_encode.html"> |
| pyarrow.compute.dictionary_encode |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.unique.html"> |
| pyarrow.compute.unique |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.value_counts.html"> |
| pyarrow.compute.value_counts |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.partition_nth_indices.html"> |
| pyarrow.compute.partition_nth_indices |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.sort_indices.html"> |
| pyarrow.compute.sort_indices |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.binary_length.html"> |
| pyarrow.compute.binary_length |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.fill_null.html"> |
| pyarrow.compute.fill_null |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.is_null.html"> |
| pyarrow.compute.is_null |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.is_valid.html"> |
| pyarrow.compute.is_valid |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.list_value_length.html"> |
| pyarrow.compute.list_value_length |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.list_flatten.html"> |
| pyarrow.compute.list_flatten |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.compute.list_parent_indices.html"> |
| pyarrow.compute.list_parent_indices |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/files.html"> |
| Streams and File Access |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"/> |
| <label for="toctree-checkbox-13"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.input_stream.html"> |
| pyarrow.input_stream |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.output_stream.html"> |
| pyarrow.output_stream |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.memory_map.html"> |
| pyarrow.memory_map |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.create_memory_map.html"> |
| pyarrow.create_memory_map |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.NativeFile.html"> |
| pyarrow.NativeFile |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.OSFile.html"> |
| pyarrow.OSFile |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.PythonFile.html"> |
| pyarrow.PythonFile |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.BufferReader.html"> |
| pyarrow.BufferReader |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.BufferOutputStream.html"> |
| pyarrow.BufferOutputStream |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.FixedSizeBufferWriter.html"> |
| pyarrow.FixedSizeBufferWriter |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.MemoryMappedFile.html"> |
| pyarrow.MemoryMappedFile |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.CompressedInputStream.html"> |
| pyarrow.CompressedInputStream |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.CompressedOutputStream.html"> |
| pyarrow.CompressedOutputStream |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.hdfs.connect.html"> |
| pyarrow.hdfs.connect |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.LocalFileSystem.html"> |
| pyarrow.LocalFileSystem |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/tables.html"> |
| Tables and Tensors |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"/> |
| <label for="toctree-checkbox-14"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.chunked_array.html"> |
| pyarrow.chunked_array |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.concat_arrays.html"> |
| pyarrow.concat_arrays |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.concat_tables.html"> |
| pyarrow.concat_tables |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.record_batch.html"> |
| pyarrow.record_batch |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.table.html"> |
| pyarrow.table |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ChunkedArray.html"> |
| pyarrow.ChunkedArray |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.RecordBatch.html"> |
| pyarrow.RecordBatch |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Table.html"> |
| pyarrow.Table |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.Tensor.html"> |
| pyarrow.Tensor |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/ipc.html"> |
| Serialization and IPC |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"/> |
| <label for="toctree-checkbox-15"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.new_file.html"> |
| pyarrow.ipc.new_file |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.open_file.html"> |
| pyarrow.ipc.open_file |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.new_stream.html"> |
| pyarrow.ipc.new_stream |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.open_stream.html"> |
| pyarrow.ipc.open_stream |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.read_message.html"> |
| pyarrow.ipc.read_message |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.read_record_batch.html"> |
| pyarrow.ipc.read_record_batch |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.get_record_batch_size.html"> |
| pyarrow.ipc.get_record_batch_size |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.read_tensor.html"> |
| pyarrow.ipc.read_tensor |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.write_tensor.html"> |
| pyarrow.ipc.write_tensor |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.get_tensor_size.html"> |
| pyarrow.ipc.get_tensor_size |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.Message.html"> |
| pyarrow.ipc.Message |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.MessageReader.html"> |
| pyarrow.ipc.MessageReader |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.RecordBatchFileReader.html"> |
| pyarrow.ipc.RecordBatchFileReader |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.RecordBatchFileWriter.html"> |
| pyarrow.ipc.RecordBatchFileWriter |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.RecordBatchStreamReader.html"> |
| pyarrow.ipc.RecordBatchStreamReader |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.ipc.RecordBatchStreamWriter.html"> |
| pyarrow.ipc.RecordBatchStreamWriter |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.serialize.html"> |
| pyarrow.serialize |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.serialize_to.html"> |
| pyarrow.serialize_to |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.deserialize.html"> |
| pyarrow.deserialize |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.deserialize_components.html"> |
| pyarrow.deserialize_components |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.deserialize_from.html"> |
| pyarrow.deserialize_from |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.read_serialized.html"> |
| pyarrow.read_serialized |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.SerializedPyObject.html"> |
| pyarrow.SerializedPyObject |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.SerializationContext.html"> |
| pyarrow.SerializationContext |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/flight.html"> |
| Arrow Flight |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"/> |
| <label for="toctree-checkbox-16"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.Action.html"> |
| pyarrow.flight.Action |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.ActionType.html"> |
| pyarrow.flight.ActionType |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.DescriptorType.html"> |
| pyarrow.flight.DescriptorType |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.FlightDescriptor.html"> |
| pyarrow.flight.FlightDescriptor |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.FlightEndpoint.html"> |
| pyarrow.flight.FlightEndpoint |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.FlightInfo.html"> |
| pyarrow.flight.FlightInfo |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.Location.html"> |
| pyarrow.flight.Location |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.Ticket.html"> |
| pyarrow.flight.Ticket |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.Result.html"> |
| pyarrow.flight.Result |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.FlightCallOptions.html"> |
| pyarrow.flight.FlightCallOptions |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.FlightClient.html"> |
| pyarrow.flight.FlightClient |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.ClientMiddlewareFactory.html"> |
| pyarrow.flight.ClientMiddlewareFactory |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.ClientMiddleware.html"> |
| pyarrow.flight.ClientMiddleware |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.FlightServerBase.html"> |
| pyarrow.flight.FlightServerBase |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.GeneratorStream.html"> |
| pyarrow.flight.GeneratorStream |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.RecordBatchStream.html"> |
| pyarrow.flight.RecordBatchStream |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.ServerMiddlewareFactory.html"> |
| pyarrow.flight.ServerMiddlewareFactory |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.ServerMiddleware.html"> |
| pyarrow.flight.ServerMiddleware |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.ClientAuthHandler.html"> |
| pyarrow.flight.ClientAuthHandler |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.ServerAuthHandler.html"> |
| pyarrow.flight.ServerAuthHandler |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.FlightMethod.html"> |
| pyarrow.flight.FlightMethod |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.flight.CallInfo.html"> |
| pyarrow.flight.CallInfo |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/formats.html"> |
| Tabular File Formats |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"/> |
| <label for="toctree-checkbox-17"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.csv.ReadOptions.html"> |
| pyarrow.csv.ReadOptions |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.csv.ParseOptions.html"> |
| pyarrow.csv.ParseOptions |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.csv.ConvertOptions.html"> |
| pyarrow.csv.ConvertOptions |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.csv.read_csv.html"> |
| pyarrow.csv.read_csv |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.csv.open_csv.html"> |
| pyarrow.csv.open_csv |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.csv.CSVStreamingReader.html"> |
| pyarrow.csv.CSVStreamingReader |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.feather.read_feather.html"> |
| pyarrow.feather.read_feather |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.feather.read_table.html"> |
| pyarrow.feather.read_table |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.feather.write_feather.html"> |
| pyarrow.feather.write_feather |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.json.ReadOptions.html"> |
| pyarrow.json.ReadOptions |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.json.ParseOptions.html"> |
| pyarrow.json.ParseOptions |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.json.read_json.html"> |
| pyarrow.json.read_json |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.parquet.ParquetDataset.html"> |
| pyarrow.parquet.ParquetDataset |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.parquet.ParquetFile.html"> |
| pyarrow.parquet.ParquetFile |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.parquet.ParquetWriter.html"> |
| pyarrow.parquet.ParquetWriter |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.parquet.read_table.html"> |
| pyarrow.parquet.read_table |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.parquet.read_metadata.html"> |
| pyarrow.parquet.read_metadata |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.parquet.read_pandas.html"> |
| pyarrow.parquet.read_pandas |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.parquet.read_schema.html"> |
| pyarrow.parquet.read_schema |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.parquet.write_metadata.html"> |
| pyarrow.parquet.write_metadata |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.parquet.write_table.html"> |
| pyarrow.parquet.write_table |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.parquet.write_to_dataset.html"> |
| pyarrow.parquet.write_to_dataset |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.orc.ORCFile.html"> |
| pyarrow.orc.ORCFile |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/filesystems.html"> |
| Filesystems |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" type="checkbox"/> |
| <label for="toctree-checkbox-18"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.fs.FileInfo.html"> |
| pyarrow.fs.FileInfo |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.fs.FileSelector.html"> |
| pyarrow.fs.FileSelector |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.fs.FileSystem.html"> |
| pyarrow.fs.FileSystem |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.fs.LocalFileSystem.html"> |
| pyarrow.fs.LocalFileSystem |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.fs.S3FileSystem.html"> |
| pyarrow.fs.S3FileSystem |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.fs.HadoopFileSystem.html"> |
| pyarrow.fs.HadoopFileSystem |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.fs.SubTreeFileSystem.html"> |
| pyarrow.fs.SubTreeFileSystem |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.fs.PyFileSystem.html"> |
| pyarrow.fs.PyFileSystem |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.fs.FileSystemHandler.html"> |
| pyarrow.fs.FileSystemHandler |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.fs.FSSpecHandler.html"> |
| pyarrow.fs.FSSpecHandler |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/dataset.html"> |
| Dataset |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" type="checkbox"/> |
| <label for="toctree-checkbox-19"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.dataset.html"> |
| pyarrow.dataset.dataset |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.parquet_dataset.html"> |
| pyarrow.dataset.parquet_dataset |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.partitioning.html"> |
| pyarrow.dataset.partitioning |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.field.html"> |
| pyarrow.dataset.field |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.scalar.html"> |
| pyarrow.dataset.scalar |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.FileFormat.html"> |
| pyarrow.dataset.FileFormat |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.ParquetFileFormat.html"> |
| pyarrow.dataset.ParquetFileFormat |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.Partitioning.html"> |
| pyarrow.dataset.Partitioning |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.PartitioningFactory.html"> |
| pyarrow.dataset.PartitioningFactory |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.DirectoryPartitioning.html"> |
| pyarrow.dataset.DirectoryPartitioning |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.HivePartitioning.html"> |
| pyarrow.dataset.HivePartitioning |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.Dataset.html"> |
| pyarrow.dataset.Dataset |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.FileSystemDataset.html"> |
| pyarrow.dataset.FileSystemDataset |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.FileSystemFactoryOptions.html"> |
| pyarrow.dataset.FileSystemFactoryOptions |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.FileSystemDatasetFactory.html"> |
| pyarrow.dataset.FileSystemDatasetFactory |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.UnionDataset.html"> |
| pyarrow.dataset.UnionDataset |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.Scanner.html"> |
| pyarrow.dataset.Scanner |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.dataset.Expression.html"> |
| pyarrow.dataset.Expression |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/plasma.html"> |
| Plasma In-Memory Object Store |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" type="checkbox"/> |
| <label for="toctree-checkbox-20"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.plasma.ObjectID.html"> |
| pyarrow.plasma.ObjectID |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.plasma.PlasmaClient.html"> |
| pyarrow.plasma.PlasmaClient |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.plasma.PlasmaBuffer.html"> |
| pyarrow.plasma.PlasmaBuffer |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/cuda.html"> |
| CUDA Integration |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" type="checkbox"/> |
| <label for="toctree-checkbox-21"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.cuda.Context.html"> |
| pyarrow.cuda.Context |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.cuda.CudaBuffer.html"> |
| pyarrow.cuda.CudaBuffer |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.cuda.new_host_buffer.html"> |
| pyarrow.cuda.new_host_buffer |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.cuda.HostBuffer.html"> |
| pyarrow.cuda.HostBuffer |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.cuda.BufferReader.html"> |
| pyarrow.cuda.BufferReader |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.cuda.BufferWriter.html"> |
| pyarrow.cuda.BufferWriter |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.cuda.serialize_record_batch.html"> |
| pyarrow.cuda.serialize_record_batch |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.cuda.read_record_batch.html"> |
| pyarrow.cuda.read_record_batch |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.cuda.read_message.html"> |
| pyarrow.cuda.read_message |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.cuda.IpcMemHandle.html"> |
| pyarrow.cuda.IpcMemHandle |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../../python/api/misc.html"> |
| Miscellaneous |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" type="checkbox"/> |
| <label for="toctree-checkbox-22"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.cpu_count.html"> |
| pyarrow.cpu_count |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.set_cpu_count.html"> |
| pyarrow.set_cpu_count |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.get_include.html"> |
| pyarrow.get_include |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.get_libraries.html"> |
| pyarrow.get_libraries |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../../python/generated/pyarrow.get_library_dirs.html"> |
| pyarrow.get_library_dirs |
| </a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/getting_involved.html"> |
| Getting Involved |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../python/benchmarks.html"> |
| Benchmarks |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://arrow.apache.org/docs/r/"> |
| R |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://github.com/apache/arrow/blob/master/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| </ul> |
| <p class="caption"> |
| <span class="caption-text"> |
| Development |
| </span> |
| </p> |
| <ul class="nav bd-sidenav"> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/contributing.html"> |
| Contributing to Apache Arrow |
| </a> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../../developers/cpp/index.html"> |
| C++ Development |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" type="checkbox"/> |
| <label for="toctree-checkbox-23"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../developers/cpp/building.html"> |
| Building Arrow C++ |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../developers/cpp/development.html"> |
| Development Guidelines |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../developers/cpp/windows.html"> |
| Developing on Windows |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../developers/cpp/conventions.html"> |
| Conventions |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../developers/cpp/fuzzing.html"> |
| Fuzzing Arrow C++ |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/python.html"> |
| Python Development |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/archery.html"> |
| Daily Development using Archery |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/crossbow.html"> |
| Packaging and Testing with Crossbow |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/docker.html"> |
| Running Docker Builds |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/benchmarks.html"> |
| Benchmarks |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../developers/documentation.html"> |
| Building the Documentation |
| </a> |
| </li> |
| </ul> |
| |
| |
| </div> |
| </nav> |
| </div> |
| |
| |
| |
| |
| <div class="d-none d-xl-block col-xl-2 bd-toc"> |
| |
| |
| <div class="toc-item"> |
| |
| <div class="tocsection onthispage pt-5 pb-3"> |
| <i class="fas fa-list"></i> On this page |
| </div> |
| |
| <nav id="bd-toc-nav"> |
| <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="#clients"> |
| Clients |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#servers"> |
| Servers |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#error-handling"> |
| Error Handling |
| </a> |
| </li> |
| </ul> |
| |
| </nav> |
| </div> |
| |
| <div class="toc-item"> |
| |
| </div> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main"> |
| |
| <div> |
| |
| <div class="section" id="arrow-flight-rpc"> |
| <h1>Arrow Flight RPC<a class="headerlink" href="#arrow-flight-rpc" title="Permalink to this headline">¶</a></h1> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Flight is currently unstable. APIs are subject to change, |
| though we don’t expect drastic changes.</p> |
| </div> |
| <div class="section" id="common-types"> |
| <h2>Common Types<a class="headerlink" href="#common-types" title="Permalink to this headline">¶</a></h2> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight6ActionE"> |
| <span id="_CPPv3N5arrow6flight6ActionE"></span><span id="_CPPv2N5arrow6flight6ActionE"></span><span id="arrow::flight::Action"></span><span class="target" id="structarrow_1_1flight_1_1_action"></span><span class="k"><span class="pre">struct</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><span class="sig-name descname"><span class="n"><span class="pre">Action</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight6ActionE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>An action to perform with the DoAction RPC. </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="_CPPv4N5arrow6flight6Action4typeE"> |
| <span id="_CPPv3N5arrow6flight6Action4typeE"></span><span id="_CPPv2N5arrow6flight6Action4typeE"></span><span id="arrow::flight::Action::type__ss"></span><span class="target" id="structarrow_1_1flight_1_1_action_1af9896e305e4138edb643078f4fcca5f4"></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">type</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight6Action4typeE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The action type. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight6Action4bodyE"> |
| <span id="_CPPv3N5arrow6flight6Action4bodyE"></span><span id="_CPPv2N5arrow6flight6Action4bodyE"></span><span id="arrow::flight::Action::body__std::shared_ptr:Buffer:"></span><span class="target" id="structarrow_1_1flight_1_1_action_1ad8502d5b8d1b7e2e0f48c90acda15ef7"></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="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer"><span class="n"><span class="pre">Buffer</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">body</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight6Action4bodyE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The action content as a <a class="reference internal" href="memory.html#classarrow_1_1_buffer"><span class="std std-ref">Buffer</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight10ActionTypeE"> |
| <span id="_CPPv3N5arrow6flight10ActionTypeE"></span><span id="_CPPv2N5arrow6flight10ActionTypeE"></span><span id="arrow::flight::ActionType"></span><span class="target" id="structarrow_1_1flight_1_1_action_type"></span><span class="k"><span class="pre">struct</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><span class="sig-name descname"><span class="n"><span class="pre">ActionType</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight10ActionTypeE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A type of action that can be performed with the DoAction RPC. </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="_CPPv4N5arrow6flight10ActionType4typeE"> |
| <span id="_CPPv3N5arrow6flight10ActionType4typeE"></span><span id="_CPPv2N5arrow6flight10ActionType4typeE"></span><span id="arrow::flight::ActionType::type__ss"></span><span class="target" id="structarrow_1_1flight_1_1_action_type_1ad0398039d125c7e81a1cf0c92e416a27"></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">type</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight10ActionType4typeE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The name of the action. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight10ActionType11descriptionE"> |
| <span id="_CPPv3N5arrow6flight10ActionType11descriptionE"></span><span id="_CPPv2N5arrow6flight10ActionType11descriptionE"></span><span id="arrow::flight::ActionType::description__ss"></span><span class="target" id="structarrow_1_1flight_1_1_action_type_1acce448827c5033af73977af150754917"></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">description</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight10ActionType11descriptionE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A human-readable description of the action. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight14AddCallHeadersE"> |
| <span id="_CPPv3N5arrow6flight14AddCallHeadersE"></span><span id="_CPPv2N5arrow6flight14AddCallHeadersE"></span><span id="arrow::flight::AddCallHeaders"></span><span class="target" id="classarrow_1_1flight_1_1_add_call_headers"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">AddCallHeaders</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight14AddCallHeadersE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A write-only wrapper around headers for an RPC call. </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="_CPPv4N5arrow6flight14AddCallHeaders9AddHeaderERKNSt6stringERKNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight14AddCallHeaders9AddHeaderERKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N5arrow6flight14AddCallHeaders9AddHeaderERKNSt6stringERKNSt6stringE"></span><span id="arrow::flight::AddCallHeaders::AddHeader__ssCR.ssCR"></span><span class="target" id="classarrow_1_1flight_1_1_add_call_headers_1a0c589c15379805a92781df546e982731"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </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">AddHeader</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">key</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">value</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight14AddCallHeaders9AddHeaderERKNSt6stringERKNSt6stringE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Add a header to be sent to the client. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8CallInfoE"> |
| <span id="_CPPv3N5arrow6flight8CallInfoE"></span><span id="_CPPv2N5arrow6flight8CallInfoE"></span><span id="arrow::flight::CallInfo"></span><span class="target" id="structarrow_1_1flight_1_1_call_info"></span><span class="k"><span class="pre">struct</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><span class="sig-name descname"><span class="n"><span class="pre">CallInfo</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight8CallInfoE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Information about an instance of a Flight RPC. </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="_CPPv4N5arrow6flight8CallInfo6methodE"> |
| <span id="_CPPv3N5arrow6flight8CallInfo6methodE"></span><span id="_CPPv2N5arrow6flight8CallInfo6methodE"></span><span id="arrow::flight::CallInfo::method__FlightMethod"></span><span class="target" id="structarrow_1_1flight_1_1_call_info_1ade3302d2aaf99d6a128fa026d2144a4c"></span><a class="reference internal" href="#_CPPv4N5arrow6flight12FlightMethodE" title="arrow::flight::FlightMethod"><span class="n"><span class="pre">FlightMethod</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">method</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight8CallInfo6methodE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The RPC method of this call. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8CriteriaE"> |
| <span id="_CPPv3N5arrow6flight8CriteriaE"></span><span id="_CPPv2N5arrow6flight8CriteriaE"></span><span id="arrow::flight::Criteria"></span><span class="target" id="structarrow_1_1flight_1_1_criteria"></span><span class="k"><span class="pre">struct</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><span class="sig-name descname"><span class="n"><span class="pre">Criteria</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight8CriteriaE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Opaque selection criteria for ListFlights RPC. </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="_CPPv4N5arrow6flight8Criteria10expressionE"> |
| <span id="_CPPv3N5arrow6flight8Criteria10expressionE"></span><span id="_CPPv2N5arrow6flight8Criteria10expressionE"></span><span id="arrow::flight::Criteria::expression__ss"></span><span class="target" id="structarrow_1_1flight_1_1_criteria_1aa7f742b91843a5345a772eeb33741c73"></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">expression</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight8Criteria10expressionE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Opaque criteria expression, dependent on server implementation. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightDescriptorE"> |
| <span id="_CPPv3N5arrow6flight16FlightDescriptorE"></span><span id="_CPPv2N5arrow6flight16FlightDescriptorE"></span><span id="arrow::flight::FlightDescriptor"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor"></span><span class="k"><span class="pre">struct</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><span class="sig-name descname"><span class="n"><span class="pre">FlightDescriptor</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDescriptorE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A request to retrieve or generate a dataset. </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="_CPPv4NK5arrow6flight16FlightDescriptor8ToStringEv"> |
| <span id="_CPPv3NK5arrow6flight16FlightDescriptor8ToStringEv"></span><span id="_CPPv2NK5arrow6flight16FlightDescriptor8ToStringEv"></span><span id="arrow::flight::FlightDescriptor::ToStringC"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor_1af36068fccc9781e62ab31c6886458a61"></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">ToString</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="#_CPPv4NK5arrow6flight16FlightDescriptor8ToStringEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get a human-readable form of this descriptor. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight16FlightDescriptor17SerializeToStringEPNSt6stringE"> |
| <span id="_CPPv3NK5arrow6flight16FlightDescriptor17SerializeToStringEPNSt6stringE"></span><span id="_CPPv2NK5arrow6flight16FlightDescriptor17SerializeToStringEPNSt6stringE"></span><span id="arrow::flight::FlightDescriptor::SerializeToString__ssPC"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor_1acfcb275c37f99881485dc02fc1d6bd48"></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">SerializeToString</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight16FlightDescriptor17SerializeToStringEPNSt6stringE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get the wire-format representation of this type. </p> |
| <p>Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types. </p> |
| </dd></dl> |
| |
| </div> |
| <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="_CPPv4N5arrow6flight16FlightDescriptor4typeE"> |
| <span id="_CPPv3N5arrow6flight16FlightDescriptor4typeE"></span><span id="_CPPv2N5arrow6flight16FlightDescriptor4typeE"></span><span id="arrow::flight::FlightDescriptor::type__DescriptorType"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor_1aabfcaa722ae6b362ee3be72273ea79ab"></span><span class="n"><span class="pre">DescriptorType</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDescriptor4typeE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The descriptor type. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightDescriptor3cmdE"> |
| <span id="_CPPv3N5arrow6flight16FlightDescriptor3cmdE"></span><span id="_CPPv2N5arrow6flight16FlightDescriptor3cmdE"></span><span id="arrow::flight::FlightDescriptor::cmd__ss"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor_1a5cc5791676902261e4985350fa9c92ed"></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">cmd</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDescriptor3cmdE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Opaque value used to express a command. </p> |
| <p>Should only be defined when type is CMD </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightDescriptor4pathE"> |
| <span id="_CPPv3N5arrow6flight16FlightDescriptor4pathE"></span><span id="_CPPv2N5arrow6flight16FlightDescriptor4pathE"></span><span id="arrow::flight::FlightDescriptor::path__std::vector:ss:"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor_1a5451422dd19bfec89dce2b62866c1e53"></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">path</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDescriptor4pathE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>List of strings identifying a particular dataset. </p> |
| <p>Should only be defined when type is PATH </p> |
| </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="_CPPv4N5arrow6flight16FlightDescriptor11DeserializeERKNSt6stringEP16FlightDescriptor"> |
| <span id="_CPPv3N5arrow6flight16FlightDescriptor11DeserializeERKNSt6stringEP16FlightDescriptor"></span><span id="_CPPv2N5arrow6flight16FlightDescriptor11DeserializeERKNSt6stringEP16FlightDescriptor"></span><span id="arrow::flight::FlightDescriptor::Deserialize__ssCR.FlightDescriptorP"></span><span class="target" id="structarrow_1_1flight_1_1_flight_descriptor_1add9e6636618f8147891a4105bde50158"></span><span class="k"><span class="pre">static</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">Deserialize</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">serialized</span></span>, <a class="reference internal" href="#_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">out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDescriptor11DeserializeERKNSt6stringEP16FlightDescriptor" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Parse the wire-format representation of this type. </p> |
| <p>Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight14FlightEndpointE"> |
| <span id="_CPPv3N5arrow6flight14FlightEndpointE"></span><span id="_CPPv2N5arrow6flight14FlightEndpointE"></span><span id="arrow::flight::FlightEndpoint"></span><span class="target" id="structarrow_1_1flight_1_1_flight_endpoint"></span><span class="k"><span class="pre">struct</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><span class="sig-name descname"><span class="n"><span class="pre">FlightEndpoint</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight14FlightEndpointE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A flight ticket and list of locations where the ticket can be redeemed. </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="_CPPv4N5arrow6flight14FlightEndpoint6ticketE"> |
| <span id="_CPPv3N5arrow6flight14FlightEndpoint6ticketE"></span><span id="_CPPv2N5arrow6flight14FlightEndpoint6ticketE"></span><span id="arrow::flight::FlightEndpoint::ticket__Ticket"></span><span class="target" id="structarrow_1_1flight_1_1_flight_endpoint_1ae88cc1607d53a206d33ea692c3f5d4f0"></span><a class="reference internal" href="#_CPPv4N5arrow6flight6TicketE" title="arrow::flight::Ticket"><span class="n"><span class="pre">Ticket</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ticket</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight14FlightEndpoint6ticketE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Opaque ticket identify; use with DoGet RPC. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight14FlightEndpoint9locationsE"> |
| <span id="_CPPv3N5arrow6flight14FlightEndpoint9locationsE"></span><span id="_CPPv2N5arrow6flight14FlightEndpoint9locationsE"></span><span id="arrow::flight::FlightEndpoint::locations__std::vector:Location:"></span><span class="target" id="structarrow_1_1flight_1_1_flight_endpoint_1a93c933152f5458413022c74b3a68ec3e"></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="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</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">locations</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight14FlightEndpoint9locationsE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>List of locations where ticket can be redeemed. </p> |
| <p>If the list is empty, the ticket can only be redeemed on the current service where the ticket was generated </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight10FlightInfoE"> |
| <span id="_CPPv3N5arrow6flight10FlightInfoE"></span><span id="_CPPv2N5arrow6flight10FlightInfoE"></span><span id="arrow::flight::FlightInfo"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">FlightInfo</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight10FlightInfoE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The access coordinates for retireval of a dataset, returned by GetFlightInfo. </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="_CPPv4NK5arrow6flight10FlightInfo9GetSchemaEPN3ipc14DictionaryMemoEPNSt10shared_ptrI6SchemaEE"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo9GetSchemaEPN3ipc14DictionaryMemoEPNSt10shared_ptrI6SchemaEE"></span><span id="_CPPv2NK5arrow6flight10FlightInfo9GetSchemaEPN3ipc14DictionaryMemoEPNSt10shared_ptrI6SchemaEE"></span><span id="arrow::flight::FlightInfo::GetSchema__ipc::DictionaryMemoP.std::shared_ptr:Schema:PC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1aa5807342b5de710ef93499977fa19c6b"></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="n"><span class="pre">ipc</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">DictionaryMemo</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">dictionary_memo</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="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight10FlightInfo9GetSchemaEPN3ipc14DictionaryMemoEPNSt10shared_ptrI6SchemaEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Deserialize the Arrow schema of the dataset, to be passed to each call to DoGet. </p> |
| <p>Populate any dictionary encoded fields into a DictionaryMemo for bookkeeping </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>dictionary_memo</strong> – <strong>[inout]</strong> for dictionary bookkeeping, will be modified </p></li> |
| <li><p><strong>out</strong> – <strong>[out]</strong> the reconstructed <a class="reference internal" href="datatype.html#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo10descriptorEv"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo10descriptorEv"></span><span id="_CPPv2NK5arrow6flight10FlightInfo10descriptorEv"></span><span id="arrow::flight::FlightInfo::descriptorC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1af948fa2fc9f46987656dff565aeb62bb"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_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="sig-name descname"><span class="n"><span class="pre">descriptor</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="#_CPPv4NK5arrow6flight10FlightInfo10descriptorEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The descriptor associated with this flight, may not be set. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo9endpointsEv"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo9endpointsEv"></span><span id="_CPPv2NK5arrow6flight10FlightInfo9endpointsEv"></span><span id="arrow::flight::FlightInfo::endpointsC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1a101f2c75e81b0eec16a59baf05514d22"></span><span class="k"><span class="pre">inline</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">vector</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_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="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">endpoints</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="#_CPPv4NK5arrow6flight10FlightInfo9endpointsEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A list of endpoints associated with the flight (dataset). </p> |
| <p>To consume the whole flight, all endpoints must be consumed </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo13total_recordsEv"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo13total_recordsEv"></span><span id="_CPPv2NK5arrow6flight10FlightInfo13total_recordsEv"></span><span id="arrow::flight::FlightInfo::total_recordsC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1a9e19c96b3ae8be6c624b56240f4356b8"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">total_records</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="#_CPPv4NK5arrow6flight10FlightInfo13total_recordsEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The total number of records (rows) in the dataset. If unknown, set to -1. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo11total_bytesEv"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo11total_bytesEv"></span><span id="_CPPv2NK5arrow6flight10FlightInfo11total_bytesEv"></span><span id="arrow::flight::FlightInfo::total_bytesC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1a558520833731ca6a747ad6ef5257ecf2"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">total_bytes</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="#_CPPv4NK5arrow6flight10FlightInfo11total_bytesEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The total number of bytes in the dataset. If unknown, set to -1. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight10FlightInfo17SerializeToStringEPNSt6stringE"> |
| <span id="_CPPv3NK5arrow6flight10FlightInfo17SerializeToStringEPNSt6stringE"></span><span id="_CPPv2NK5arrow6flight10FlightInfo17SerializeToStringEPNSt6stringE"></span><span id="arrow::flight::FlightInfo::SerializeToString__ssPC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1aa14803d54f009e993fe39f20113274f5"></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">SerializeToString</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight10FlightInfo17SerializeToStringEPNSt6stringE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get the wire-format representation of this type. </p> |
| <p>Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types. </p> |
| </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="_CPPv4N5arrow6flight10FlightInfo4MakeERK6SchemaRK16FlightDescriptorRKNSt6vectorI14FlightEndpointEE7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow6flight10FlightInfo4MakeERK6SchemaRK16FlightDescriptorRKNSt6vectorI14FlightEndpointEE7int64_t7int64_t"></span><span id="_CPPv2N5arrow6flight10FlightInfo4MakeERK6SchemaRK16FlightDescriptorRKNSt6vectorI14FlightEndpointEE7int64_t7int64_t"></span><span id="arrow::flight::FlightInfo::Make__SchemaCR.FlightDescriptorCR.std::vector:FlightEndpoint:CR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1ae9cdacea5c70b0445cceb35731642ecd"></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><a class="reference internal" href="#_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="sig-name descname"><span class="n"><span class="pre">Make</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="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><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><a class="reference internal" href="#_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="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><a class="reference internal" href="#_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="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">endpoints</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">total_records</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">total_bytes</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight10FlightInfo4MakeERK6SchemaRK16FlightDescriptorRKNSt6vectorI14FlightEndpointEE7int64_t7int64_t" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Factory method to construct a <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight10FlightInfo11DeserializeERKNSt6stringEPNSt10unique_ptrI10FlightInfoEE"> |
| <span id="_CPPv3N5arrow6flight10FlightInfo11DeserializeERKNSt6stringEPNSt10unique_ptrI10FlightInfoEE"></span><span id="_CPPv2N5arrow6flight10FlightInfo11DeserializeERKNSt6stringEPNSt10unique_ptrI10FlightInfoEE"></span><span id="arrow::flight::FlightInfo::Deserialize__ssCR.std::unique_ptr:FlightInfo:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_info_1a44d8bfa5c21f30d7478dde5068502b6e"></span><span class="k"><span class="pre">static</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">Deserialize</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">serialized</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="#_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">out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight10FlightInfo11DeserializeERKNSt6stringEPNSt10unique_ptrI10FlightInfoEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Parse the wire-format representation of this type. </p> |
| <p>Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types. </p> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight10FlightInfo4DataE"> |
| <span id="_CPPv3N5arrow6flight10FlightInfo4DataE"></span><span id="_CPPv2N5arrow6flight10FlightInfo4DataE"></span><span id="arrow::flight::FlightInfo::Data"></span><span class="target" id="structarrow_1_1flight_1_1_flight_info_1_1_data"></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">Data</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight10FlightInfo4DataE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight13FlightPayloadE"> |
| <span id="_CPPv3N5arrow6flight13FlightPayloadE"></span><span id="_CPPv2N5arrow6flight13FlightPayloadE"></span><span id="arrow::flight::FlightPayload"></span><span class="target" id="structarrow_1_1flight_1_1_flight_payload"></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">FlightPayload</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight13FlightPayloadE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Staging data structure for messages about to be put on the wire. </p> |
| <p>This structure corresponds to FlightData in the protocol. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight13FlightListingE"> |
| <span id="_CPPv3N5arrow6flight13FlightListingE"></span><span id="_CPPv2N5arrow6flight13FlightListingE"></span><span id="arrow::flight::FlightListing"></span><span class="target" id="classarrow_1_1flight_1_1_flight_listing"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">FlightListing</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight13FlightListingE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>An iterator to <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> instances returned by ListFlights. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1flight_1_1_simple_flight_listing"><span class="std std-ref">arrow::flight::SimpleFlightListing</span></a></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="_CPPv4N5arrow6flight13FlightListing4NextEPNSt10unique_ptrI10FlightInfoEE"> |
| <span id="_CPPv3N5arrow6flight13FlightListing4NextEPNSt10unique_ptrI10FlightInfoEE"></span><span id="_CPPv2N5arrow6flight13FlightListing4NextEPNSt10unique_ptrI10FlightInfoEE"></span><span id="arrow::flight::FlightListing::Next__std::unique_ptr:FlightInfo:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_listing_1a4d341f57f093134d0a89c47084be5b05"></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">Next</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">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_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="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight13FlightListing4NextEPNSt10unique_ptrI10FlightInfoEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Retrieve the next <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> from the iterator. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>info</strong> – <strong>[out]</strong> A single <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a>. Set to <em>nullptr</em> if there are none left. </p> |
| </dd> |
| <dt class="field-even">Returns</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> |
| </dd></dl> |
| |
| <dl class="cpp enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethodE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethodE"></span><span id="_CPPv2N5arrow6flight12FlightMethodE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9"></span><span class="k"><span class="pre">enum</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><span class="sig-name descname"><span class="n"><span class="pre">FlightMethod</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethodE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>An enumeration of the RPC methods Flight implements. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod7InvalidE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod7InvalidE"></span><span id="_CPPv2N5arrow6flight12FlightMethod7InvalidE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a4bbb8f967da6d1a610596d7257179c2b"></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">Invalid</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod7InvalidE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod9HandshakeE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod9HandshakeE"></span><span id="_CPPv2N5arrow6flight12FlightMethod9HandshakeE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a7559811a22a9c4b79332bd85a197e4c5"></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">Handshake</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod9HandshakeE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod11ListFlightsE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod11ListFlightsE"></span><span id="_CPPv2N5arrow6flight12FlightMethod11ListFlightsE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a05c19eb1b6596dd2588a8b09cc246ef4"></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">ListFlights</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod11ListFlightsE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod13GetFlightInfoE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod13GetFlightInfoE"></span><span id="_CPPv2N5arrow6flight12FlightMethod13GetFlightInfoE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9aebfc9ab310a15a21c35657482c3450b8"></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">GetFlightInfo</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod13GetFlightInfoE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod9GetSchemaE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod9GetSchemaE"></span><span id="_CPPv2N5arrow6flight12FlightMethod9GetSchemaE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a8d3cfdcce46efdccebb2a0c7ee3eadc3"></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">GetSchema</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod9GetSchemaE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod5DoGetE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod5DoGetE"></span><span id="_CPPv2N5arrow6flight12FlightMethod5DoGetE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a3554dde31575307018486d06a5937808"></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">DoGet</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod5DoGetE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod5DoPutE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod5DoPutE"></span><span id="_CPPv2N5arrow6flight12FlightMethod5DoPutE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9ae514ccb580e9528bc16903b05ae550c7"></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">DoPut</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod5DoPutE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod8DoActionE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod8DoActionE"></span><span id="_CPPv2N5arrow6flight12FlightMethod8DoActionE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a2be1259a544968886c788fa905020bc9"></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">DoAction</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod8DoActionE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod11ListActionsE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod11ListActionsE"></span><span id="_CPPv2N5arrow6flight12FlightMethod11ListActionsE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a7676138469fbafceabd2e7cf7533c027"></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">ListActions</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod11ListActionsE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightMethod10DoExchangeE"> |
| <span id="_CPPv3N5arrow6flight12FlightMethod10DoExchangeE"></span><span id="_CPPv2N5arrow6flight12FlightMethod10DoExchangeE"></span><span class="target" id="namespacearrow_1_1flight_1a7abdca3c76e06cc034cfa07866f82fe9a10dd9d9d389f6546b7e80f4b6038b62b"></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">DoExchange</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightMethod10DoExchangeE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8LocationE"> |
| <span id="_CPPv3N5arrow6flight8LocationE"></span><span id="_CPPv2N5arrow6flight8LocationE"></span><span id="arrow::flight::Location"></span><span class="target" id="structarrow_1_1flight_1_1_location"></span><span class="k"><span class="pre">struct</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><span class="sig-name descname"><span class="n"><span class="pre">Location</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight8LocationE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A host location (a URI) </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="_CPPv4N5arrow6flight8Location8LocationEv"> |
| <span id="_CPPv3N5arrow6flight8Location8LocationEv"></span><span id="_CPPv2N5arrow6flight8Location8LocationEv"></span><span id="arrow::flight::Location::Location"></span><span class="target" id="structarrow_1_1flight_1_1_location_1a7428db46789c3d40ccc63f40b2b823cd"></span><span class="sig-name descname"><span class="n"><span class="pre">Location</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight8Location8LocationEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initialize a blank location. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight8Location8ToStringEv"> |
| <span id="_CPPv3NK5arrow6flight8Location8ToStringEv"></span><span id="_CPPv2NK5arrow6flight8Location8ToStringEv"></span><span id="arrow::flight::Location::ToStringC"></span><span class="target" id="structarrow_1_1flight_1_1_location_1adaa5abc85f6f527e2c5b1ba3f52015cd"></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">ToString</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="#_CPPv4NK5arrow6flight8Location8ToStringEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get a representation of this URI as a string. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight8Location6schemeEv"> |
| <span id="_CPPv3NK5arrow6flight8Location6schemeEv"></span><span id="_CPPv2NK5arrow6flight8Location6schemeEv"></span><span id="arrow::flight::Location::schemeC"></span><span class="target" id="structarrow_1_1flight_1_1_location_1a9103044f6a0aee9674ff695a29a74db6"></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">scheme</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="#_CPPv4NK5arrow6flight8Location6schemeEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get the scheme of this URI. </p> |
| </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="_CPPv4N5arrow6flight8Location5ParseERKNSt6stringEP8Location"> |
| <span id="_CPPv3N5arrow6flight8Location5ParseERKNSt6stringEP8Location"></span><span id="_CPPv2N5arrow6flight8Location5ParseERKNSt6stringEP8Location"></span><span id="arrow::flight::Location::Parse__ssCR.LocationP"></span><span class="target" id="structarrow_1_1flight_1_1_location_1a4fad241023dedc589a7e8d39d89388bd"></span><span class="k"><span class="pre">static</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">Parse</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">uri_string</span></span>, <a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">location</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight8Location5ParseERKNSt6stringEP8Location" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initialize a location by parsing a URI string. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8Location10ForGrpcTcpERKNSt6stringEKiP8Location"> |
| <span id="_CPPv3N5arrow6flight8Location10ForGrpcTcpERKNSt6stringEKiP8Location"></span><span id="_CPPv2N5arrow6flight8Location10ForGrpcTcpERKNSt6stringEKiP8Location"></span><span id="arrow::flight::Location::ForGrpcTcp__ssCR.iC.LocationP"></span><span class="target" id="structarrow_1_1flight_1_1_location_1adce31bbfb95588667e49f68e7ce7fdec"></span><span class="k"><span class="pre">static</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">ForGrpcTcp</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">host</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">port</span></span>, <a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">location</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight8Location10ForGrpcTcpERKNSt6stringEKiP8Location" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initialize a location for a non-TLS, gRPC-based Flight service from a host and port. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>host</strong> – <strong>[in]</strong> The hostname to connect to </p></li> |
| <li><p><strong>port</strong> – <strong>[in]</strong> The port </p></li> |
| <li><p><strong>location</strong> – <strong>[out]</strong> The resulting location </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8Location10ForGrpcTlsERKNSt6stringEKiP8Location"> |
| <span id="_CPPv3N5arrow6flight8Location10ForGrpcTlsERKNSt6stringEKiP8Location"></span><span id="_CPPv2N5arrow6flight8Location10ForGrpcTlsERKNSt6stringEKiP8Location"></span><span id="arrow::flight::Location::ForGrpcTls__ssCR.iC.LocationP"></span><span class="target" id="structarrow_1_1flight_1_1_location_1a544226ce79e9ca24d4c18c9db9b80d62"></span><span class="k"><span class="pre">static</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">ForGrpcTls</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">host</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">port</span></span>, <a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">location</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight8Location10ForGrpcTlsERKNSt6stringEKiP8Location" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initialize a location for a TLS-enabled, gRPC-based Flight service from a host and port. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>host</strong> – <strong>[in]</strong> The hostname to connect to </p></li> |
| <li><p><strong>port</strong> – <strong>[in]</strong> The port </p></li> |
| <li><p><strong>location</strong> – <strong>[out]</strong> The resulting location </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight8Location11ForGrpcUnixERKNSt6stringEP8Location"> |
| <span id="_CPPv3N5arrow6flight8Location11ForGrpcUnixERKNSt6stringEP8Location"></span><span id="_CPPv2N5arrow6flight8Location11ForGrpcUnixERKNSt6stringEP8Location"></span><span id="arrow::flight::Location::ForGrpcUnix__ssCR.LocationP"></span><span class="target" id="structarrow_1_1flight_1_1_location_1a1caa274c20ae70c70b97d4b3c3d7e3e5"></span><span class="k"><span class="pre">static</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">ForGrpcUnix</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">path</span></span>, <a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">location</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight8Location11ForGrpcUnixERKNSt6stringEP8Location" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initialize a location for a domain socket-based Flight service. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>path</strong> – <strong>[in]</strong> The path to the domain socket </p></li> |
| <li><p><strong>location</strong> – <strong>[out]</strong> The resulting location </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight25MetadataRecordBatchReaderE"> |
| <span id="_CPPv3N5arrow6flight25MetadataRecordBatchReaderE"></span><span id="_CPPv2N5arrow6flight25MetadataRecordBatchReaderE"></span><span id="arrow::flight::MetadataRecordBatchReader"></span><span class="target" id="classarrow_1_1flight_1_1_metadata_record_batch_reader"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">MetadataRecordBatchReader</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight25MetadataRecordBatchReaderE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>An interface to read Flight data with metadata. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_message_reader"><span class="std std-ref">arrow::flight::FlightMessageReader</span></a>, <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_stream_reader"><span class="std std-ref">arrow::flight::FlightStreamReader</span></a></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="_CPPv4N5arrow6flight25MetadataRecordBatchReader9GetSchemaEv"> |
| <span id="_CPPv3N5arrow6flight25MetadataRecordBatchReader9GetSchemaEv"></span><span id="_CPPv2N5arrow6flight25MetadataRecordBatchReader9GetSchemaEv"></span><span id="arrow::flight::MetadataRecordBatchReader::GetSchema"></span><span class="target" id="classarrow_1_1flight_1_1_metadata_record_batch_reader_1aa0eeeb0a8e43c0941fc7f25164316641"></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">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="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="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight25MetadataRecordBatchReader9GetSchemaEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get the schema for this stream. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight25MetadataRecordBatchReader4NextEP17FlightStreamChunk"> |
| <span id="_CPPv3N5arrow6flight25MetadataRecordBatchReader4NextEP17FlightStreamChunk"></span><span id="_CPPv2N5arrow6flight25MetadataRecordBatchReader4NextEP17FlightStreamChunk"></span><span id="arrow::flight::MetadataRecordBatchReader::Next__FlightStreamChunkP"></span><span class="target" id="classarrow_1_1flight_1_1_metadata_record_batch_reader_1a15efb059d78e6843783bb923097a7743"></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">Next</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">FlightStreamChunk</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">next</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight25MetadataRecordBatchReader4NextEP17FlightStreamChunk" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get the next message from Flight. </p> |
| <p>If the stream is finished, then the members of <em>FlightStreamChunk</em> will be nullptr. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight25MetadataRecordBatchReader7ReadAllEPNSt6vectorINSt10shared_ptrI11RecordBatchEEEE"> |
| <span id="_CPPv3N5arrow6flight25MetadataRecordBatchReader7ReadAllEPNSt6vectorINSt10shared_ptrI11RecordBatchEEEE"></span><span id="_CPPv2N5arrow6flight25MetadataRecordBatchReader7ReadAllEPNSt6vectorINSt10shared_ptrI11RecordBatchEEEE"></span><span id="arrow::flight::MetadataRecordBatchReader::ReadAll__std::vector:std::shared_ptr:RecordBatch::P"></span><span class="target" id="classarrow_1_1flight_1_1_metadata_record_batch_reader_1a29a2d4a0fefab1fa60c8d710eaeee3ea"></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">ReadAll</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">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">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="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">batches</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight25MetadataRecordBatchReader7ReadAllEPNSt6vectorINSt10shared_ptrI11RecordBatchEEEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Consume entire stream as a vector of record batches. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight25MetadataRecordBatchReader7ReadAllEPNSt10shared_ptrI5TableEE"> |
| <span id="_CPPv3N5arrow6flight25MetadataRecordBatchReader7ReadAllEPNSt10shared_ptrI5TableEE"></span><span id="_CPPv2N5arrow6flight25MetadataRecordBatchReader7ReadAllEPNSt10shared_ptrI5TableEE"></span><span id="arrow::flight::MetadataRecordBatchReader::ReadAll__std::shared_ptr:Table:P"></span><span class="target" id="classarrow_1_1flight_1_1_metadata_record_batch_reader_1a79d785a9952e5c46d907426de6d9a892"></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">ReadAll</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#_CPPv4N5arrow5TableE" title="arrow::Table"><span class="n"><span class="pre">Table</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">table</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight25MetadataRecordBatchReader7ReadAllEPNSt10shared_ptrI5TableEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Consume entire stream as a <a class="reference internal" href="table.html#classarrow_1_1_table"><span class="std std-ref">Table</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight6ResultE"> |
| <span id="_CPPv3N5arrow6flight6ResultE"></span><span id="_CPPv2N5arrow6flight6ResultE"></span><span id="arrow::flight::Result"></span><span class="target" id="structarrow_1_1flight_1_1_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">Result</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight6ResultE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Opaque result returned after executing an action. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12ResultStreamE"> |
| <span id="_CPPv3N5arrow6flight12ResultStreamE"></span><span id="_CPPv2N5arrow6flight12ResultStreamE"></span><span id="arrow::flight::ResultStream"></span><span class="target" id="classarrow_1_1flight_1_1_result_stream"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">ResultStream</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12ResultStreamE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>An iterator to <a class="reference internal" href="#structarrow_1_1flight_1_1_result"><span class="std std-ref">Result</span></a> instances returned by DoAction. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1flight_1_1_simple_result_stream"><span class="std std-ref">arrow::flight::SimpleResultStream</span></a>, arrow::py::flight::PyFlightResultStream</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="_CPPv4N5arrow6flight12ResultStream4NextEPNSt10unique_ptrI6ResultEE"> |
| <span id="_CPPv3N5arrow6flight12ResultStream4NextEPNSt10unique_ptrI6ResultEE"></span><span id="_CPPv2N5arrow6flight12ResultStream4NextEPNSt10unique_ptrI6ResultEE"></span><span id="arrow::flight::ResultStream::Next__std::unique_ptr:Result:P"></span><span class="target" id="classarrow_1_1flight_1_1_result_stream_1a8367eb136dccc60dedd7fce32a14ea02"></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">Next</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">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight6ResultE" title="arrow::flight::Result"><span class="n"><span class="pre">Result</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="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12ResultStream4NextEPNSt10unique_ptrI6ResultEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Retrieve the next <a class="reference internal" href="#structarrow_1_1flight_1_1_result"><span class="std std-ref">Result</span></a> from the iterator. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>info</strong> – <strong>[out]</strong> A single result. Set to <em>nullptr</em> if there are none left. </p> |
| </dd> |
| <dt class="field-even">Returns</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> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight6TicketE"> |
| <span id="_CPPv3N5arrow6flight6TicketE"></span><span id="_CPPv2N5arrow6flight6TicketE"></span><span id="arrow::flight::Ticket"></span><span class="target" id="structarrow_1_1flight_1_1_ticket"></span><span class="k"><span class="pre">struct</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><span class="sig-name descname"><span class="n"><span class="pre">Ticket</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight6TicketE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Data structure providing an opaque identifier or credential to use when requesting a data stream with the DoGet RPC. </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="_CPPv4NK5arrow6flight6Ticket17SerializeToStringEPNSt6stringE"> |
| <span id="_CPPv3NK5arrow6flight6Ticket17SerializeToStringEPNSt6stringE"></span><span id="_CPPv2NK5arrow6flight6Ticket17SerializeToStringEPNSt6stringE"></span><span id="arrow::flight::Ticket::SerializeToString__ssPC"></span><span class="target" id="structarrow_1_1flight_1_1_ticket_1a78e2339782faf566cfb2557ac2220125"></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">SerializeToString</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight6Ticket17SerializeToStringEPNSt6stringE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get the wire-format representation of this type. </p> |
| <p>Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types. </p> |
| </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="_CPPv4N5arrow6flight6Ticket11DeserializeERKNSt6stringEP6Ticket"> |
| <span id="_CPPv3N5arrow6flight6Ticket11DeserializeERKNSt6stringEP6Ticket"></span><span id="_CPPv2N5arrow6flight6Ticket11DeserializeERKNSt6stringEP6Ticket"></span><span id="arrow::flight::Ticket::Deserialize__ssCR.TicketP"></span><span class="target" id="structarrow_1_1flight_1_1_ticket_1ae0f91bbf92f83db03f67e34870236487"></span><span class="k"><span class="pre">static</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">Deserialize</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">serialized</span></span>, <a class="reference internal" href="#_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">out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight6Ticket11DeserializeERKNSt6stringEP6Ticket" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Parse the wire-format representation of this type. </p> |
| <p>Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="clients"> |
| <h2>Clients<a class="headerlink" href="#clients" title="Permalink to this headline">¶</a></h2> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClientE"> |
| <span id="_CPPv3N5arrow6flight12FlightClientE"></span><span id="_CPPv2N5arrow6flight12FlightClientE"></span><span id="arrow::flight::FlightClient"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">FlightClient</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClientE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Client class for Arrow Flight RPC services (gRPC-based). </p> |
| <p>API experimental for now </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="_CPPv4N5arrow6flight12FlightClient12AuthenticateERK17FlightCallOptionsNSt10unique_ptrI17ClientAuthHandlerEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient12AuthenticateERK17FlightCallOptionsNSt10unique_ptrI17ClientAuthHandlerEE"></span><span id="_CPPv2N5arrow6flight12FlightClient12AuthenticateERK17FlightCallOptionsNSt10unique_ptrI17ClientAuthHandlerEE"></span><span id="arrow::flight::FlightClient::Authenticate__FlightCallOptionsCR.std::unique_ptr:ClientAuthHandler:"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1aed24e3c298ae6669e7cade15aafd6eeb"></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">Authenticate</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="#_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="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="#_CPPv4N5arrow6flight17ClientAuthHandlerE" title="arrow::flight::ClientAuthHandler"><span class="n"><span class="pre">ClientAuthHandler</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">auth_handler</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient12AuthenticateERK17FlightCallOptionsNSt10unique_ptrI17ClientAuthHandlerEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Authenticate to the server using the given handler. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>auth_handler</strong> – <strong>[in]</strong> The authentication mechanism to use </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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> OK if the client authenticated successfully </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient22AuthenticateBasicTokenERK17FlightCallOptionsRKNSt6stringERKNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient22AuthenticateBasicTokenERK17FlightCallOptionsRKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N5arrow6flight12FlightClient22AuthenticateBasicTokenERK17FlightCallOptionsRKNSt6stringERKNSt6stringE"></span><span id="arrow::flight::FlightClient::AuthenticateBasicToken__FlightCallOptionsCR.ssCR.ssCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a43bd8581511ebacf2ac656b294d0176e"></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">pair</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="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AuthenticateBasicToken</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="#_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">username</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">password</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient22AuthenticateBasicTokenERK17FlightCallOptionsRKNSt6stringERKNSt6stringE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Authenticate to the server using basic HTTP style authentication. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>username</strong> – <strong>[in]</strong> Username to use </p></li> |
| <li><p><strong>password</strong> – <strong>[in]</strong> Password to use </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>Arrow result with bearer token and status OK if client authenticated sucessfully </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient8DoActionERK17FlightCallOptionsRK6ActionPNSt10unique_ptrI12ResultStreamEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient8DoActionERK17FlightCallOptionsRK6ActionPNSt10unique_ptrI12ResultStreamEE"></span><span id="_CPPv2N5arrow6flight12FlightClient8DoActionERK17FlightCallOptionsRK6ActionPNSt10unique_ptrI12ResultStreamEE"></span><span id="arrow::flight::FlightClient::DoAction__FlightCallOptionsCR.ActionCR.std::unique_ptr:ResultStream:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a390e35877659b6e975656dfeeb063caf"></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="#_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="#_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="#_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">results</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient8DoActionERK17FlightCallOptionsRK6ActionPNSt10unique_ptrI12ResultStreamEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Perform the indicated action, returning an iterator to the stream of results, if any. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>action</strong> – <strong>[in]</strong> the action to be performed </p></li> |
| <li><p><strong>results</strong> – <strong>[out]</strong> an iterator object for reading the returned results </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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="_CPPv4N5arrow6flight12FlightClient11ListActionsERK17FlightCallOptionsPNSt6vectorI10ActionTypeEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient11ListActionsERK17FlightCallOptionsPNSt6vectorI10ActionTypeEE"></span><span id="_CPPv2N5arrow6flight12FlightClient11ListActionsERK17FlightCallOptionsPNSt6vectorI10ActionTypeEE"></span><span id="arrow::flight::FlightClient::ListActions__FlightCallOptionsCR.std::vector:ActionType:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a3824825cbab04ade6d37f3b466335905"></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="#_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="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="#_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><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient11ListActionsERK17FlightCallOptionsPNSt6vectorI10ActionTypeEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Retrieve a list of available <a class="reference internal" href="#structarrow_1_1flight_1_1_action"><span class="std std-ref">Action</span></a> types. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>actions</strong> – <strong>[out]</strong> the available actions </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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="_CPPv4N5arrow6flight12FlightClient13GetFlightInfoERK17FlightCallOptionsRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient13GetFlightInfoERK17FlightCallOptionsRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE"></span><span id="_CPPv2N5arrow6flight12FlightClient13GetFlightInfoERK17FlightCallOptionsRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE"></span><span id="arrow::flight::FlightClient::GetFlightInfo__FlightCallOptionsCR.FlightDescriptorCR.std::unique_ptr:FlightInfo:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1af95b8bb8081f7e83de6531e3cd3eded3"></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="#_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="#_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="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="#_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><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient13GetFlightInfoERK17FlightCallOptionsRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Request access plan for a single flight, which may be an existing dataset or a command to be executed. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> the dataset request, whether a named dataset or command </p></li> |
| <li><p><strong>info</strong> – <strong>[out]</strong> the <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> describing where to access the dataset </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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="_CPPv4N5arrow6flight12FlightClient9GetSchemaERK17FlightCallOptionsRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient9GetSchemaERK17FlightCallOptionsRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE"></span><span id="_CPPv2N5arrow6flight12FlightClient9GetSchemaERK17FlightCallOptionsRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE"></span><span id="arrow::flight::FlightClient::GetSchema__FlightCallOptionsCR.FlightDescriptorCR.std::unique_ptr:SchemaResult:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1ae1afd8df73fa755667f85acc846a9528"></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="#_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="#_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="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_result</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient9GetSchemaERK17FlightCallOptionsRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Request schema for a single flight, which may be an existing dataset or a command to be executed. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> the dataset request, whether a named dataset or command </p></li> |
| <li><p><strong>schema_result</strong> – <strong>[out]</strong> the SchemaResult describing the dataset schema </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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="_CPPv4N5arrow6flight12FlightClient11ListFlightsEPNSt10unique_ptrI13FlightListingEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient11ListFlightsEPNSt10unique_ptrI13FlightListingEE"></span><span id="_CPPv2N5arrow6flight12FlightClient11ListFlightsEPNSt10unique_ptrI13FlightListingEE"></span><span id="arrow::flight::FlightClient::ListFlights__std::unique_ptr:FlightListing:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1ac69cc9ce6c42740aa0eb7c298f744162"></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">ListFlights</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">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight13FlightListingE" title="arrow::flight::FlightListing"><span class="n"><span class="pre">FlightListing</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">listing</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient11ListFlightsEPNSt10unique_ptrI13FlightListingEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>List all available flights known to the server. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>listing</strong> – <strong>[out]</strong> an iterator that returns a <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> for each flight </p> |
| </dd> |
| <dt class="field-even">Returns</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="_CPPv4N5arrow6flight12FlightClient11ListFlightsERK17FlightCallOptionsRK8CriteriaPNSt10unique_ptrI13FlightListingEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient11ListFlightsERK17FlightCallOptionsRK8CriteriaPNSt10unique_ptrI13FlightListingEE"></span><span id="_CPPv2N5arrow6flight12FlightClient11ListFlightsERK17FlightCallOptionsRK8CriteriaPNSt10unique_ptrI13FlightListingEE"></span><span id="arrow::flight::FlightClient::ListFlights__FlightCallOptionsCR.CriteriaCR.std::unique_ptr:FlightListing:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a3f68fc0382631de5eb3bfe20603dca50"></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">ListFlights</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="#_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="#_CPPv4N5arrow6flight8CriteriaE" title="arrow::flight::Criteria"><span class="n"><span class="pre">Criteria</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">criteria</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="#_CPPv4N5arrow6flight13FlightListingE" title="arrow::flight::FlightListing"><span class="n"><span class="pre">FlightListing</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">listing</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient11ListFlightsERK17FlightCallOptionsRK8CriteriaPNSt10unique_ptrI13FlightListingEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>List available flights given indicated filter criteria. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>criteria</strong> – <strong>[in]</strong> the filter criteria (opaque) </p></li> |
| <li><p><strong>listing</strong> – <strong>[out]</strong> an iterator that returns a <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> for each flight </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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="_CPPv4N5arrow6flight12FlightClient5DoGetERK17FlightCallOptionsRK6TicketPNSt10unique_ptrI18FlightStreamReaderEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient5DoGetERK17FlightCallOptionsRK6TicketPNSt10unique_ptrI18FlightStreamReaderEE"></span><span id="_CPPv2N5arrow6flight12FlightClient5DoGetERK17FlightCallOptionsRK6TicketPNSt10unique_ptrI18FlightStreamReaderEE"></span><span id="arrow::flight::FlightClient::DoGet__FlightCallOptionsCR.TicketCR.std::unique_ptr:FlightStreamReader:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a18f7186e0a7417b4dd5d58d11ea223d5"></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="#_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="#_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="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="#_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="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><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient5DoGetERK17FlightCallOptionsRK6TicketPNSt10unique_ptrI18FlightStreamReaderEE" 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</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> |
| <li><p><strong>stream</strong> – <strong>[out]</strong> the returned <a class="reference internal" href="table.html#classarrow_1_1_record_batch_reader"><span class="std std-ref">RecordBatchReader</span></a> </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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="_CPPv4N5arrow6flight12FlightClient5DoPutERK17FlightCallOptionsRK16FlightDescriptorRKNSt10shared_ptrI6SchemaEEPNSt10unique_ptrI18FlightStreamWriterEEPNSt10unique_ptrI20FlightMetadataReaderEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient5DoPutERK17FlightCallOptionsRK16FlightDescriptorRKNSt10shared_ptrI6SchemaEEPNSt10unique_ptrI18FlightStreamWriterEEPNSt10unique_ptrI20FlightMetadataReaderEE"></span><span id="_CPPv2N5arrow6flight12FlightClient5DoPutERK17FlightCallOptionsRK16FlightDescriptorRKNSt10shared_ptrI6SchemaEEPNSt10unique_ptrI18FlightStreamWriterEEPNSt10unique_ptrI20FlightMetadataReaderEE"></span><span id="arrow::flight::FlightClient::DoPut__FlightCallOptionsCR.FlightDescriptorCR.std::shared_ptr:Schema:CR.std::unique_ptr:FlightStreamWriter:P.std::unique_ptr:FlightMetadataReader:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a1936c7c7fe7e1589838af10e47f01313"></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="#_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="#_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="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="n sig-param"><span class="pre">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">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight18FlightStreamWriterE" title="arrow::flight::FlightStreamWriter"><span class="n"><span class="pre">FlightStreamWriter</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="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">FlightMetadataReader</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">reader</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient5DoPutERK17FlightCallOptionsRK16FlightDescriptorRKNSt10shared_ptrI6SchemaEEPNSt10unique_ptrI18FlightStreamWriterEEPNSt10unique_ptrI20FlightMetadataReaderEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Upload data to a Flight described by the given descriptor. </p> |
| <p>The caller must call Close() on the returned stream once they are done writing.</p> |
| <p>The reader and writer are linked; closing the writer will also close the reader. Use <em>DoneWriting</em> to only close the write side of the channel.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Per-RPC options </p></li> |
| <li><p><strong>descriptor</strong> – <strong>[in]</strong> the descriptor of the stream </p></li> |
| <li><p><strong>schema</strong> – <strong>[in]</strong> the schema for the data to upload </p></li> |
| <li><p><strong>stream</strong> – <strong>[out]</strong> a writer to write record batches to </p></li> |
| <li><p><strong>reader</strong> – <strong>[out]</strong> a reader for application metadata from the server </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient7ConnectERK8LocationPNSt10unique_ptrI12FlightClientEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient7ConnectERK8LocationPNSt10unique_ptrI12FlightClientEE"></span><span id="_CPPv2N5arrow6flight12FlightClient7ConnectERK8LocationPNSt10unique_ptrI12FlightClientEE"></span><span id="arrow::flight::FlightClient::Connect__LocationCR.std::unique_ptr:FlightClient:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a4f6f53a7e955fffa3243902d4180471b"></span><span class="k"><span class="pre">static</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">Connect</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="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">location</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="#_CPPv4N5arrow6flight12FlightClientE" title="arrow::flight::FlightClient"><span class="n"><span class="pre">FlightClient</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">client</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient7ConnectERK8LocationPNSt10unique_ptrI12FlightClientEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Connect to an unauthenticated flight service. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>location</strong> – <strong>[in]</strong> the URI </p></li> |
| <li><p><strong>client</strong> – <strong>[out]</strong> the created <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_client"><span class="std std-ref">FlightClient</span></a> </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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> OK status may not indicate that the connection was successful </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight12FlightClient7ConnectERK8LocationRK19FlightClientOptionsPNSt10unique_ptrI12FlightClientEE"> |
| <span id="_CPPv3N5arrow6flight12FlightClient7ConnectERK8LocationRK19FlightClientOptionsPNSt10unique_ptrI12FlightClientEE"></span><span id="_CPPv2N5arrow6flight12FlightClient7ConnectERK8LocationRK19FlightClientOptionsPNSt10unique_ptrI12FlightClientEE"></span><span id="arrow::flight::FlightClient::Connect__LocationCR.FlightClientOptionsCR.std::unique_ptr:FlightClient:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_client_1a8cf7a50ad0ec8554a3888d07d2e14219"></span><span class="k"><span class="pre">static</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">Connect</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="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">location</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight19FlightClientOptionsE" title="arrow::flight::FlightClientOptions"><span class="n"><span class="pre">FlightClientOptions</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="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="#_CPPv4N5arrow6flight12FlightClientE" title="arrow::flight::FlightClient"><span class="n"><span class="pre">FlightClient</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">client</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight12FlightClient7ConnectERK8LocationRK19FlightClientOptionsPNSt10unique_ptrI12FlightClientEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Connect to an unauthenticated flight service. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>location</strong> – <strong>[in]</strong> the URI </p></li> |
| <li><p><strong>options</strong> – <strong>[in]</strong> Other options for setting up the client </p></li> |
| <li><p><strong>client</strong> – <strong>[out]</strong> the created <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_client"><span class="std std-ref">FlightClient</span></a> </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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> OK status may not indicate that the connection was successful </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptionsE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptionsE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptionsE"></span><span id="arrow::flight::FlightClientOptions"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options"></span><span class="k"><span class="pre">struct</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><span class="sig-name descname"><span class="n"><span class="pre">FlightClientOptions</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptionsE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><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="_CPPv4N5arrow6flight19FlightClientOptions14tls_root_certsE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions14tls_root_certsE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions14tls_root_certsE"></span><span id="arrow::flight::FlightClientOptions::tls_root_certs__ss"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1add5f255e136e5d25243a504bfbe90958"></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">tls_root_certs</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions14tls_root_certsE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Root certificates to use for validating server certificates. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions17override_hostnameE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions17override_hostnameE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions17override_hostnameE"></span><span id="arrow::flight::FlightClientOptions::override_hostname__ss"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1a494b451fcfece2fd181c609cfe4f0e4b"></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">override_hostname</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions17override_hostnameE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Override the hostname checked by TLS. Use with caution. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions10cert_chainE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions10cert_chainE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions10cert_chainE"></span><span id="arrow::flight::FlightClientOptions::cert_chain__ss"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1a2bc5e5269cb3a82eb5ba0d8b6251193e"></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">cert_chain</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions10cert_chainE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The client certificate to use if using Mutual TLS. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions11private_keyE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions11private_keyE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions11private_keyE"></span><span id="arrow::flight::FlightClientOptions::private_key__ss"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1aaeb361d048b6b807689d9d3c0e027065"></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">private_key</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions11private_keyE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The private key associated with the client certificate for Mutual TLS. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions10middlewareE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions10middlewareE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions10middlewareE"></span><span id="arrow::flight::FlightClientOptions::middleware__std::vector:std::shared_ptr:ClientMiddlewareFactory::"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1a1b798cd0468120edb6a2acf7a87e931b"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight23ClientMiddlewareFactoryE" title="arrow::flight::ClientMiddlewareFactory"><span class="n"><span class="pre">ClientMiddlewareFactory</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">middleware</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions10middlewareE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A list of client middleware to apply. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions22write_size_limit_bytesE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions22write_size_limit_bytesE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions22write_size_limit_bytesE"></span><span id="arrow::flight::FlightClientOptions::write_size_limit_bytes__int64_t"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1ae9af5c10b0f2ab2f74a773f8ea6591b1"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">write_size_limit_bytes</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions22write_size_limit_bytesE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A soft limit on the number of bytes to write in a single batch when sending Arrow data to a server. </p> |
| <p>Used to help limit server memory consumption. Only enabled if positive. When enabled, FlightStreamWriter.Write* may yield a IOError with error detail FlightWriteSizeStatusDetail. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions15generic_optionsE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions15generic_optionsE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions15generic_optionsE"></span><span id="arrow::flight::FlightClientOptions::generic_options__std::vector:std::pair:ss.util::Variant:i.ss:::"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1ac478d924edecf9c10313f3909ac1ff28"></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">pair</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">util</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="kt"><span class="pre">int</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="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">generic_options</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions15generic_optionsE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Generic connection options, passed to the underlying transport; interpretation is implementation-dependent. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightClientOptions27disable_server_verificationE"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions27disable_server_verificationE"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions27disable_server_verificationE"></span><span id="arrow::flight::FlightClientOptions::disable_server_verification__b"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1a41311f8730083f5dbaf6032da9a8a171"></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">disable_server_verification</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">false</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions27disable_server_verificationE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Use TLS without validating the server certificate. Use with caution. </p> |
| </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="_CPPv4N5arrow6flight19FlightClientOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow6flight19FlightClientOptions8DefaultsEv"></span><span id="_CPPv2N5arrow6flight19FlightClientOptions8DefaultsEv"></span><span id="arrow::flight::FlightClientOptions::Defaults"></span><span class="target" id="structarrow_1_1flight_1_1_flight_client_options_1a8e55ccb95e5bbf3db24e2577df5eead8"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight19FlightClientOptionsE" title="arrow::flight::FlightClientOptions"><span class="n"><span class="pre">FlightClientOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Defaults</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightClientOptions8DefaultsEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get default options. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17FlightCallOptionsE"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptionsE"></span><span id="_CPPv2N5arrow6flight17FlightCallOptionsE"></span><span id="arrow::flight::FlightCallOptions"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">FlightCallOptions</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptionsE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Hints to the underlying RPC layer for Arrow Flight 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="_CPPv4N5arrow6flight17FlightCallOptions17FlightCallOptionsEv"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptions17FlightCallOptionsEv"></span><span id="_CPPv2N5arrow6flight17FlightCallOptions17FlightCallOptionsEv"></span><span id="arrow::flight::FlightCallOptions::FlightCallOptions"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options_1a49638080ba66ff44fe1126f27a02f5be"></span><span class="sig-name descname"><span class="n"><span class="pre">FlightCallOptions</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptions17FlightCallOptionsEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Create a default set of call options. </p> |
| </dd></dl> |
| |
| </div> |
| <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="_CPPv4N5arrow6flight17FlightCallOptions7timeoutE"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptions7timeoutE"></span><span id="_CPPv2N5arrow6flight17FlightCallOptions7timeoutE"></span><span id="arrow::flight::FlightCallOptions::timeout__TimeoutDuration"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options_1ae767c6ad69172b3d2ddd6ca40494bb85"></span><a class="reference internal" href="#_CPPv4N5arrow6flight15TimeoutDurationE" title="arrow::flight::TimeoutDuration"><span class="n"><span class="pre">TimeoutDuration</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">timeout</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptions7timeoutE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>An optional timeout for this call. </p> |
| <p>Negative durations mean an implementation-defined default behavior will be used instead. This is the default value. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17FlightCallOptions12read_optionsE"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptions12read_optionsE"></span><span id="_CPPv2N5arrow6flight17FlightCallOptions12read_optionsE"></span><span id="arrow::flight::FlightCallOptions::read_options__ipc::IpcReadOptions"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options_1aad9c5cc750e23ec785275d7765a35af1"></span><span class="n"><span class="pre">ipc</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="ipc.html#_CPPv4N5arrow3ipc14IpcReadOptionsE" title="arrow::ipc::IpcReadOptions"><span class="n"><span class="pre">IpcReadOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">read_options</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptions12read_optionsE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>IPC reader options, if applicable for the call. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17FlightCallOptions13write_optionsE"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptions13write_optionsE"></span><span id="_CPPv2N5arrow6flight17FlightCallOptions13write_optionsE"></span><span id="arrow::flight::FlightCallOptions::write_options__ipc::IpcWriteOptions"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options_1ac68eae40ad88558d997d430a78fe11b2"></span><span class="n"><span class="pre">ipc</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="ipc.html#_CPPv4N5arrow3ipc15IpcWriteOptionsE" title="arrow::ipc::IpcWriteOptions"><span class="n"><span class="pre">IpcWriteOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">write_options</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptions13write_optionsE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>IPC writer options, if applicable for the call. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17FlightCallOptions7headersE"> |
| <span id="_CPPv3N5arrow6flight17FlightCallOptions7headersE"></span><span id="_CPPv2N5arrow6flight17FlightCallOptions7headersE"></span><span id="arrow::flight::FlightCallOptions::headers__std::vector:std::pair:ss.ss::"></span><span class="target" id="classarrow_1_1flight_1_1_flight_call_options_1a1fa1dc582343a4134346d647509deedc"></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">pair</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="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">headers</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17FlightCallOptions7headersE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Headers for client to add to context. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ClientAuthHandlerE"> |
| <span id="_CPPv3N5arrow6flight17ClientAuthHandlerE"></span><span id="_CPPv2N5arrow6flight17ClientAuthHandlerE"></span><span id="arrow::flight::ClientAuthHandler"></span><span class="target" id="classarrow_1_1flight_1_1_client_auth_handler"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">ClientAuthHandler</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17ClientAuthHandlerE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>An authentication implementation for a Flight service. </p> |
| <p>Authentication includes both an initial negotiation and a per-call token validation. Implementations may choose to use either or both mechanisms. </p> |
| <p>Subclassed by arrow::py::flight::PyClientAuthHandler</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="_CPPv4N5arrow6flight17ClientAuthHandler12AuthenticateEP16ClientAuthSenderP16ClientAuthReader"> |
| <span id="_CPPv3N5arrow6flight17ClientAuthHandler12AuthenticateEP16ClientAuthSenderP16ClientAuthReader"></span><span id="_CPPv2N5arrow6flight17ClientAuthHandler12AuthenticateEP16ClientAuthSenderP16ClientAuthReader"></span><span id="arrow::flight::ClientAuthHandler::Authenticate__ClientAuthSenderP.ClientAuthReaderP"></span><span class="target" id="classarrow_1_1flight_1_1_client_auth_handler_1a86a152f14aad68ef020c890f59102ce4"></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">Authenticate</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">ClientAuthSender</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">outgoing</span></span>, <span class="n"><span class="pre">ClientAuthReader</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">incoming</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17ClientAuthHandler12AuthenticateEP16ClientAuthSenderP16ClientAuthReader" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Authenticate the client on initial connection. </p> |
| <p>The client can send messages to/read responses from the server at any time. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a> OK if authenticated successfully </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ClientAuthHandler8GetTokenEPNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight17ClientAuthHandler8GetTokenEPNSt6stringE"></span><span id="_CPPv2N5arrow6flight17ClientAuthHandler8GetTokenEPNSt6stringE"></span><span id="arrow::flight::ClientAuthHandler::GetToken__ssP"></span><span class="target" id="classarrow_1_1flight_1_1_client_auth_handler_1aeb21d551b7a3d8fe9b7dc094fa287843"></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">GetToken</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">token</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17ClientAuthHandler8GetTokenEPNSt6stringE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get a per-call token. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>token</strong> – <strong>[out]</strong> The token to send to the server. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16ClientMiddlewareE"> |
| <span id="_CPPv3N5arrow6flight16ClientMiddlewareE"></span><span id="_CPPv2N5arrow6flight16ClientMiddlewareE"></span><span id="arrow::flight::ClientMiddleware"></span><span class="target" id="classarrow_1_1flight_1_1_client_middleware"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">ClientMiddleware</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ClientMiddlewareE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Client-side middleware for a call, instantiated per RPC. </p> |
| <p>Middleware should be fast and must be infallible: there is no way to reject the call or report errors from the middleware instance. </p> |
| <p>Subclassed by arrow::py::flight::PyClientMiddleware</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="_CPPv4N5arrow6flight16ClientMiddleware14SendingHeadersEP14AddCallHeaders"> |
| <span id="_CPPv3N5arrow6flight16ClientMiddleware14SendingHeadersEP14AddCallHeaders"></span><span id="_CPPv2N5arrow6flight16ClientMiddleware14SendingHeadersEP14AddCallHeaders"></span><span id="arrow::flight::ClientMiddleware::SendingHeaders__AddCallHeadersP"></span><span class="target" id="classarrow_1_1flight_1_1_client_middleware_1a4a72af5fd73ded195c78ec25052f14d8"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </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">SendingHeaders</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow6flight14AddCallHeadersE" title="arrow::flight::AddCallHeaders"><span class="n"><span class="pre">AddCallHeaders</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">outgoing_headers</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ClientMiddleware14SendingHeadersEP14AddCallHeaders" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A callback before headers are sent. </p> |
| <p>Extra headers can be added, but existing ones cannot be read. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16ClientMiddleware15ReceivedHeadersERK11CallHeaders"> |
| <span id="_CPPv3N5arrow6flight16ClientMiddleware15ReceivedHeadersERK11CallHeaders"></span><span id="_CPPv2N5arrow6flight16ClientMiddleware15ReceivedHeadersERK11CallHeaders"></span><span id="arrow::flight::ClientMiddleware::ReceivedHeaders__CallHeadersCR"></span><span class="target" id="classarrow_1_1flight_1_1_client_middleware_1a492de955bab10ba3bf73030e389e7cfa"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </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">ReceivedHeaders</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">CallHeaders</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">incoming_headers</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ClientMiddleware15ReceivedHeadersERK11CallHeaders" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A callback when headers are received from the server. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16ClientMiddleware13CallCompletedERK6Status"> |
| <span id="_CPPv3N5arrow6flight16ClientMiddleware13CallCompletedERK6Status"></span><span id="_CPPv2N5arrow6flight16ClientMiddleware13CallCompletedERK6Status"></span><span id="arrow::flight::ClientMiddleware::CallCompleted__StatusCR"></span><span class="target" id="classarrow_1_1flight_1_1_client_middleware_1a6687c6c857f4aea7a2a16b6944e7b834"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </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">CallCompleted</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="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">status</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ClientMiddleware13CallCompletedERK6Status" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A callback after the call has completed. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight23ClientMiddlewareFactoryE"> |
| <span id="_CPPv3N5arrow6flight23ClientMiddlewareFactoryE"></span><span id="_CPPv2N5arrow6flight23ClientMiddlewareFactoryE"></span><span id="arrow::flight::ClientMiddlewareFactory"></span><span class="target" id="classarrow_1_1flight_1_1_client_middleware_factory"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">ClientMiddlewareFactory</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight23ClientMiddlewareFactoryE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A factory for new middleware instances. </p> |
| <p>If added to a client, this will be called for each RPC (including Handshake) to give the opportunity to intercept the call.</p> |
| <p>It is guaranteed that all client middleware methods are called from the same thread that calls the RPC method implementation. </p> |
| <p>Subclassed by arrow::py::flight::PyClientMiddlewareFactory</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="_CPPv4N5arrow6flight23ClientMiddlewareFactory9StartCallERK8CallInfoPNSt10unique_ptrI16ClientMiddlewareEE"> |
| <span id="_CPPv3N5arrow6flight23ClientMiddlewareFactory9StartCallERK8CallInfoPNSt10unique_ptrI16ClientMiddlewareEE"></span><span id="_CPPv2N5arrow6flight23ClientMiddlewareFactory9StartCallERK8CallInfoPNSt10unique_ptrI16ClientMiddlewareEE"></span><span id="arrow::flight::ClientMiddlewareFactory::StartCall__CallInfoCR.std::unique_ptr:ClientMiddleware:P"></span><span class="target" id="classarrow_1_1flight_1_1_client_middleware_factory_1a840570d1d9c0a8bee4f313bdb711370c"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </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">StartCall</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="#_CPPv4N5arrow6flight8CallInfoE" title="arrow::flight::CallInfo"><span class="n"><span class="pre">CallInfo</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="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="#_CPPv4N5arrow6flight16ClientMiddlewareE" title="arrow::flight::ClientMiddleware"><span class="n"><span class="pre">ClientMiddleware</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">middleware</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight23ClientMiddlewareFactory9StartCallERK8CallInfoPNSt10unique_ptrI16ClientMiddlewareEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A callback for the start of a new call. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>info</strong> – Information about the call. </p></li> |
| <li><p><strong>middleware</strong> – <strong>[out]</strong> The middleware instance for this call. If unset, will not add middleware to this call instance from this factory. </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight15TimeoutDurationE"> |
| <span id="_CPPv3N5arrow6flight15TimeoutDurationE"></span><span id="_CPPv2N5arrow6flight15TimeoutDurationE"></span><span id="arrow::flight::TimeoutDuration"></span><span class="target" id="namespacearrow_1_1flight_1a300f0f4f1be96f649588886489265633"></span><span class="k"><span class="pre">typedef</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">chrono</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">duration</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">double</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">chrono</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">seconds</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">period</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><span class="sig-name descname"><span class="n"><span class="pre">TimeoutDuration</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight15TimeoutDurationE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A duration type for Flight call timeouts. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStreamReaderE"> |
| <span id="_CPPv3N5arrow6flight18FlightStreamReaderE"></span><span id="_CPPv2N5arrow6flight18FlightStreamReaderE"></span><span id="arrow::flight::FlightStreamReader"></span><span class="target" id="classarrow_1_1flight_1_1_flight_stream_reader"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">FlightStreamReader</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="#_CPPv4N5arrow6flight25MetadataRecordBatchReaderE" title="arrow::flight::MetadataRecordBatchReader"><span class="n"><span class="pre">MetadataRecordBatchReader</span></span></a><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStreamReaderE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A <a class="reference internal" href="table.html#classarrow_1_1_record_batch_reader"><span class="std std-ref">RecordBatchReader</span></a> exposing Flight metadata and cancel operations. </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="_CPPv4N5arrow6flight18FlightStreamReader6CancelEv"> |
| <span id="_CPPv3N5arrow6flight18FlightStreamReader6CancelEv"></span><span id="_CPPv2N5arrow6flight18FlightStreamReader6CancelEv"></span><span id="arrow::flight::FlightStreamReader::Cancel"></span><span class="target" id="classarrow_1_1flight_1_1_flight_stream_reader_1a2da607d7731a356d69f7842ac5c19918"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </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">Cancel</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStreamReader6CancelEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Try to cancel the call. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStreamWriterE"> |
| <span id="_CPPv3N5arrow6flight18FlightStreamWriterE"></span><span id="_CPPv2N5arrow6flight18FlightStreamWriterE"></span><span id="arrow::flight::FlightStreamWriter"></span><span class="target" id="classarrow_1_1flight_1_1_flight_stream_writer"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">FlightStreamWriter</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><span class="n"><span class="pre">MetadataRecordBatchWriter</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStreamWriterE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A RecordBatchWriter that also allows sending application-defined metadata via the Flight protocol. </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="_CPPv4N5arrow6flight18FlightStreamWriter11DoneWritingEv"> |
| <span id="_CPPv3N5arrow6flight18FlightStreamWriter11DoneWritingEv"></span><span id="_CPPv2N5arrow6flight18FlightStreamWriter11DoneWritingEv"></span><span id="arrow::flight::FlightStreamWriter::DoneWriting"></span><span class="target" id="classarrow_1_1flight_1_1_flight_stream_writer_1a5d0da94bfa911d652d8257ee13fbe8ed"></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">DoneWriting</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStreamWriter11DoneWritingEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Indicate that the application is done writing to this stream. </p> |
| <p>The application may not write to this stream after calling this. This differs from closing the stream because this writer may represent only one half of a readable and writable stream. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="servers"> |
| <h2>Servers<a class="headerlink" href="#servers" title="Permalink to this headline">¶</a></h2> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBaseE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBaseE"></span><span id="_CPPv2N5arrow6flight16FlightServerBaseE"></span><span id="arrow::flight::FlightServerBase"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">FlightServerBase</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBaseE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Skeleton RPC server implementation which can be used to create custom servers by implementing its abstract methods. </p> |
| <p>Subclassed by arrow::py::flight::PyFlightServer</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="_CPPv4N5arrow6flight16FlightServerBase4InitERK19FlightServerOptions"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase4InitERK19FlightServerOptions"></span><span id="_CPPv2N5arrow6flight16FlightServerBase4InitERK19FlightServerOptions"></span><span id="arrow::flight::FlightServerBase::Init__FlightServerOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a06a8ce8cfc29ea5fc361873fe76764fa"></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">Init</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="#_CPPv4N5arrow6flight19FlightServerOptionsE" title="arrow::flight::FlightServerOptions"><span class="n"><span class="pre">FlightServerOptions</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="#_CPPv4N5arrow6flight16FlightServerBase4InitERK19FlightServerOptions" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Initialize a Flight server listening at the given location. </p> |
| <p>This method must be called before any other method. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>options</strong> – <strong>[in]</strong> The configuration for this server. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight16FlightServerBase4portEv"> |
| <span id="_CPPv3NK5arrow6flight16FlightServerBase4portEv"></span><span id="_CPPv2NK5arrow6flight16FlightServerBase4portEv"></span><span id="arrow::flight::FlightServerBase::portC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1ac9c3d43f50ae7905fa4723b843d8cd98"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">port</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="#_CPPv4NK5arrow6flight16FlightServerBase4portEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get the port that the Flight server is listening on. </p> |
| <p>This method must only be called after <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a06a8ce8cfc29ea5fc361873fe76764fa"><span class="std std-ref">Init()</span></a>. Will return a non-positive value if no port exists (e.g. when listening on a domain socket). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase20SetShutdownOnSignalsEKNSt6vectorIiEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase20SetShutdownOnSignalsEKNSt6vectorIiEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase20SetShutdownOnSignalsEKNSt6vectorIiEE"></span><span id="arrow::flight::FlightServerBase::SetShutdownOnSignals__std::vector:i:C"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1ae02679a91fbfb8dac640df0569c0e32d"></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">SetShutdownOnSignals</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">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="n sig-param"><span class="pre">sigs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase20SetShutdownOnSignalsEKNSt6vectorIiEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Set the server to stop when receiving any of the given signal numbers. </p> |
| <p>This method must be called before <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a7fa89e356d84b3bc61c78f509a16e202"><span class="std std-ref">Serve()</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase5ServeEv"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase5ServeEv"></span><span id="_CPPv2N5arrow6flight16FlightServerBase5ServeEv"></span><span id="arrow::flight::FlightServerBase::Serve"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a7fa89e356d84b3bc61c78f509a16e202"></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">Serve</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase5ServeEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Start serving. </p> |
| <p>This method blocks until either <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a9fa570580e87d5308dc38f929daa35fc"><span class="std std-ref">Shutdown()</span></a> is called or one of the signals registered in <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1ae02679a91fbfb8dac640df0569c0e32d"><span class="std std-ref">SetShutdownOnSignals()</span></a> is received. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight16FlightServerBase9GotSignalEv"> |
| <span id="_CPPv3NK5arrow6flight16FlightServerBase9GotSignalEv"></span><span id="_CPPv2NK5arrow6flight16FlightServerBase9GotSignalEv"></span><span id="arrow::flight::FlightServerBase::GotSignalC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a3005b9262b4a5a97d53d9fed8a469097"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GotSignal</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="#_CPPv4NK5arrow6flight16FlightServerBase9GotSignalEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Query whether <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a7fa89e356d84b3bc61c78f509a16e202"><span class="std std-ref">Serve()</span></a> was interrupted by a signal. </p> |
| <p>This method must be called after <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a7fa89e356d84b3bc61c78f509a16e202"><span class="std std-ref">Serve()</span></a> has returned.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>int the signal number that interrupted <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a7fa89e356d84b3bc61c78f509a16e202"><span class="std std-ref">Serve()</span></a>, if any, otherwise 0 </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase8ShutdownEv"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase8ShutdownEv"></span><span id="_CPPv2N5arrow6flight16FlightServerBase8ShutdownEv"></span><span id="arrow::flight::FlightServerBase::Shutdown"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a9fa570580e87d5308dc38f929daa35fc"></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">Shutdown</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase8ShutdownEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Shut down the server. </p> |
| <p>Can be called from signal handler or another thread while <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_server_base_1a7fa89e356d84b3bc61c78f509a16e202"><span class="std std-ref">Serve()</span></a> blocks.</p> |
| <p>TODO(wesm): Shutdown with deadline </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase4WaitEv"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase4WaitEv"></span><span id="_CPPv2N5arrow6flight16FlightServerBase4WaitEv"></span><span id="arrow::flight::FlightServerBase::Wait"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1ad68a6e1600bf121f1fe2bc32459ad391"></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">Wait</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase4WaitEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Block until server is terminated with Shutdown. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightServerBase11ListFlightsERK17ServerCallContextPK8CriteriaPNSt10unique_ptrI13FlightListingEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase11ListFlightsERK17ServerCallContextPK8CriteriaPNSt10unique_ptrI13FlightListingEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase11ListFlightsERK17ServerCallContextPK8CriteriaPNSt10unique_ptrI13FlightListingEE"></span><span id="arrow::flight::FlightServerBase::ListFlights__ServerCallContextCR.CriteriaCP.std::unique_ptr:FlightListing:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1aa9b655acfcfdaf6e2b911565827dd2b9"></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">ListFlights</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="#_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="#_CPPv4N5arrow6flight8CriteriaE" title="arrow::flight::Criteria"><span class="n"><span class="pre">Criteria</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">criteria</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="#_CPPv4N5arrow6flight13FlightListingE" title="arrow::flight::FlightListing"><span class="n"><span class="pre">FlightListing</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">listings</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase11ListFlightsERK17ServerCallContextPK8CriteriaPNSt10unique_ptrI13FlightListingEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Retrieve a list of available fields given an optional opaque criteria. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>context</strong> – <strong>[in]</strong> The call context. </p></li> |
| <li><p><strong>criteria</strong> – <strong>[in]</strong> may be null </p></li> |
| <li><p><strong>listings</strong> – <strong>[out]</strong> the returned listings iterator </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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="_CPPv4N5arrow6flight16FlightServerBase13GetFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase13GetFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase13GetFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI10FlightInfoEE"></span><span id="arrow::flight::FlightServerBase::GetFlightInfo__ServerCallContextCR.FlightDescriptorCR.std::unique_ptr:FlightInfo:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a225ae1502c6f9b09f650768e98280cf9"></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="#_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="#_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="#_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><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase13GetFlightInfoERK17ServerCallContextRK16FlightDescriptorPNSt10unique_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</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> may be null </p></li> |
| <li><p><strong>info</strong> – <strong>[out]</strong> the returned flight info provider </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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="_CPPv4N5arrow6flight16FlightServerBase9GetSchemaERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase9GetSchemaERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase9GetSchemaERK17ServerCallContextRK16FlightDescriptorPNSt10unique_ptrI12SchemaResultEE"></span><span id="arrow::flight::FlightServerBase::GetSchema__ServerCallContextCR.FlightDescriptorCR.std::unique_ptr:SchemaResult:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a7b4107bd314af21cd1284d7c9c0c450a"></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="#_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="#_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><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase9GetSchemaERK17ServerCallContextRK16FlightDescriptorPNSt10unique_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</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> may be null </p></li> |
| <li><p><strong>schema</strong> – <strong>[out]</strong> the returned flight schema provider </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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="_CPPv4N5arrow6flight16FlightServerBase5DoGetERK17ServerCallContextRK6TicketPNSt10unique_ptrI16FlightDataStreamEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase5DoGetERK17ServerCallContextRK6TicketPNSt10unique_ptrI16FlightDataStreamEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase5DoGetERK17ServerCallContextRK6TicketPNSt10unique_ptrI16FlightDataStreamEE"></span><span id="arrow::flight::FlightServerBase::DoGet__ServerCallContextCR.TicketCR.std::unique_ptr:FlightDataStream:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a6a28902c5eaad91cd3cab3c9a7b694f9"></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="#_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="#_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="#_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><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase5DoGetERK17ServerCallContextRK6TicketPNSt10unique_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</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</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="_CPPv4N5arrow6flight16FlightServerBase5DoPutERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI20FlightMetadataWriterEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase5DoPutERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI20FlightMetadataWriterEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase5DoPutERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI20FlightMetadataWriterEE"></span><span id="arrow::flight::FlightServerBase::DoPut__ServerCallContextCR.std::unique_ptr:FlightMessageReader:.std::unique_ptr:FlightMetadataWriter:"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a3dd52ff2cf92b7bb1e7e5c449294bfd3"></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="#_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="#_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="#_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><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase5DoPutERK17ServerCallContextNSt10unique_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</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</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="_CPPv4N5arrow6flight16FlightServerBase10DoExchangeERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI19FlightMessageWriterEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase10DoExchangeERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI19FlightMessageWriterEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase10DoExchangeERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI19FlightMessageWriterEE"></span><span id="arrow::flight::FlightServerBase::DoExchange__ServerCallContextCR.std::unique_ptr:FlightMessageReader:.std::unique_ptr:FlightMessageWriter:"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1ada5dd1277b40965b05b310d428f4e305"></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">DoExchange</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="#_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="#_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><span class="n"><span class="pre">FlightMessageWriter</span></span><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><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase10DoExchangeERK17ServerCallContextNSt10unique_ptrI19FlightMessageReaderEENSt10unique_ptrI19FlightMessageWriterEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Process a bidirectional stream of IPC payloads. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</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 data back to the client </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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="_CPPv4N5arrow6flight16FlightServerBase8DoActionERK17ServerCallContextRK6ActionPNSt10unique_ptrI12ResultStreamEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase8DoActionERK17ServerCallContextRK6ActionPNSt10unique_ptrI12ResultStreamEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase8DoActionERK17ServerCallContextRK6ActionPNSt10unique_ptrI12ResultStreamEE"></span><span id="arrow::flight::FlightServerBase::DoAction__ServerCallContextCR.ActionCR.std::unique_ptr:ResultStream:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1af386bc5f425feb6d7953e6bb041d1a8b"></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="#_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="#_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="#_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><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase8DoActionERK17ServerCallContextRK6ActionPNSt10unique_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</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</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="_CPPv4N5arrow6flight16FlightServerBase11ListActionsERK17ServerCallContextPNSt6vectorI10ActionTypeEE"> |
| <span id="_CPPv3N5arrow6flight16FlightServerBase11ListActionsERK17ServerCallContextPNSt6vectorI10ActionTypeEE"></span><span id="_CPPv2N5arrow6flight16FlightServerBase11ListActionsERK17ServerCallContextPNSt6vectorI10ActionTypeEE"></span><span id="arrow::flight::FlightServerBase::ListActions__ServerCallContextCR.std::vector:ActionType:P"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_base_1a32e5270b934ee373b64cef4cee07bf97"></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="#_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="#_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><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightServerBase11ListActionsERK17ServerCallContextPNSt6vectorI10ActionTypeEE" 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</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</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> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptionsE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptionsE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptionsE"></span><span id="arrow::flight::FlightServerOptions"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">FlightServerOptions</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptionsE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><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="_CPPv4N5arrow6flight19FlightServerOptions8locationE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions8locationE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions8locationE"></span><span id="arrow::flight::FlightServerOptions::location__Location"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1aa7faa740a57bce03c267148e43afd411"></span><a class="reference internal" href="#_CPPv4N5arrow6flight8LocationE" title="arrow::flight::Location"><span class="n"><span class="pre">Location</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">location</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions8locationE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The host & port (or domain socket path) to listen on. </p> |
| <p>Use port 0 to bind to an available port. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions12auth_handlerE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions12auth_handlerE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions12auth_handlerE"></span><span id="arrow::flight::FlightServerOptions::auth_handler__std::shared_ptr:ServerAuthHandler:"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1af3dff1faed9844a53f964275f312d5d8"></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="#_CPPv4N5arrow6flight17ServerAuthHandlerE" title="arrow::flight::ServerAuthHandler"><span class="n"><span class="pre">ServerAuthHandler</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">auth_handler</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions12auth_handlerE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The authentication handler to use. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions16tls_certificatesE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions16tls_certificatesE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions16tls_certificatesE"></span><span id="arrow::flight::FlightServerOptions::tls_certificates__std::vector:CertKeyPair:"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1a931bfee1d34d25729f25d681210a4825"></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="#_CPPv4N5arrow6flight11CertKeyPairE" title="arrow::flight::CertKeyPair"><span class="n"><span class="pre">CertKeyPair</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">tls_certificates</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions16tls_certificatesE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A list of TLS certificate+key pairs to use. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions13verify_clientE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions13verify_clientE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions13verify_clientE"></span><span id="arrow::flight::FlightServerOptions::verify_client__b"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1a68f7c0d9d9c59a5f23babef692de8223"></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">verify_client</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions13verify_clientE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Enable mTLS and require that the client present a certificate. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions17root_certificatesE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions17root_certificatesE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions17root_certificatesE"></span><span id="arrow::flight::FlightServerOptions::root_certificates__ss"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1a8e960d31126e6e15605c36a006137fba"></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">root_certificates</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions17root_certificatesE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>If using mTLS, the PEM-encoded root certificate to use. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions10middlewareE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions10middlewareE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions10middlewareE"></span><span id="arrow::flight::FlightServerOptions::middleware__std::vector:std::pair:ss.std::shared_ptr:ServerMiddlewareFactory:::"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1a8ce3177a754ac0ca7750b37aae56e9f3"></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">pair</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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight23ServerMiddlewareFactoryE" title="arrow::flight::ServerMiddlewareFactory"><span class="n"><span class="pre">ServerMiddlewareFactory</span></span></a><span class="p"><span class="pre">></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">middleware</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions10middlewareE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A list of server middleware to apply, along with a key to identify them by. </p> |
| <p>Middleware are always applied in the order provided. Duplicate keys are an error. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightServerOptions12builder_hookE"> |
| <span id="_CPPv3N5arrow6flight19FlightServerOptions12builder_hookE"></span><span id="_CPPv2N5arrow6flight19FlightServerOptions12builder_hookE"></span><span class="target" id="classarrow_1_1flight_1_1_flight_server_options_1ac80e7f3b8317bce30cf0ffc6623dfe30"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">void</span></span><span class="p"><span class="pre">(</span></span><span class="kt"><span class="pre">void</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><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">builder_hook</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightServerOptions12builder_hookE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A Flight implementation-specific callback to customize transport-specific options. </p> |
| <p>Not guaranteed to be called. The type of the parameter is specific to the Flight implementation. Users should take care to link to the same transport implementation as Flight to avoid runtime problems. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight11CertKeyPairE"> |
| <span id="_CPPv3N5arrow6flight11CertKeyPairE"></span><span id="_CPPv2N5arrow6flight11CertKeyPairE"></span><span id="arrow::flight::CertKeyPair"></span><span class="target" id="structarrow_1_1flight_1_1_cert_key_pair"></span><span class="k"><span class="pre">struct</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><span class="sig-name descname"><span class="n"><span class="pre">CertKeyPair</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight11CertKeyPairE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A TLS certificate plus key. </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="_CPPv4N5arrow6flight11CertKeyPair8pem_certE"> |
| <span id="_CPPv3N5arrow6flight11CertKeyPair8pem_certE"></span><span id="_CPPv2N5arrow6flight11CertKeyPair8pem_certE"></span><span id="arrow::flight::CertKeyPair::pem_cert__ss"></span><span class="target" id="structarrow_1_1flight_1_1_cert_key_pair_1ab8ccf50ff902c1d72f10fd7b3139a122"></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">pem_cert</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight11CertKeyPair8pem_certE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The certificate in PEM format. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight11CertKeyPair7pem_keyE"> |
| <span id="_CPPv3N5arrow6flight11CertKeyPair7pem_keyE"></span><span id="_CPPv2N5arrow6flight11CertKeyPair7pem_keyE"></span><span id="arrow::flight::CertKeyPair::pem_key__ss"></span><span class="target" id="structarrow_1_1flight_1_1_cert_key_pair_1abfc97775bd03a5ad77db6f565a4211de"></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">pem_key</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight11CertKeyPair7pem_keyE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The key in PEM format. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightDataStreamE"> |
| <span id="_CPPv3N5arrow6flight16FlightDataStreamE"></span><span id="_CPPv2N5arrow6flight16FlightDataStreamE"></span><span id="arrow::flight::FlightDataStream"></span><span class="target" id="classarrow_1_1flight_1_1_flight_data_stream"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">FlightDataStream</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDataStreamE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Interface that produces a sequence of IPC payloads to be sent in FlightData protobuf messages. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1flight_1_1_record_batch_stream"><span class="std std-ref">arrow::flight::RecordBatchStream</span></a>, arrow::py::flight::PyFlightDataStream, arrow::py::flight::PyGeneratorFlightDataStream</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="_CPPv4N5arrow6flight16FlightDataStream16GetSchemaPayloadEP13FlightPayload"> |
| <span id="_CPPv3N5arrow6flight16FlightDataStream16GetSchemaPayloadEP13FlightPayload"></span><span id="_CPPv2N5arrow6flight16FlightDataStream16GetSchemaPayloadEP13FlightPayload"></span><span id="arrow::flight::FlightDataStream::GetSchemaPayload__FlightPayloadP"></span><span class="target" id="classarrow_1_1flight_1_1_flight_data_stream_1ac24218f540e244c11c97449c0bc19978"></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">GetSchemaPayload</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow6flight13FlightPayloadE" title="arrow::flight::FlightPayload"><span class="n"><span class="pre">FlightPayload</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">payload</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightDataStream16GetSchemaPayloadEP13FlightPayload" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Compute <a class="reference internal" href="#structarrow_1_1flight_1_1_flight_payload"><span class="std std-ref">FlightPayload</span></a> containing serialized <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a> schema. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19FlightMessageReaderE"> |
| <span id="_CPPv3N5arrow6flight19FlightMessageReaderE"></span><span id="_CPPv2N5arrow6flight19FlightMessageReaderE"></span><span id="arrow::flight::FlightMessageReader"></span><span class="target" id="classarrow_1_1flight_1_1_flight_message_reader"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">FlightMessageReader</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="#_CPPv4N5arrow6flight25MetadataRecordBatchReaderE" title="arrow::flight::MetadataRecordBatchReader"><span class="n"><span class="pre">MetadataRecordBatchReader</span></span></a><a class="headerlink" href="#_CPPv4N5arrow6flight19FlightMessageReaderE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A reader for IPC payloads uploaded by a client. </p> |
| <p>Also allows reading application-defined metadata via the Flight protocol. </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="_CPPv4NK5arrow6flight19FlightMessageReader10descriptorEv"> |
| <span id="_CPPv3NK5arrow6flight19FlightMessageReader10descriptorEv"></span><span id="_CPPv2NK5arrow6flight19FlightMessageReader10descriptorEv"></span><span id="arrow::flight::FlightMessageReader::descriptorC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_message_reader_1a8ae42ba038e74f746a827284534f3ee6"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_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="sig-name descname"><span class="n"><span class="pre">descriptor</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><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight19FlightMessageReader10descriptorEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get the descriptor for this upload. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight20FlightMetadataWriterE"> |
| <span id="_CPPv3N5arrow6flight20FlightMetadataWriterE"></span><span id="_CPPv2N5arrow6flight20FlightMetadataWriterE"></span><span id="arrow::flight::FlightMetadataWriter"></span><span class="target" id="classarrow_1_1flight_1_1_flight_metadata_writer"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">FlightMetadataWriter</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight20FlightMetadataWriterE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A writer for application-specific metadata sent back to the client during an upload. </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="_CPPv4N5arrow6flight20FlightMetadataWriter13WriteMetadataERK6Buffer"> |
| <span id="_CPPv3N5arrow6flight20FlightMetadataWriter13WriteMetadataERK6Buffer"></span><span id="_CPPv2N5arrow6flight20FlightMetadataWriter13WriteMetadataERK6Buffer"></span><span id="arrow::flight::FlightMetadataWriter::WriteMetadata__BufferCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_metadata_writer_1acbcc91a2d29430578ddf8eee6b60c66f"></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">WriteMetadata</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="memory.html#_CPPv4N5arrow6BufferE" title="arrow::Buffer"><span class="n"><span class="pre">Buffer</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">app_metadata</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight20FlightMetadataWriter13WriteMetadataERK6Buffer" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Send a message to the client. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17RecordBatchStreamE"> |
| <span id="_CPPv3N5arrow6flight17RecordBatchStreamE"></span><span id="_CPPv2N5arrow6flight17RecordBatchStreamE"></span><span id="arrow::flight::RecordBatchStream"></span><span class="target" id="classarrow_1_1flight_1_1_record_batch_stream"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">RecordBatchStream</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="#_CPPv4N5arrow6flight16FlightDataStreamE" title="arrow::flight::FlightDataStream"><span class="n"><span class="pre">FlightDataStream</span></span></a><a class="headerlink" href="#_CPPv4N5arrow6flight17RecordBatchStreamE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A basic implementation of <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_data_stream"><span class="std std-ref">FlightDataStream</span></a> that will provide a sequence of FlightData messages to be written to a gRPC stream. </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="_CPPv4N5arrow6flight17RecordBatchStream17RecordBatchStreamERKNSt10shared_ptrI17RecordBatchReaderEERKN3ipc15IpcWriteOptionsE"> |
| <span id="_CPPv3N5arrow6flight17RecordBatchStream17RecordBatchStreamERKNSt10shared_ptrI17RecordBatchReaderEERKN3ipc15IpcWriteOptionsE"></span><span id="_CPPv2N5arrow6flight17RecordBatchStream17RecordBatchStreamERKNSt10shared_ptrI17RecordBatchReaderEERKN3ipc15IpcWriteOptionsE"></span><span id="arrow::flight::RecordBatchStream::RecordBatchStream__std::shared_ptr:RecordBatchReader:CR.ipc::IpcWriteOptionsCR"></span><span class="target" id="classarrow_1_1flight_1_1_record_batch_stream_1ac2fcf4c337009f94f89d22370230027b"></span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">RecordBatchStream</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">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><span class="n"><span class="pre">ipc</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="ipc.html#_CPPv4N5arrow3ipc15IpcWriteOptionsE" title="arrow::ipc::IpcWriteOptions"><span class="n"><span class="pre">IpcWriteOptions</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="n"><span class="pre">ipc</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="ipc.html#_CPPv4N5arrow3ipc15IpcWriteOptionsE" title="arrow::ipc::IpcWriteOptions"><span class="n"><span class="pre">IpcWriteOptions</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Defaults</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="#_CPPv4N5arrow6flight17RecordBatchStream17RecordBatchStreamERKNSt10shared_ptrI17RecordBatchReaderEERKN3ipc15IpcWriteOptionsE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>reader</strong> – <strong>[in]</strong> produces a sequence of record batches </p></li> |
| <li><p><strong>options</strong> – <strong>[in]</strong> IPC options for writing </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17RecordBatchStream16GetSchemaPayloadEP13FlightPayload"> |
| <span id="_CPPv3N5arrow6flight17RecordBatchStream16GetSchemaPayloadEP13FlightPayload"></span><span id="_CPPv2N5arrow6flight17RecordBatchStream16GetSchemaPayloadEP13FlightPayload"></span><span id="arrow::flight::RecordBatchStream::GetSchemaPayload__FlightPayloadP"></span><span class="target" id="classarrow_1_1flight_1_1_record_batch_stream_1aa2f4d76e34bd384d1b8db10a1e0f22df"></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">GetSchemaPayload</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow6flight13FlightPayloadE" title="arrow::flight::FlightPayload"><span class="n"><span class="pre">FlightPayload</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">payload</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17RecordBatchStream16GetSchemaPayloadEP13FlightPayload" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Compute <a class="reference internal" href="#structarrow_1_1flight_1_1_flight_payload"><span class="std std-ref">FlightPayload</span></a> containing serialized <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a> schema. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ServerAuthHandlerE"> |
| <span id="_CPPv3N5arrow6flight17ServerAuthHandlerE"></span><span id="_CPPv2N5arrow6flight17ServerAuthHandlerE"></span><span id="arrow::flight::ServerAuthHandler"></span><span class="target" id="classarrow_1_1flight_1_1_server_auth_handler"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">ServerAuthHandler</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17ServerAuthHandlerE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>An authentication implementation for a Flight service. </p> |
| <p>Authentication includes both an initial negotiation and a per-call token validation. Implementations may choose to use either or both mechanisms. An implementation may need to track some state, e.g. a mapping of client tokens to authenticated identities. </p> |
| <p>Subclassed by arrow::flight::NoOpAuthHandler, arrow::py::flight::PyServerAuthHandler</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="_CPPv4N5arrow6flight17ServerAuthHandler12AuthenticateEP16ServerAuthSenderP16ServerAuthReader"> |
| <span id="_CPPv3N5arrow6flight17ServerAuthHandler12AuthenticateEP16ServerAuthSenderP16ServerAuthReader"></span><span id="_CPPv2N5arrow6flight17ServerAuthHandler12AuthenticateEP16ServerAuthSenderP16ServerAuthReader"></span><span id="arrow::flight::ServerAuthHandler::Authenticate__ServerAuthSenderP.ServerAuthReaderP"></span><span class="target" id="classarrow_1_1flight_1_1_server_auth_handler_1a0894c7d60d620e5cafb3ffdcd4924766"></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">Authenticate</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">ServerAuthSender</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">outgoing</span></span>, <span class="n"><span class="pre">ServerAuthReader</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">incoming</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17ServerAuthHandler12AuthenticateEP16ServerAuthSenderP16ServerAuthReader" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Authenticate the client on initial connection. </p> |
| <p>The server can send and read responses from the client at any time. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ServerAuthHandler7IsValidERKNSt6stringEPNSt6stringE"> |
| <span id="_CPPv3N5arrow6flight17ServerAuthHandler7IsValidERKNSt6stringEPNSt6stringE"></span><span id="_CPPv2N5arrow6flight17ServerAuthHandler7IsValidERKNSt6stringEPNSt6stringE"></span><span id="arrow::flight::ServerAuthHandler::IsValid__ssCR.ssP"></span><span class="target" id="classarrow_1_1flight_1_1_server_auth_handler_1aa756900200309dfbe26e1f90d29151e6"></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">IsValid</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">token</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="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">peer_identity</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17ServerAuthHandler7IsValidERKNSt6stringEPNSt6stringE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Validate a per-call client token. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>token</strong> – <strong>[in]</strong> The client token. May be the empty string if the client does not provide a token. </p></li> |
| <li><p><strong>peer_identity</strong> – <strong>[out]</strong> The identity of the peer, if this authentication method supports it. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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> OK if the token is valid, any other status if validation failed </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight17ServerCallContextE"> |
| <span id="_CPPv3N5arrow6flight17ServerCallContextE"></span><span id="_CPPv2N5arrow6flight17ServerCallContextE"></span><span id="arrow::flight::ServerCallContext"></span><span class="target" id="classarrow_1_1flight_1_1_server_call_context"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">ServerCallContext</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight17ServerCallContextE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Call state/contextual data. </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="_CPPv4NK5arrow6flight17ServerCallContext13peer_identityEv"> |
| <span id="_CPPv3NK5arrow6flight17ServerCallContext13peer_identityEv"></span><span id="_CPPv2NK5arrow6flight17ServerCallContext13peer_identityEv"></span><span id="arrow::flight::ServerCallContext::peer_identityC"></span><span class="target" id="classarrow_1_1flight_1_1_server_call_context_1abc9372b6fc4110789bc1bd94edc6cef0"></span><span class="k"><span class="pre">virtual</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">string</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">peer_identity</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><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight17ServerCallContext13peer_identityEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The name of the authenticated peer (may be the empty string) </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight17ServerCallContext4peerEv"> |
| <span id="_CPPv3NK5arrow6flight17ServerCallContext4peerEv"></span><span id="_CPPv2NK5arrow6flight17ServerCallContext4peerEv"></span><span id="arrow::flight::ServerCallContext::peerC"></span><span class="target" id="classarrow_1_1flight_1_1_server_call_context_1a58a569abc8437dc66ca97c9bfbd591a6"></span><span class="k"><span class="pre">virtual</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">string</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">peer</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><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight17ServerCallContext4peerEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The peer address (not validated) </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight17ServerCallContext13GetMiddlewareERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow6flight17ServerCallContext13GetMiddlewareERKNSt6stringE"></span><span id="_CPPv2NK5arrow6flight17ServerCallContext13GetMiddlewareERKNSt6stringE"></span><span id="arrow::flight::ServerCallContext::GetMiddleware__ssCRC"></span><span class="target" id="classarrow_1_1flight_1_1_server_call_context_1a9e5c663e42b9180ee1c78079b297f869"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow6flight16ServerMiddlewareE" title="arrow::flight::ServerMiddleware"><span class="n"><span class="pre">ServerMiddleware</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetMiddleware</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">key</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight17ServerCallContext13GetMiddlewareERKNSt6stringE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Look up a middleware by key. </p> |
| <p>Do not maintain a reference to the object beyond the request body. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>The middleware, or nullptr if not found. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16ServerMiddlewareE"> |
| <span id="_CPPv3N5arrow6flight16ServerMiddlewareE"></span><span id="_CPPv2N5arrow6flight16ServerMiddlewareE"></span><span id="arrow::flight::ServerMiddleware"></span><span class="target" id="classarrow_1_1flight_1_1_server_middleware"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">ServerMiddleware</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ServerMiddlewareE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Server-side middleware for a call, instantiated per RPC. </p> |
| <p>Middleware should be fast and must be infallible: there is no way to reject the call or report errors from the middleware instance. </p> |
| <p>Subclassed by arrow::py::flight::PyServerMiddleware</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="_CPPv4NK5arrow6flight16ServerMiddleware4nameEv"> |
| <span id="_CPPv3NK5arrow6flight16ServerMiddleware4nameEv"></span><span id="_CPPv2NK5arrow6flight16ServerMiddleware4nameEv"></span><span id="arrow::flight::ServerMiddleware::nameC"></span><span class="target" id="classarrow_1_1flight_1_1_server_middleware_1a107036290f879e0209321164cc49e6f6"></span><span class="k"><span class="pre">virtual</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="sig-name descname"><span class="n"><span class="pre">name</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><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight16ServerMiddleware4nameEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Unique name of middleware, used as alternative to RTTI. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>the string name of the middleware </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16ServerMiddleware14SendingHeadersEP14AddCallHeaders"> |
| <span id="_CPPv3N5arrow6flight16ServerMiddleware14SendingHeadersEP14AddCallHeaders"></span><span id="_CPPv2N5arrow6flight16ServerMiddleware14SendingHeadersEP14AddCallHeaders"></span><span id="arrow::flight::ServerMiddleware::SendingHeaders__AddCallHeadersP"></span><span class="target" id="classarrow_1_1flight_1_1_server_middleware_1a6f4d5745cc7725577ee0f76558167949"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </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">SendingHeaders</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow6flight14AddCallHeadersE" title="arrow::flight::AddCallHeaders"><span class="n"><span class="pre">AddCallHeaders</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">outgoing_headers</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ServerMiddleware14SendingHeadersEP14AddCallHeaders" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A callback before headers are sent. </p> |
| <p>Extra headers can be added, but existing ones cannot be read. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16ServerMiddleware13CallCompletedERK6Status"> |
| <span id="_CPPv3N5arrow6flight16ServerMiddleware13CallCompletedERK6Status"></span><span id="_CPPv2N5arrow6flight16ServerMiddleware13CallCompletedERK6Status"></span><span id="arrow::flight::ServerMiddleware::CallCompleted__StatusCR"></span><span class="target" id="classarrow_1_1flight_1_1_server_middleware_1a0c50914c910beb5a5bababe8fd283f1f"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </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">CallCompleted</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="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">status</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16ServerMiddleware13CallCompletedERK6Status" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A callback after the call has completed. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight23ServerMiddlewareFactoryE"> |
| <span id="_CPPv3N5arrow6flight23ServerMiddlewareFactoryE"></span><span id="_CPPv2N5arrow6flight23ServerMiddlewareFactoryE"></span><span id="arrow::flight::ServerMiddlewareFactory"></span><span class="target" id="classarrow_1_1flight_1_1_server_middleware_factory"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">ServerMiddlewareFactory</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight23ServerMiddlewareFactoryE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A factory for new middleware instances. </p> |
| <p>If added to a server, this will be called for each RPC (including Handshake) to give the opportunity to intercept the call.</p> |
| <p>It is guaranteed that all server middleware methods are called from the same thread that calls the RPC method implementation. </p> |
| <p>Subclassed by arrow::py::flight::PyServerMiddlewareFactory</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="_CPPv4N5arrow6flight23ServerMiddlewareFactory9StartCallERK8CallInfoRK11CallHeadersPNSt10shared_ptrI16ServerMiddlewareEE"> |
| <span id="_CPPv3N5arrow6flight23ServerMiddlewareFactory9StartCallERK8CallInfoRK11CallHeadersPNSt10shared_ptrI16ServerMiddlewareEE"></span><span id="_CPPv2N5arrow6flight23ServerMiddlewareFactory9StartCallERK8CallInfoRK11CallHeadersPNSt10shared_ptrI16ServerMiddlewareEE"></span><span id="arrow::flight::ServerMiddlewareFactory::StartCall__CallInfoCR.CallHeadersCR.std::shared_ptr:ServerMiddleware:P"></span><span class="target" id="classarrow_1_1flight_1_1_server_middleware_factory_1a6fa0cd1d556d25d41012a207225aa60f"></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">StartCall</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="#_CPPv4N5arrow6flight8CallInfoE" title="arrow::flight::CallInfo"><span class="n"><span class="pre">CallInfo</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="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">CallHeaders</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">incoming_headers</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="#_CPPv4N5arrow6flight16ServerMiddlewareE" title="arrow::flight::ServerMiddleware"><span class="n"><span class="pre">ServerMiddleware</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">middleware</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight23ServerMiddlewareFactory9StartCallERK8CallInfoRK11CallHeadersPNSt10shared_ptrI16ServerMiddlewareEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A callback for the start of a new call. </p> |
| <p>Return a non-OK status to reject the call with the given status.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>info</strong> – Information about the call. </p></li> |
| <li><p><strong>incoming_headers</strong> – Headers sent by the client for this call. Do not retain a reference to this object. </p></li> |
| <li><p><strong>middleware</strong> – <strong>[out]</strong> The middleware instance for this call. If null, no middleware will be added to this call instance from this factory. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</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> A non-OK status will reject the call with the given status. Middleware previously in the chain will have their CallCompleted callback called. Other middleware factories will not be called. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight19SimpleFlightListingE"> |
| <span id="_CPPv3N5arrow6flight19SimpleFlightListingE"></span><span id="_CPPv2N5arrow6flight19SimpleFlightListingE"></span><span id="arrow::flight::SimpleFlightListing"></span><span class="target" id="classarrow_1_1flight_1_1_simple_flight_listing"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">SimpleFlightListing</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="#_CPPv4N5arrow6flight13FlightListingE" title="arrow::flight::FlightListing"><span class="n"><span class="pre">FlightListing</span></span></a><a class="headerlink" href="#_CPPv4N5arrow6flight19SimpleFlightListingE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_listing"><span class="std std-ref">FlightListing</span></a> implementation based on a vector of <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> objects. </p> |
| <p>This can be iterated once, then it is consumed. </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="_CPPv4N5arrow6flight19SimpleFlightListing4NextEPNSt10unique_ptrI10FlightInfoEE"> |
| <span id="_CPPv3N5arrow6flight19SimpleFlightListing4NextEPNSt10unique_ptrI10FlightInfoEE"></span><span id="_CPPv2N5arrow6flight19SimpleFlightListing4NextEPNSt10unique_ptrI10FlightInfoEE"></span><span id="arrow::flight::SimpleFlightListing::Next__std::unique_ptr:FlightInfo:P"></span><span class="target" id="classarrow_1_1flight_1_1_simple_flight_listing_1a5a7451bd1e34fddd9a99adcc693c6f84"></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">Next</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">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_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">override</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight19SimpleFlightListing4NextEPNSt10unique_ptrI10FlightInfoEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Retrieve the next <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a> from the iterator. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>info</strong> – <strong>[out]</strong> A single <a class="reference internal" href="#classarrow_1_1flight_1_1_flight_info"><span class="std std-ref">FlightInfo</span></a>. Set to <em>nullptr</em> if there are none left. </p> |
| </dd> |
| <dt class="field-even">Returns</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> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18SimpleResultStreamE"> |
| <span id="_CPPv3N5arrow6flight18SimpleResultStreamE"></span><span id="_CPPv2N5arrow6flight18SimpleResultStreamE"></span><span id="arrow::flight::SimpleResultStream"></span><span class="target" id="classarrow_1_1flight_1_1_simple_result_stream"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">SimpleResultStream</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="#_CPPv4N5arrow6flight12ResultStreamE" title="arrow::flight::ResultStream"><span class="n"><span class="pre">ResultStream</span></span></a><a class="headerlink" href="#_CPPv4N5arrow6flight18SimpleResultStreamE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A <a class="reference internal" href="#classarrow_1_1flight_1_1_result_stream"><span class="std std-ref">ResultStream</span></a> implementation based on a vector of <a class="reference internal" href="#structarrow_1_1flight_1_1_result"><span class="std std-ref">Result</span></a> objects. </p> |
| <p>This can be iterated once, then it is consumed. </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="_CPPv4N5arrow6flight18SimpleResultStream4NextEPNSt10unique_ptrI6ResultEE"> |
| <span id="_CPPv3N5arrow6flight18SimpleResultStream4NextEPNSt10unique_ptrI6ResultEE"></span><span id="_CPPv2N5arrow6flight18SimpleResultStream4NextEPNSt10unique_ptrI6ResultEE"></span><span id="arrow::flight::SimpleResultStream::Next__std::unique_ptr:Result:P"></span><span class="target" id="classarrow_1_1flight_1_1_simple_result_stream_1a16073801fb1549acfb8ced6ad984acaf"></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">Next</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">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6flight6ResultE" title="arrow::flight::Result"><span class="n"><span class="pre">Result</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">override</span></span><a class="headerlink" href="#_CPPv4N5arrow6flight18SimpleResultStream4NextEPNSt10unique_ptrI6ResultEE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Retrieve the next <a class="reference internal" href="#structarrow_1_1flight_1_1_result"><span class="std std-ref">Result</span></a> from the iterator. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>info</strong> – <strong>[out]</strong> A single result. Set to <em>nullptr</em> if there are none left. </p> |
| </dd> |
| <dt class="field-even">Returns</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> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="error-handling"> |
| <h2>Error Handling<a class="headerlink" href="#error-handling" title="Permalink to this headline">¶</a></h2> |
| <p>Error handling uses the normal <a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">arrow::Status</span></code></a> class, combined |
| with a custom <a class="reference internal" href="support.html#_CPPv4N5arrow12StatusDetailE" title="arrow::StatusDetail"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">arrow::StatusDetail</span></code></a> object for Flight-specific |
| error codes.</p> |
| <dl class="cpp enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCodeE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCodeE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCodeE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450"></span><span class="k"><span class="pre">enum</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><span class="sig-name descname"><span class="n"><span class="pre">FlightStatusCode</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCodeE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A Flight-specific status code. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode8InternalE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode8InternalE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode8InternalE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450aafbf0897a5a83fdd873dfb032ec695d3"></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">Internal</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode8InternalE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>An implementation error has occurred. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode8TimedOutE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode8TimedOutE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode8TimedOutE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450a9541eb2348d883dd8e32ae0420274c4c"></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">TimedOut</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode8TimedOutE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A request timed out. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode9CancelledE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode9CancelledE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode9CancelledE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450aa149e85a44aeec9140e92733d9ed694e"></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">Cancelled</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode9CancelledE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A request was cancelled. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode15UnauthenticatedE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode15UnauthenticatedE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode15UnauthenticatedE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450ab403ce880ed2c28d0784a2430a9b6eda"></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">Unauthenticated</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode15UnauthenticatedE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>We are not authenticated to the remote service. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode12UnauthorizedE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode12UnauthorizedE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode12UnauthorizedE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450ae06d1ba70f1331e9f9a113cc2f887d3f"></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">Unauthorized</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode12UnauthorizedE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>We do not have permission to make this request. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode11UnavailableE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode11UnavailableE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode11UnavailableE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450a453e6aa38d87b28ccae545967c53004f"></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">Unavailable</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode11UnavailableE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>The remote service cannot handle this request at the moment. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight16FlightStatusCode6FailedE"> |
| <span id="_CPPv3N5arrow6flight16FlightStatusCode6FailedE"></span><span id="_CPPv2N5arrow6flight16FlightStatusCode6FailedE"></span><span class="target" id="namespacearrow_1_1flight_1a9646b05ed7886d8967494f73da99b450ad7c8c85bf79bbe1b7188497c32c3b0ca"></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">Failed</span></span></span><a class="headerlink" href="#_CPPv4N5arrow6flight16FlightStatusCode6FailedE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>A request failed for some other reason. </p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStatusDetailE"> |
| <span id="_CPPv3N5arrow6flight18FlightStatusDetailE"></span><span id="_CPPv2N5arrow6flight18FlightStatusDetailE"></span><span id="arrow::flight::FlightStatusDetail"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail"></span><span class="k"><span class="pre">class</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><span class="sig-name descname"><span class="n"><span class="pre">FlightStatusDetail</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><a class="reference internal" href="support.html#_CPPv4N5arrow12StatusDetailE" title="arrow::StatusDetail"><span class="n"><span class="pre">StatusDetail</span></span></a><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStatusDetailE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Flight-specific error information in a <a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a>. </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="_CPPv4NK5arrow6flight18FlightStatusDetail7type_idEv"> |
| <span id="_CPPv3NK5arrow6flight18FlightStatusDetail7type_idEv"></span><span id="_CPPv2NK5arrow6flight18FlightStatusDetail7type_idEv"></span><span id="arrow::flight::FlightStatusDetail::type_idC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1ab59e2fe85ee3450eff144e0ff6459733"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</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">type_id</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><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight18FlightStatusDetail7type_idEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Return a unique id for the type of the <a class="reference internal" href="support.html#classarrow_1_1_status_detail"><span class="std std-ref">StatusDetail</span></a> (effectively a poor man’s substitute for RTTI). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight18FlightStatusDetail8ToStringEv"> |
| <span id="_CPPv3NK5arrow6flight18FlightStatusDetail8ToStringEv"></span><span id="_CPPv2NK5arrow6flight18FlightStatusDetail8ToStringEv"></span><span id="arrow::flight::FlightStatusDetail::ToStringC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1a207c81b2953ee1b50a18988ab8780642"></span><span class="k"><span class="pre">virtual</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="sig-name descname"><span class="n"><span class="pre">ToString</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><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow6flight18FlightStatusDetail8ToStringEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Produce a human-readable description of this status. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight18FlightStatusDetail4codeEv"> |
| <span id="_CPPv3NK5arrow6flight18FlightStatusDetail4codeEv"></span><span id="_CPPv2NK5arrow6flight18FlightStatusDetail4codeEv"></span><span id="arrow::flight::FlightStatusDetail::codeC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1a09f374efbb0448572e53486c0c92ea00"></span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightStatusCodeE" title="arrow::flight::FlightStatusCode"><span class="n"><span class="pre">FlightStatusCode</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">code</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="#_CPPv4NK5arrow6flight18FlightStatusDetail4codeEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get the Flight status code. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight18FlightStatusDetail10extra_infoEv"> |
| <span id="_CPPv3NK5arrow6flight18FlightStatusDetail10extra_infoEv"></span><span id="_CPPv2NK5arrow6flight18FlightStatusDetail10extra_infoEv"></span><span id="arrow::flight::FlightStatusDetail::extra_infoC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1a210cc1b0ca7757d395035c546c88ebfb"></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">extra_info</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="#_CPPv4NK5arrow6flight18FlightStatusDetail10extra_infoEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get the extra error info. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6flight18FlightStatusDetail12CodeAsStringEv"> |
| <span id="_CPPv3NK5arrow6flight18FlightStatusDetail12CodeAsStringEv"></span><span id="_CPPv2NK5arrow6flight18FlightStatusDetail12CodeAsStringEv"></span><span id="arrow::flight::FlightStatusDetail::CodeAsStringC"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1aa57e23e681bd5d0bd34af31db469b24b"></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">CodeAsString</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="#_CPPv4NK5arrow6flight18FlightStatusDetail12CodeAsStringEv" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Get the human-readable name of the status code. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight18FlightStatusDetail14set_extra_infoENSt6stringE"> |
| <span id="_CPPv3N5arrow6flight18FlightStatusDetail14set_extra_infoENSt6stringE"></span><span id="_CPPv2N5arrow6flight18FlightStatusDetail14set_extra_infoENSt6stringE"></span><span id="arrow::flight::FlightStatusDetail::set_extra_info__ss"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1a24e0b3664e844e71afdfba6f06d2ad1f"></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">set_extra_info</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">string</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">extra_info</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStatusDetail14set_extra_infoENSt6stringE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Set the extra error info. </p> |
| </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="_CPPv4N5arrow6flight18FlightStatusDetail12UnwrapStatusERKN5arrow6StatusE"> |
| <span id="_CPPv3N5arrow6flight18FlightStatusDetail12UnwrapStatusERKN5arrow6StatusE"></span><span id="_CPPv2N5arrow6flight18FlightStatusDetail12UnwrapStatusERKN5arrow6StatusE"></span><span id="arrow::flight::FlightStatusDetail::UnwrapStatus__arrow::StatusCR"></span><span class="target" id="classarrow_1_1flight_1_1_flight_status_detail_1acb518cdec271a628e6d6ff00f2379ac1"></span><span class="k"><span class="pre">static</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="#_CPPv4N5arrow6flight18FlightStatusDetailE" title="arrow::flight::FlightStatusDetail"><span class="n"><span class="pre">FlightStatusDetail</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">UnwrapStatus</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">arrow</span></span><span class="p"><span class="pre">::</span></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="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">status</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow6flight18FlightStatusDetail12UnwrapStatusERKN5arrow6StatusE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Try to extract a <em><a class="reference internal" href="#classarrow_1_1flight_1_1_flight_status_detail"><span class="std std-ref">FlightStatusDetail</span></a></em> from any Arrow status. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>a <em><a class="reference internal" href="#classarrow_1_1flight_1_1_flight_status_detail"><span class="std std-ref">FlightStatusDetail</span></a></em> if it could be unwrapped, <em>nullptr</em> otherwise </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6flight15MakeFlightErrorE16FlightStatusCodeNSt6stringENSt6stringE"> |
| <span id="_CPPv3N5arrow6flight15MakeFlightErrorE16FlightStatusCodeNSt6stringENSt6stringE"></span><span id="_CPPv2N5arrow6flight15MakeFlightErrorE16FlightStatusCodeNSt6stringENSt6stringE"></span><span id="arrow::flight::MakeFlightError__FlightStatusCode.ss.ss"></span><span class="target" id="namespacearrow_1_1flight_1a4fa5fe5f0e743ee65c77564b353dfef7"></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-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><span class="sig-name descname"><span class="n"><span class="pre">MakeFlightError</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow6flight16FlightStatusCodeE" title="arrow::flight::FlightStatusCode"><span class="n"><span class="pre">FlightStatusCode</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">code</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">message</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">extra_info</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="#_CPPv4N5arrow6flight15MakeFlightErrorE16FlightStatusCodeNSt6stringENSt6stringE" title="Permalink to this definition">¶</a><br /></dt> |
| <dd><p>Make an appropriate Arrow status for the given Flight-specific status. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>code</strong> – The Flight status code. </p></li> |
| <li><p><strong>message</strong> – The message for the error. </p></li> |
| <li><p><strong>extra_info</strong> – Optional extra binary info for the error (eg protobuf) </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class='prev-next-bottom'> |
| |
| <a class='left-prev' id="prev-link" href="cuda.html" title="previous page">CUDA support</a> |
| <a class='right-next' id="next-link" href="filesystem.html" title="next page">Filesystems</a> |
| |
| </div> |
| |
| </main> |
| |
| |
| </div> |
| </div> |
| |
| <script src="../../_static/js/index.1c5a1a01449ed65a7b51.js"></script> |
| |
| |
| <!-- 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 --> |
| <footer class="footer mt-5 mt-md-0"> |
| <div class="container"> |
| |
| <div class="footer-item"> |
| <p class="copyright"> |
| © Copyright 2016-2019 Apache Software Foundation.<br/> |
| </p> |
| </div> |
| |
| <div class="footer-item"> |
| <p class="sphinx-version"> |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.0.2.<br/> |
| </p> |
| </div> |
| |
| </div> |
| </footer> |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script> </body> |
| </html> |
