| <!DOCTYPE html> |
| <!-- Generated by pkgdown: do not edit by hand --><html lang="en-US"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Package index • Arrow R Package</title><!-- favicons --><link rel="icon" type="image/png" sizes="96x96" href="../favicon-96x96.png"><link rel="icon" type="”image/svg+xml”" href="../favicon.svg"><link rel="apple-touch-icon" sizes="180x180" href="../apple-touch-icon.png"><link rel="icon" sizes="any" href="../favicon.ico"><link rel="manifest" href="../site.webmanifest"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Package index"><meta property="og:image" content="https://arrow.apache.org/img/arrow-logo_horizontal_black-txt_white-bg.png"><meta property="og:image:alt" content="Apache Arrow logo, displaying the triple chevron image adjacent to the text"><!-- 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 --><!-- Kapa AI --><script async src="https://widget.kapa.ai/kapa-widget.bundle.js" data-website-id="9db461d5-ac77-4b3f-a5c5-75efa78339d2" data-project-name="Apache Arrow" data-project-color="#000000" data-project-logo="https://arrow.apache.org/img/arrow-logo_chevrons_white-txt_black-bg.png" data-modal-disclaimer="This is a custom LLM with access to all of [Arrow documentation](https://arrow.apache.org/docs/). If you want an R-specific answer, please mention this in your question." data-consent-required="true" data-user-analytics-cookie-enabled="false" data-consent-screen-disclaimer="By clicking "I agree, let's chat", you consent to the use of the AI assistant in accordance with kapa.ai's [Privacy Policy](https://www.kapa.ai/content/privacy-policy). This service uses reCAPTCHA, which requires your consent to Google's [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms). By proceeding, you explicitly agree to both kapa.ai's and Google's privacy policies."></script><!-- End Kapa AI --></head><body> |
| <a href="#main" class="visually-hidden-focusable">Skip to contents</a> |
| |
| |
| <nav class="navbar fixed-top navbar-dark navbar-expand-lg bg-black"><div class="container"> |
| |
| <a class="navbar-brand me-2" href="../index.html">Arrow R Package</a> |
| |
| <span class="version"> |
| <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">22.0.0.9000</small> |
| </span> |
| |
| |
| <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation"> |
| <span class="navbar-toggler-icon"></span> |
| </button> |
| |
| <div id="navbar" class="collapse navbar-collapse ms-3"> |
| <ul class="navbar-nav me-auto"><li class="nav-item"><a class="nav-link" href="../articles/arrow.html">Get started</a></li> |
| <li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li> |
| <li class="nav-item dropdown"> |
| <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button> |
| <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li> |
| <li><h6 class="dropdown-header" data-toc-skip>Using the package</h6></li> |
| <li><a class="dropdown-item" href="../articles/read_write.html">Reading and writing data files</a></li> |
| <li><a class="dropdown-item" href="../articles/data_wrangling.html">Data analysis with dplyr syntax</a></li> |
| <li><a class="dropdown-item" href="../articles/dataset.html">Working with multi-file data sets</a></li> |
| <li><a class="dropdown-item" href="../articles/python.html">Integrating Arrow, Python, and R</a></li> |
| <li><a class="dropdown-item" href="../articles/fs.html">Using cloud storage (S3, GCS)</a></li> |
| <li><a class="dropdown-item" href="../articles/flight.html">Connecting to a Flight server</a></li> |
| <li><hr class="dropdown-divider"></li> |
| <li><h6 class="dropdown-header" data-toc-skip>Arrow concepts</h6></li> |
| <li><a class="dropdown-item" href="../articles/data_objects.html">Data objects</a></li> |
| <li><a class="dropdown-item" href="../articles/data_types.html">Data types</a></li> |
| <li><a class="dropdown-item" href="../articles/metadata.html">Metadata</a></li> |
| <li><hr class="dropdown-divider"></li> |
| <li><h6 class="dropdown-header" data-toc-skip>Installation</h6></li> |
| <li><a class="dropdown-item" href="../articles/install.html">Installing on Linux</a></li> |
| <li><a class="dropdown-item" href="../articles/install_nightly.html">Installing development versions</a></li> |
| <li><hr class="dropdown-divider"></li> |
| <li><a class="dropdown-item" href="../articles/index.html">More articles...</a></li> |
| </ul></li> |
| <li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li> |
| </ul><form class="form-inline my-2 my-lg-0" role="search"> |
| <input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="" autocomplete="off"></form> |
| |
| <ul class="navbar-nav"><li class="nav-item"><a class="external-link nav-link" href="https://github.com/apache/arrow/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li> |
| </ul></div> |
| |
| |
| </div> |
| </nav><div class="container template-reference-index"> |
| <div class="row"> |
| <main id="main" class="col-md-9"><div class="page-header"> |
| |
| <h1>Package index</h1> |
| </div> |
| |
| <div class="section level2"> |
| <h2 id="read-datasets">Read datasets<a class="anchor" aria-label="anchor" href="#read-datasets"></a></h2> |
| |
| <div class="section-desc"><p>Open multi-file datasets as Arrow Dataset objects.</p></div> |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="open_dataset.html">open_dataset()</a></code> |
| |
| </dt> |
| <dd>Open a multi-file dataset</dd> |
| |
| <dt> |
| |
| <code><a href="open_delim_dataset.html">open_delim_dataset()</a></code> <code><a href="open_delim_dataset.html">open_csv_dataset()</a></code> <code><a href="open_delim_dataset.html">open_tsv_dataset()</a></code> |
| |
| </dt> |
| <dd>Open a multi-file dataset of CSV or other delimiter-separated format</dd> |
| |
| <dt> |
| |
| <code><a href="csv_read_options.html">csv_read_options()</a></code> |
| |
| </dt> |
| <dd>CSV Reading Options</dd> |
| |
| <dt> |
| |
| <code><a href="csv_parse_options.html">csv_parse_options()</a></code> |
| |
| </dt> |
| <dd>CSV Parsing Options</dd> |
| |
| <dt> |
| |
| <code><a href="csv_convert_options.html">csv_convert_options()</a></code> |
| |
| </dt> |
| <dd>CSV Convert Options</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="write-datasets">Write datasets<a class="anchor" aria-label="anchor" href="#write-datasets"></a></h2> |
| |
| <div class="section-desc"><p>Write multi-file datasets to disk.</p></div> |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="write_dataset.html">write_dataset()</a></code> |
| |
| </dt> |
| <dd>Write a dataset</dd> |
| |
| <dt> |
| |
| <code><a href="write_delim_dataset.html">write_delim_dataset()</a></code> <code><a href="write_delim_dataset.html">write_csv_dataset()</a></code> <code><a href="write_delim_dataset.html">write_tsv_dataset()</a></code> |
| |
| </dt> |
| <dd>Write a dataset into partitioned flat files.</dd> |
| |
| <dt> |
| |
| <code><a href="csv_write_options.html">csv_write_options()</a></code> |
| |
| </dt> |
| <dd>CSV Writing Options</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="read-files">Read files<a class="anchor" aria-label="anchor" href="#read-files"></a></h2> |
| |
| <div class="section-desc"><p>Read files in a variety of formats in as tibbles or Arrow Tables.</p></div> |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="read_delim_arrow.html">read_delim_arrow()</a></code> <code><a href="read_delim_arrow.html">read_csv_arrow()</a></code> <code><a href="read_delim_arrow.html">read_csv2_arrow()</a></code> <code><a href="read_delim_arrow.html">read_tsv_arrow()</a></code> |
| |
| </dt> |
| <dd>Read a CSV or other delimited file with Arrow</dd> |
| |
| <dt> |
| |
| <code><a href="read_parquet.html">read_parquet()</a></code> |
| |
| </dt> |
| <dd>Read a Parquet file</dd> |
| |
| <dt> |
| |
| <code><a href="read_feather.html">read_feather()</a></code> <code><a href="read_feather.html">read_ipc_file()</a></code> |
| |
| </dt> |
| <dd>Read a Feather file (an Arrow IPC file)</dd> |
| |
| <dt> |
| |
| <code><a href="read_ipc_stream.html">read_ipc_stream()</a></code> |
| |
| </dt> |
| <dd>Read Arrow IPC stream format</dd> |
| |
| <dt> |
| |
| <code><a href="read_json_arrow.html">read_json_arrow()</a></code> |
| |
| </dt> |
| <dd>Read a JSON file</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="write-files">Write files<a class="anchor" aria-label="anchor" href="#write-files"></a></h2> |
| |
| <div class="section-desc"><p>Write to files in a variety of formats.</p></div> |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="write_csv_arrow.html">write_csv_arrow()</a></code> |
| |
| </dt> |
| <dd>Write CSV file to disk</dd> |
| |
| <dt> |
| |
| <code><a href="write_parquet.html">write_parquet()</a></code> |
| |
| </dt> |
| <dd>Write Parquet file to disk</dd> |
| |
| <dt> |
| |
| <code><a href="write_feather.html">write_feather()</a></code> <code><a href="write_feather.html">write_ipc_file()</a></code> |
| |
| </dt> |
| <dd>Write a Feather file (an Arrow IPC file)</dd> |
| |
| <dt> |
| |
| <code><a href="write_ipc_stream.html">write_ipc_stream()</a></code> |
| |
| </dt> |
| <dd>Write Arrow IPC stream format</dd> |
| |
| <dt> |
| |
| <code><a href="write_to_raw.html">write_to_raw()</a></code> |
| |
| </dt> |
| <dd>Write Arrow data to a raw vector</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="creating-arrow-data-containers">Creating Arrow data containers<a class="anchor" aria-label="anchor" href="#creating-arrow-data-containers"></a></h2> |
| |
| <div class="section-desc"><p>Classes and functions for creating Arrow data containers.</p></div> |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="scalar.html">scalar()</a></code> |
| |
| </dt> |
| <dd>Create an Arrow Scalar</dd> |
| |
| <dt> |
| |
| <code><a href="arrow_array.html">arrow_array()</a></code> |
| |
| </dt> |
| <dd>Create an Arrow Array</dd> |
| |
| <dt> |
| |
| <code><a href="chunked_array.html">chunked_array()</a></code> |
| |
| </dt> |
| <dd>Create a Chunked Array</dd> |
| |
| <dt> |
| |
| <code><a href="record_batch.html">record_batch()</a></code> |
| |
| </dt> |
| <dd>Create a RecordBatch</dd> |
| |
| <dt> |
| |
| <code><a href="table.html">arrow_table()</a></code> |
| |
| </dt> |
| <dd>Create an Arrow Table</dd> |
| |
| <dt> |
| |
| <code><a href="buffer.html">buffer()</a></code> |
| |
| </dt> |
| <dd>Create a Buffer</dd> |
| |
| <dt> |
| |
| <code><a href="vctrs_extension_array.html">vctrs_extension_array()</a></code> <code><a href="vctrs_extension_array.html">vctrs_extension_type()</a></code> |
| |
| </dt> |
| <dd>Extension type for generic typed vectors</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="working-with-arrow-data-containers">Working with Arrow data containers<a class="anchor" aria-label="anchor" href="#working-with-arrow-data-containers"></a></h2> |
| |
| <div class="section-desc"><p>Functions for converting R objects to Arrow data containers and combining Arrow data containers.</p></div> |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="as_arrow_array.html">as_arrow_array()</a></code> |
| |
| </dt> |
| <dd>Convert an object to an Arrow Array</dd> |
| |
| <dt> |
| |
| <code><a href="as_chunked_array.html">as_chunked_array()</a></code> |
| |
| </dt> |
| <dd>Convert an object to an Arrow ChunkedArray</dd> |
| |
| <dt> |
| |
| <code><a href="as_record_batch.html">as_record_batch()</a></code> |
| |
| </dt> |
| <dd>Convert an object to an Arrow RecordBatch</dd> |
| |
| <dt> |
| |
| <code><a href="as_arrow_table.html">as_arrow_table()</a></code> |
| |
| </dt> |
| <dd>Convert an object to an Arrow Table</dd> |
| |
| <dt> |
| |
| <code><a href="concat_arrays.html">concat_arrays()</a></code> <code><a href="concat_arrays.html">c(<i><Array></i>)</a></code> |
| |
| </dt> |
| <dd>Concatenate zero or more Arrays</dd> |
| |
| <dt> |
| |
| <code><a href="concat_tables.html">concat_tables()</a></code> |
| |
| </dt> |
| <dd>Concatenate one or more Tables</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="arrow-data-types">Arrow data types<a class="anchor" aria-label="anchor" href="#arrow-data-types"></a></h2> |
| |
| |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="data-type.html">int8()</a></code> <code><a href="data-type.html">int16()</a></code> <code><a href="data-type.html">int32()</a></code> <code><a href="data-type.html">int64()</a></code> <code><a href="data-type.html">uint8()</a></code> <code><a href="data-type.html">uint16()</a></code> <code><a href="data-type.html">uint32()</a></code> <code><a href="data-type.html">uint64()</a></code> <code><a href="data-type.html">float16()</a></code> <code><a href="data-type.html">halffloat()</a></code> <code><a href="data-type.html">float32()</a></code> <code><a href="data-type.html">float()</a></code> <code><a href="data-type.html">float64()</a></code> <code><a href="data-type.html">boolean()</a></code> <code><a href="data-type.html">bool()</a></code> <code><a href="data-type.html">utf8()</a></code> <code><a href="data-type.html">large_utf8()</a></code> <code><a href="data-type.html">binary()</a></code> <code><a href="data-type.html">large_binary()</a></code> <code><a href="data-type.html">fixed_size_binary()</a></code> <code><a href="data-type.html">string()</a></code> <code><a href="data-type.html">date32()</a></code> <code><a href="data-type.html">date64()</a></code> <code><a href="data-type.html">time32()</a></code> <code><a href="data-type.html">time64()</a></code> <code><a href="data-type.html">duration()</a></code> <code><a href="data-type.html">null()</a></code> <code><a href="data-type.html">timestamp()</a></code> <code><a href="data-type.html">decimal()</a></code> <code><a href="data-type.html">decimal32()</a></code> <code><a href="data-type.html">decimal64()</a></code> <code><a href="data-type.html">decimal128()</a></code> <code><a href="data-type.html">decimal256()</a></code> <code><a href="data-type.html">struct()</a></code> <code><a href="data-type.html">list_of()</a></code> <code><a href="data-type.html">large_list_of()</a></code> <code><a href="data-type.html">fixed_size_list_of()</a></code> <code><a href="data-type.html">map_of()</a></code> |
| |
| </dt> |
| <dd>Create Arrow data types</dd> |
| |
| <dt> |
| |
| <code><a href="dictionary.html">dictionary()</a></code> |
| |
| </dt> |
| <dd>Create a dictionary type</dd> |
| |
| <dt> |
| |
| <code><a href="new_extension_type.html">new_extension_type()</a></code> <code><a href="new_extension_type.html">new_extension_array()</a></code> <code><a href="new_extension_type.html">register_extension_type()</a></code> <code><a href="new_extension_type.html">reregister_extension_type()</a></code> <code><a href="new_extension_type.html">unregister_extension_type()</a></code> |
| |
| </dt> |
| <dd>Extension types</dd> |
| |
| <dt> |
| |
| <code><a href="vctrs_extension_array.html">vctrs_extension_array()</a></code> <code><a href="vctrs_extension_array.html">vctrs_extension_type()</a></code> |
| |
| </dt> |
| <dd>Extension type for generic typed vectors</dd> |
| |
| <dt> |
| |
| <code><a href="as_data_type.html">as_data_type()</a></code> |
| |
| </dt> |
| <dd>Convert an object to an Arrow DataType</dd> |
| |
| <dt> |
| |
| <code><a href="infer_type.html">infer_type()</a></code> <code><a href="infer_type.html">type()</a></code> |
| |
| </dt> |
| <dd>Infer the arrow Array type from an R object</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="fields-and-schemas">Fields and schemas<a class="anchor" aria-label="anchor" href="#fields-and-schemas"></a></h2> |
| |
| |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="Field.html">field()</a></code> |
| |
| </dt> |
| <dd>Create a Field</dd> |
| |
| <dt> |
| |
| <code><a href="schema.html">schema()</a></code> |
| |
| </dt> |
| <dd>Create a schema or extract one from an object.</dd> |
| |
| <dt> |
| |
| <code><a href="unify_schemas.html">unify_schemas()</a></code> |
| |
| </dt> |
| <dd>Combine and harmonize schemas</dd> |
| |
| <dt> |
| |
| <code><a href="as_schema.html">as_schema()</a></code> |
| |
| </dt> |
| <dd>Convert an object to an Arrow Schema</dd> |
| |
| <dt> |
| |
| <code><a href="infer_schema.html">infer_schema()</a></code> |
| |
| </dt> |
| <dd>Extract a schema from an object</dd> |
| |
| <dt> |
| |
| <code><a href="read_schema.html">read_schema()</a></code> |
| |
| </dt> |
| <dd>Read a Schema from a stream</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="computation">Computation<a class="anchor" aria-label="anchor" href="#computation"></a></h2> |
| |
| <div class="section-desc"><p>Functionality for computing values on Arrow data objects.</p></div> |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="acero.html">acero</a></code> <code><a href="acero.html">arrow-functions</a></code> <code><a href="acero.html">arrow-verbs</a></code> <code><a href="acero.html">arrow-dplyr</a></code> |
| |
| </dt> |
| <dd>Functions available in Arrow dplyr queries</dd> |
| |
| <dt> |
| |
| <code><a href="call_function.html">call_function()</a></code> |
| |
| </dt> |
| <dd>Call an Arrow compute function</dd> |
| |
| <dt> |
| |
| <code><a href="match_arrow.html">match_arrow()</a></code> <code><a href="match_arrow.html">is_in()</a></code> |
| |
| </dt> |
| <dd>Value matching for Arrow objects</dd> |
| |
| <dt> |
| |
| <code><a href="value_counts.html">value_counts()</a></code> |
| |
| </dt> |
| <dd><code>table</code> for Arrow objects</dd> |
| |
| <dt> |
| |
| <code><a href="list_compute_functions.html">list_compute_functions()</a></code> |
| |
| </dt> |
| <dd>List available Arrow C++ compute functions</dd> |
| |
| <dt> |
| |
| <code><a href="register_scalar_function.html">register_scalar_function()</a></code> |
| |
| </dt> |
| <dd>Register user-defined functions</dd> |
| |
| <dt> |
| |
| <code><a href="show_exec_plan.html">show_exec_plan()</a></code> |
| |
| </dt> |
| <dd>Show the details of an Arrow Execution Plan</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="duckdb">DuckDB<a class="anchor" aria-label="anchor" href="#duckdb"></a></h2> |
| |
| <div class="section-desc"><p>Pass data to and from DuckDB</p></div> |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="to_arrow.html">to_arrow()</a></code> |
| |
| </dt> |
| <dd>Create an Arrow object from a DuckDB connection</dd> |
| |
| <dt> |
| |
| <code><a href="to_duckdb.html">to_duckdb()</a></code> |
| |
| </dt> |
| <dd>Create a (virtual) DuckDB table from an Arrow object</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="file-systems">File systems<a class="anchor" aria-label="anchor" href="#file-systems"></a></h2> |
| |
| <div class="section-desc"><p>Functions for working with files on S3 and GCS</p></div> |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="s3_bucket.html">s3_bucket()</a></code> |
| |
| </dt> |
| <dd>Connect to an AWS S3 bucket</dd> |
| |
| <dt> |
| |
| <code><a href="gs_bucket.html">gs_bucket()</a></code> |
| |
| </dt> |
| <dd>Connect to a Google Cloud Storage (GCS) bucket</dd> |
| |
| <dt> |
| |
| <code><a href="copy_files.html">copy_files()</a></code> |
| |
| </dt> |
| <dd>Copy files between FileSystems</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="flight">Flight<a class="anchor" aria-label="anchor" href="#flight"></a></h2> |
| |
| |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="load_flight_server.html">load_flight_server()</a></code> |
| |
| </dt> |
| <dd>Load a Python Flight server</dd> |
| |
| <dt> |
| |
| <code><a href="flight_connect.html">flight_connect()</a></code> |
| |
| </dt> |
| <dd>Connect to a Flight server</dd> |
| |
| <dt> |
| |
| <code><a href="flight_disconnect.html">flight_disconnect()</a></code> |
| |
| </dt> |
| <dd>Explicitly close a Flight client</dd> |
| |
| <dt> |
| |
| <code><a href="flight_get.html">flight_get()</a></code> |
| |
| </dt> |
| <dd>Get data from a Flight server</dd> |
| |
| <dt> |
| |
| <code><a href="flight_put.html">flight_put()</a></code> |
| |
| </dt> |
| <dd>Send data to a Flight server</dd> |
| |
| <dt> |
| |
| <code><a href="list_flights.html">list_flights()</a></code> <code><a href="list_flights.html">flight_path_exists()</a></code> |
| |
| </dt> |
| <dd>See available resources on a Flight server</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="arrow-configuration">Arrow Configuration<a class="anchor" aria-label="anchor" href="#arrow-configuration"></a></h2> |
| |
| |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="arrow_info.html">arrow_info()</a></code> <code><a href="arrow_info.html">arrow_available()</a></code> <code><a href="arrow_info.html">arrow_with_acero()</a></code> <code><a href="arrow_info.html">arrow_with_dataset()</a></code> <code><a href="arrow_info.html">arrow_with_substrait()</a></code> <code><a href="arrow_info.html">arrow_with_parquet()</a></code> <code><a href="arrow_info.html">arrow_with_s3()</a></code> <code><a href="arrow_info.html">arrow_with_gcs()</a></code> <code><a href="arrow_info.html">arrow_with_json()</a></code> |
| |
| </dt> |
| <dd>Report information on the package's capabilities</dd> |
| |
| <dt> |
| |
| <code><a href="cpu_count.html">cpu_count()</a></code> <code><a href="cpu_count.html">set_cpu_count()</a></code> |
| |
| </dt> |
| <dd>Manage the global CPU thread pool in libarrow</dd> |
| |
| <dt> |
| |
| <code><a href="io_thread_count.html">io_thread_count()</a></code> <code><a href="io_thread_count.html">set_io_thread_count()</a></code> |
| |
| </dt> |
| <dd>Manage the global I/O thread pool in libarrow</dd> |
| |
| <dt> |
| |
| <code><a href="install_arrow.html">install_arrow()</a></code> |
| |
| </dt> |
| <dd>Install or upgrade the Arrow library</dd> |
| |
| <dt> |
| |
| <code><a href="install_pyarrow.html">install_pyarrow()</a></code> |
| |
| </dt> |
| <dd>Install pyarrow for use with reticulate</dd> |
| |
| <dt> |
| |
| <code><a href="create_package_with_all_dependencies.html">create_package_with_all_dependencies()</a></code> |
| |
| </dt> |
| <dd>Create a source bundle that includes all thirdparty dependencies</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="input-output">Input/Output<a class="anchor" aria-label="anchor" href="#input-output"></a></h2> |
| |
| |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="InputStream.html">InputStream</a></code> <code><a href="InputStream.html">RandomAccessFile</a></code> <code><a href="InputStream.html">MemoryMappedFile</a></code> <code><a href="InputStream.html">ReadableFile</a></code> <code><a href="InputStream.html">BufferReader</a></code> |
| |
| </dt> |
| <dd>InputStream classes</dd> |
| |
| <dt> |
| |
| <code><a href="read_message.html">read_message()</a></code> |
| |
| </dt> |
| <dd>Read a Message from a stream</dd> |
| |
| <dt> |
| |
| <code><a href="mmap_open.html">mmap_open()</a></code> |
| |
| </dt> |
| <dd>Open a memory mapped file</dd> |
| |
| <dt> |
| |
| <code><a href="mmap_create.html">mmap_create()</a></code> |
| |
| </dt> |
| <dd>Create a new read/write memory mapped file of a given size</dd> |
| |
| <dt> |
| |
| <code><a href="OutputStream.html">OutputStream</a></code> <code><a href="OutputStream.html">FileOutputStream</a></code> <code><a href="OutputStream.html">BufferOutputStream</a></code> |
| |
| </dt> |
| <dd>OutputStream classes</dd> |
| |
| <dt> |
| |
| <code><a href="Message.html">Message</a></code> |
| |
| </dt> |
| <dd>Message class</dd> |
| |
| <dt> |
| |
| <code><a href="MessageReader.html">MessageReader</a></code> |
| |
| </dt> |
| <dd>MessageReader class</dd> |
| |
| <dt> |
| |
| <code><a href="compression.html">compression</a></code> <code><a href="compression.html">CompressedOutputStream</a></code> <code><a href="compression.html">CompressedInputStream</a></code> |
| |
| </dt> |
| <dd>Compressed stream classes</dd> |
| |
| <dt> |
| |
| <code><a href="Codec.html">Codec</a></code> |
| |
| </dt> |
| <dd>Compression Codec class</dd> |
| |
| <dt> |
| |
| <code><a href="codec_is_available.html">codec_is_available()</a></code> |
| |
| </dt> |
| <dd>Check whether a compression codec is available</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="file-read-writer-interface">File read/writer interface<a class="anchor" aria-label="anchor" href="#file-read-writer-interface"></a></h2> |
| |
| |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="ParquetFileReader.html">ParquetFileReader</a></code> |
| |
| </dt> |
| <dd>ParquetFileReader class</dd> |
| |
| <dt> |
| |
| <code><a href="ParquetReaderProperties.html">ParquetReaderProperties</a></code> |
| |
| </dt> |
| <dd>ParquetReaderProperties class</dd> |
| |
| <dt> |
| |
| <code><a href="ParquetArrowReaderProperties.html">ParquetArrowReaderProperties</a></code> |
| |
| </dt> |
| <dd>ParquetArrowReaderProperties class</dd> |
| |
| <dt> |
| |
| <code><a href="ParquetFileWriter.html">ParquetFileWriter</a></code> |
| |
| </dt> |
| <dd>ParquetFileWriter class</dd> |
| |
| <dt> |
| |
| <code><a href="ParquetWriterProperties.html">ParquetWriterProperties</a></code> |
| |
| </dt> |
| <dd>ParquetWriterProperties class</dd> |
| |
| <dt> |
| |
| <code><a href="FeatherReader.html">FeatherReader</a></code> |
| |
| </dt> |
| <dd>FeatherReader class</dd> |
| |
| <dt> |
| |
| <code><a href="CsvTableReader.html">CsvTableReader</a></code> <code><a href="CsvTableReader.html">JsonTableReader</a></code> |
| |
| </dt> |
| <dd>Arrow CSV and JSON table reader classes</dd> |
| |
| <dt> |
| |
| <code><a href="CsvReadOptions.html">CsvReadOptions</a></code> <code><a href="CsvReadOptions.html">CsvWriteOptions</a></code> <code><a href="CsvReadOptions.html">CsvParseOptions</a></code> <code><a href="CsvReadOptions.html">TimestampParser</a></code> <code><a href="CsvReadOptions.html">CsvConvertOptions</a></code> <code><a href="CsvReadOptions.html">JsonReadOptions</a></code> <code><a href="CsvReadOptions.html">JsonParseOptions</a></code> |
| |
| </dt> |
| <dd>File reader options</dd> |
| |
| <dt> |
| |
| <code><a href="RecordBatchReader.html">RecordBatchReader</a></code> <code><a href="RecordBatchReader.html">RecordBatchStreamReader</a></code> <code><a href="RecordBatchReader.html">RecordBatchFileReader</a></code> |
| |
| </dt> |
| <dd>RecordBatchReader classes</dd> |
| |
| <dt> |
| |
| <code><a href="RecordBatchWriter.html">RecordBatchWriter</a></code> <code><a href="RecordBatchWriter.html">RecordBatchStreamWriter</a></code> <code><a href="RecordBatchWriter.html">RecordBatchFileWriter</a></code> |
| |
| </dt> |
| <dd>RecordBatchWriter classes</dd> |
| |
| <dt> |
| |
| <code><a href="as_record_batch_reader.html">as_record_batch_reader()</a></code> |
| |
| </dt> |
| <dd>Convert an object to an Arrow RecordBatchReader</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="low-level-c-wrappers">Low-level C++ wrappers<a class="anchor" aria-label="anchor" href="#low-level-c-wrappers"></a></h2> |
| |
| <div class="section-desc"><p>Low-level R6 class representations of Arrow C++ objects intended for advanced users.</p></div> |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="Buffer-class.html">Buffer</a></code> |
| |
| </dt> |
| <dd>Buffer class</dd> |
| |
| <dt> |
| |
| <code><a href="Scalar-class.html">Scalar</a></code> |
| |
| </dt> |
| <dd>Arrow scalars</dd> |
| |
| <dt> |
| |
| <code><a href="array-class.html">Array</a></code> <code><a href="array-class.html">DictionaryArray</a></code> <code><a href="array-class.html">StructArray</a></code> <code><a href="array-class.html">ListArray</a></code> <code><a href="array-class.html">LargeListArray</a></code> <code><a href="array-class.html">FixedSizeListArray</a></code> <code><a href="array-class.html">MapArray</a></code> |
| |
| </dt> |
| <dd>Array Classes</dd> |
| |
| <dt> |
| |
| <code><a href="ChunkedArray-class.html">ChunkedArray</a></code> |
| |
| </dt> |
| <dd>ChunkedArray class</dd> |
| |
| <dt> |
| |
| <code><a href="RecordBatch-class.html">RecordBatch</a></code> |
| |
| </dt> |
| <dd>RecordBatch class</dd> |
| |
| <dt> |
| |
| <code><a href="Schema-class.html">Schema</a></code> |
| |
| </dt> |
| <dd>Schema class</dd> |
| |
| <dt> |
| |
| <code><a href="Field-class.html">Field</a></code> |
| |
| </dt> |
| <dd>Field class</dd> |
| |
| <dt> |
| |
| <code><a href="Table-class.html">Table</a></code> |
| |
| </dt> |
| <dd>Table class</dd> |
| |
| <dt> |
| |
| <code><a href="DataType-class.html">DataType</a></code> |
| |
| </dt> |
| <dd>DataType class</dd> |
| |
| <dt> |
| |
| <code><a href="ArrayData.html">ArrayData</a></code> |
| |
| </dt> |
| <dd>ArrayData class</dd> |
| |
| <dt> |
| |
| <code><a href="DictionaryType.html">DictionaryType</a></code> |
| |
| </dt> |
| <dd>class DictionaryType</dd> |
| |
| <dt> |
| |
| <code><a href="FixedWidthType.html">FixedWidthType</a></code> |
| |
| </dt> |
| <dd>FixedWidthType class</dd> |
| |
| <dt> |
| |
| <code><a href="ExtensionType.html">ExtensionType</a></code> |
| |
| </dt> |
| <dd>ExtensionType class</dd> |
| |
| <dt> |
| |
| <code><a href="ExtensionArray.html">ExtensionArray</a></code> |
| |
| </dt> |
| <dd>ExtensionArray class</dd> |
| </dl></div><div class="section level2"> |
| <h2 id="dataset-and-filesystem-r-classes-and-helper-functions">Dataset and Filesystem R6 classes and helper functions<a class="anchor" aria-label="anchor" href="#dataset-and-filesystem-r-classes-and-helper-functions"></a></h2> |
| |
| <div class="section-desc"><p>R6 classes and helper functions useful for when working with multi-file datases in Arrow.</p></div> |
| |
| <dl></dl></div><div class="section level2"> |
| |
| |
| |
| |
| <dl><dt> |
| |
| <code><a href="Dataset.html">Dataset</a></code> <code><a href="Dataset.html">FileSystemDataset</a></code> <code><a href="Dataset.html">UnionDataset</a></code> <code><a href="Dataset.html">InMemoryDataset</a></code> <code><a href="Dataset.html">DatasetFactory</a></code> <code><a href="Dataset.html">FileSystemDatasetFactory</a></code> |
| |
| </dt> |
| <dd>Multi-file datasets</dd> |
| |
| <dt> |
| |
| <code><a href="dataset_factory.html">dataset_factory()</a></code> |
| |
| </dt> |
| <dd>Create a DatasetFactory</dd> |
| |
| <dt> |
| |
| <code><a href="Partitioning.html">Partitioning</a></code> <code><a href="Partitioning.html">DirectoryPartitioning</a></code> <code><a href="Partitioning.html">HivePartitioning</a></code> <code><a href="Partitioning.html">DirectoryPartitioningFactory</a></code> <code><a href="Partitioning.html">HivePartitioningFactory</a></code> |
| |
| </dt> |
| <dd>Define Partitioning for a Dataset</dd> |
| |
| <dt> |
| |
| <code><a href="Expression.html">Expression</a></code> |
| |
| </dt> |
| <dd>Arrow expressions</dd> |
| |
| <dt> |
| |
| <code><a href="Scanner.html">Scanner</a></code> <code><a href="Scanner.html">ScannerBuilder</a></code> |
| |
| </dt> |
| <dd>Scan the contents of a dataset</dd> |
| |
| <dt> |
| |
| <code><a href="FileFormat.html">FileFormat</a></code> <code><a href="FileFormat.html">ParquetFileFormat</a></code> <code><a href="FileFormat.html">IpcFileFormat</a></code> |
| |
| </dt> |
| <dd>Dataset file formats</dd> |
| |
| <dt> |
| |
| <code><a href="CsvFileFormat.html">CsvFileFormat</a></code> |
| |
| </dt> |
| <dd>CSV dataset file format</dd> |
| |
| <dt> |
| |
| <code><a href="JsonFileFormat.html">JsonFileFormat</a></code> |
| |
| </dt> |
| <dd>JSON dataset file format</dd> |
| |
| <dt> |
| |
| <code><a href="FileWriteOptions.html">FileWriteOptions</a></code> |
| |
| </dt> |
| <dd>Format-specific write options</dd> |
| |
| <dt> |
| |
| <code><a href="FragmentScanOptions.html">FragmentScanOptions</a></code> <code><a href="FragmentScanOptions.html">CsvFragmentScanOptions</a></code> <code><a href="FragmentScanOptions.html">ParquetFragmentScanOptions</a></code> <code><a href="FragmentScanOptions.html">JsonFragmentScanOptions</a></code> |
| |
| </dt> |
| <dd>Format-specific scan options</dd> |
| |
| <dt> |
| |
| <code><a href="hive_partition.html">hive_partition()</a></code> |
| |
| </dt> |
| <dd>Construct Hive partitioning</dd> |
| |
| <dt> |
| |
| <code><a href="map_batches.html">map_batches()</a></code> |
| |
| </dt> |
| <dd>Apply a function to a stream of RecordBatches</dd> |
| |
| <dt> |
| |
| <code><a href="FileSystem.html">FileSystem</a></code> <code><a href="FileSystem.html">LocalFileSystem</a></code> <code><a href="FileSystem.html">S3FileSystem</a></code> <code><a href="FileSystem.html">GcsFileSystem</a></code> <code><a href="FileSystem.html">SubTreeFileSystem</a></code> |
| |
| </dt> |
| <dd>FileSystem classes</dd> |
| |
| <dt> |
| |
| <code><a href="FileInfo.html">FileInfo</a></code> |
| |
| </dt> |
| <dd>FileSystem entry info</dd> |
| |
| <dt> |
| |
| <code><a href="FileSelector.html">FileSelector</a></code> |
| |
| </dt> |
| <dd>file selector</dd> |
| </dl></div> |
| </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2> |
| </nav></aside></div> |
| |
| |
| <footer><div class="pkgdown-footer-left"> |
| <p><a href="https://arrow.apache.org/docs/r/versions.html">Older versions of these docs</a></p> |
| </div> |
| |
| <div class="pkgdown-footer-right"> |
| <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.2.0.</p> |
| </div> |
| |
| </footer></div> |
| |
| |
| |
| |
| |
| </body></html> |
| |
