build based on 9c439ba
diff --git a/dev/index.html b/dev/index.html
index 10f2dc2..a8a5be9 100644
--- a/dev/index.html
+++ b/dev/index.html
@@ -1,2 +1,2 @@
<!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · Arrow.jl</title><script data-outdated-warner src="assets/warner.js"></script><link rel="canonical" href="https://arrow.juliadata.org/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>Arrow.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li><li><a class="tocitem" href="manual/">User Manual</a></li><li><a class="tocitem" href="reference/">API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/apache/arrow-julia/blob/main/docs/src/index.md#L" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><p><!–- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at</p><pre><code class="nohighlight hljs">http://www.apache.org/licenses/LICENSE-2.0</code></pre><p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. –></p><h1 id="Arrow.jl"><a class="docs-heading-anchor" href="#Arrow.jl">Arrow.jl</a><a id="Arrow.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Arrow.jl" title="Permalink"></a></h1><ul><li><a href="manual/#User-Manual">User Manual</a></li><li class="no-marker"><ul><li><a href="manual/#Support-for-generic-path-like-types">Support for generic path-like types</a></li><li><a href="manual/#Reading-arrow-data">Reading arrow data</a></li><li class="no-marker"><ul><li><a href="manual/#Arrow.Table"><code>Arrow.Table</code></a></li><li><a href="manual/#Arrow-types">Arrow types</a></li><li><a href="manual/#Arrow.Stream"><code>Arrow.Stream</code></a></li><li><a href="manual/#Custom-application-metadata">Custom application metadata</a></li></ul></li><li><a href="manual/#Writing-arrow-data">Writing arrow data</a></li><li class="no-marker"><ul><li><a href="manual/#Arrow.write"><code>Arrow.write</code></a></li><li><a href="manual/#Arrow.Writer"><code>Arrow.Writer</code></a></li><li><a href="manual/#Multithreaded-writing">Multithreaded writing</a></li><li><a href="manual/#Compression">Compression</a></li></ul></li></ul></li><li><a href="reference/#API-Reference">API Reference</a></li></ul><article class="docstring"><header><a class="docstring-binding" id="Arrow" href="#Arrow"><code>Arrow</code></a> — <span class="docstring-category">Module</span></header><section><div><pre><code class="language-julia hljs">Arrow.jl</code></pre><p>A pure Julia implementation of the <a href="https://arrow.apache.org/">apache arrow</a> memory format specification.</p><p>This implementation supports the 1.0 version of the specification, including support for:</p><ul><li>All primitive data types</li><li>All nested data types</li><li>Dictionary encodings, nested dictionary encodings, and messages</li><li>Extension types</li><li>Streaming, file, record batch, and replacement and isdelta dictionary messages</li><li>Buffer compression/decompression via the standard LZ4 frame and Zstd formats</li></ul><p>It currently doesn't include support for:</p><ul><li>Tensors or sparse tensors</li><li>Flight RPC</li><li>C data interface</li></ul><p>Third-party data formats:</p><ul><li>csv and parquet support via the existing <a href="https://github.com/JuliaData/CSV.jl">CSV.jl</a> and <a href="https://github.com/JuliaIO/Parquet.jl">Parquet.jl</a> packages</li><li>Other <a href="https://github.com/JuliaData/Tables.jl">Tables.jl</a>-compatible packages automatically supported (<a href="https://github.com/JuliaData/DataFrames.jl">DataFrames.jl</a>, <a href="https://github.com/JuliaData/JSONTables.jl">JSONTables.jl</a>, <a href="https://github.com/JuliaData/JuliaDB.jl">JuliaDB.jl</a>, <a href="https://github.com/JuliaDatabases/SQLite.jl">SQLite.jl</a>, <a href="https://github.com/JuliaDatabases/MySQL.jl">MySQL.jl</a>, <a href="https://github.com/JuliaDatabases/JDBC.jl">JDBC.jl</a>, <a href="https://github.com/JuliaDatabases/ODBC.jl">ODBC.jl</a>, <a href="https://github.com/felipenoris/XLSX.jl">XLSX.jl</a>, etc.)</li><li>No current Julia packages support ORC or Avro data formats</li></ul><p>See docs for official Arrow.jl API with the <a href="manual/#User-Manual">User Manual</a> and reference docs for <a href="reference/#Arrow.Table"><code>Arrow.Table</code></a>, <a href="reference/#Arrow.write"><code>Arrow.write</code></a>, and <a href="reference/#Arrow.Stream"><code>Arrow.Stream</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/Arrow.jl#LL17-L41">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="manual/">User Manual »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 13 June 2023 13:45">Tuesday 13 June 2023</span>. Using Julia version 1.9.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · Arrow.jl</title><script data-outdated-warner src="assets/warner.js"></script><link rel="canonical" href="https://arrow.juliadata.org/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>Arrow.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li><li><a class="tocitem" href="manual/">User Manual</a></li><li><a class="tocitem" href="reference/">API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/apache/arrow-julia/blob/main/docs/src/index.md#L" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><p><!–- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at</p><pre><code class="nohighlight hljs">http://www.apache.org/licenses/LICENSE-2.0</code></pre><p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. –></p><h1 id="Arrow.jl"><a class="docs-heading-anchor" href="#Arrow.jl">Arrow.jl</a><a id="Arrow.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Arrow.jl" title="Permalink"></a></h1><ul><li><a href="manual/#User-Manual">User Manual</a></li><li class="no-marker"><ul><li><a href="manual/#Support-for-generic-path-like-types">Support for generic path-like types</a></li><li><a href="manual/#Reading-arrow-data">Reading arrow data</a></li><li class="no-marker"><ul><li><a href="manual/#Arrow.Table"><code>Arrow.Table</code></a></li><li><a href="manual/#Arrow-types">Arrow types</a></li><li><a href="manual/#Arrow.Stream"><code>Arrow.Stream</code></a></li><li><a href="manual/#Custom-application-metadata">Custom application metadata</a></li></ul></li><li><a href="manual/#Writing-arrow-data">Writing arrow data</a></li><li class="no-marker"><ul><li><a href="manual/#Arrow.write"><code>Arrow.write</code></a></li><li><a href="manual/#Arrow.Writer"><code>Arrow.Writer</code></a></li><li><a href="manual/#Multithreaded-writing">Multithreaded writing</a></li><li><a href="manual/#Compression">Compression</a></li></ul></li></ul></li><li><a href="reference/#API-Reference">API Reference</a></li></ul><article class="docstring"><header><a class="docstring-binding" id="Arrow" href="#Arrow"><code>Arrow</code></a> — <span class="docstring-category">Module</span></header><section><div><pre><code class="language-julia hljs">Arrow.jl</code></pre><p>A pure Julia implementation of the <a href="https://arrow.apache.org/">apache arrow</a> memory format specification.</p><p>This implementation supports the 1.0 version of the specification, including support for:</p><ul><li>All primitive data types</li><li>All nested data types</li><li>Dictionary encodings, nested dictionary encodings, and messages</li><li>Extension types</li><li>Streaming, file, record batch, and replacement and isdelta dictionary messages</li><li>Buffer compression/decompression via the standard LZ4 frame and Zstd formats</li></ul><p>It currently doesn't include support for:</p><ul><li>Tensors or sparse tensors</li><li>Flight RPC</li><li>C data interface</li></ul><p>Third-party data formats:</p><ul><li>csv and parquet support via the existing <a href="https://github.com/JuliaData/CSV.jl">CSV.jl</a> and <a href="https://github.com/JuliaIO/Parquet.jl">Parquet.jl</a> packages</li><li>Other <a href="https://github.com/JuliaData/Tables.jl">Tables.jl</a>-compatible packages automatically supported (<a href="https://github.com/JuliaData/DataFrames.jl">DataFrames.jl</a>, <a href="https://github.com/JuliaData/JSONTables.jl">JSONTables.jl</a>, <a href="https://github.com/JuliaData/JuliaDB.jl">JuliaDB.jl</a>, <a href="https://github.com/JuliaDatabases/SQLite.jl">SQLite.jl</a>, <a href="https://github.com/JuliaDatabases/MySQL.jl">MySQL.jl</a>, <a href="https://github.com/JuliaDatabases/JDBC.jl">JDBC.jl</a>, <a href="https://github.com/JuliaDatabases/ODBC.jl">ODBC.jl</a>, <a href="https://github.com/felipenoris/XLSX.jl">XLSX.jl</a>, etc.)</li><li>No current Julia packages support ORC or Avro data formats</li></ul><p>See docs for official Arrow.jl API with the <a href="manual/#User-Manual">User Manual</a> and reference docs for <a href="reference/#Arrow.Table"><code>Arrow.Table</code></a>, <a href="reference/#Arrow.write"><code>Arrow.write</code></a>, and <a href="reference/#Arrow.Stream"><code>Arrow.Stream</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/Arrow.jl#LL17-L41">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="manual/">User Manual »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 13 June 2023 13:49">Tuesday 13 June 2023</span>. Using Julia version 1.9.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/manual/index.html b/dev/manual/index.html
index 623691f..cee2dab 100644
--- a/dev/manual/index.html
+++ b/dev/manual/index.html
@@ -50,4 +50,4 @@
# treat an array of csv files with same schema where each file is a partition
# in this form, a function `CSV.File` is applied to each element of 2nd argument
csv_parts = Tables.partitioner(CSV.File, csv_files)
-Arrow.write(io, csv_parts)</code></pre><h3 id="Arrow.Writer"><a class="docs-heading-anchor" href="#Arrow.Writer"><code>Arrow.Writer</code></a><a id="Arrow.Writer-1"></a><a class="docs-heading-anchor-permalink" href="#Arrow.Writer" title="Permalink"></a></h3><p>With <code>Arrow.Writer</code>, you instantiate an <code>Arrow.Writer</code> object, write sources using it, and then close it. This allows for incrmental writes to the same sink. It is similar to <code>Arrow.append</code> without having to close and re-open the sink in between writes and without the limitation of only supporting the IPC stream format.</p><h3 id="Multithreaded-writing"><a class="docs-heading-anchor" href="#Multithreaded-writing">Multithreaded writing</a><a id="Multithreaded-writing-1"></a><a class="docs-heading-anchor-permalink" href="#Multithreaded-writing" title="Permalink"></a></h3><p>By default, <code>Arrow.write</code> will use multiple threads to write multiple record batches simultaneously (e.g. if julia is started with <code>julia -t 8</code> or the <code>JULIA_NUM_THREADS</code> environment variable is set). The number of concurrent tasks to use when writing can be controlled by passing the <code>ntasks</code> keyword argument to <code>Arrow.write</code>. Passing <code>ntasks=1</code> avoids any multithreading when writing.</p><h3 id="Compression"><a class="docs-heading-anchor" href="#Compression">Compression</a><a id="Compression-1"></a><a class="docs-heading-anchor-permalink" href="#Compression" title="Permalink"></a></h3><p>Compression is supported when writing via the <code>compress</code> keyword argument. Possible values include <code>:lz4</code>, <code>:zstd</code>, or your own initialized <code>LZ4FrameCompressor</code> or <code>ZstdCompressor</code> objects; will cause all buffers in each record batch to use the respective compression encoding or compressor.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../reference/">API Reference »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 13 June 2023 13:45">Tuesday 13 June 2023</span>. Using Julia version 1.9.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+Arrow.write(io, csv_parts)</code></pre><h3 id="Arrow.Writer"><a class="docs-heading-anchor" href="#Arrow.Writer"><code>Arrow.Writer</code></a><a id="Arrow.Writer-1"></a><a class="docs-heading-anchor-permalink" href="#Arrow.Writer" title="Permalink"></a></h3><p>With <code>Arrow.Writer</code>, you instantiate an <code>Arrow.Writer</code> object, write sources using it, and then close it. This allows for incrmental writes to the same sink. It is similar to <code>Arrow.append</code> without having to close and re-open the sink in between writes and without the limitation of only supporting the IPC stream format.</p><h3 id="Multithreaded-writing"><a class="docs-heading-anchor" href="#Multithreaded-writing">Multithreaded writing</a><a id="Multithreaded-writing-1"></a><a class="docs-heading-anchor-permalink" href="#Multithreaded-writing" title="Permalink"></a></h3><p>By default, <code>Arrow.write</code> will use multiple threads to write multiple record batches simultaneously (e.g. if julia is started with <code>julia -t 8</code> or the <code>JULIA_NUM_THREADS</code> environment variable is set). The number of concurrent tasks to use when writing can be controlled by passing the <code>ntasks</code> keyword argument to <code>Arrow.write</code>. Passing <code>ntasks=1</code> avoids any multithreading when writing.</p><h3 id="Compression"><a class="docs-heading-anchor" href="#Compression">Compression</a><a id="Compression-1"></a><a class="docs-heading-anchor-permalink" href="#Compression" title="Permalink"></a></h3><p>Compression is supported when writing via the <code>compress</code> keyword argument. Possible values include <code>:lz4</code>, <code>:zstd</code>, or your own initialized <code>LZ4FrameCompressor</code> or <code>ZstdCompressor</code> objects; will cause all buffers in each record batch to use the respective compression encoding or compressor.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../reference/">API Reference »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 13 June 2023 13:49">Tuesday 13 June 2023</span>. Using Julia version 1.9.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/reference/index.html b/dev/reference/index.html
index c6863a3..46c394d 100644
--- a/dev/reference/index.html
+++ b/dev/reference/index.html
@@ -1,11 +1,11 @@
<!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API Reference · Arrow.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://arrow.juliadata.org/reference/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Arrow.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../manual/">User Manual</a></li><li class="is-active"><a class="tocitem" href>API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API Reference</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/apache/arrow-julia/blob/main/docs/src/reference.md#L" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><p><!–- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at</p><pre><code class="nohighlight hljs">http://www.apache.org/licenses/LICENSE-2.0</code></pre><p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. –></p><h1 id="API-Reference"><a class="docs-heading-anchor" href="#API-Reference">API Reference</a><a id="API-Reference-1"></a><a class="docs-heading-anchor-permalink" href="#API-Reference" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="Arrow.ArrowVector" href="#Arrow.ArrowVector"><code>Arrow.ArrowVector</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.ArrowVector</code></pre><p>An abstract type that subtypes <code>AbstractVector</code>. Each specific arrow array type subtypes <code>ArrowVector</code>. See <a href="#Arrow.BoolVector"><code>BoolVector</code></a>, <a href="#Arrow.Primitive"><code>Primitive</code></a>, <a href="#Arrow.List"><code>List</code></a>, <a href="#Arrow.Map"><code>Map</code></a>, <a href="#Arrow.FixedSizeList"><code>FixedSizeList</code></a>, <a href="#Arrow.Struct"><code>Struct</code></a>, <a href="#Arrow.DenseUnion"><code>DenseUnion</code></a>, <a href="#Arrow.SparseUnion"><code>SparseUnion</code></a>, and <a href="#Arrow.DictEncoded"><code>DictEncoded</code></a> for more details.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/arraytypes.jl#LL17-L24">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.BoolVector" href="#Arrow.BoolVector"><code>Arrow.BoolVector</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.BoolVector</code></pre><p>A bit-packed array type, similar to <a href="#Arrow.ValidityBitmap"><code>ValidityBitmap</code></a>, but which holds boolean values, <code>true</code> or <code>false</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/bool.jl#LL17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Compressed" href="#Arrow.Compressed"><code>Arrow.Compressed</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Compressed</code></pre><p>Represents the compressed version of an <a href="#Arrow.ArrowVector"><code>ArrowVector</code></a>. Holds a reference to the original column. May have <code>Compressed</code> children for nested array types.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/compressed.jl#LL22-L28">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.DenseUnion" href="#Arrow.DenseUnion"><code>Arrow.DenseUnion</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.DenseUnion</code></pre><p>An <code>ArrowVector</code> where the type of each element is one of a fixed set of types, meaning its eltype is like a julia <code>Union{type1, type2, ...}</code>. An <code>Arrow.DenseUnion</code>, in comparison to <code>Arrow.SparseUnion</code>, stores elements in a set of arrays, one array per possible type, and an "offsets" array, where each offset element is the index into one of the typed arrays. This allows a sort of "compression", where no extra space is used/allocated to store all the elements.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/unions.jl#LL52-L59">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.DictEncode" href="#Arrow.DictEncode"><code>Arrow.DictEncode</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.DictEncode(::AbstractVector, id::Integer=nothing)</code></pre><p>Signals that a column/array should be dictionary encoded when serialized to the arrow streaming/file format. An optional <code>id</code> number may be provided to signal that multiple columns should use the same pool when being dictionary encoded.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/dictencoding.jl#LL56-L63">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.DictEncoded" href="#Arrow.DictEncoded"><code>Arrow.DictEncoded</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.DictEncoded</code></pre><p>A dictionary encoded array type (similar to a <code>PooledArray</code>). Behaves just like a normal array in most respects; internally, possible values are stored in the <code>encoding::DictEncoding</code> field, while the <code>indices::Vector{<:Integer}</code> field holds the "codes" of each element for indexing into the encoding pool. Any column/array can be dict encoding when serializing to the arrow format either by passing the <code>dictencode=true</code> keyword argument to <a href="#Arrow.write"><code>Arrow.write</code></a> (which causes <em>all</em> columns to be dict encoded), or wrapping individual columns/ arrays in <a href="#Arrow.DictEncode"><code>Arrow.DictEncode(x)</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/dictencoding.jl#LL77-L88">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.DictEncoding" href="#Arrow.DictEncoding"><code>Arrow.DictEncoding</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.DictEncoding</code></pre><p>Represents the "pool" of possible values for a <a href="#Arrow.DictEncoded"><code>DictEncoded</code></a> array type. Whether the order of values is significant can be checked by looking at the <code>isOrdered</code> boolean field.</p><p>The <code>S</code> type parameter, while not tied directly to any field, is the signed integer "index type" of the parent DictEncoded. We keep track of this in the DictEncoding in order to validate the length of the pool doesn't exceed the index type limit. The general workflow of writing arrow data means the initial schema will typically be based off the data in the first record batch, and subsequent record batches need to match the same schema exactly. For example, if a non-first record batch dict encoded column were to cause a DictEncoding pool to overflow on unique values, a fatal error should be thrown.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/dictencoding.jl#LL17-L33">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.FixedSizeList" href="#Arrow.FixedSizeList"><code>Arrow.FixedSizeList</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.FixedSizeList</code></pre><p>An <code>ArrowVector</code> where each element is a "fixed size" list of some kind, like a <code>NTuple{N, T}</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/fixedsizelist.jl#LL17-L21">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.List" href="#Arrow.List"><code>Arrow.List</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.List</code></pre><p>An <code>ArrowVector</code> where each element is a variable sized list of some kind, like an <code>AbstractVector</code> or <code>AbstractString</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/list.jl#LL31-L35">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Map" href="#Arrow.Map"><code>Arrow.Map</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Map</code></pre><p>An <code>ArrowVector</code> where each element is a "map" of some kind, like a <code>Dict</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/map.jl#LL17-L21">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Primitive" href="#Arrow.Primitive"><code>Arrow.Primitive</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Primitive</code></pre><p>An <code>ArrowVector</code> where each element is a "fixed size" scalar of some kind, like an integer, float, decimal, or time type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/primitive.jl#LL17-L21">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.SparseUnion" href="#Arrow.SparseUnion"><code>Arrow.SparseUnion</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.SparseUnion</code></pre><p>An <code>ArrowVector</code> where the type of each element is one of a fixed set of types, meaning its eltype is like a julia <code>Union{type1, type2, ...}</code>. An <code>Arrow.SparseUnion</code>, in comparison to <code>Arrow.DenseUnion</code>, stores elements in a set of arrays, one array per possible type, and each typed array has the same length as the full array. This ends up with "wasted" space, since only one slot among the typed arrays is valid per full array element, but can allow for certain optimizations when each typed array has the same length.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/unions.jl#LL176-L183">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Stream" href="#Arrow.Stream"><code>Arrow.Stream</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Stream(io::IO; convert::Bool=true)
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API Reference · Arrow.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://arrow.juliadata.org/reference/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Arrow.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../manual/">User Manual</a></li><li class="is-active"><a class="tocitem" href>API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API Reference</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/apache/arrow-julia/blob/main/docs/src/reference.md#L" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><p><!–- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at</p><pre><code class="nohighlight hljs">http://www.apache.org/licenses/LICENSE-2.0</code></pre><p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. –></p><h1 id="API-Reference"><a class="docs-heading-anchor" href="#API-Reference">API Reference</a><a id="API-Reference-1"></a><a class="docs-heading-anchor-permalink" href="#API-Reference" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="Arrow.ArrowVector" href="#Arrow.ArrowVector"><code>Arrow.ArrowVector</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.ArrowVector</code></pre><p>An abstract type that subtypes <code>AbstractVector</code>. Each specific arrow array type subtypes <code>ArrowVector</code>. See <a href="#Arrow.BoolVector"><code>BoolVector</code></a>, <a href="#Arrow.Primitive"><code>Primitive</code></a>, <a href="#Arrow.List"><code>List</code></a>, <a href="#Arrow.Map"><code>Map</code></a>, <a href="#Arrow.FixedSizeList"><code>FixedSizeList</code></a>, <a href="#Arrow.Struct"><code>Struct</code></a>, <a href="#Arrow.DenseUnion"><code>DenseUnion</code></a>, <a href="#Arrow.SparseUnion"><code>SparseUnion</code></a>, and <a href="#Arrow.DictEncoded"><code>DictEncoded</code></a> for more details.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/arraytypes.jl#LL17-L24">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.BoolVector" href="#Arrow.BoolVector"><code>Arrow.BoolVector</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.BoolVector</code></pre><p>A bit-packed array type, similar to <a href="#Arrow.ValidityBitmap"><code>ValidityBitmap</code></a>, but which holds boolean values, <code>true</code> or <code>false</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/bool.jl#LL17-L22">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Compressed" href="#Arrow.Compressed"><code>Arrow.Compressed</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Compressed</code></pre><p>Represents the compressed version of an <a href="#Arrow.ArrowVector"><code>ArrowVector</code></a>. Holds a reference to the original column. May have <code>Compressed</code> children for nested array types.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/compressed.jl#LL22-L28">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.DenseUnion" href="#Arrow.DenseUnion"><code>Arrow.DenseUnion</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.DenseUnion</code></pre><p>An <code>ArrowVector</code> where the type of each element is one of a fixed set of types, meaning its eltype is like a julia <code>Union{type1, type2, ...}</code>. An <code>Arrow.DenseUnion</code>, in comparison to <code>Arrow.SparseUnion</code>, stores elements in a set of arrays, one array per possible type, and an "offsets" array, where each offset element is the index into one of the typed arrays. This allows a sort of "compression", where no extra space is used/allocated to store all the elements.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/unions.jl#LL52-L59">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.DictEncode" href="#Arrow.DictEncode"><code>Arrow.DictEncode</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.DictEncode(::AbstractVector, id::Integer=nothing)</code></pre><p>Signals that a column/array should be dictionary encoded when serialized to the arrow streaming/file format. An optional <code>id</code> number may be provided to signal that multiple columns should use the same pool when being dictionary encoded.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/dictencoding.jl#LL56-L63">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.DictEncoded" href="#Arrow.DictEncoded"><code>Arrow.DictEncoded</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.DictEncoded</code></pre><p>A dictionary encoded array type (similar to a <code>PooledArray</code>). Behaves just like a normal array in most respects; internally, possible values are stored in the <code>encoding::DictEncoding</code> field, while the <code>indices::Vector{<:Integer}</code> field holds the "codes" of each element for indexing into the encoding pool. Any column/array can be dict encoding when serializing to the arrow format either by passing the <code>dictencode=true</code> keyword argument to <a href="#Arrow.write"><code>Arrow.write</code></a> (which causes <em>all</em> columns to be dict encoded), or wrapping individual columns/ arrays in <a href="#Arrow.DictEncode"><code>Arrow.DictEncode(x)</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/dictencoding.jl#LL77-L88">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.DictEncoding" href="#Arrow.DictEncoding"><code>Arrow.DictEncoding</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.DictEncoding</code></pre><p>Represents the "pool" of possible values for a <a href="#Arrow.DictEncoded"><code>DictEncoded</code></a> array type. Whether the order of values is significant can be checked by looking at the <code>isOrdered</code> boolean field.</p><p>The <code>S</code> type parameter, while not tied directly to any field, is the signed integer "index type" of the parent DictEncoded. We keep track of this in the DictEncoding in order to validate the length of the pool doesn't exceed the index type limit. The general workflow of writing arrow data means the initial schema will typically be based off the data in the first record batch, and subsequent record batches need to match the same schema exactly. For example, if a non-first record batch dict encoded column were to cause a DictEncoding pool to overflow on unique values, a fatal error should be thrown.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/dictencoding.jl#LL17-L33">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.FixedSizeList" href="#Arrow.FixedSizeList"><code>Arrow.FixedSizeList</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.FixedSizeList</code></pre><p>An <code>ArrowVector</code> where each element is a "fixed size" list of some kind, like a <code>NTuple{N, T}</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/fixedsizelist.jl#LL17-L21">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.List" href="#Arrow.List"><code>Arrow.List</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.List</code></pre><p>An <code>ArrowVector</code> where each element is a variable sized list of some kind, like an <code>AbstractVector</code> or <code>AbstractString</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/list.jl#LL31-L35">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Map" href="#Arrow.Map"><code>Arrow.Map</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Map</code></pre><p>An <code>ArrowVector</code> where each element is a "map" of some kind, like a <code>Dict</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/map.jl#LL17-L21">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Primitive" href="#Arrow.Primitive"><code>Arrow.Primitive</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Primitive</code></pre><p>An <code>ArrowVector</code> where each element is a "fixed size" scalar of some kind, like an integer, float, decimal, or time type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/primitive.jl#LL17-L21">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.SparseUnion" href="#Arrow.SparseUnion"><code>Arrow.SparseUnion</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.SparseUnion</code></pre><p>An <code>ArrowVector</code> where the type of each element is one of a fixed set of types, meaning its eltype is like a julia <code>Union{type1, type2, ...}</code>. An <code>Arrow.SparseUnion</code>, in comparison to <code>Arrow.DenseUnion</code>, stores elements in a set of arrays, one array per possible type, and each typed array has the same length as the full array. This ends up with "wasted" space, since only one slot among the typed arrays is valid per full array element, but can allow for certain optimizations when each typed array has the same length.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/unions.jl#LL176-L183">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Stream" href="#Arrow.Stream"><code>Arrow.Stream</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Stream(io::IO; convert::Bool=true)
Arrow.Stream(file::String; convert::Bool=true)
Arrow.Stream(bytes::Vector{UInt8}, pos=1, len=nothing; convert::Bool=true)
-Arrow.Stream(inputs::Vector; convert::Bool=true)</code></pre><p>Start reading an arrow formatted table, from:</p><ul><li><code>io</code>, bytes will be read all at once via <code>read(io)</code></li><li><code>file</code>, bytes will be read via <code>Mmap.mmap(file)</code></li><li><code>bytes</code>, a byte vector directly, optionally allowing specifying the starting byte position <code>pos</code> and <code>len</code></li><li>A <code>Vector</code> of any of the above, in which each input should be an IPC or arrow file and must match schema</li></ul><p>Reads the initial schema message from the arrow stream/file, then returns an <code>Arrow.Stream</code> object which will iterate over record batch messages, producing an <a href="#Arrow.Table"><code>Arrow.Table</code></a> on each iteration.</p><p>By iterating <a href="#Arrow.Table"><code>Arrow.Table</code></a>, <code>Arrow.Stream</code> satisfies the <code>Tables.partitions</code> interface, and as such can be passed to Tables.jl-compatible sink functions.</p><p>This allows iterating over extremely large "arrow tables" in chunks represented as record batches.</p><p>Supports the <code>convert</code> keyword argument which controls whether certain arrow primitive types will be lazily converted to more friendly Julia defaults; by default, <code>convert=true</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/table.jl#LL42-L64">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Struct" href="#Arrow.Struct"><code>Arrow.Struct</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Struct</code></pre><p>An <code>ArrowVector</code> where each element is a "struct" of some kind with ordered, named fields, like a <code>NamedTuple{names, types}</code> or regular julia <code>struct</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/struct.jl#LL17-L21">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Table" href="#Arrow.Table"><code>Arrow.Table</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Table(io::IO; convert::Bool=true)
+Arrow.Stream(inputs::Vector; convert::Bool=true)</code></pre><p>Start reading an arrow formatted table, from:</p><ul><li><code>io</code>, bytes will be read all at once via <code>read(io)</code></li><li><code>file</code>, bytes will be read via <code>Mmap.mmap(file)</code></li><li><code>bytes</code>, a byte vector directly, optionally allowing specifying the starting byte position <code>pos</code> and <code>len</code></li><li>A <code>Vector</code> of any of the above, in which each input should be an IPC or arrow file and must match schema</li></ul><p>Reads the initial schema message from the arrow stream/file, then returns an <code>Arrow.Stream</code> object which will iterate over record batch messages, producing an <a href="#Arrow.Table"><code>Arrow.Table</code></a> on each iteration.</p><p>By iterating <a href="#Arrow.Table"><code>Arrow.Table</code></a>, <code>Arrow.Stream</code> satisfies the <code>Tables.partitions</code> interface, and as such can be passed to Tables.jl-compatible sink functions.</p><p>This allows iterating over extremely large "arrow tables" in chunks represented as record batches.</p><p>Supports the <code>convert</code> keyword argument which controls whether certain arrow primitive types will be lazily converted to more friendly Julia defaults; by default, <code>convert=true</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/table.jl#LL42-L64">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Struct" href="#Arrow.Struct"><code>Arrow.Struct</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Struct</code></pre><p>An <code>ArrowVector</code> where each element is a "struct" of some kind with ordered, named fields, like a <code>NamedTuple{names, types}</code> or regular julia <code>struct</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/struct.jl#LL17-L21">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Table" href="#Arrow.Table"><code>Arrow.Table</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Table(io::IO; convert::Bool=true)
Arrow.Table(file::String; convert::Bool=true)
Arrow.Table(bytes::Vector{UInt8}, pos=1, len=nothing; convert::Bool=true)
-Arrow.Table(inputs::Vector; convert::Bool=true)</code></pre><p>Read an arrow formatted table, from:</p><ul><li><code>io</code>, bytes will be read all at once via <code>read(io)</code></li><li><code>file</code>, bytes will be read via <code>Mmap.mmap(file)</code></li><li><code>bytes</code>, a byte vector directly, optionally allowing specifying the starting byte position <code>pos</code> and <code>len</code></li><li>A <code>Vector</code> of any of the above, in which each input should be an IPC or arrow file and must match schema</li></ul><p>Returns a <code>Arrow.Table</code> object that allows column access via <code>table.col1</code>, <code>table[:col1]</code>, or <code>table[1]</code>.</p><p>NOTE: the columns in an <code>Arrow.Table</code> are views into the original arrow memory, and hence are not easily modifiable (with e.g. <code>push!</code>, <code>append!</code>, etc.). To mutate arrow columns, call <code>copy(x)</code> to materialize the arrow data as a normal Julia array.</p><p><code>Arrow.Table</code> also satisfies the <a href="https://github.com/JuliaData/Tables.jl">Tables.jl</a> interface, and so can easily be materialied via any supporting sink function: e.g. <code>DataFrame(Arrow.Table(file))</code>, <code>SQLite.load!(db, "table", Arrow.Table(file))</code>, etc.</p><p>Supports the <code>convert</code> keyword argument which controls whether certain arrow primitive types will be lazily converted to more friendly Julia defaults; by default, <code>convert=true</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/table.jl#LL242-L265">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.ToTimestamp" href="#Arrow.ToTimestamp"><code>Arrow.ToTimestamp</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.ToTimestamp(x::AbstractVector{ZonedDateTime})</code></pre><p>Wrapper array that provides a more efficient encoding of <code>ZonedDateTime</code> elements to the arrow format. In the arrow format, timestamp columns with timezone information are encoded as the arrow equivalent of a Julia type parameter, meaning an entire column <em>should</em> have elements all with the same timezone. If a <code>ZonedDateTime</code> column is passed to <code>Arrow.write</code>, for correctness, it must scan each element to check each timezone. <code>Arrow.ToTimestamp</code> provides a "bypass" of this process by encoding the timezone of the first element of the <code>AbstractVector{ZonedDateTime}</code>, which in turn allows <code>Arrow.write</code> to avoid costly checking/conversion and can encode the <code>ZonedDateTime</code> as <code>Arrow.Timestamp</code> directly.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/eltypes.jl#LL314-L323">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.ValidityBitmap" href="#Arrow.ValidityBitmap"><code>Arrow.ValidityBitmap</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.ValidityBitmap</code></pre><p>A bit-packed array type where each bit corresponds to an element in an <a href="#Arrow.ArrowVector"><code>ArrowVector</code></a>, indicating whether that element is "valid" (bit == 1), or not (bit == 0). Used to indicate element missingness (whether it's null).</p><p>If the null count of an array is zero, the <code>ValidityBitmap</code> will be "empty" and all elements are treated as "valid"/non-null.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/arraytypes/arraytypes.jl#LL121-L130">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Writer" href="#Arrow.Writer"><code>Arrow.Writer</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Writer{T<:IO}</code></pre><p>An object that can be used to incrementally write Arrow partitions</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia> writer = open(Arrow.Writer, tempname())
+Arrow.Table(inputs::Vector; convert::Bool=true)</code></pre><p>Read an arrow formatted table, from:</p><ul><li><code>io</code>, bytes will be read all at once via <code>read(io)</code></li><li><code>file</code>, bytes will be read via <code>Mmap.mmap(file)</code></li><li><code>bytes</code>, a byte vector directly, optionally allowing specifying the starting byte position <code>pos</code> and <code>len</code></li><li>A <code>Vector</code> of any of the above, in which each input should be an IPC or arrow file and must match schema</li></ul><p>Returns a <code>Arrow.Table</code> object that allows column access via <code>table.col1</code>, <code>table[:col1]</code>, or <code>table[1]</code>.</p><p>NOTE: the columns in an <code>Arrow.Table</code> are views into the original arrow memory, and hence are not easily modifiable (with e.g. <code>push!</code>, <code>append!</code>, etc.). To mutate arrow columns, call <code>copy(x)</code> to materialize the arrow data as a normal Julia array.</p><p><code>Arrow.Table</code> also satisfies the <a href="https://github.com/JuliaData/Tables.jl">Tables.jl</a> interface, and so can easily be materialied via any supporting sink function: e.g. <code>DataFrame(Arrow.Table(file))</code>, <code>SQLite.load!(db, "table", Arrow.Table(file))</code>, etc.</p><p>Supports the <code>convert</code> keyword argument which controls whether certain arrow primitive types will be lazily converted to more friendly Julia defaults; by default, <code>convert=true</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/table.jl#LL242-L265">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.ToTimestamp" href="#Arrow.ToTimestamp"><code>Arrow.ToTimestamp</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.ToTimestamp(x::AbstractVector{ZonedDateTime})</code></pre><p>Wrapper array that provides a more efficient encoding of <code>ZonedDateTime</code> elements to the arrow format. In the arrow format, timestamp columns with timezone information are encoded as the arrow equivalent of a Julia type parameter, meaning an entire column <em>should</em> have elements all with the same timezone. If a <code>ZonedDateTime</code> column is passed to <code>Arrow.write</code>, for correctness, it must scan each element to check each timezone. <code>Arrow.ToTimestamp</code> provides a "bypass" of this process by encoding the timezone of the first element of the <code>AbstractVector{ZonedDateTime}</code>, which in turn allows <code>Arrow.write</code> to avoid costly checking/conversion and can encode the <code>ZonedDateTime</code> as <code>Arrow.Timestamp</code> directly.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/eltypes.jl#LL314-L323">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.ValidityBitmap" href="#Arrow.ValidityBitmap"><code>Arrow.ValidityBitmap</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.ValidityBitmap</code></pre><p>A bit-packed array type where each bit corresponds to an element in an <a href="#Arrow.ArrowVector"><code>ArrowVector</code></a>, indicating whether that element is "valid" (bit == 1), or not (bit == 0). Used to indicate element missingness (whether it's null).</p><p>If the null count of an array is zero, the <code>ValidityBitmap</code> will be "empty" and all elements are treated as "valid"/non-null.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/arraytypes/arraytypes.jl#LL121-L130">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.Writer" href="#Arrow.Writer"><code>Arrow.Writer</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Arrow.Writer{T<:IO}</code></pre><p>An object that can be used to incrementally write Arrow partitions</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia> writer = open(Arrow.Writer, tempname())
julia> partition1 = (col1 = [1, 2], col2 = ["A", "B"])
(col1 = [1, 2], col2 = ["A", "B"])
@@ -22,8 +22,8 @@
Arrow.write(writer, partition1)
partition2 = (col1 = [3, 4], col2 = ["C", "D"])
Arrow.write(writer, partition1)
- end</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/write.jl#LL78-L110">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.append" href="#Arrow.append"><code>Arrow.append</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">Arrow.append(io::IO, tbl)
+ end</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/write.jl#LL78-L110">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.append" href="#Arrow.append"><code>Arrow.append</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">Arrow.append(io::IO, tbl)
Arrow.append(file::String, tbl)
-tbl |> Arrow.append(file)</code></pre><p>Append any <a href="https://github.com/JuliaData/Tables.jl">Tables.jl</a>-compatible <code>tbl</code> to an existing arrow formatted file or IO. The existing arrow data must be in IPC stream format. Note that appending to the "feather formatted file" is <em>not</em> allowed, as this file format doesn't support appending. That means files written like <code>Arrow.write(filename::String, tbl)</code> <em>cannot</em> be appended to; instead, you should write like <code>Arrow.write(filename::String, tbl; file=false)</code>.</p><p>When an IO object is provided to be written on to, it must support seeking. For example, a file opened in <code>r+</code> mode or an <code>IOBuffer</code> that is readable, writable and seekable can be appended to, but not a network stream.</p><p>Multiple record batches will be written based on the number of <code>Tables.partitions(tbl)</code> that are provided; by default, this is just one for a given table, but some table sources support automatic partitioning. Note you can turn multiple table objects into partitions by doing <code>Tables.partitioner([tbl1, tbl2, ...])</code>, but note that each table must have the exact same <code>Tables.Schema</code>.</p><p>By default, <code>Arrow.append</code> will use multiple threads to write multiple record batches simultaneously (e.g. if julia is started with <code>julia -t 8</code> or the <code>JULIA_NUM_THREADS</code> environment variable is set).</p><p>Supported keyword arguments to <code>Arrow.append</code> include:</p><ul><li><code>alignment::Int=8</code>: specify the number of bytes to align buffers to when written in messages; strongly recommended to only use alignment values of 8 or 64 for modern memory cache line optimization</li><li><code>colmetadata=nothing</code>: the metadata that should be written as the table's columns' <code>custom_metadata</code> fields; must either be <code>nothing</code> or an <code>AbstractDict</code> of <code>column_name::Symbol => column_metadata</code> where <code>column_metadata</code> is an iterable of <code><:AbstractString</code> pairs.</li><li><code>dictencode::Bool=false</code>: whether all columns should use dictionary encoding when being written; to dict encode specific columns, wrap the column/array in <code>Arrow.DictEncode(col)</code></li><li><code>dictencodenested::Bool=false</code>: whether nested data type columns should also dict encode nested arrays/buffers; other language implementations <a href="https://arrow.apache.org/docs/status.html">may not support this</a></li><li><code>denseunions::Bool=true</code>: whether Julia <code>Vector{<:Union}</code> arrays should be written using the dense union layout; passing <code>false</code> will result in the sparse union layout</li><li><code>largelists::Bool=false</code>: causes list column types to be written with Int64 offset arrays; mainly for testing purposes; by default, Int64 offsets will be used only if needed</li><li><code>maxdepth::Int=6</code>: deepest allowed nested serialization level; this is provided by default to prevent accidental infinite recursion with mutually recursive data structures</li><li><code>metadata=Arrow.getmetadata(tbl)</code>: the metadata that should be written as the table's schema's <code>custom_metadata</code> field; must either be <code>nothing</code> or an iterable of <code><:AbstractString</code> pairs.</li><li><code>ntasks::Int</code>: number of concurrent threaded tasks to allow while writing input partitions out as arrow record batches; default is no limit; to disable multithreaded writing, pass <code>ntasks=1</code></li><li><code>convert::Bool</code>: whether certain arrow primitive types in the schema of <code>file</code> should be converted to Julia defaults for matching them to the schema of <code>tbl</code>; by default, <code>convert=true</code>.</li><li><code>file::Bool</code>: applicable when an <code>IO</code> is provided, whether it is a file; by default <code>file=false</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/append.jl#LL18-L57">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.arrowtype" href="#Arrow.arrowtype"><code>Arrow.arrowtype</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Given a FlatBuffers.Builder and a Julia column or column eltype, Write the field.type flatbuffer definition of the eltype</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/eltypes.jl#LL27-L30">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.getmetadata-Tuple{Arrow.Table}" href="#Arrow.getmetadata-Tuple{Arrow.Table}"><code>Arrow.getmetadata</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Arrow.getmetadata(x)</code></pre><p>If <code>x isa Arrow.Table</code> return a <code>Base.ImmutableDict{String,String}</code> representation of <code>x</code>'s <code>Schema</code> <code>custom_metadata</code>, or <code>nothing</code> if no such metadata exists.</p><p>If <code>x isa Arrow.ArrowVector</code>, return a <code>Base.ImmutableDict{String,String}</code> representation of <code>x</code>'s <code>Field</code> <code>custom_metadata</code>, or <code>nothing</code> if no such metadata exists.</p><p>Otherwise, return <code>nothing</code>.</p><p>See <a href="https://arrow.apache.org/docs/format/Columnar.html#custom-application-metadata">the official Arrow documentation for more details on custom application metadata</a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/table.jl#LL289-L301">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.juliaeltype" href="#Arrow.juliaeltype"><code>Arrow.juliaeltype</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Given a flatbuffers metadata type definition (a Field instance from Schema.fbs), translate to the appropriate Julia storage eltype</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/eltypes.jl#LL17-L20">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.write" href="#Arrow.write"><code>Arrow.write</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">Arrow.write(io::IO, tbl)
+tbl |> Arrow.append(file)</code></pre><p>Append any <a href="https://github.com/JuliaData/Tables.jl">Tables.jl</a>-compatible <code>tbl</code> to an existing arrow formatted file or IO. The existing arrow data must be in IPC stream format. Note that appending to the "feather formatted file" is <em>not</em> allowed, as this file format doesn't support appending. That means files written like <code>Arrow.write(filename::String, tbl)</code> <em>cannot</em> be appended to; instead, you should write like <code>Arrow.write(filename::String, tbl; file=false)</code>.</p><p>When an IO object is provided to be written on to, it must support seeking. For example, a file opened in <code>r+</code> mode or an <code>IOBuffer</code> that is readable, writable and seekable can be appended to, but not a network stream.</p><p>Multiple record batches will be written based on the number of <code>Tables.partitions(tbl)</code> that are provided; by default, this is just one for a given table, but some table sources support automatic partitioning. Note you can turn multiple table objects into partitions by doing <code>Tables.partitioner([tbl1, tbl2, ...])</code>, but note that each table must have the exact same <code>Tables.Schema</code>.</p><p>By default, <code>Arrow.append</code> will use multiple threads to write multiple record batches simultaneously (e.g. if julia is started with <code>julia -t 8</code> or the <code>JULIA_NUM_THREADS</code> environment variable is set).</p><p>Supported keyword arguments to <code>Arrow.append</code> include:</p><ul><li><code>alignment::Int=8</code>: specify the number of bytes to align buffers to when written in messages; strongly recommended to only use alignment values of 8 or 64 for modern memory cache line optimization</li><li><code>colmetadata=nothing</code>: the metadata that should be written as the table's columns' <code>custom_metadata</code> fields; must either be <code>nothing</code> or an <code>AbstractDict</code> of <code>column_name::Symbol => column_metadata</code> where <code>column_metadata</code> is an iterable of <code><:AbstractString</code> pairs.</li><li><code>dictencode::Bool=false</code>: whether all columns should use dictionary encoding when being written; to dict encode specific columns, wrap the column/array in <code>Arrow.DictEncode(col)</code></li><li><code>dictencodenested::Bool=false</code>: whether nested data type columns should also dict encode nested arrays/buffers; other language implementations <a href="https://arrow.apache.org/docs/status.html">may not support this</a></li><li><code>denseunions::Bool=true</code>: whether Julia <code>Vector{<:Union}</code> arrays should be written using the dense union layout; passing <code>false</code> will result in the sparse union layout</li><li><code>largelists::Bool=false</code>: causes list column types to be written with Int64 offset arrays; mainly for testing purposes; by default, Int64 offsets will be used only if needed</li><li><code>maxdepth::Int=6</code>: deepest allowed nested serialization level; this is provided by default to prevent accidental infinite recursion with mutually recursive data structures</li><li><code>metadata=Arrow.getmetadata(tbl)</code>: the metadata that should be written as the table's schema's <code>custom_metadata</code> field; must either be <code>nothing</code> or an iterable of <code><:AbstractString</code> pairs.</li><li><code>ntasks::Int</code>: number of concurrent threaded tasks to allow while writing input partitions out as arrow record batches; default is no limit; to disable multithreaded writing, pass <code>ntasks=1</code></li><li><code>convert::Bool</code>: whether certain arrow primitive types in the schema of <code>file</code> should be converted to Julia defaults for matching them to the schema of <code>tbl</code>; by default, <code>convert=true</code>.</li><li><code>file::Bool</code>: applicable when an <code>IO</code> is provided, whether it is a file; by default <code>file=false</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/append.jl#LL18-L57">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.arrowtype" href="#Arrow.arrowtype"><code>Arrow.arrowtype</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Given a FlatBuffers.Builder and a Julia column or column eltype, Write the field.type flatbuffer definition of the eltype</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/eltypes.jl#LL27-L30">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.getmetadata-Tuple{Arrow.Table}" href="#Arrow.getmetadata-Tuple{Arrow.Table}"><code>Arrow.getmetadata</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Arrow.getmetadata(x)</code></pre><p>If <code>x isa Arrow.Table</code> return a <code>Base.ImmutableDict{String,String}</code> representation of <code>x</code>'s <code>Schema</code> <code>custom_metadata</code>, or <code>nothing</code> if no such metadata exists.</p><p>If <code>x isa Arrow.ArrowVector</code>, return a <code>Base.ImmutableDict{String,String}</code> representation of <code>x</code>'s <code>Field</code> <code>custom_metadata</code>, or <code>nothing</code> if no such metadata exists.</p><p>Otherwise, return <code>nothing</code>.</p><p>See <a href="https://arrow.apache.org/docs/format/Columnar.html#custom-application-metadata">the official Arrow documentation for more details on custom application metadata</a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/table.jl#LL289-L301">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.juliaeltype" href="#Arrow.juliaeltype"><code>Arrow.juliaeltype</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Given a flatbuffers metadata type definition (a Field instance from Schema.fbs), translate to the appropriate Julia storage eltype</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/eltypes.jl#LL17-L20">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Arrow.write" href="#Arrow.write"><code>Arrow.write</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">Arrow.write(io::IO, tbl)
Arrow.write(file::String, tbl)
-tbl |> Arrow.write(io_or_file)</code></pre><p>Write any <a href="https://github.com/JuliaData/Tables.jl">Tables.jl</a>-compatible <code>tbl</code> out as arrow formatted data. Providing an <code>io::IO</code> argument will cause the data to be written to it in the <a href="https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format">"streaming" format</a>, unless <code>file=true</code> keyword argument is passed. Providing a <code>file::String</code> argument will result in the <a href="https://arrow.apache.org/docs/format/Columnar.html#ipc-file-format">"file" format</a> being written.</p><p>Multiple record batches will be written based on the number of <code>Tables.partitions(tbl)</code> that are provided; by default, this is just one for a given table, but some table sources support automatic partitioning. Note you can turn multiple table objects into partitions by doing <code>Tables.partitioner([tbl1, tbl2, ...])</code>, but note that each table must have the exact same <code>Tables.Schema</code>.</p><p>By default, <code>Arrow.write</code> will use multiple threads to write multiple record batches simultaneously (e.g. if julia is started with <code>julia -t 8</code> or the <code>JULIA_NUM_THREADS</code> environment variable is set).</p><p>Supported keyword arguments to <code>Arrow.write</code> include:</p><ul><li><code>colmetadata=nothing</code>: the metadata that should be written as the table's columns' <code>custom_metadata</code> fields; must either be <code>nothing</code> or an <code>AbstractDict</code> of <code>column_name::Symbol => column_metadata</code> where <code>column_metadata</code> is an iterable of <code><:AbstractString</code> pairs.</li><li><code>compress</code>: possible values include <code>:lz4</code>, <code>:zstd</code>, or your own initialized <code>LZ4FrameCompressor</code> or <code>ZstdCompressor</code> objects; will cause all buffers in each record batch to use the respective compression encoding</li><li><code>alignment::Int=8</code>: specify the number of bytes to align buffers to when written in messages; strongly recommended to only use alignment values of 8 or 64 for modern memory cache line optimization</li><li><code>dictencode::Bool=false</code>: whether all columns should use dictionary encoding when being written; to dict encode specific columns, wrap the column/array in <code>Arrow.DictEncode(col)</code></li><li><code>dictencodenested::Bool=false</code>: whether nested data type columns should also dict encode nested arrays/buffers; other language implementations <a href="https://arrow.apache.org/docs/status.html">may not support this</a></li><li><code>denseunions::Bool=true</code>: whether Julia <code>Vector{<:Union}</code> arrays should be written using the dense union layout; passing <code>false</code> will result in the sparse union layout</li><li><code>largelists::Bool=false</code>: causes list column types to be written with Int64 offset arrays; mainly for testing purposes; by default, Int64 offsets will be used only if needed</li><li><code>maxdepth::Int=6</code>: deepest allowed nested serialization level; this is provided by default to prevent accidental infinite recursion with mutually recursive data structures</li><li><code>metadata=Arrow.getmetadata(tbl)</code>: the metadata that should be written as the table's schema's <code>custom_metadata</code> field; must either be <code>nothing</code> or an iterable of <code><:AbstractString</code> pairs.</li><li><code>ntasks::Int</code>: number of buffered threaded tasks to allow while writing input partitions out as arrow record batches; default is no limit; for unbuffered writing, pass <code>ntasks=0</code></li><li><code>file::Bool=false</code>: if a an <code>io</code> argument is being written to, passing <code>file=true</code> will cause the arrow file format to be written instead of just IPC streaming</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/a48407886eae3acf54ee3d43e7e8ed3836d234b7/src/write.jl#LL19-L51">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../manual/">« User Manual</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 13 June 2023 13:45">Tuesday 13 June 2023</span>. Using Julia version 1.9.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+tbl |> Arrow.write(io_or_file)</code></pre><p>Write any <a href="https://github.com/JuliaData/Tables.jl">Tables.jl</a>-compatible <code>tbl</code> out as arrow formatted data. Providing an <code>io::IO</code> argument will cause the data to be written to it in the <a href="https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format">"streaming" format</a>, unless <code>file=true</code> keyword argument is passed. Providing a <code>file::String</code> argument will result in the <a href="https://arrow.apache.org/docs/format/Columnar.html#ipc-file-format">"file" format</a> being written.</p><p>Multiple record batches will be written based on the number of <code>Tables.partitions(tbl)</code> that are provided; by default, this is just one for a given table, but some table sources support automatic partitioning. Note you can turn multiple table objects into partitions by doing <code>Tables.partitioner([tbl1, tbl2, ...])</code>, but note that each table must have the exact same <code>Tables.Schema</code>.</p><p>By default, <code>Arrow.write</code> will use multiple threads to write multiple record batches simultaneously (e.g. if julia is started with <code>julia -t 8</code> or the <code>JULIA_NUM_THREADS</code> environment variable is set).</p><p>Supported keyword arguments to <code>Arrow.write</code> include:</p><ul><li><code>colmetadata=nothing</code>: the metadata that should be written as the table's columns' <code>custom_metadata</code> fields; must either be <code>nothing</code> or an <code>AbstractDict</code> of <code>column_name::Symbol => column_metadata</code> where <code>column_metadata</code> is an iterable of <code><:AbstractString</code> pairs.</li><li><code>compress</code>: possible values include <code>:lz4</code>, <code>:zstd</code>, or your own initialized <code>LZ4FrameCompressor</code> or <code>ZstdCompressor</code> objects; will cause all buffers in each record batch to use the respective compression encoding</li><li><code>alignment::Int=8</code>: specify the number of bytes to align buffers to when written in messages; strongly recommended to only use alignment values of 8 or 64 for modern memory cache line optimization</li><li><code>dictencode::Bool=false</code>: whether all columns should use dictionary encoding when being written; to dict encode specific columns, wrap the column/array in <code>Arrow.DictEncode(col)</code></li><li><code>dictencodenested::Bool=false</code>: whether nested data type columns should also dict encode nested arrays/buffers; other language implementations <a href="https://arrow.apache.org/docs/status.html">may not support this</a></li><li><code>denseunions::Bool=true</code>: whether Julia <code>Vector{<:Union}</code> arrays should be written using the dense union layout; passing <code>false</code> will result in the sparse union layout</li><li><code>largelists::Bool=false</code>: causes list column types to be written with Int64 offset arrays; mainly for testing purposes; by default, Int64 offsets will be used only if needed</li><li><code>maxdepth::Int=6</code>: deepest allowed nested serialization level; this is provided by default to prevent accidental infinite recursion with mutually recursive data structures</li><li><code>metadata=Arrow.getmetadata(tbl)</code>: the metadata that should be written as the table's schema's <code>custom_metadata</code> field; must either be <code>nothing</code> or an iterable of <code><:AbstractString</code> pairs.</li><li><code>ntasks::Int</code>: number of buffered threaded tasks to allow while writing input partitions out as arrow record batches; default is no limit; for unbuffered writing, pass <code>ntasks=0</code></li><li><code>file::Bool=false</code>: if a an <code>io</code> argument is being written to, passing <code>file=true</code> will cause the arrow file format to be written instead of just IPC streaming</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/apache/arrow-julia/blob/9c439bac84d1f4f59180837338d3b2eb0ec6de6c/src/write.jl#LL19-L51">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../manual/">« User Manual</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 13 June 2023 13:49">Tuesday 13 June 2023</span>. Using Julia version 1.9.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/search/index.html b/dev/search/index.html
index 2e3623f..c981925 100644
--- a/dev/search/index.html
+++ b/dev/search/index.html
@@ -1,2 +1,2 @@
<!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · Arrow.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://arrow.juliadata.org/search/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Arrow.jl</a></span></div><form class="docs-search" action><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../manual/">User Manual</a></li><li><a class="tocitem" href="../reference/">API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 13 June 2023 13:45">Tuesday 13 June 2023</span>. Using Julia version 1.9.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="../search_index.js"></script><script src="../assets/search.js"></script></html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · Arrow.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://arrow.juliadata.org/search/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Arrow.jl</a></span></div><form class="docs-search" action><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../manual/">User Manual</a></li><li><a class="tocitem" href="../reference/">API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 13 June 2023 13:49">Tuesday 13 June 2023</span>. Using Julia version 1.9.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="../search_index.js"></script><script src="../assets/search.js"></script></html>
