| <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Apache Arrow - v17.0.0-SNAPSHOT</title><meta name="description" content="Documentation for Apache Arrow"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Apache Arrow - v17.0.0-SNAPSHOT</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>Apache Arrow - v17.0.0-SNAPSHOT</h2></div><div class="tsd-panel tsd-typography"><!--- |
| 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 |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| 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. |
| --> |
| |
| <a id="md:apache-arrow-in-js" class="tsd-anchor"></a><h1><a href="#md:apache-arrow-in-js"><a href="https://github.com/apache/arrow">Apache Arrow</a> in JS</a></h1><p><a href="https://www.npmjs.com/package/apache-arrow"><img src="https://img.shields.io/npm/v/apache-arrow.svg" alt="npm version"></a></p> |
| <p>Arrow is a set of technologies that enable big data systems to process and transfer data quickly.</p> |
| <a id="md:install-apache-arrow-from-npm" class="tsd-anchor"></a><h2><a href="#md:install-apache-arrow-from-npm">Install <code>apache-arrow</code> from NPM</a></h2><p><code>npm install apache-arrow</code> or <code>yarn add apache-arrow</code></p> |
| <p>(read about how we <a href="#md:packaging">package apache-arrow</a> below)</p> |
| <a id="md:powering-columnar-in-memory-analytics" class="tsd-anchor"></a><h1><a href="#md:powering-columnar-in-memory-analytics">Powering Columnar In-Memory Analytics</a></h1><p><a href="https://github.com/apache/arrow">Apache Arrow</a> is a columnar memory layout specification for encoding vectors and table-like containers of flat and nested data. The Arrow spec aligns columnar data in memory to minimize cache misses and take advantage of the latest SIMD (Single input multiple data) and GPU operations on modern processors.</p> |
| <p>Apache Arrow is the emerging standard for large in-memory columnar data (<a href="https://spark.apache.org/">Spark</a>, <a href="https://wesmckinney.com/blog/pandas-and-apache-arrow/">Pandas</a>, <a href="https://drill.apache.org/">Drill</a>, <a href="https://www.graphistry.com">Graphistry</a>, ...). By standardizing on a common binary interchange format, big data systems can reduce the costs and friction associated with cross-system communication.</p> |
| <a id="md:get-started" class="tsd-anchor"></a><h1><a href="#md:get-started">Get Started</a></h1><p>Check out our <a href="https://arrow.apache.org/docs/js/">API documentation</a> to learn more about how to use Apache Arrow's JS implementation. You can also learn by example by checking out some of the following resources:</p> |
| <ul> |
| <li><a href="https://github.com/apache/arrow/tree/main/js/test/unit">/js/test/unit</a> - Unit tests for Table and Vector</li> |
| </ul> |
| <a id="md:cookbook" class="tsd-anchor"></a><h2><a href="#md:cookbook">Cookbook</a></h2><a id="md:get-a-table-from-an-arrow-file-on-disk-in-ipc-format" class="tsd-anchor"></a><h3><a href="#md:get-a-table-from-an-arrow-file-on-disk-in-ipc-format">Get a table from an Arrow file on disk (in IPC format)</a></h3><pre><code class="language-js"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">readFileSync</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'fs'</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">tableFromIPC</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'apache-arrow'</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">arrow</span><span class="hl-1"> = </span><span class="hl-6">readFileSync</span><span class="hl-1">(</span><span class="hl-3">'simple.arrow'</span><span class="hl-1">);</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">table</span><span class="hl-1"> = </span><span class="hl-6">tableFromIPC</span><span class="hl-1">(</span><span class="hl-2">arrow</span><span class="hl-1">);</span><br/><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">table</span><span class="hl-1">(</span><span class="hl-2">table</span><span class="hl-1">.</span><span class="hl-6">toArray</span><span class="hl-1">());</span><br/><br/><span class="hl-7">/*</span><br/><span class="hl-7"> foo, bar, baz</span><br/><span class="hl-7"> 1, 1, aa</span><br/><span class="hl-7">null, null, null</span><br/><span class="hl-7"> 3, null, null</span><br/><span class="hl-7"> 4, 4, bbb</span><br/><span class="hl-7"> 5, 5, cccc</span><br/><span class="hl-7">*/</span> |
| </code><button>Copy</button></pre> |
| <a id="md:create-a-table-when-the-arrow-file-is-split-across-buffers" class="tsd-anchor"></a><h3><a href="#md:create-a-table-when-the-arrow-file-is-split-across-buffers">Create a Table when the Arrow file is split across buffers</a></h3><pre><code class="language-js"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">readFileSync</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'fs'</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">tableFromIPC</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'apache-arrow'</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">table</span><span class="hl-1"> = </span><span class="hl-6">tableFromIPC</span><span class="hl-1">([</span><br/><span class="hl-1"> </span><span class="hl-3">'latlong/schema.arrow'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-3">'latlong/records.arrow'</span><br/><span class="hl-1">].</span><span class="hl-6">map</span><span class="hl-1">((</span><span class="hl-2">file</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-6">readFileSync</span><span class="hl-1">(</span><span class="hl-2">file</span><span class="hl-1">)));</span><br/><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">table</span><span class="hl-1">([...</span><span class="hl-2">table</span><span class="hl-1">]);</span><br/><br/><span class="hl-7">/*</span><br/><span class="hl-7"> origin_lat, origin_lon</span><br/><span class="hl-7">35.393089294433594, -97.6007308959961</span><br/><span class="hl-7">35.393089294433594, -97.6007308959961</span><br/><span class="hl-7">35.393089294433594, -97.6007308959961</span><br/><span class="hl-7">29.533695220947266, -98.46977996826172</span><br/><span class="hl-7">29.533695220947266, -98.46977996826172</span><br/><span class="hl-7">*/</span> |
| </code><button>Copy</button></pre> |
| <a id="md:create-a-table-from-javascript-arrays" class="tsd-anchor"></a><h3><a href="#md:create-a-table-from-javascript-arrays">Create a Table from JavaScript arrays</a></h3><pre><code class="language-js"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">tableFromArrays</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'apache-arrow'</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">LENGTH</span><span class="hl-1"> = </span><span class="hl-8">2000</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">rainAmounts</span><span class="hl-1"> = </span><span class="hl-2">Float32Array</span><span class="hl-1">.</span><span class="hl-6">from</span><span class="hl-1">(</span><br/><span class="hl-1"> { </span><span class="hl-2">length:</span><span class="hl-1"> </span><span class="hl-5">LENGTH</span><span class="hl-1"> },</span><br/><span class="hl-1"> () </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-6">Number</span><span class="hl-1">((</span><span class="hl-2">Math</span><span class="hl-1">.</span><span class="hl-6">random</span><span class="hl-1">() * </span><span class="hl-8">20</span><span class="hl-1">).</span><span class="hl-6">toFixed</span><span class="hl-1">(</span><span class="hl-8">1</span><span class="hl-1">)));</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">rainDates</span><span class="hl-1"> = </span><span class="hl-2">Array</span><span class="hl-1">.</span><span class="hl-6">from</span><span class="hl-1">(</span><br/><span class="hl-1"> { </span><span class="hl-2">length:</span><span class="hl-1"> </span><span class="hl-5">LENGTH</span><span class="hl-1"> },</span><br/><span class="hl-1"> (</span><span class="hl-2">_</span><span class="hl-1">, </span><span class="hl-2">i</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Date</span><span class="hl-1">(</span><span class="hl-2">Date</span><span class="hl-1">.</span><span class="hl-6">now</span><span class="hl-1">() - </span><span class="hl-8">1000</span><span class="hl-1"> * </span><span class="hl-8">60</span><span class="hl-1"> * </span><span class="hl-8">60</span><span class="hl-1"> * </span><span class="hl-8">24</span><span class="hl-1"> * </span><span class="hl-2">i</span><span class="hl-1">));</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">rainfall</span><span class="hl-1"> = </span><span class="hl-6">tableFromArrays</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-2">precipitation:</span><span class="hl-1"> </span><span class="hl-2">rainAmounts</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">date:</span><span class="hl-1"> </span><span class="hl-2">rainDates</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">table</span><span class="hl-1">([...</span><span class="hl-2">rainfall</span><span class="hl-1">]);</span> |
| </code><button>Copy</button></pre> |
| <a id="md:load-data-with-fetch" class="tsd-anchor"></a><h3><a href="#md:load-data-with-fetch">Load data with <code>fetch</code></a></h3><pre><code class="language-js"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">tableFromIPC</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">"apache-arrow"</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">table</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-6">tableFromIPC</span><span class="hl-1">(</span><span class="hl-6">fetch</span><span class="hl-1">(</span><span class="hl-3">"/simple.arrow"</span><span class="hl-1">));</span><br/><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">table</span><span class="hl-1">([...</span><span class="hl-2">table</span><span class="hl-1">]);</span> |
| </code><button>Copy</button></pre> |
| <a id="md:vectors-look-like-js-arrays" class="tsd-anchor"></a><h3><a href="#md:vectors-look-like-js-arrays">Vectors look like JS Arrays</a></h3><p>You can create vector from JavaScript typed arrays with <code>makeVector</code> and from JavaScript arrays with <code>vectorFromArray</code>. <code>makeVector</code> is a lot faster and does not require a copy.</p> |
| <pre><code class="language-js"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">makeVector</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">"apache-arrow"</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">LENGTH</span><span class="hl-1"> = </span><span class="hl-8">2000</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">rainAmounts</span><span class="hl-1"> = </span><span class="hl-2">Float32Array</span><span class="hl-1">.</span><span class="hl-6">from</span><span class="hl-1">(</span><br/><span class="hl-1"> { </span><span class="hl-2">length:</span><span class="hl-1"> </span><span class="hl-5">LENGTH</span><span class="hl-1"> },</span><br/><span class="hl-1"> () </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-6">Number</span><span class="hl-1">((</span><span class="hl-2">Math</span><span class="hl-1">.</span><span class="hl-6">random</span><span class="hl-1">() * </span><span class="hl-8">20</span><span class="hl-1">).</span><span class="hl-6">toFixed</span><span class="hl-1">(</span><span class="hl-8">1</span><span class="hl-1">)));</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">vector</span><span class="hl-1"> = </span><span class="hl-6">makeVector</span><span class="hl-1">(</span><span class="hl-2">rainAmounts</span><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">typed</span><span class="hl-1"> = </span><span class="hl-2">vector</span><span class="hl-1">.</span><span class="hl-6">toArray</span><span class="hl-1">()</span><br/><br/><span class="hl-6">assert</span><span class="hl-1">(</span><span class="hl-2">typed</span><span class="hl-1"> </span><span class="hl-4">instanceof</span><span class="hl-1"> </span><span class="hl-9">Float32Array</span><span class="hl-1">);</span><br/><br/><span class="hl-0">for</span><span class="hl-1"> (</span><span class="hl-4">let</span><span class="hl-1"> </span><span class="hl-2">i</span><span class="hl-1"> = -</span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-2">n</span><span class="hl-1"> = </span><span class="hl-2">vector</span><span class="hl-1">.</span><span class="hl-2">length</span><span class="hl-1">; ++</span><span class="hl-2">i</span><span class="hl-1"> < </span><span class="hl-2">n</span><span class="hl-1">;) {</span><br/><span class="hl-1"> </span><span class="hl-6">assert</span><span class="hl-1">(</span><span class="hl-2">vector</span><span class="hl-1">.</span><span class="hl-6">get</span><span class="hl-1">(</span><span class="hl-2">i</span><span class="hl-1">) === </span><span class="hl-2">typed</span><span class="hl-1">[</span><span class="hl-2">i</span><span class="hl-1">]);</span><br/><span class="hl-1">}</span> |
| </code><button>Copy</button></pre> |
| <a id="md:string-vectors" class="tsd-anchor"></a><h3><a href="#md:string-vectors">String vectors</a></h3><p>Strings can be encoded as UTF-8 or dictionary encoded UTF-8. Dictionary encoding encodes repeated values more efficiently. You can create a dictionary encoded string conveniently with <code>vectorFromArray</code> or efficiently with <code>makeVector</code>.</p> |
| <pre><code class="language-js"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">makeVector</span><span class="hl-1">, </span><span class="hl-2">vectorFromArray</span><span class="hl-1">, </span><span class="hl-2">Dictionary</span><span class="hl-1">, </span><span class="hl-2">Uint8</span><span class="hl-1">, </span><span class="hl-2">Utf8</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">"apache-arrow"</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">utf8Vector</span><span class="hl-1"> = </span><span class="hl-6">vectorFromArray</span><span class="hl-1">([</span><span class="hl-3">'foo'</span><span class="hl-1">, </span><span class="hl-3">'bar'</span><span class="hl-1">, </span><span class="hl-3">'baz'</span><span class="hl-1">], </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-2">Utf8</span><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">dictionaryVector1</span><span class="hl-1"> = </span><span class="hl-6">vectorFromArray</span><span class="hl-1">(</span><br/><span class="hl-1"> [</span><span class="hl-3">'foo'</span><span class="hl-1">, </span><span class="hl-3">'bar'</span><span class="hl-1">, </span><span class="hl-3">'baz'</span><span class="hl-1">, </span><span class="hl-3">'foo'</span><span class="hl-1">, </span><span class="hl-3">'bar'</span><span class="hl-1">]</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">dictionaryVector2</span><span class="hl-1"> = </span><span class="hl-6">makeVector</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-2">data:</span><span class="hl-1"> [</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-8">2</span><span class="hl-1">, </span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-8">1</span><span class="hl-1">], </span><span class="hl-7">// indexes into the dictionary</span><br/><span class="hl-1"> </span><span class="hl-2">dictionary:</span><span class="hl-1"> </span><span class="hl-2">utf8Vector</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Dictionary</span><span class="hl-1">(</span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-2">Utf8</span><span class="hl-1">, </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-2">Uint8</span><span class="hl-1">)</span><br/><span class="hl-1">});</span> |
| </code><button>Copy</button></pre> |
| <a id="md:getting-involved" class="tsd-anchor"></a><h1><a href="#md:getting-involved">Getting involved</a></h1><p>See <a href="DEVELOP.md">DEVELOP.md</a></p> |
| <p>Even if you do not plan to contribute to Apache Arrow itself or Arrow |
| integrations in other projects, we'd be happy to have you involved:</p> |
| <ul> |
| <li>Join the mailing list: send an email to |
| <a href="mailto:dev-subscribe@arrow.apache.org">dev-subscribe@arrow.apache.org</a>. Share your ideas and use cases for the |
| project</li> |
| <li>Follow our activity on <a href="https://github.com/apache/arrow/issues">GitHub issues</a></li> |
| <li><a href="https://github.com/apache/arrow/tree/main/format">Learn the format</a></li> |
| <li>Contribute code to one of the reference implementations</li> |
| </ul> |
| <p>We prefer to receive contributions in the form of GitHub pull requests. |
| Please send pull requests against the <a href="https://github.com/apache/arrow">github.com/apache/arrow</a> repository.</p> |
| <p>If you are looking for some ideas on what to contribute, check out the <a href="https://github.com/apache/arrow/issues">GitHub |
| issues</a> for the Apache Arrow project. Comment on the issue and/or contact |
| <a href="https://mail-archives.apache.org/mod_mbox/arrow-dev/">dev@arrow.apache.org</a> |
| with your questions and ideas.</p> |
| <p>If you’d like to report a bug but don’t have time to fix it, you can still post |
| it on GitHub issues, or email the mailing list |
| <a href="https://mail-archives.apache.org/mod_mbox/arrow-dev/">dev@arrow.apache.org</a></p> |
| <a id="md:packaging" class="tsd-anchor"></a><h2><a href="#md:packaging">Packaging</a></h2><p><code>apache-arrow</code> is written in TypeScript, but the project is compiled to multiple JS versions and common module formats.</p> |
| <p>The base <code>apache-arrow</code> package includes all the compilation targets for convenience, but if you're conscientious about your <code>node_modules</code> footprint, we got you.</p> |
| <p>The targets are also published under the <code>@apache-arrow</code> namespace:</p> |
| <pre><code class="language-sh"><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">apache-arrow</span><span class="hl-1"> </span><span class="hl-7"># <-- combined es2015/CommonJS/ESModules/UMD + esnext/UMD</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">@apache-arrow/ts</span><span class="hl-1"> </span><span class="hl-7"># standalone TypeScript package</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">@apache-arrow/es5-cjs</span><span class="hl-1"> </span><span class="hl-7"># standalone es5/CommonJS package</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">@apache-arrow/es5-esm</span><span class="hl-1"> </span><span class="hl-7"># standalone es5/ESModules package</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">@apache-arrow/es5-umd</span><span class="hl-1"> </span><span class="hl-7"># standalone es5/UMD package</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">@apache-arrow/es2015-cjs</span><span class="hl-1"> </span><span class="hl-7"># standalone es2015/CommonJS package</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">@apache-arrow/es2015-esm</span><span class="hl-1"> </span><span class="hl-7"># standalone es2015/ESModules package</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">@apache-arrow/es2015-umd</span><span class="hl-1"> </span><span class="hl-7"># standalone es2015/UMD package</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">@apache-arrow/esnext-cjs</span><span class="hl-1"> </span><span class="hl-7"># standalone esNext/CommonJS package</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">@apache-arrow/esnext-esm</span><span class="hl-1"> </span><span class="hl-7"># standalone esNext/ESModules package</span><br/><span class="hl-6">npm</span><span class="hl-1"> </span><span class="hl-3">install</span><span class="hl-1"> </span><span class="hl-3">@apache-arrow/esnext-umd</span><span class="hl-1"> </span><span class="hl-7"># standalone esNext/UMD package</span> |
| </code><button>Copy</button></pre> |
| <a id="md:why-we-package-like-this" class="tsd-anchor"></a><h3><a href="#md:why-we-package-like-this">Why we package like this</a></h3><p>The JS community is a diverse group with a varied list of target environments and tool chains. Publishing multiple packages accommodates projects of all stripes.</p> |
| <p>If you think we missed a compilation target and it's a blocker for adoption, please open an issue.</p> |
| <a id="md:supported-browsers-and-platforms" class="tsd-anchor"></a><h3><a href="#md:supported-browsers-and-platforms">Supported Browsers and Platforms</a></h3><p>The bundles we compile support moderns browser released in the last 5 years. This includes supported versions of |
| Firefox, Chrome, Edge, and Safari. We do not actively support Internet Explorer. |
| Apache Arrow also works on <a href="https://nodejs.org/en/about/releases/">maintained versions of Node</a>.</p> |
| <a id="md:people" class="tsd-anchor"></a><h1><a href="#md:people">People</a></h1><p>Full list of broader Apache Arrow <a href="https://arrow.apache.org/committers/">committers</a>.</p> |
| <ul> |
| <li>Brian Hulette, <em>committer</em></li> |
| <li>Paul Taylor, <em>committer</em></li> |
| <li>Dominik Moritz, <em>committer</em></li> |
| </ul> |
| <a id="md:powered-by-apache-arrow-in-js" class="tsd-anchor"></a><h1><a href="#md:powered-by-apache-arrow-in-js">Powered By Apache Arrow in JS</a></h1><p>Full list of broader Apache Arrow <a href="https://arrow.apache.org/powered_by/">projects & organizations</a>.</p> |
| <a id="md:open-source-projects" class="tsd-anchor"></a><h2><a href="#md:open-source-projects">Open Source Projects</a></h2><ul> |
| <li><a href="https://arrow.apache.org">Apache Arrow</a> -- Parent project for Powering Columnar In-Memory Analytics, including affiliated open source projects</li> |
| <li><a href="https://github.com/finos/perspective">Perspective</a> -- Perspective is an interactive analytics and data visualization component well-suited for large and/or streaming datasets. Perspective leverages Arrow C++ compiled to WebAssembly.</li> |
| <li><a href="https://github.com/uwdata/falcon">Falcon</a> is a visualization tool for linked interactions across multiple aggregate visualizations of millions or billions of records.</li> |
| <li><a href="https://github.com/vega">Vega</a> is an ecosystem of tools for interactive visualizations on the web. The Vega team implemented an <a href="https://github.com/vega/vega-loader-arrow">Arrow loader</a>.</li> |
| <li><a href="https://github.com/uwdata/arquero">Arquero</a> is a library for query processing and transformation of array-backed data tables.</li> |
| <li><a href="https://github.com/omnisci/mapd-connector">OmniSci</a> is a GPU database. Its JavaScript connector returns Arrow dataframes.</li> |
| </ul> |
| <a id="md:license" class="tsd-anchor"></a><h1><a href="#md:license">License</a></h1><p><a href="https://github.com/apache/arrow/blob/main/LICENSE">Apache 2.0</a></p> |
| </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:apache-arrow-in-js"><span>Apache <wbr/>Arrow in JS</span></a><ul><li><a href="#md:install-apache-arrow-from-npm"><span>Install apache-<wbr/>arrow from NPM</span></a></li></ul><a href="#md:powering-columnar-in-memory-analytics"><span>Powering <wbr/>Columnar <wbr/>In-<wbr/>Memory <wbr/>Analytics</span></a><a href="#md:get-started"><span>Get <wbr/>Started</span></a><ul><li><a href="#md:cookbook"><span>Cookbook</span></a></li><li><ul><li><a href="#md:get-a-table-from-an-arrow-file-on-disk-in-ipc-format"><span>Get a table from an <wbr/>Arrow file on disk (in IPC format)</span></a></li><li><a href="#md:create-a-table-when-the-arrow-file-is-split-across-buffers"><span>Create a <wbr/>Table when the <wbr/>Arrow file is split across buffers</span></a></li><li><a href="#md:create-a-table-from-javascript-arrays"><span>Create a <wbr/>Table from <wbr/>Java<wbr/>Script arrays</span></a></li><li><a href="#md:load-data-with-fetch"><span>Load data with fetch</span></a></li><li><a href="#md:vectors-look-like-js-arrays"><span>Vectors look like JS <wbr/>Arrays</span></a></li><li><a href="#md:string-vectors"><span>String vectors</span></a></li></ul></li></ul><a href="#md:getting-involved"><span>Getting involved</span></a><ul><li><a href="#md:packaging"><span>Packaging</span></a></li><li><ul><li><a href="#md:why-we-package-like-this"><span>Why we package like this</span></a></li><li><a href="#md:supported-browsers-and-platforms"><span>Supported <wbr/>Browsers and <wbr/>Platforms</span></a></li></ul></li></ul><a href="#md:people"><span>People</span></a><a href="#md:powered-by-apache-arrow-in-js"><span>Powered <wbr/>By <wbr/>Apache <wbr/>Arrow in JS</span></a><ul><li><a href="#md:open-source-projects"><span>Open <wbr/>Source <wbr/>Projects</span></a></li></ul><a href="#md:license"><span>License</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>Apache Arrow - v17.0.0-SNAPSHOT</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
