| <!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>Convert an object to a nanoarrow array_stream — as_nanoarrow_array_stream • 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><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><meta property="og:title" content="Convert an object to a nanoarrow array_stream — as_nanoarrow_array_stream"><meta name="description" content="In nanoarrow, an 'array stream' corresponds to the struct ArrowArrayStream |
| as defined in the Arrow C Stream interface. This object is used to represent |
| a stream of arrays with a common |
| schema. This is similar to an |
| arrow::RecordBatchReader except it can be used to represent a stream of |
| any type (not just record batches). Note that a stream of record batches |
| and a stream of non-nullable struct arrays are represented identically. |
| Also note that array streams are mutable objects and are passed by |
| reference and not by value."><meta property="og:description" content="In nanoarrow, an 'array stream' corresponds to the struct ArrowArrayStream |
| as defined in the Arrow C Stream interface. This object is used to represent |
| a stream of arrays with a common |
| schema. This is similar to an |
| arrow::RecordBatchReader except it can be used to represent a stream of |
| any type (not just record batches). Note that a stream of record batches |
| and a stream of non-nullable struct arrays are represented identically. |
| Also note that array streams are mutable objects and are passed by |
| reference and not by value."></head><body> |
| <a href="#main" class="visually-hidden-focusable">Skip to contents</a> |
| |
| |
| <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><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.6.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><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search"> |
| <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li> |
| <li class="nav-item"><a class="external-link nav-link" href="https://github.com/apache/arrow-nanoarrow/" aria-label="GitHub"><span class="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"> |
| |
| <h1>Convert an object to a nanoarrow array_stream</h1> |
| <small class="dont-index">Source: <a href="https://github.com/apache/arrow-nanoarrow/blob/main/r/R/array-stream.R" class="external-link"><code>R/array-stream.R</code></a></small> |
| <div class="d-none name"><code>as_nanoarrow_array_stream.Rd</code></div> |
| </div> |
| |
| <div class="ref-description section level2"> |
| <p>In nanoarrow, an 'array stream' corresponds to the <code>struct ArrowArrayStream</code> |
| as defined in the Arrow C Stream interface. This object is used to represent |
| a stream of <a href="as_nanoarrow_array.html">arrays</a> with a common |
| <a href="as_nanoarrow_schema.html">schema</a>. This is similar to an |
| <a href="https://arrow.apache.org/docs/r/reference/RecordBatchReader.html" class="external-link">arrow::RecordBatchReader</a> except it can be used to represent a stream of |
| any type (not just record batches). Note that a stream of record batches |
| and a stream of non-nullable struct arrays are represented identically. |
| Also note that array streams are mutable objects and are passed by |
| reference and not by value.</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">as_nanoarrow_array_stream</span><span class="op">(</span><span class="va">x</span>, <span class="va">...</span>, schema <span class="op">=</span> <span class="cn">NULL</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 id="arg-x">x<a class="anchor" aria-label="anchor" href="#arg-x"></a></dt> |
| <dd><p>An object to convert to a array_stream</p></dd> |
| |
| |
| <dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt> |
| <dd><p>Passed to S3 methods</p></dd> |
| |
| |
| <dt id="arg-schema">schema<a class="anchor" aria-label="anchor" href="#arg-schema"></a></dt> |
| <dd><p>An optional schema used to enforce conversion to a particular |
| type. Defaults to <code><a href="as_nanoarrow_schema.html">infer_nanoarrow_schema()</a></code>.</p></dd> |
| |
| </dl></div> |
| <div class="section level2"> |
| <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2> |
| <p>An object of class 'nanoarrow_array_stream'</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="op">(</span><span class="va">stream</span> <span class="op"><-</span> <span class="fu">as_nanoarrow_array_stream</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span>x <span class="op">=</span> <span class="fl">1</span><span class="op">:</span><span class="fl">5</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> <nanoarrow_array_stream struct<x: int32>></span> |
| <span class="r-out co"><span class="r-pr">#></span> $ get_schema:function () </span> |
| <span class="r-out co"><span class="r-pr">#></span> $ get_next :function (schema = x$get_schema(), validate = TRUE) </span> |
| <span class="r-out co"><span class="r-pr">#></span> $ release :function () </span> |
| <span class="r-in"><span><span class="va">stream</span><span class="op">$</span><span class="fu">get_schema</span><span class="op">(</span><span class="op">)</span></span></span> |
| <span class="r-out co"><span class="r-pr">#></span> <nanoarrow_schema struct></span> |
| <span class="r-out co"><span class="r-pr">#></span> $ format : chr "+s"</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ name : chr ""</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ metadata : list()</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ flags : int 0</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ children :List of 1</span> |
| <span class="r-out co"><span class="r-pr">#></span> ..$ x:<nanoarrow_schema int32></span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ format : chr "i"</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ name : chr "x"</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ metadata : list()</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ flags : int 2</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ children : list()</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ dictionary: NULL</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ dictionary: NULL</span> |
| <span class="r-in"><span><span class="va">stream</span><span class="op">$</span><span class="fu">get_next</span><span class="op">(</span><span class="op">)</span></span></span> |
| <span class="r-out co"><span class="r-pr">#></span> <nanoarrow_array struct[5]></span> |
| <span class="r-out co"><span class="r-pr">#></span> $ length : int 5</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ null_count: int 0</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ offset : int 0</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ buffers :List of 1</span> |
| <span class="r-out co"><span class="r-pr">#></span> ..$ :<nanoarrow_buffer validity<bool>[null] ``</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ children :List of 1</span> |
| <span class="r-out co"><span class="r-pr">#></span> ..$ x:<nanoarrow_array int32[5]></span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ length : int 5</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ null_count: int 0</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ offset : int 0</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ buffers :List of 2</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. .. ..$ :<nanoarrow_buffer validity<bool>[null] ``</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. .. ..$ :<nanoarrow_buffer data<int32>[5][20 b]> `1 2 3 4 5`</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ dictionary: NULL</span> |
| <span class="r-out co"><span class="r-pr">#></span> .. ..$ children : list()</span> |
| <span class="r-out co"><span class="r-pr">#></span> $ dictionary: NULL</span> |
| <span class="r-in"><span></span></span> |
| <span class="r-in"><span><span class="co"># The last batch is returned as NULL</span></span></span> |
| <span class="r-in"><span><span class="va">stream</span><span class="op">$</span><span class="fu">get_next</span><span class="op">(</span><span class="op">)</span></span></span> |
| <span class="r-out co"><span class="r-pr">#></span> NULL</span> |
| <span class="r-in"><span></span></span> |
| <span class="r-in"><span><span class="co"># Release the stream</span></span></span> |
| <span class="r-in"><span><span class="va">stream</span><span class="op">$</span><span class="fu">release</span><span class="op">(</span><span class="op">)</span></span></span> |
| <span class="r-in"><span></span></span> |
| </code></pre></div> |
| </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>Developed by Dewey Dunnington, Apache Arrow.</p> |
| </div> |
| |
| <div class="pkgdown-footer-right"> |
| <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p> |
| </div> |
| |
| </footer></div> |
| |
| |
| |
| |
| |
| </body></html> |
| |
