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 5ba3b0c4 update documentation for tag main
5ba3b0c4 is described below
commit 5ba3b0c413cf0f991ed2be30bfd4a48126af9f55
Author: GitHub Actions <[email protected]>
AuthorDate: Sat Sep 14 04:15:31 2024 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1162388 -> 1163756
bytes
.../reference/python/array-stream.doctree | Bin 45264 -> 45324 bytes
main/.doctrees/reference/python/array.doctree | Bin 87107 -> 91441 bytes
main/.doctrees/reference/python/schema.doctree | Bin 282100 -> 286386 bytes
main/genindex.html | 12 +-
main/getting-started/cpp.html | 2 +-
main/getting-started/index.html | 2 +-
main/getting-started/python.html | 2 +-
main/getting-started/r.html | 2 +-
main/index.html | 2 +-
main/objects.inv | Bin 17622 -> 17636 bytes
main/py-modindex.html | 2 +-
main/r/pkgdown.yml | 2 +-
main/reference/c.html | 2 +-
main/reference/cpp.html | 2 +-
main/reference/device.html | 2 +-
main/reference/index.html | 2 +-
main/reference/ipc.html | 2 +-
main/reference/python/advanced.html | 2 +-
main/reference/python/array-stream.html | 14 +-
main/reference/python/array.html | 22 +-
main/reference/python/index.html | 2 +-
main/reference/python/schema.html | 294 +++++++++++----------
main/reference/r.html | 2 +-
main/reference/testing.html | 2 +-
main/roadmap.html | 2 +-
main/search.html | 2 +-
main/searchindex.js | 2 +-
28 files changed, 209 insertions(+), 171 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index bf098ccb..809e0f9d 100644
Binary files a/main/.doctrees/environment.pickle and
b/main/.doctrees/environment.pickle differ
diff --git a/main/.doctrees/reference/python/array-stream.doctree
b/main/.doctrees/reference/python/array-stream.doctree
index fbb0c3c3..0f98a1e8 100644
Binary files a/main/.doctrees/reference/python/array-stream.doctree and
b/main/.doctrees/reference/python/array-stream.doctree differ
diff --git a/main/.doctrees/reference/python/array.doctree
b/main/.doctrees/reference/python/array.doctree
index 4f4e789e..295d4783 100644
Binary files a/main/.doctrees/reference/python/array.doctree and
b/main/.doctrees/reference/python/array.doctree differ
diff --git a/main/.doctrees/reference/python/schema.doctree
b/main/.doctrees/reference/python/schema.doctree
index dff21a8b..fe8c6d34 100644
Binary files a/main/.doctrees/reference/python/schema.doctree and
b/main/.doctrees/reference/python/schema.doctree differ
diff --git a/main/genindex.html b/main/genindex.html
index e03ec806..b3acb75e 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -1419,12 +1419,18 @@ document.write(`
</ul></li>
<li><a
href="reference/python/schema.html#nanoarrow.schema.Schema">Schema (class in
nanoarrow.schema)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/python/array.html#nanoarrow.array.Scalar.schema">schema (Scalar
property)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/python/schema.html#nanoarrow.schema.schema">schema() (in module
nanoarrow.schema)</a>
</li>
+ <li><a
href="reference/python/array.html#nanoarrow.array.Array.serialize">serialize()
(Array method)</a>
+
+ <ul>
+ <li><a
href="reference/python/schema.html#nanoarrow.schema.Schema.serialize">(Schema
method)</a>
+</li>
+ </ul></li>
<li><a
href="reference/python/schema.html#nanoarrow.schema.ExtensionAccessor.storage">storage
(ExtensionAccessor property)</a>
</li>
<li><a
href="reference/python/schema.html#nanoarrow.schema.string">string() (in module
nanoarrow.schema)</a>
@@ -1564,7 +1570,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/getting-started/cpp.html b/main/getting-started/cpp.html
index bd11dfac..403d5fdb 100644
--- a/main/getting-started/cpp.html
+++ b/main/getting-started/cpp.html
@@ -1014,7 +1014,7 @@ exposing an Arrow-based API implemented using the
nanoarrow C library.</p>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/getting-started/index.html b/main/getting-started/index.html
index e517bdbb..37cd3ff8 100644
--- a/main/getting-started/index.html
+++ b/main/getting-started/index.html
@@ -522,7 +522,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/getting-started/python.html b/main/getting-started/python.html
index 69f38986..66453d72 100644
--- a/main/getting-started/python.html
+++ b/main/getting-started/python.html
@@ -863,7 +863,7 @@ in the working tree.</p>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/getting-started/r.html b/main/getting-started/r.html
index b8bb2747..55370437 100644
--- a/main/getting-started/r.html
+++ b/main/getting-started/r.html
@@ -759,7 +759,7 @@ equivalent nanoarrow objects into many arrow functions and
vice versa.</p>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/index.html b/main/index.html
index d8cf59e6..18ead48f 100644
--- a/main/index.html
+++ b/main/index.html
@@ -658,7 +658,7 @@ meson<span class="w"> </span><span
class="nb">test</span><span class="w"> </span
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/objects.inv b/main/objects.inv
index f0991652..18708fa2 100644
Binary files a/main/objects.inv and b/main/objects.inv differ
diff --git a/main/py-modindex.html b/main/py-modindex.html
index c2cee45b..d6071530 100644
--- a/main/py-modindex.html
+++ b/main/py-modindex.html
@@ -451,7 +451,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index cd8e6203..166ac1cd 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-11T17:37Z
+last_built: 2024-09-14T04:15Z
diff --git a/main/reference/c.html b/main/reference/c.html
index 4e174395..cb37d481 100644
--- a/main/reference/c.html
+++ b/main/reference/c.html
@@ -1786,7 +1786,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/reference/cpp.html b/main/reference/cpp.html
index bd646593..ba62bb6a 100644
--- a/main/reference/cpp.html
+++ b/main/reference/cpp.html
@@ -784,7 +784,7 @@ This class allows a standard C++ class to be exported to a
generic ArrowArrayStr
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/reference/device.html b/main/reference/device.html
index f6432947..c55d999d 100644
--- a/main/reference/device.html
+++ b/main/reference/device.html
@@ -1020,7 +1020,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/reference/index.html b/main/reference/index.html
index 69d0c601..ebf2e47a 100644
--- a/main/reference/index.html
+++ b/main/reference/index.html
@@ -552,7 +552,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index b327778b..251f3f5e 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -1280,7 +1280,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/reference/python/advanced.html
b/main/reference/python/advanced.html
index b3e72278..02e3af2e 100644
--- a/main/reference/python/advanced.html
+++ b/main/reference/python/advanced.html
@@ -933,7 +933,7 @@ These objects are usually created using
<cite>nanoarrow.c_array_stream()</cite>.
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/reference/python/array-stream.html
b/main/reference/python/array-stream.html
index 2bd9fcab..2542d9a0 100644
--- a/main/reference/python/array-stream.html
+++ b/main/reference/python/array-stream.html
@@ -478,11 +478,11 @@ this stream.</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">tempfile</span>
<span class="gp">>>> </span><span class="kn">import</span> <span
class="nn">os</span>
<span class="gp">>>> </span><span class="kn">import</span> <span
class="nn">nanoarrow</span> <span class="k">as</span> <span class="nn">na</span>
-<span class="gp">>>> </span><span class="kn">from</span> <span
class="nn">nanoarrow.ipc</span> <span class="kn">import</span> <span
class="n">Stream</span>
+<span class="gp">>>> </span><span class="kn">from</span> <span
class="nn">nanoarrow.ipc</span> <span class="kn">import</span> <span
class="n">InputStream</span>
<span class="gp">>>> </span><span class="k">with</span> <span
class="n">tempfile</span><span class="o">.</span><span
class="n">TemporaryDirectory</span><span class="p">()</span> <span
class="k">as</span> <span class="n">td</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">path</span> <span
class="o">=</span> <span class="n">os</span><span class="o">.</span><span
class="n">path</span><span class="o">.</span><span class="n">join</span><span
class="p">(</span><span class="n">td</span><span class="p">,</span> <span
class="s2">"test.arrows"</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">with</span> <span
class="nb">open</span><span class="p">(</span><span class="n">path</span><span
class="p">,</span> <span class="s2">"wb"</span><span
class="p">)</span> <span class="k">as</span> <span class="n">f</span><span
class="p">:</span>
-<span class="gp">... </span> <span class="n">nbytes</span> <span
class="o">=</span> <span class="n">f</span><span class="o">.</span><span
class="n">write</span><span class="p">(</span><span
class="n">Stream</span><span class="o">.</span><span
class="n">example_bytes</span><span class="p">())</span>
+<span class="gp">... </span> <span class="n">nbytes</span> <span
class="o">=</span> <span class="n">f</span><span class="o">.</span><span
class="n">write</span><span class="p">(</span><span
class="n">InputStream</span><span class="o">.</span><span
class="n">example_bytes</span><span class="p">())</span>
<span class="gp">...</span>
<span class="gp">... </span> <span class="k">with</span> <span
class="n">na</span><span class="o">.</span><span
class="n">ArrayStream</span><span class="o">.</span><span
class="n">from_path</span><span class="p">(</span><span
class="n">path</span><span class="p">)</span> <span class="k">as</span> <span
class="n">stream</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">stream</span><span
class="o">.</span><span class="n">read_all</span><span class="p">()</span>
@@ -502,8 +502,8 @@ this stream.</p>
<section id="id3">
<h3>Examples<a class="headerlink" href="#id3" title="Link to this
heading">#</a></h3>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
-<span class="gp">>>> </span><span class="kn">from</span> <span
class="nn">nanoarrow.ipc</span> <span class="kn">import</span> <span
class="n">Stream</span>
-<span class="gp">>>> </span><span class="k">with</span> <span
class="n">na</span><span class="o">.</span><span
class="n">ArrayStream</span><span class="o">.</span><span
class="n">from_readable</span><span class="p">(</span><span
class="n">Stream</span><span class="o">.</span><span
class="n">example_bytes</span><span class="p">())</span> <span
class="k">as</span> <span class="n">stream</span><span class="p">:</span>
+<span class="gp">>>> </span><span class="kn">from</span> <span
class="nn">nanoarrow.ipc</span> <span class="kn">import</span> <span
class="n">InputStream</span>
+<span class="gp">>>> </span><span class="k">with</span> <span
class="n">na</span><span class="o">.</span><span
class="n">ArrayStream</span><span class="o">.</span><span
class="n">from_readable</span><span class="p">(</span><span
class="n">InputStream</span><span class="o">.</span><span
class="n">example_bytes</span><span class="p">())</span> <span
class="k">as</span> <span class="n">stream</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">stream</span><span
class="o">.</span><span class="n">read_all</span><span class="p">()</span>
<span class="go">nanoarrow.Array<non-nullable struct<some_col:
int32>>[3]</span>
<span class="go">{'some_col': 1}</span>
@@ -524,11 +524,11 @@ this stream.</p>
<span class="gp">>>> </span><span class="kn">import</span> <span
class="nn">tempfile</span>
<span class="gp">>>> </span><span class="kn">import</span> <span
class="nn">os</span>
<span class="gp">>>> </span><span class="kn">import</span> <span
class="nn">nanoarrow</span> <span class="k">as</span> <span class="nn">na</span>
-<span class="gp">>>> </span><span class="kn">from</span> <span
class="nn">nanoarrow.ipc</span> <span class="kn">import</span> <span
class="n">Stream</span>
+<span class="gp">>>> </span><span class="kn">from</span> <span
class="nn">nanoarrow.ipc</span> <span class="kn">import</span> <span
class="n">InputStream</span>
<span class="gp">>>> </span><span class="k">with</span> <span
class="n">tempfile</span><span class="o">.</span><span
class="n">TemporaryDirectory</span><span class="p">()</span> <span
class="k">as</span> <span class="n">td</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">path</span> <span
class="o">=</span> <span class="n">os</span><span class="o">.</span><span
class="n">path</span><span class="o">.</span><span class="n">join</span><span
class="p">(</span><span class="n">td</span><span class="p">,</span> <span
class="s2">"test.arrows"</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">with</span> <span
class="nb">open</span><span class="p">(</span><span class="n">path</span><span
class="p">,</span> <span class="s2">"wb"</span><span
class="p">)</span> <span class="k">as</span> <span class="n">f</span><span
class="p">:</span>
-<span class="gp">... </span> <span class="n">nbytes</span> <span
class="o">=</span> <span class="n">f</span><span class="o">.</span><span
class="n">write</span><span class="p">(</span><span
class="n">Stream</span><span class="o">.</span><span
class="n">example_bytes</span><span class="p">())</span>
+<span class="gp">... </span> <span class="n">nbytes</span> <span
class="o">=</span> <span class="n">f</span><span class="o">.</span><span
class="n">write</span><span class="p">(</span><span
class="n">InputStream</span><span class="o">.</span><span
class="n">example_bytes</span><span class="p">())</span>
<span class="gp">...</span>
<span class="gp">... </span> <span class="n">uri</span> <span
class="o">=</span> <span class="n">pathlib</span><span class="o">.</span><span
class="n">Path</span><span class="p">(</span><span class="n">path</span><span
class="p">)</span><span class="o">.</span><span class="n">as_uri</span><span
class="p">()</span>
<span class="gp">... </span> <span class="k">with</span> <span
class="n">na</span><span class="o">.</span><span
class="n">ArrayStream</span><span class="o">.</span><span
class="n">from_url</span><span class="p">(</span><span
class="n">uri</span><span class="p">)</span> <span class="k">as</span> <span
class="n">stream</span><span class="p">:</span>
@@ -774,7 +774,7 @@ in this stream.</p>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/reference/python/array.html b/main/reference/python/array.html
index 73f89e79..dd0eb620 100644
--- a/main/reference/python/array.html
+++ b/main/reference/python/array.html
@@ -794,6 +794,21 @@ contiguous in memory.</p>
<dd><p>Get the schema (data type) of this Array</p>
</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="nanoarrow.array.Array.serialize">
+<span class="sig-name descname"><span class="pre">serialize</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">dst</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">None</span></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <span
class="sig-return-typehint"><span class="pre">bytes</span><span class="w">
</span><spa [...]
+<dd><p>Write this Array into dst as zero or more encapsulated IPC messages</p>
+<section id="id22">
+<h3>Parameters<a class="headerlink" href="#id22" title="Link to this
heading">#</a></h3>
+<dl class="simple">
+<dt>dst<span class="classifier">file-like, optional</span></dt><dd><p>If
present, a file-like object into which the chunks of this array
+should be serialized. If omitted, this will create a <code class="docutils
literal notranslate"><span class="pre">io.BytesIO()</span></code>
+and return the serialized result.</p>
+</dd>
+</dl>
+</section>
+</dd></dl>
+
</section>
</dd></dl>
@@ -808,8 +823,8 @@ an <a class="reference internal"
href="#nanoarrow.array.Array" title="nanoarrow.
<p>Note that it is rarely efficient to iterate over Scalar objects:
use the iterators in <code class="xref py py-mod docutils literal
notranslate"><span class="pre">nanoarrow.iterator</span></code> to more
effectively
iterate over an <a class="reference internal" href="#nanoarrow.array.Array"
title="nanoarrow.array.Array"><code class="xref py py-class docutils literal
notranslate"><span class="pre">Array</span></code></a>.</p>
-<section id="id22">
-<h2>Examples<a class="headerlink" href="#id22" title="Link to this
heading">#</a></h2>
+<section id="id23">
+<h2>Examples<a class="headerlink" href="#id23" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">array</span> <span
class="o">=</span> <span class="n">na</span><span class="o">.</span><span
class="n">Array</span><span class="p">([</span><span class="mi">1</span><span
class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span
class="mi">3</span><span class="p">],</span> <span class="n">na</span><span
class="o">.</span><span class="n">int32</span><span class="p">())</span>
<span class="gp">>>> </span><span class="n">array</span><span
class="p">[</span><span class="mi">0</span><span class="p">]</span>
@@ -909,6 +924,7 @@ iterate over an <a class="reference internal"
href="#nanoarrow.array.Array" titl
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array.Array.n_chunks"><code class="docutils literal
notranslate"><span class="pre">Array.n_chunks</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array.Array.offset"><code class="docutils literal
notranslate"><span class="pre">Array.offset</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array.Array.schema"><code class="docutils literal
notranslate"><span class="pre">Array.schema</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array.Array.serialize"><code class="docutils literal
notranslate"><span class="pre">Array.serialize()</span></code></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.array.Scalar"><code class="docutils literal notranslate"><span
class="pre">Scalar</span></code></a><ul class="visible nav section-nav
flex-column">
@@ -979,7 +995,7 @@ iterate over an <a class="reference internal"
href="#nanoarrow.array.Array" titl
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/reference/python/index.html b/main/reference/python/index.html
index 077fb6db..d5ac0ece 100644
--- a/main/reference/python/index.html
+++ b/main/reference/python/index.html
@@ -574,7 +574,7 @@ Arrow C Data and Arrow C Stream interfaces.</p>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/reference/python/schema.html
b/main/reference/python/schema.html
index be7e77fd..7faec7ed 100644
--- a/main/reference/python/schema.html
+++ b/main/reference/python/schema.html
@@ -645,6 +645,21 @@ this type together with its type identifier.</p>
</div>
</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="nanoarrow.schema.Schema.serialize">
+<span class="sig-name descname"><span class="pre">serialize</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">dst</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">None</span></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <span
class="sig-return-typehint"><span class="pre">bytes</span><span class="w">
</span><spa [...]
+<dd><p>Write this Schema into dst as an encapsulated IPC message</p>
+<section id="id1">
+<h3>Parameters<a class="headerlink" href="#id1" title="Link to this
heading">#</a></h3>
+<dl class="simple">
+<dt>dst<span class="classifier">file-like, optional</span></dt><dd><p>If
present, a file-like object into which the schema should be
+serialized. If omitted, this will create a <code class="docutils literal
notranslate"><span class="pre">io.BytesIO()</span></code> and
+return the serialized result.</p>
+</dd>
+</dl>
+</section>
+</dd></dl>
+
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.timezone">
<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">timezone</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">str</span><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><span
class="pre">None</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.timezone" title="Link to this d [...]
@@ -728,15 +743,15 @@ categories can be identified. Type values can be used in
place of
<dt class="sig sig-object py" id="nanoarrow.schema.binary">
<span class="sig-name descname"><span class="pre">binary</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-pare [...]
<dd><p>Create an instance of a variable or fixed-width binary type.</p>
-<section id="id1">
-<h2>Parameters<a class="headerlink" href="#id1" title="Link to this
heading">#</a></h2>
+<section id="id2">
+<h2>Parameters<a class="headerlink" href="#id2" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id2">
-<h2>Examples<a class="headerlink" href="#id2" title="Link to this
heading">#</a></h2>
+<section id="id3">
+<h2>Examples<a class="headerlink" href="#id3" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">binary</span><span class="p">()</span>
<span class="go"><Schema> binary</span>
@@ -749,15 +764,15 @@ categories can be identified. Type values can be used in
place of
<dt class="sig sig-object py" id="nanoarrow.schema.bool_">
<span class="sig-name descname"><span class="pre">bool_</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-paren [...]
<dd><p>Create an instance of a boolean type.</p>
-<section id="id3">
-<h2>Parameters<a class="headerlink" href="#id3" title="Link to this
heading">#</a></h2>
+<section id="id4">
+<h2>Parameters<a class="headerlink" href="#id4" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id4">
-<h2>Examples<a class="headerlink" href="#id4" title="Link to this
heading">#</a></h2>
+<section id="id5">
+<h2>Examples<a class="headerlink" href="#id5" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">bool_</span><span class="p">()</span>
<span class="go"><Schema> bool</span>
@@ -770,15 +785,15 @@ categories can be identified. Type values can be used in
place of
<dt class="sig sig-object py" id="nanoarrow.schema.date32">
<span class="sig-name descname"><span class="pre">date32</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-pare [...]
<dd><p>Create an instance of a 32-bit date type (days since 1970-01-01).</p>
-<section id="id5">
-<h2>Parameters<a class="headerlink" href="#id5" title="Link to this
heading">#</a></h2>
+<section id="id6">
+<h2>Parameters<a class="headerlink" href="#id6" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id6">
-<h2>Examples<a class="headerlink" href="#id6" title="Link to this
heading">#</a></h2>
+<section id="id7">
+<h2>Examples<a class="headerlink" href="#id7" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">date32</span><span class="p">()</span>
<span class="go"><Schema> date32</span>
@@ -791,15 +806,15 @@ categories can be identified. Type values can be used in
place of
<dt class="sig sig-object py" id="nanoarrow.schema.date64">
<span class="sig-name descname"><span class="pre">date64</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-pare [...]
<dd><p>Create an instance of a 64-bit date type (milliseconds since
1970-01-01).</p>
-<section id="id7">
-<h2>Parameters<a class="headerlink" href="#id7" title="Link to this
heading">#</a></h2>
+<section id="id8">
+<h2>Parameters<a class="headerlink" href="#id8" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id8">
-<h2>Examples<a class="headerlink" href="#id8" title="Link to this
heading">#</a></h2>
+<section id="id9">
+<h2>Examples<a class="headerlink" href="#id9" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">date64</span><span class="p">()</span>
<span class="go"><Schema> date64</span>
@@ -812,8 +827,8 @@ categories can be identified. Type values can be used in
place of
<dt class="sig sig-object py" id="nanoarrow.schema.decimal128">
<span class="sig-name descname"><span
class="pre">decimal128</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">precision</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span
class="pre">scale</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span class=
[...]
<dd><p>Create an instance of a 128-bit decimal type.</p>
-<section id="id9">
-<h2>Parameters<a class="headerlink" href="#id9" title="Link to this
heading">#</a></h2>
+<section id="id10">
+<h2>Parameters<a class="headerlink" href="#id10" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>precision<span class="classifier">int</span></dt><dd><p>The number of
significant digits representable by this type. Must be
between 1 and 38.</p>
@@ -824,8 +839,8 @@ between 1 and 38.</p>
</dd>
</dl>
</section>
-<section id="id10">
-<h2>Examples<a class="headerlink" href="#id10" title="Link to this
heading">#</a></h2>
+<section id="id11">
+<h2>Examples<a class="headerlink" href="#id11" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">decimal128</span><span
class="p">(</span><span class="mi">10</span><span class="p">,</span> <span
class="mi">3</span><span class="p">)</span>
<span class="go"><Schema> decimal128(10, 3)</span>
@@ -838,8 +853,8 @@ between 1 and 38.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.decimal256">
<span class="sig-name descname"><span
class="pre">decimal256</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">precision</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span
class="pre">scale</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span class=
[...]
<dd><p>Create an instance of a 256-bit decimal type.</p>
-<section id="id11">
-<h2>Parameters<a class="headerlink" href="#id11" title="Link to this
heading">#</a></h2>
+<section id="id12">
+<h2>Parameters<a class="headerlink" href="#id12" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>precision<span class="classifier">int</span></dt><dd><p>The number of
significant digits representable by this type. Must be
between 1 and 76.</p>
@@ -850,8 +865,8 @@ between 1 and 76.</p>
</dd>
</dl>
</section>
-<section id="id12">
-<h2>Examples<a class="headerlink" href="#id12" title="Link to this
heading">#</a></h2>
+<section id="id13">
+<h2>Examples<a class="headerlink" href="#id13" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">decimal256</span><span
class="p">(</span><span class="mi">10</span><span class="p">,</span> <span
class="mi">3</span><span class="p">)</span>
<span class="go"><Schema> decimal256(10, 3)</span>
@@ -864,8 +879,8 @@ between 1 and 76.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.dictionary">
<span class="sig-name descname"><span
class="pre">dictionary</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">index_type</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">value_type</span></span></em>, <em
class="sig-param"><span class="n"><span
class="pre">dictionary_ordered</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">False</span></span></em><span [...]
<dd><p>Create a type representing dictionary-encoded values</p>
-<section id="id13">
-<h2>Parameters<a class="headerlink" href="#id13" title="Link to this
heading">#</a></h2>
+<section id="id14">
+<h2>Parameters<a class="headerlink" href="#id14" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>index_type<span class="classifier">schema-like</span></dt><dd><p>The data
type of the indices. Must be an integral type.</p>
</dd>
@@ -878,8 +893,8 @@ meaningful.</p>
</dd>
</dl>
</section>
-<section id="id14">
-<h2>Examples<a class="headerlink" href="#id14" title="Link to this
heading">#</a></h2>
+<section id="id15">
+<h2>Examples<a class="headerlink" href="#id15" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">dictionary</span><span
class="p">(</span><span class="n">na</span><span class="o">.</span><span
class="n">int32</span><span class="p">(),</span> <span class="n">na</span><span
class="o">.</span><span class="n">string</span><span class="p">())</span>
<span class="go"><Schema> dictionary(int32)<string></span>
@@ -892,8 +907,8 @@ meaningful.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.duration">
<span class="sig-name descname"><span class="pre">duration</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">unit</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span c [...]
<dd><p>Create an instance of a duration type.</p>
-<section id="id15">
-<h2>Parameters<a class="headerlink" href="#id15" title="Link to this
heading">#</a></h2>
+<section id="id16">
+<h2>Parameters<a class="headerlink" href="#id16" title="Link to this
heading">#</a></h2>
<dl>
<dt>unit<span class="classifier">str or <a class="reference internal"
href="#nanoarrow.schema.TimeUnit" title="nanoarrow.schema.TimeUnit"><code
class="xref py py-class docutils literal notranslate"><span
class="pre">TimeUnit</span></code></a></span></dt><dd><p>The unit of values
stored by this type.</p>
</dd>
@@ -901,8 +916,8 @@ meaningful.</p>
</dd>
</dl>
</section>
-<section id="id16">
-<h2>Examples<a class="headerlink" href="#id16" title="Link to this
heading">#</a></h2>
+<section id="id17">
+<h2>Examples<a class="headerlink" href="#id17" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">duration</span><span class="p">(</span><span
class="s2">"s"</span><span class="p">)</span>
<span class="go"><Schema> duration('s')</span>
@@ -915,8 +930,8 @@ meaningful.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.extension_type">
<span class="sig-name descname"><span
class="pre">extension_type</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">storage_schema</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">extension_name</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span
class="pre">extension_metadata</ [...]
<dd><p>Create an Arrow extension type</p>
-<section id="id17">
-<h2>Parameters<a class="headerlink" href="#id17" title="Link to this
heading">#</a></h2>
+<section id="id18">
+<h2>Parameters<a class="headerlink" href="#id18" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>extension_name: str</dt><dd><p>The extension name to associate with this
type.</p>
</dd>
@@ -933,8 +948,8 @@ extension type.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.fixed_size_binary">
<span class="sig-name descname"><span
class="pre">fixed_size_binary</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">byte_width</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n">< [...]
<dd><p>Create an instance of a variable or fixed-width binary type.</p>
-<section id="id18">
-<h2>Parameters<a class="headerlink" href="#id18" title="Link to this
heading">#</a></h2>
+<section id="id19">
+<h2>Parameters<a class="headerlink" href="#id19" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>byte_width<span class="classifier">int</span></dt><dd><p>The width of each
element in bytes.</p>
</dd>
@@ -942,8 +957,8 @@ extension type.</p>
</dd>
</dl>
</section>
-<section id="id19">
-<h2>Examples<a class="headerlink" href="#id19" title="Link to this
heading">#</a></h2>
+<section id="id20">
+<h2>Examples<a class="headerlink" href="#id20" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">fixed_size_binary</span><span
class="p">(</span><span class="mi">123</span><span class="p">)</span>
<span class="go"><Schema> fixed_size_binary(123)</span>
@@ -956,8 +971,8 @@ extension type.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.fixed_size_list">
<span class="sig-name descname"><span
class="pre">fixed_size_list</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">value_type</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">list_size</span></span></em>, <em
class="sig-param"><span class="n"><span class="pre">nullable</span></span><span
class="o"><span class="pre">=</span></span><span class="default_value"><span
class="pre">True</span></span></em><span class= [...]
<dd><p>Create a type representing a fixed-size list of some other type.</p>
-<section id="id20">
-<h2>Parameters<a class="headerlink" href="#id20" title="Link to this
heading">#</a></h2>
+<section id="id21">
+<h2>Parameters<a class="headerlink" href="#id21" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>value_type<span class="classifier">schema-like</span></dt><dd><p>The type
of values in each list element.</p>
</dd>
@@ -967,8 +982,8 @@ extension type.</p>
</dd>
</dl>
</section>
-<section id="id21">
-<h2>Examples<a class="headerlink" href="#id21" title="Link to this
heading">#</a></h2>
+<section id="id22">
+<h2>Examples<a class="headerlink" href="#id22" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">fixed_size_list</span><span
class="p">(</span><span class="n">na</span><span class="o">.</span><span
class="n">int32</span><span class="p">(),</span> <span
class="mi">123</span><span class="p">)</span>
<span class="go"><Schema> fixed_size_list(123)<item: int32></span>
@@ -981,15 +996,15 @@ extension type.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.float16">
<span class="sig-name descname"><span class="pre">float16</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-par [...]
<dd><p>Create an instance of a 16-bit floating-point type.</p>
-<section id="id22">
-<h2>Parameters<a class="headerlink" href="#id22" title="Link to this
heading">#</a></h2>
+<section id="id23">
+<h2>Parameters<a class="headerlink" href="#id23" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id23">
-<h2>Examples<a class="headerlink" href="#id23" title="Link to this
heading">#</a></h2>
+<section id="id24">
+<h2>Examples<a class="headerlink" href="#id24" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">float16</span><span class="p">()</span>
<span class="go"><Schema> half_float</span>
@@ -1002,15 +1017,15 @@ extension type.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.float32">
<span class="sig-name descname"><span class="pre">float32</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-par [...]
<dd><p>Create an instance of a 32-bit floating-point type.</p>
-<section id="id24">
-<h2>Parameters<a class="headerlink" href="#id24" title="Link to this
heading">#</a></h2>
+<section id="id25">
+<h2>Parameters<a class="headerlink" href="#id25" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id25">
-<h2>Examples<a class="headerlink" href="#id25" title="Link to this
heading">#</a></h2>
+<section id="id26">
+<h2>Examples<a class="headerlink" href="#id26" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">float32</span><span class="p">()</span>
<span class="go"><Schema> float</span>
@@ -1023,15 +1038,15 @@ extension type.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.float64">
<span class="sig-name descname"><span class="pre">float64</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-par [...]
<dd><p>Create an instance of a 64-bit floating-point type.</p>
-<section id="id26">
-<h2>Parameters<a class="headerlink" href="#id26" title="Link to this
heading">#</a></h2>
+<section id="id27">
+<h2>Parameters<a class="headerlink" href="#id27" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id27">
-<h2>Examples<a class="headerlink" href="#id27" title="Link to this
heading">#</a></h2>
+<section id="id28">
+<h2>Examples<a class="headerlink" href="#id28" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">float64</span><span class="p">()</span>
<span class="go"><Schema> double</span>
@@ -1044,15 +1059,15 @@ extension type.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.int16">
<span class="sig-name descname"><span class="pre">int16</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-paren [...]
<dd><p>Create an instance of a signed 16-bit integer type.</p>
-<section id="id28">
-<h2>Parameters<a class="headerlink" href="#id28" title="Link to this
heading">#</a></h2>
+<section id="id29">
+<h2>Parameters<a class="headerlink" href="#id29" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id29">
-<h2>Examples<a class="headerlink" href="#id29" title="Link to this
heading">#</a></h2>
+<section id="id30">
+<h2>Examples<a class="headerlink" href="#id30" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">int16</span><span class="p">()</span>
<span class="go"><Schema> int16</span>
@@ -1065,15 +1080,15 @@ extension type.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.int32">
<span class="sig-name descname"><span class="pre">int32</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-paren [...]
<dd><p>Create an instance of a signed 32-bit integer type.</p>
-<section id="id30">
-<h2>Parameters<a class="headerlink" href="#id30" title="Link to this
heading">#</a></h2>
+<section id="id31">
+<h2>Parameters<a class="headerlink" href="#id31" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id31">
-<h2>Examples<a class="headerlink" href="#id31" title="Link to this
heading">#</a></h2>
+<section id="id32">
+<h2>Examples<a class="headerlink" href="#id32" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">int32</span><span class="p">()</span>
<span class="go"><Schema> int32</span>
@@ -1086,15 +1101,15 @@ extension type.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.int64">
<span class="sig-name descname"><span class="pre">int64</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-paren [...]
<dd><p>Create an instance of a signed 32-bit integer type.</p>
-<section id="id32">
-<h2>Parameters<a class="headerlink" href="#id32" title="Link to this
heading">#</a></h2>
+<section id="id33">
+<h2>Parameters<a class="headerlink" href="#id33" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id33">
-<h2>Examples<a class="headerlink" href="#id33" title="Link to this
heading">#</a></h2>
+<section id="id34">
+<h2>Examples<a class="headerlink" href="#id34" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">int64</span><span class="p">()</span>
<span class="go"><Schema> int64</span>
@@ -1107,15 +1122,15 @@ extension type.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.int8">
<span class="sig-name descname"><span class="pre">int8</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-paren" [...]
<dd><p>Create an instance of a signed 8-bit integer type.</p>
-<section id="id34">
-<h2>Parameters<a class="headerlink" href="#id34" title="Link to this
heading">#</a></h2>
+<section id="id35">
+<h2>Parameters<a class="headerlink" href="#id35" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id35">
-<h2>Examples<a class="headerlink" href="#id35" title="Link to this
heading">#</a></h2>
+<section id="id36">
+<h2>Examples<a class="headerlink" href="#id36" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">int8</span><span class="p">()</span>
<span class="go"><Schema> int8</span>
@@ -1128,15 +1143,15 @@ extension type.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.interval_day_time">
<span class="sig-name descname"><span
class="pre">interval_day_time</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">nullable</span></span><span
class="p"><span class="pre">:</span></span><span class="w"> </span><span
class="n"><span class="pre">bool</span></span><span class="w"> </span><span
class="o"><span class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span clas [...]
<dd><p>Create an instance of an interval type measured as a day/time pair.</p>
-<section id="id36">
-<h2>Parameters<a class="headerlink" href="#id36" title="Link to this
heading">#</a></h2>
+<section id="id37">
+<h2>Parameters<a class="headerlink" href="#id37" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id37">
-<h2>Examples<a class="headerlink" href="#id37" title="Link to this
heading">#</a></h2>
+<section id="id38">
+<h2>Examples<a class="headerlink" href="#id38" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">interval_day_time</span><span
class="p">()</span>
<span class="go"><Schema> interval_day_time</span>
@@ -1150,15 +1165,15 @@ extension type.</p>
<span class="sig-name descname"><span
class="pre">interval_month_day_nano</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><spa [...]
<dd><p>Create an instance of an interval type measured as a
month/day/nanosecond
tuple.</p>
-<section id="id38">
-<h2>Parameters<a class="headerlink" href="#id38" title="Link to this
heading">#</a></h2>
+<section id="id39">
+<h2>Parameters<a class="headerlink" href="#id39" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id39">
-<h2>Examples<a class="headerlink" href="#id39" title="Link to this
heading">#</a></h2>
+<section id="id40">
+<h2>Examples<a class="headerlink" href="#id40" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">interval_month_day_nano</span><span
class="p">()</span>
<span class="go"><Schema> interval_month_day_nano</span>
@@ -1171,15 +1186,15 @@ tuple.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.interval_months">
<span class="sig-name descname"><span
class="pre">interval_months</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">nullable</span></span><span
class="p"><span class="pre">:</span></span><span class="w"> </span><span
class="n"><span class="pre">bool</span></span><span class="w"> </span><span
class="o"><span class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span class=
[...]
<dd><p>Create an instance of an interval type measured in months.</p>
-<section id="id40">
-<h2>Parameters<a class="headerlink" href="#id40" title="Link to this
heading">#</a></h2>
+<section id="id41">
+<h2>Parameters<a class="headerlink" href="#id41" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id41">
-<h2>Examples<a class="headerlink" href="#id41" title="Link to this
heading">#</a></h2>
+<section id="id42">
+<h2>Examples<a class="headerlink" href="#id42" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">interval_months</span><span
class="p">()</span>
<span class="go"><Schema> interval_months</span>
@@ -1192,15 +1207,15 @@ tuple.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.large_binary">
<span class="sig-name descname"><span
class="pre">large_binary</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">nullable</span></span><span
class="p"><span class="pre">:</span></span><span class="w"> </span><span
class="n"><span class="pre">bool</span></span><span class="w"> </span><span
class="o"><span class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span class="si
[...]
<dd><p>Create an instance of a variable-length binary type that uses 64-bit
offsets.</p>
-<section id="id42">
-<h2>Parameters<a class="headerlink" href="#id42" title="Link to this
heading">#</a></h2>
+<section id="id43">
+<h2>Parameters<a class="headerlink" href="#id43" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id43">
-<h2>Examples<a class="headerlink" href="#id43" title="Link to this
heading">#</a></h2>
+<section id="id44">
+<h2>Examples<a class="headerlink" href="#id44" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">large_binary</span><span class="p">()</span>
<span class="go"><Schema> large_binary</span>
@@ -1215,8 +1230,8 @@ tuple.</p>
<dd><p>Create a type representing a variable-size list of some other type.</p>
<p>Unlike <a class="reference internal" href="#nanoarrow.schema.list_"
title="nanoarrow.schema.list_"><code class="xref py py-func docutils literal
notranslate"><span class="pre">list_()</span></code></a>, the
func:<cite>large_list</cite> can accomodate arrays
with more than <code class="docutils literal notranslate"><span
class="pre">2</span> <span class="pre">**</span> <span class="pre">31</span>
<span class="pre">-</span> <span class="pre">1</span></code> items in the
values array.</p>
-<section id="id44">
-<h2>Parameters<a class="headerlink" href="#id44" title="Link to this
heading">#</a></h2>
+<section id="id45">
+<h2>Parameters<a class="headerlink" href="#id45" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>value_type<span class="classifier">schema-like</span></dt><dd><p>The type
of values in each list element.</p>
</dd>
@@ -1224,8 +1239,8 @@ with more than <code class="docutils literal
notranslate"><span class="pre">2</s
</dd>
</dl>
</section>
-<section id="id45">
-<h2>Examples<a class="headerlink" href="#id45" title="Link to this
heading">#</a></h2>
+<section id="id46">
+<h2>Examples<a class="headerlink" href="#id46" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">large_list</span><span
class="p">(</span><span class="n">na</span><span class="o">.</span><span
class="n">int32</span><span class="p">())</span>
<span class="go"><Schema> large_list<item: int32></span>
@@ -1239,15 +1254,15 @@ with more than <code class="docutils literal
notranslate"><span class="pre">2</s
<span class="sig-name descname"><span
class="pre">large_string</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">nullable</span></span><span
class="p"><span class="pre">:</span></span><span class="w"> </span><span
class="n"><span class="pre">bool</span></span><span class="w"> </span><span
class="o"><span class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span class="si
[...]
<dd><p>Create an instance of a variable-length UTF-8 encoded string type
that uses 64-bit offsets.</p>
-<section id="id46">
-<h2>Parameters<a class="headerlink" href="#id46" title="Link to this
heading">#</a></h2>
+<section id="id47">
+<h2>Parameters<a class="headerlink" href="#id47" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id47">
-<h2>Examples<a class="headerlink" href="#id47" title="Link to this
heading">#</a></h2>
+<section id="id48">
+<h2>Examples<a class="headerlink" href="#id48" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">large_string</span><span class="p">()</span>
<span class="go"><Schema> large_string</span>
@@ -1260,8 +1275,8 @@ that uses 64-bit offsets.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.list_">
<span class="sig-name descname"><span class="pre">list_</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">value_type</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">nullable</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">True</span></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <spa [...]
<dd><p>Create a type representing a variable-size list of some other type.</p>
-<section id="id48">
-<h2>Parameters<a class="headerlink" href="#id48" title="Link to this
heading">#</a></h2>
+<section id="id49">
+<h2>Parameters<a class="headerlink" href="#id49" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>value_type<span class="classifier">schema-like</span></dt><dd><p>The type
of values in each list element.</p>
</dd>
@@ -1269,8 +1284,8 @@ that uses 64-bit offsets.</p>
</dd>
</dl>
</section>
-<section id="id49">
-<h2>Examples<a class="headerlink" href="#id49" title="Link to this
heading">#</a></h2>
+<section id="id50">
+<h2>Examples<a class="headerlink" href="#id50" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">list_</span><span class="p">(</span><span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">())</span>
<span class="go"><Schema> list<item: int32></span>
@@ -1283,15 +1298,15 @@ that uses 64-bit offsets.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.null">
<span class="sig-name descname"><span class="pre">null</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-paren" [...]
<dd><p>Create an instance of a null type.</p>
-<section id="id50">
-<h2>Parameters<a class="headerlink" href="#id50" title="Link to this
heading">#</a></h2>
+<section id="id51">
+<h2>Parameters<a class="headerlink" href="#id51" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id51">
-<h2>Examples<a class="headerlink" href="#id51" title="Link to this
heading">#</a></h2>
+<section id="id52">
+<h2>Examples<a class="headerlink" href="#id52" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">null</span><span class="p">()</span>
<span class="go"><Schema> na</span>
@@ -1311,15 +1326,15 @@ that uses 64-bit offsets.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.string">
<span class="sig-name descname"><span class="pre">string</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-pare [...]
<dd><p>Create an instance of a variable-length UTF-8 encoded string type.</p>
-<section id="id52">
-<h2>Parameters<a class="headerlink" href="#id52" title="Link to this
heading">#</a></h2>
+<section id="id53">
+<h2>Parameters<a class="headerlink" href="#id53" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id53">
-<h2>Examples<a class="headerlink" href="#id53" title="Link to this
heading">#</a></h2>
+<section id="id54">
+<h2>Examples<a class="headerlink" href="#id54" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">string</span><span class="p">()</span>
<span class="go"><Schema> string</span>
@@ -1332,8 +1347,8 @@ that uses 64-bit offsets.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.struct">
<span class="sig-name descname"><span class="pre">struct</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">fields</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">nullable</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">True</span></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <span c [...]
<dd><p>Create a type representing a named sequence of fields.</p>
-<section id="id54">
-<h2>Parameters<a class="headerlink" href="#id54" title="Link to this
heading">#</a></h2>
+<section id="id55">
+<h2>Parameters<a class="headerlink" href="#id55" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>fields :</dt><dd><ul class="simple">
<li><p>A dictionary whose keys are field names and values are schema-like
objects</p></li>
@@ -1345,8 +1360,8 @@ inherited from the schema-like object.</p></li>
</dd>
</dl>
</section>
-<section id="id55">
-<h2>Examples<a class="headerlink" href="#id55" title="Link to this
heading">#</a></h2>
+<section id="id56">
+<h2>Examples<a class="headerlink" href="#id56" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">struct</span><span class="p">([</span><span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">()])</span>
<span class="go"><Schema> struct<: int32></span>
@@ -1361,8 +1376,8 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.time32">
<span class="sig-name descname"><span class="pre">time32</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">unit</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.TimeUnit"
title="nanoarrow.schema.TimeUnit"><spa [...]
<dd><p>Create an instance of a 32-bit time of day type.</p>
-<section id="id56">
-<h2>Parameters<a class="headerlink" href="#id56" title="Link to this
heading">#</a></h2>
+<section id="id57">
+<h2>Parameters<a class="headerlink" href="#id57" title="Link to this
heading">#</a></h2>
<dl>
<dt>unit<span class="classifier">str or <a class="reference internal"
href="#nanoarrow.schema.TimeUnit" title="nanoarrow.schema.TimeUnit"><code
class="xref py py-class docutils literal notranslate"><span
class="pre">TimeUnit</span></code></a></span></dt><dd><p>The unit of values
stored by this type.</p>
</dd>
@@ -1370,8 +1385,8 @@ inherited from the schema-like object.</p></li>
</dd>
</dl>
</section>
-<section id="id57">
-<h2>Examples<a class="headerlink" href="#id57" title="Link to this
heading">#</a></h2>
+<section id="id58">
+<h2>Examples<a class="headerlink" href="#id58" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">time32</span><span class="p">(</span><span
class="s2">"s"</span><span class="p">)</span>
<span class="go"><Schema> time32('s')</span>
@@ -1384,8 +1399,8 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.time64">
<span class="sig-name descname"><span class="pre">time64</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">unit</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.TimeUnit"
title="nanoarrow.schema.TimeUnit"><spa [...]
<dd><p>Create an instance of a 64-bit time of day type.</p>
-<section id="id58">
-<h2>Parameters<a class="headerlink" href="#id58" title="Link to this
heading">#</a></h2>
+<section id="id59">
+<h2>Parameters<a class="headerlink" href="#id59" title="Link to this
heading">#</a></h2>
<dl>
<dt>unit<span class="classifier">str or <a class="reference internal"
href="#nanoarrow.schema.TimeUnit" title="nanoarrow.schema.TimeUnit"><code
class="xref py py-class docutils literal notranslate"><span
class="pre">TimeUnit</span></code></a></span></dt><dd><p>The unit of values
stored by this type.</p>
</dd>
@@ -1393,8 +1408,8 @@ inherited from the schema-like object.</p></li>
</dd>
</dl>
</section>
-<section id="id59">
-<h2>Examples<a class="headerlink" href="#id59" title="Link to this
heading">#</a></h2>
+<section id="id60">
+<h2>Examples<a class="headerlink" href="#id60" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">time64</span><span class="p">(</span><span
class="s2">"us"</span><span class="p">)</span>
<span class="go"><Schema> time64('us')</span>
@@ -1407,8 +1422,8 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.timestamp">
<span class="sig-name descname"><span class="pre">timestamp</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">unit</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.TimeUnit" title="nanoarrow.schema.TimeUnit"><
[...]
<dd><p>Create an instance of a timestamp type.</p>
-<section id="id60">
-<h2>Parameters<a class="headerlink" href="#id60" title="Link to this
heading">#</a></h2>
+<section id="id61">
+<h2>Parameters<a class="headerlink" href="#id61" title="Link to this
heading">#</a></h2>
<dl>
<dt>unit<span class="classifier">str or <a class="reference internal"
href="#nanoarrow.schema.TimeUnit" title="nanoarrow.schema.TimeUnit"><code
class="xref py py-class docutils literal notranslate"><span
class="pre">TimeUnit</span></code></a></span></dt><dd><p>The unit of values
stored by this type.</p>
</dd>
@@ -1416,8 +1431,8 @@ inherited from the schema-like object.</p></li>
</dd>
</dl>
</section>
-<section id="id61">
-<h2>Examples<a class="headerlink" href="#id61" title="Link to this
heading">#</a></h2>
+<section id="id62">
+<h2>Examples<a class="headerlink" href="#id62" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">timestamp</span><span class="p">(</span><span
class="s2">"s"</span><span class="p">)</span>
<span class="go"><Schema> timestamp('s', '')</span>
@@ -1432,15 +1447,15 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.uint16">
<span class="sig-name descname"><span class="pre">uint16</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-pare [...]
<dd><p>Create an instance of an unsigned 16-bit integer type.</p>
-<section id="id62">
-<h2>Parameters<a class="headerlink" href="#id62" title="Link to this
heading">#</a></h2>
+<section id="id63">
+<h2>Parameters<a class="headerlink" href="#id63" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id63">
-<h2>Examples<a class="headerlink" href="#id63" title="Link to this
heading">#</a></h2>
+<section id="id64">
+<h2>Examples<a class="headerlink" href="#id64" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">uint16</span><span class="p">()</span>
<span class="go"><Schema> uint16</span>
@@ -1453,15 +1468,15 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.uint32">
<span class="sig-name descname"><span class="pre">uint32</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-pare [...]
<dd><p>Create an instance of an unsigned 32-bit integer type.</p>
-<section id="id64">
-<h2>Parameters<a class="headerlink" href="#id64" title="Link to this
heading">#</a></h2>
+<section id="id65">
+<h2>Parameters<a class="headerlink" href="#id65" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id65">
-<h2>Examples<a class="headerlink" href="#id65" title="Link to this
heading">#</a></h2>
+<section id="id66">
+<h2>Examples<a class="headerlink" href="#id66" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">uint32</span><span class="p">()</span>
<span class="go"><Schema> uint32</span>
@@ -1474,15 +1489,15 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.uint64">
<span class="sig-name descname"><span class="pre">uint64</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-pare [...]
<dd><p>Create an instance of an unsigned 32-bit integer type.</p>
-<section id="id66">
-<h2>Parameters<a class="headerlink" href="#id66" title="Link to this
heading">#</a></h2>
+<section id="id67">
+<h2>Parameters<a class="headerlink" href="#id67" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id67">
-<h2>Examples<a class="headerlink" href="#id67" title="Link to this
heading">#</a></h2>
+<section id="id68">
+<h2>Examples<a class="headerlink" href="#id68" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">uint64</span><span class="p">()</span>
<span class="go"><Schema> uint64</span>
@@ -1495,15 +1510,15 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.uint8">
<span class="sig-name descname"><span class="pre">uint8</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-paren [...]
<dd><p>Create an instance of an unsigned 8-bit integer type.</p>
-<section id="id68">
-<h2>Parameters<a class="headerlink" href="#id68" title="Link to this
heading">#</a></h2>
+<section id="id69">
+<h2>Parameters<a class="headerlink" href="#id69" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id69">
-<h2>Examples<a class="headerlink" href="#id69" title="Link to this
heading">#</a></h2>
+<section id="id70">
+<h2>Examples<a class="headerlink" href="#id70" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">uint8</span><span class="p">()</span>
<span class="go"><Schema> uint8</span>
@@ -1581,6 +1596,7 @@ inherited from the schema-like object.</p></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.params"><code class="docutils literal
notranslate"><span class="pre">Schema.params</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.precision"><code class="docutils literal
notranslate"><span class="pre">Schema.precision</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.scale"><code class="docutils literal
notranslate"><span class="pre">Schema.scale</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.serialize"><code class="docutils literal
notranslate"><span class="pre">Schema.serialize()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.timezone"><code class="docutils literal
notranslate"><span class="pre">Schema.timezone</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.type"><code class="docutils literal
notranslate"><span class="pre">Schema.type</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.unit"><code class="docutils literal
notranslate"><span class="pre">Schema.unit</span></code></a></li>
@@ -1690,7 +1706,7 @@ inherited from the schema-like object.</p></li>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/reference/r.html b/main/reference/r.html
index cfc58338..ae60a578 100644
--- a/main/reference/r.html
+++ b/main/reference/r.html
@@ -507,7 +507,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/reference/testing.html b/main/reference/testing.html
index 0f6b371d..ea7fd800 100644
--- a/main/reference/testing.html
+++ b/main/reference/testing.html
@@ -777,7 +777,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/roadmap.html b/main/roadmap.html
index 15cf823d..be44dca5 100644
--- a/main/roadmap.html
+++ b/main/roadmap.html
@@ -604,7 +604,7 @@ Python bindings.</p></li>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/search.html b/main/search.html
index 8d494f25..effc63e6 100644
--- a/main/search.html
+++ b/main/search.html
@@ -430,7 +430,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.4.6.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 8.0.2.
<br/>
</p>
</div>
diff --git a/main/searchindex.js b/main/searchindex.js
index 13fa5de4..0dbcb9e8 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[8, null]], "Array Stream
utilities": [[6, "array-stream-utilities"]], "Array Streams": [[3,
"array-streams"]], "Array streams": [[2, "array-streams"]], "Arrays": [[2,
"arrays"], [3, "arrays"]], "Arrow C Data Interface": [[5,
"arrow-c-data-interface"]], "Arrow C Device Interface": [[7,
"arrow-c-device-interface"]], "Arrow C data/nanoarrow interface basics": [[0,
"arrow-c-data-nanoarrow-interface-basics"]], "Bitmap utilities": [[5, "bitmap-
[...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[8, null]], "Array Stream
utilities": [[6, "array-stream-utilities"]], "Array Streams": [[3,
"array-streams"]], "Array streams": [[2, "array-streams"]], "Arrays": [[2,
"arrays"], [3, "arrays"]], "Arrow C Data Interface": [[5,
"arrow-c-data-interface"]], "Arrow C Device Interface": [[7,
"arrow-c-device-interface"]], "Arrow C data/nanoarrow interface basics": [[0,
"arrow-c-data-nanoarrow-interface-basics"]], "Bitmap utilities": [[5, "bitmap-
[...]
\ No newline at end of file
