| <!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>Create type objects — na_type • 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.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.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="Create type objects — na_type"><meta name="description" content="In nanoarrow, types, fields, and schemas are all represented by a |
| nanoarrow_schema. These functions are convenience |
| constructors to create these objects in a readable way. Use na_type() to |
| construct types based on the constructor name, which is also the name that |
| prints/is returned by nanoarrow_schema_parse()."><meta property="og:description" content="In nanoarrow, types, fields, and schemas are all represented by a |
| nanoarrow_schema. These functions are convenience |
| constructors to create these objects in a readable way. Use na_type() to |
| construct types based on the constructor name, which is also the name that |
| prints/is returned by nanoarrow_schema_parse()."></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.5.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>Create type objects</h1> |
| <small class="dont-index">Source: <a href="https://github.com/apache/arrow-nanoarrow/blob/main/r/R/type.R" class="external-link"><code>R/type.R</code></a></small> |
| <div class="d-none name"><code>na_type.Rd</code></div> |
| </div> |
| |
| <div class="ref-description section level2"> |
| <p>In nanoarrow, types, fields, and schemas are all represented by a |
| <a href="as_nanoarrow_schema.html">nanoarrow_schema</a>. These functions are convenience |
| constructors to create these objects in a readable way. Use <code>na_type()</code> to |
| construct types based on the constructor name, which is also the name that |
| prints/is returned by <code><a href="as_nanoarrow_schema.html">nanoarrow_schema_parse()</a></code>.</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">na_type</span><span class="op">(</span></span> |
| <span> <span class="va">type_name</span>,</span> |
| <span> byte_width <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> unit <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> timezone <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> column_types <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> item_type <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> key_type <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> value_type <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> index_type <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> ordered <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> list_size <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> keys_sorted <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> storage_type <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> extension_name <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> extension_metadata <span class="op">=</span> <span class="cn">NULL</span>,</span> |
| <span> nullable <span class="op">=</span> <span class="cn">NULL</span></span> |
| <span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_na</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_bool</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_int8</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_uint8</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_int16</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_uint16</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_int32</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_uint32</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_int64</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_uint64</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_half_float</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_float</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_double</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_string</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_large_string</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_binary</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_large_binary</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_fixed_size_binary</span><span class="op">(</span><span class="va">byte_width</span>, nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_date32</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_date64</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_time32</span><span class="op">(</span>unit <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"ms"</span>, <span class="st">"s"</span><span class="op">)</span>, nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_time64</span><span class="op">(</span>unit <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"us"</span>, <span class="st">"ns"</span><span class="op">)</span>, nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_duration</span><span class="op">(</span>unit <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"ms"</span>, <span class="st">"s"</span>, <span class="st">"us"</span>, <span class="st">"ns"</span><span class="op">)</span>, nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_interval_months</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_interval_day_time</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_interval_month_day_nano</span><span class="op">(</span>nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_timestamp</span><span class="op">(</span>unit <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"us"</span>, <span class="st">"ns"</span>, <span class="st">"s"</span>, <span class="st">"ms"</span><span class="op">)</span>, timezone <span class="op">=</span> <span class="st">""</span>, nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_decimal128</span><span class="op">(</span><span class="va">precision</span>, <span class="va">scale</span>, nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_decimal256</span><span class="op">(</span><span class="va">precision</span>, <span class="va">scale</span>, nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_struct</span><span class="op">(</span>column_types <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="op">)</span>, nullable <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_sparse_union</span><span class="op">(</span>column_types <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_dense_union</span><span class="op">(</span>column_types <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_list</span><span class="op">(</span><span class="va">item_type</span>, nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_large_list</span><span class="op">(</span><span class="va">item_type</span>, nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_fixed_size_list</span><span class="op">(</span><span class="va">item_type</span>, <span class="va">list_size</span>, nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_map</span><span class="op">(</span><span class="va">key_type</span>, <span class="va">item_type</span>, keys_sorted <span class="op">=</span> <span class="cn">FALSE</span>, nullable <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_dictionary</span><span class="op">(</span><span class="va">value_type</span>, index_type <span class="op">=</span> <span class="fu">na_int32</span><span class="op">(</span><span class="op">)</span>, ordered <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">na_extension</span><span class="op">(</span><span class="va">storage_type</span>, <span class="va">extension_name</span>, extension_metadata <span class="op">=</span> <span class="st">""</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-type-name">type_name<a class="anchor" aria-label="anchor" href="#arg-type-name"></a></dt> |
| <dd><p>The name of the type (e.g., "int32"). This form of the |
| constructor is useful for writing tests that loop over many types.</p></dd> |
| |
| |
| <dt id="arg-byte-width">byte_width<a class="anchor" aria-label="anchor" href="#arg-byte-width"></a></dt> |
| <dd><p>For <code>na_fixed_size_binary()</code>, the number of bytes |
| occupied by each item.</p></dd> |
| |
| |
| <dt id="arg-unit">unit<a class="anchor" aria-label="anchor" href="#arg-unit"></a></dt> |
| <dd><p>One of 's' (seconds), 'ms' (milliseconds), 'us' (microseconds), |
| or 'ns' (nanoseconds).</p></dd> |
| |
| |
| <dt id="arg-timezone">timezone<a class="anchor" aria-label="anchor" href="#arg-timezone"></a></dt> |
| <dd><p>A string representing a timezone name. The empty string "" |
| represents a naive point in time (i.e., one that has no associated |
| timezone).</p></dd> |
| |
| |
| <dt id="arg-column-types">column_types<a class="anchor" aria-label="anchor" href="#arg-column-types"></a></dt> |
| <dd><p>A <code><a href="https://rdrr.io/r/base/list.html" class="external-link">list()</a></code> of <a href="as_nanoarrow_schema.html">nanoarrow_schema</a>s.</p></dd> |
| |
| |
| <dt id="arg-item-type">item_type<a class="anchor" aria-label="anchor" href="#arg-item-type"></a></dt> |
| <dd><p>For <code>na_list()</code>, <code>na_large_list()</code>, <code>na_fixed_size_list()</code>, |
| and <code>na_map()</code>, the <a href="as_nanoarrow_schema.html">nanoarrow_schema</a> representing |
| the item type.</p></dd> |
| |
| |
| <dt id="arg-key-type">key_type<a class="anchor" aria-label="anchor" href="#arg-key-type"></a></dt> |
| <dd><p>The <a href="as_nanoarrow_schema.html">nanoarrow_schema</a> representing the |
| <code>na_map()</code> key type.</p></dd> |
| |
| |
| <dt id="arg-value-type">value_type<a class="anchor" aria-label="anchor" href="#arg-value-type"></a></dt> |
| <dd><p>The <a href="as_nanoarrow_schema.html">nanoarrow_schema</a> representing the |
| <code>na_dictionary()</code> or <code>na_map()</code> value type.</p></dd> |
| |
| |
| <dt id="arg-index-type">index_type<a class="anchor" aria-label="anchor" href="#arg-index-type"></a></dt> |
| <dd><p>The <a href="as_nanoarrow_schema.html">nanoarrow_schema</a> representing the |
| <code>na_dictionary()</code> index type.</p></dd> |
| |
| |
| <dt id="arg-ordered">ordered<a class="anchor" aria-label="anchor" href="#arg-ordered"></a></dt> |
| <dd><p>Use <code>TRUE</code> to assert that the order of values in the |
| dictionary are meaningful.</p></dd> |
| |
| |
| <dt id="arg-list-size">list_size<a class="anchor" aria-label="anchor" href="#arg-list-size"></a></dt> |
| <dd><p>The number of elements in each item in a |
| <code>na_fixed_size_list()</code>.</p></dd> |
| |
| |
| <dt id="arg-keys-sorted">keys_sorted<a class="anchor" aria-label="anchor" href="#arg-keys-sorted"></a></dt> |
| <dd><p>Use <code>TRUE</code> to assert that keys are sorted.</p></dd> |
| |
| |
| <dt id="arg-storage-type">storage_type<a class="anchor" aria-label="anchor" href="#arg-storage-type"></a></dt> |
| <dd><p>For <code>na_extension()</code>, the underlying value type.</p></dd> |
| |
| |
| <dt id="arg-extension-name">extension_name<a class="anchor" aria-label="anchor" href="#arg-extension-name"></a></dt> |
| <dd><p>For <code>na_extension()</code>, the extension name. This is |
| typically namespaced separated by dots (e.g., arrow.r.vctrs).</p></dd> |
| |
| |
| <dt id="arg-extension-metadata">extension_metadata<a class="anchor" aria-label="anchor" href="#arg-extension-metadata"></a></dt> |
| <dd><p>A string or raw vector defining extension metadata. |
| Most Arrow extension types define extension metadata as a JSON object.</p></dd> |
| |
| |
| <dt id="arg-nullable">nullable<a class="anchor" aria-label="anchor" href="#arg-nullable"></a></dt> |
| <dd><p>Use <code>FALSE</code> to assert that this field cannot contain |
| null values.</p></dd> |
| |
| |
| <dt id="arg-precision">precision<a class="anchor" aria-label="anchor" href="#arg-precision"></a></dt> |
| <dd><p>The total number of digits representable by the decimal type</p></dd> |
| |
| |
| <dt id="arg-scale">scale<a class="anchor" aria-label="anchor" href="#arg-scale"></a></dt> |
| <dd><p>The number of digits after the decimal point in a decimal type</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_schema.html">nanoarrow_schema</a></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">na_int32</span><span class="op">(</span><span class="op">)</span></span></span> |
| <span class="r-out co"><span class="r-pr">#></span> <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 ""</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-in"><span><span class="fu">na_struct</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span>col1 <span class="op">=</span> <span class="fu">na_int32</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> <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> ..$ col1:<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 "col1"</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></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.0.</p> |
| </div> |
| |
| </footer></div> |
| |
| |
| |
| |
| |
| </body></html> |
| |
