| <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> |
