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 bf822b29 update documentation for tag main
bf822b29 is described below
commit bf822b295674826bfa65f001a2f0b5fc196f3c1d
Author: GitHub Actions <[email protected]>
AuthorDate: Tue Sep 17 14:41:04 2024 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1163756 -> 1163756 bytes
main/r/pkgdown.yml | 2 +-
main/r/reference/index.html | 4 ++--
main/r/reference/read_nanoarrow.html | 31 +++++++++++++++++++------------
main/r/search.json | 2 +-
5 files changed, 23 insertions(+), 16 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index d99f0a8b..9af35137 100644
Binary files a/main/.doctrees/environment.pickle and
b/main/.doctrees/environment.pickle differ
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index d973dc95..2f33f473 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.1.3
pkgdown: 2.1.0
pkgdown_sha: ~
articles: {}
-last_built: 2024-09-17T03:02Z
+last_built: 2024-09-17T14:40Z
diff --git a/main/r/reference/index.html b/main/r/reference/index.html
index 8fdca994..1fc77a8a 100644
--- a/main/r/reference/index.html
+++ b/main/r/reference/index.html
@@ -158,10 +158,10 @@
<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>
+ <code><a href="read_nanoarrow.html">read_nanoarrow()</a></code>
<code><a href="read_nanoarrow.html">write_nanoarrow()</a></code> <code><a
href="read_nanoarrow.html">example_ipc_stream()</a></code>
</dt>
- <dd>Read serialized streams of Arrow data</dd>
+ <dd>Read/write 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
index 4fcdc8d0..efcf8988 100644
--- a/main/r/reference/read_nanoarrow.html
+++ b/main/r/reference/read_nanoarrow.html
@@ -1,12 +1,12 @@
<!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"><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-wid [...]
-data. Arrow documentation typically refers to this format as "Arrow IPC",
-since its origin was as a means to transmit tables between processes
+<!-- 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"><title>Read/write 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=devi [...]
+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.'><meta
property="og: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
+a CSV file that does a better job maintaining types.'><meta
property="og:description" content='Reads/writes connections, file paths, URLs,
or raw vectors from/to 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.'></head><body>
@@ -38,15 +38,15 @@ a CSV file that does a better job maintaining
types.'></head><body>
<div class="row">
<main id="main" class="col-md-9"><div class="page-header">
- <h1>Read serialized streams of Arrow data</h1>
+ <h1>Read/write 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
+ <p>Reads/writes connections, file paths, URLs, or raw vectors from/to
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>
@@ -56,6 +56,8 @@ a CSV file that does a better job maintaining types.</p>
<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">write_nanoarrow</span><span class="op">(</span><span
class="va">data</span>, <span class="va">x</span>, <span
class="va">...</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>
@@ -79,6 +81,11 @@ 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>
+
+<dt id="arg-data">data<a class="anchor" aria-label="anchor"
href="#arg-data"></a></dt>
+<dd><p>An object to write as an Arrow IPC stream, converted using
+<code><a
href="as_nanoarrow_array_stream.html">as_nanoarrow_array_stream()</a></code>.
Notably, this includes a <code><a href="https://rdrr.io/r/base/data.frame.html";
class="external-link">data.frame()</a></code>.</p></dd>
+
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor"
href="#value"></a></h2>
@@ -86,8 +93,8 @@ is actually consumed.</p></dd>
</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
+ <p>The nanoarrow package implements an IPC writer; however, you can also
+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>
diff --git a/main/r/search.json b/main/r/search.json
index 7102cb75..4254f159 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":"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 [...]
+[{"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":"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 [...]
