This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 57463037 update documentation for tag main
57463037 is described below
commit 574630371aab1dacabaaad9c61be1428e6bcfae2
Author: GitHub Actions <[email protected]>
AuthorDate: Fri Feb 23 20:09:16 2024 +0000
update documentation for tag main
---
main/r/pkgdown.yml | 2 +-
main/r/reference/index.html | 5 ++
main/r/reference/read_nanoarrow.html | 140 +++++++++++++++++++++++++++++++++++
main/r/search.json | 2 +-
main/r/sitemap.xml | 3 +
5 files changed, 150 insertions(+), 2 deletions(-)
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index 7519702e..77550476 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.9.2.1
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2024-02-21T17:16Z
+last_built: 2024-02-23T20:09Z
diff --git a/main/r/reference/index.html b/main/r/reference/index.html
index 93a7e7f2..91379b5d 100644
--- a/main/r/reference/index.html
+++ b/main/r/reference/index.html
@@ -144,6 +144,11 @@
<code><a
href="nanoarrow_version.html">nanoarrow_version()</a></code>
</dt>
<dd>Underlying 'nanoarrow' C library build</dd>
+ </dl><dl><dt>
+
+ <code><a href="read_nanoarrow.html">read_nanoarrow()</a></code>
<code><a href="read_nanoarrow.html">example_ipc_stream()</a></code>
+ </dt>
+ <dd>Read serialized streams of Arrow data</dd>
</dl></div>
</main></div>
diff --git a/main/r/reference/read_nanoarrow.html
b/main/r/reference/read_nanoarrow.html
new file mode 100644
index 00000000..3d6818d3
--- /dev/null
+++ b/main/r/reference/read_nanoarrow.html
@@ -0,0 +1,140 @@
+<!DOCTYPE html>
+<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><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"><meta name="description" content='Reads connections, file
paths, URLs, or raw vectors of serialized Arrow
+data. Arrow documentation typically refers to this format as "Arrow IPC",
+since its origin was as a means to transmit tables between processes
+(e.g., multiple R sessions). This format can also be written to and read
+from files or URLs and is essentially a high performance equivalent of
+a CSV file that does a better job maintaining types.'><title>Read serialized
streams of Arrow data — read_nanoarrow • nanoarrow</title><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><!-- Font
Awesome icons --><link rel="stylesheet" href="https:// [...]
+data. Arrow documentation typically refers to this format as "Arrow IPC",
+since its origin was as a means to transmit tables between processes
+(e.g., multiple R sessions). This format can also be written to and read
+from files or URLs and is essentially a high performance equivalent of
+a CSV file that does a better job maintaining types.'><!-- mathjax --><script
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js";
integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k="
crossorigin="anonymous"></script><script
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js";
integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA="
crossorigin="anonymous"></script><!--[if lt IE 9]>
+<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js";></script>
+<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script>
+<![endif]--></head><body>
+ <a href="#main" class="visually-hidden-focusable">Skip to contents</a>
+
+
+ <nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div
class="container">
+
+ <a class="navbar-brand me-2" href="../index.html">nanoarrow</a>
+
+ <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip"
data-bs-placement="bottom" title="">0.4.0.9000</small>
+
+
+ <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="active nav-item">
+ <a class="nav-link" href="../reference/index.html">Reference</a>
+</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="Search for" autocomplete="off"></form>
+
+ <ul class="navbar-nav"><li class="nav-item">
+ <a class="external-link nav-link"
href="https://github.com/apache/arrow-nanoarrow/"; aria-label="github">
+ <span class="fab fa fab fa-github fa-lg"></span>
+
+ </a>
+</li>
+ </ul></div>
+
+
+ </div>
+</nav><div class="container template-reference-topic">
+<div class="row">
+ <main id="main" class="col-md-9"><div class="page-header">
+ <img src="" class="logo" alt=""><h1>Read serialized streams of Arrow
data</h1>
+ <small class="dont-index">Source: <a
href="https://github.com/apache/arrow-nanoarrow/blob/main/r/R/ipc.R";
class="external-link"><code>R/ipc.R</code></a></small>
+ <div class="d-none name"><code>read_nanoarrow.Rd</code></div>
+ </div>
+
+ <div class="ref-description section level2">
+ <p>Reads connections, file paths, URLs, or raw vectors of serialized Arrow
+data. Arrow documentation typically refers to this format as "Arrow IPC",
+since its origin was as a means to transmit tables between processes
+(e.g., multiple R sessions). This format can also be written to and read
+from files or URLs and is essentially a high performance equivalent of
+a CSV file that does a better job maintaining types.</p>
+ </div>
+
+ <div class="section level2">
+ <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor"
href="#ref-usage"></a></h2>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span><span
class="fu">read_nanoarrow</span><span class="op">(</span><span
class="va">x</span>, <span class="va">...</span>, lazy <span
class="op">=</span> <span class="cn">FALSE</span><span
class="op">)</span></span>
+<span></span>
+<span><span class="fu">example_ipc_stream</span><span class="op">(</span><span
class="op">)</span></span></code></pre></div>
+ </div>
+
+ <div class="section level2">
+ <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor"
href="#arguments"></a></h2>
+ <dl><dt>x</dt>
+<dd><p>A <code><a href="https://rdrr.io/r/base/raw.html";
class="external-link">raw()</a></code> vector, connection, or file path from
which to read
+binary data. Common extensions indicating compression (.gz, .bz2, .zip)
+are automatically uncompressed.</p></dd>
+
+
+<dt>...</dt>
+<dd><p>Currently unused.</p></dd>
+
+
+<dt>lazy</dt>
+<dd><p>By default, <code>read_nanoarrow()</code> will read and discard a copy
of
+the reader's schema to ensure that invalid streams are discovered as
+soon as possible. Use <code>lazy = TRUE</code> to defer this check until the
reader
+is actually consumed.</p></dd>
+
+</dl></div>
+ <div class="section level2">
+ <h2 id="value">Value<a class="anchor" aria-label="anchor"
href="#value"></a></h2>
+
+
+<p>A <a href="as_nanoarrow_array_stream.html">nanoarrow_array_stream</a></p>
+
+
+ </div>
+ <div class="section level2">
+ <h2 id="details">Details<a class="anchor" aria-label="anchor"
href="#details"></a></h2>
+ <p>The nanoarrow package does not currently have the ability to write
serialized
+IPC data: use <code><a
href="https://arrow.apache.org/docs/r/reference/write_ipc_stream.html";
class="external-link">arrow::write_ipc_stream()</a></code> to write data from
R, or use
+the equivalent writer from another Arrow implementation in Python, C++,
+Rust, JavaScript, Julia, C#, and beyond.</p>
+<p>The media type of an Arrow stream is
<code>application/vnd.apache.arrow.stream</code>
+and the recommended file extension is <code>.arrows</code>.</p>
+ </div>
+
+ <div class="section level2">
+ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor"
href="#ref-examples"></a></h2>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span
class="r-in"><span><span class="fu"><a
href="https://rdrr.io/r/base/as.data.frame.html";
class="external-link">as.data.frame</a></span><span class="op">(</span><span
class="fu">read_nanoarrow</span><span class="op">(</span><span
class="fu">example_ipc_stream</span><span class="op">(</span><span
class="op">)</span><span class="op">)</span><span
class="op">)</span></span></span>
+<span class="r-out co"><span class="r-pr">#></span> some_col</span>
+<span class="r-out co"><span class="r-pr">#></span> 1 1</span>
+<span class="r-out co"><span class="r-pr">#></span> 2 2</span>
+<span class="r-out co"><span class="r-pr">#></span> 3 3</span>
+<span class="r-in"><span></span></span>
+</code></pre></div>
+ </div>
+ </main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
+ </nav></aside></div>
+
+
+ <footer><div class="pkgdown-footer-left">
+ <p></p><p>Developed by Dewey Dunnington, Apache Arrow.</p>
+</div>
+
+<div class="pkgdown-footer-right">
+ <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/";
class="external-link">pkgdown</a> 2.0.7.</p>
+</div>
+
+ </footer></div>
+
+
+
+
+
+ </body></html>
+
diff --git a/main/r/search.json b/main/r/search.json
index 75dd3065..25c63808 100644
--- a/main/r/search.json
+++ b/main/r/search.json
@@ -1 +1 @@
-[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"/LICENSE.html","id":"1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title":"Apache License","text":"“License” shall mean terms
conditions use, reproduction, distribution defined Sections 1 9 [...]
+[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"/LICENSE.html","id":"1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title":"Apache License","text":"“License” shall mean terms
conditions use, reproduction, distribution defined Sections 1 9 [...]
diff --git a/main/r/sitemap.xml b/main/r/sitemap.xml
index 8e38d14c..253ca992 100644
--- a/main/r/sitemap.xml
+++ b/main/r/sitemap.xml
@@ -75,4 +75,7 @@
<url>
<loc>/reference/nanoarrow_version.html</loc>
</url>
+ <url>
+ <loc>/reference/read_nanoarrow.html</loc>
+ </url>
</urlset>
