| |
| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" > |
| <head> |
| <meta charset="utf-8" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| |
| <title>API Reference — Apache Arrow v3.0.0</title> |
| |
| |
| |
| <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" /> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <!--[if lt IE 9]> |
| <script src="../_static/js/html5shiv.min.js"></script> |
| <![endif]--> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> |
| <script src="../_static/jquery.js"></script> |
| <script src="../_static/underscore.js"></script> |
| <script src="../_static/doctools.js"></script> |
| <script src="../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../_static/js/theme.js"></script> |
| |
| |
| <link rel="canonical" href="https://arrow.apache.org/docs/cpp/api.html" /> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="Programming Support" href="api/support.html" /> |
| <link rel="prev" title="Conversion of range of std::tuple-like to Table instances" href="examples/tuple_range_conversion.html" /> |
|
|
|
|
| <!-- Matomo -->
|
| <script>
|
| var _paq = window._paq = window._paq || [];
|
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
|
| _paq.push(["setDoNotTrack", true]);
|
| _paq.push(["disableCookies"]);
|
| _paq.push(['trackPageView']);
|
| _paq.push(['enableLinkTracking']);
|
| (function() {
|
| var u="https://analytics.apache.org/";
|
| _paq.push(['setTrackerUrl', u+'matomo.php']);
|
| _paq.push(['setSiteId', '20']);
|
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
|
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
|
| })();
|
| </script>
|
| <!-- End Matomo Code -->
|
|
|
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../index.html" class="icon icon-home"> Apache Arrow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 3.0.0 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <p class="caption"><span class="caption-text">Specifications and Protocols</span></p> |
| <ul> |
| <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"> |
| <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"><a class="reference internal" href="index.html">C++</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="getting_started.html">User Guide</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="examples/index.html">Examples</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">API Reference</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="api/support.html">Programming Support</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/memory.html">Memory (management)</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/datatype.html">Data Types</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/array.html">Arrays</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/scalar.html">Scalars</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/builder.html">Array Builders</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/table.html">Two-dimensional Datasets</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/c_abi.html">C Interfaces</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/compute.html">Compute Functions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/tensor.html">Tensors</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/utilities.html">Utilities</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/io.html">Input / output</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/ipc.html">Arrow IPC</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/formats.html">File Formats</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/cuda.html">CUDA support</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/flight.html">Arrow Flight RPC</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/filesystem.html">Filesystems</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"><a class="reference internal" href="../java/index.html">Java</a></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"><a class="reference internal" href="../python/index.html">Python</a></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> |
| <li class="toctree-l1"><a class="reference internal" href="../developers/contributing.html">Contributing to Apache Arrow</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../developers/cpp/index.html">C++ Development</a></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> |
| |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../index.html">Apache Arrow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../index.html" class="icon icon-home"></a> »</li> |
| |
| <li><a href="index.html">C++ Implementation</a> »</li> |
| |
| <li>API Reference</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../_sources/cpp/api.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="api-reference"> |
| <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="api/support.html">Programming Support</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/support.html#general-information">General information</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/support.html#error-return-and-reporting">Error return and reporting</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/memory.html">Memory (management)</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/memory.html#devices">Devices</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/memory.html#memory-managers">Memory Managers</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/memory.html#buffers">Buffers</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/memory.html#memory-pools">Memory Pools</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/memory.html#allocation-functions">Allocation Functions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/memory.html#slicing">Slicing</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/memory.html#buffer-builders">Buffer Builders</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/memory.html#stl-integration">STL Integration</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/datatype.html">Data Types</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/datatype.html#factory-functions">Factory functions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/datatype.html#concrete-type-subclasses">Concrete type subclasses</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="api/datatype.html#primitive">Primitive</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/datatype.html#time-related">Time-related</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/datatype.html#binary-like">Binary-like</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/datatype.html#nested">Nested</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/datatype.html#dictionary-encoded">Dictionary-encoded</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="api/datatype.html#fields-and-schemas">Fields and Schemas</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/array.html">Arrays</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/array.html#concrete-array-subclasses">Concrete array subclasses</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="api/array.html#non-nested">Non-nested</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/array.html#nested">Nested</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="api/array.html#chunked-arrays">Chunked Arrays</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/scalar.html">Scalars</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/scalar.html#factory-functions">Factory functions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/scalar.html#concrete-scalar-subclasses">Concrete scalar subclasses</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/builder.html">Array Builders</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/builder.html#concrete-builder-subclasses">Concrete builder subclasses</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/table.html">Two-dimensional Datasets</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/table.html#record-batches">Record Batches</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/table.html#tables">Tables</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/c_abi.html">C Interfaces</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/c_abi.html#abi-structures">ABI Structures</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/c_abi.html#c-data-interface">C Data Interface</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/c_abi.html#c-stream-interface">C Stream Interface</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/compute.html">Compute Functions</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/compute.html#datum-class">Datum class</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/compute.html#abstract-function-classes">Abstract Function classes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/compute.html#function-registry">Function registry</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/compute.html#convenience-functions">Convenience functions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/compute.html#concrete-options-classes">Concrete options classes</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/tensor.html">Tensors</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/tensor.html#dense-tensors">Dense Tensors</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/tensor.html#sparse-tensors">Sparse Tensors</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/utilities.html">Utilities</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/utilities.html#decimal-numbers">Decimal Numbers</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/utilities.html#abstract-sequences">Abstract Sequences</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/utilities.html#compression">Compression</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/io.html">Input / output</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/io.html#interfaces">Interfaces</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/io.html#concrete-implementations">Concrete implementations</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="api/io.html#in-memory-streams">In-memory streams</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/io.html#local-files">Local files</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/io.html#buffering-input-output-wrappers">Buffering input / output wrappers</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/io.html#compressed-input-output-wrappers">Compressed input / output wrappers</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/ipc.html">Arrow IPC</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/ipc.html#ipc-options">IPC options</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/ipc.html#reading-ipc-streams-and-files">Reading IPC streams and files</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="api/ipc.html#blocking-api">Blocking API</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/ipc.html#event-driven-api">Event-driven API</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/ipc.html#statistics">Statistics</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="api/ipc.html#writing-ipc-streams-and-files">Writing IPC streams and files</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="api/ipc.html#id1">Blocking API</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="api/ipc.html#id2">Statistics</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/formats.html">File Formats</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/formats.html#csv">CSV</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/formats.html#line-separated-json">Line-separated JSON</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/formats.html#parquet-reader">Parquet reader</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/formats.html#parquet-writer">Parquet writer</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/cuda.html">CUDA support</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/cuda.html#contexts">Contexts</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/cuda.html#devices">Devices</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/cuda.html#buffers">Buffers</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/cuda.html#memory-input-output">Memory Input / Output</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/cuda.html#ipc">IPC</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/flight.html">Arrow Flight RPC</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/flight.html#common-types">Common Types</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/flight.html#clients">Clients</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/flight.html#servers">Servers</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/flight.html#error-handling">Error Handling</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="api/filesystem.html">Filesystems</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="api/filesystem.html#interface">Interface</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/filesystem.html#high-level-factory-function">High-level factory function</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="api/filesystem.html#concrete-implementations">Concrete implementations</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| <a href="api/support.html" class="btn btn-neutral float-right" title="Programming Support" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| <a href="examples/tuple_range_conversion.html" class="btn btn-neutral float-left" title="Conversion of range of std::tuple-like to Table instances" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright 2016-2019 Apache Software Foundation. |
| |
| </p> |
| </div> |
| |
| |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body> |
| </html> |
