| <!doctype html> |
| <html class="default no-js"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <title>Apache Arrow</title> |
| <meta name="description" content="Documentation for Apache Arrow"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <link rel="stylesheet" href="assets/css/main.css"> |
| <script async src="assets/js/search.js" id="search-script"></script> |
| </head> |
| <body> |
| <header> |
| <div class="tsd-page-toolbar"> |
| <div class="container"> |
| <div class="table-wrap"> |
| <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base="."> |
| <div class="field"> |
| <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> |
| <input id="tsd-search-field" type="text" /> |
| </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</a> |
| </div> |
| <div class="table-cell" id="tsd-widgets"> |
| <div id="tsd-filter"> |
| <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> |
| <div class="tsd-filter-group"> |
| <div class="tsd-select" id="tsd-filter-visibility"> |
| <span class="tsd-select-label">All</span> |
| <ul class="tsd-select-list"> |
| <li data-value="public">Public</li> |
| <li data-value="protected">Public/Protected</li> |
| <li data-value="private" class="selected">All</li> |
| </ul> |
| </div> |
| <input type="checkbox" id="tsd-filter-inherited" checked /> |
| <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> |
| </div> |
| </div> |
| <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="tsd-page-title"> |
| <div class="container"> |
| <h1>Apache Arrow</h1> |
| </div> |
| </div> |
| </header> |
| <div class="container container-main"> |
| <div class="row"> |
| <div class="col-8 col-content"> |
| <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 href="#apache-arrow-in-js" id="apache-arrow-in-js" style="color: inherit; text-decoration: none;"> |
| <h1><a href="https://github.com/apache/arrow">Apache Arrow</a> in JS</h1> |
| </a> |
| <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 href="#install-apache-arrow-from-npm" id="install-apache-arrow-from-npm" style="color: inherit; text-decoration: none;"> |
| <h2>Install <code>apache-arrow</code> from NPM</h2> |
| </a> |
| <p><code>npm install apache-arrow</code> or <code>yarn add apache-arrow</code></p> |
| <p>(read about how we <a href="#packaging">package apache-arrow</a> below)</p> |
| <a href="#powering-columnar-in-memory-analytics" id="powering-columnar-in-memory-analytics" style="color: inherit; text-decoration: none;"> |
| <h1>Powering Columnar In-Memory Analytics</h1> |
| </a> |
| <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 href="#get-started" id="get-started" style="color: inherit; text-decoration: none;"> |
| <h1>Get Started</h1> |
| </a> |
| <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://beta.observablehq.com/@theneuralbit/introduction-to-apache-arrow">Observable: Introduction to Apache Arrow</a></li> |
| <li><a href="https://beta.observablehq.com/@lmeyerov/manipulating-flat-arrays-arrow-style">Observable: Manipulating flat arrays arrow-style</a></li> |
| <li><a href="https://observablehq.com/@lmeyerov/rich-data-types-in-apache-arrow-js-efficient-data-tables-wit">Observable: Rich columnar data tables - Dictionary-encoded strings, 64bit ints, and nested structs</a></li> |
| <li><a href="https://github.com/apache/arrow/tree/master/js/test/unit">/js/test/unit</a> - Unit tests for Table and Vector</li> |
| </ul> |
| <a href="#cookbook" id="cookbook" style="color: inherit; text-decoration: none;"> |
| <h2>Cookbook</h2> |
| </a> |
| <a href="#get-a-table-from-an-arrow-file-on-disk-in-ipc-format" id="get-a-table-from-an-arrow-file-on-disk-in-ipc-format" style="color: inherit; text-decoration: none;"> |
| <h3>Get a table from an Arrow file on disk (in IPC format)</h3> |
| </a> |
| <pre><code class="language-js"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">readFileSync</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'fs'</span><span style="color: #000000">;</span> |
| <span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Table</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'apache-arrow'</span><span style="color: #000000">;</span> |
| |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">arrow</span><span style="color: #000000"> = </span><span style="color: #795E26">readFileSync</span><span style="color: #000000">(</span><span style="color: #A31515">'simple.arrow'</span><span style="color: #000000">);</span> |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">table</span><span style="color: #000000"> = </span><span style="color: #001080">Table</span><span style="color: #000000">.</span><span style="color: #795E26">from</span><span style="color: #000000">([</span><span style="color: #001080">arrow</span><span style="color: #000000">]);</span> |
| |
| <span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">table</span><span style="color: #000000">.</span><span style="color: #795E26">toString</span><span style="color: #000000">());</span> |
| |
| <span style="color: #008000">/*</span> |
| <span style="color: #008000"> foo, bar, baz</span> |
| <span style="color: #008000"> 1, 1, aa</span> |
| <span style="color: #008000">null, null, null</span> |
| <span style="color: #008000"> 3, null, null</span> |
| <span style="color: #008000"> 4, 4, bbb</span> |
| <span style="color: #008000"> 5, 5, cccc</span> |
| <span style="color: #008000">*/</span> |
| </code></pre> |
| <a href="#create-a-table-when-the-arrow-file-is-split-across-buffers" id="create-a-table-when-the-arrow-file-is-split-across-buffers" style="color: inherit; text-decoration: none;"> |
| <h3>Create a Table when the Arrow file is split across buffers</h3> |
| </a> |
| <pre><code class="language-js"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">readFileSync</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'fs'</span><span style="color: #000000">;</span> |
| <span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Table</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'apache-arrow'</span><span style="color: #000000">;</span> |
| |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">table</span><span style="color: #000000"> = </span><span style="color: #001080">Table</span><span style="color: #000000">.</span><span style="color: #795E26">from</span><span style="color: #000000">([</span> |
| <span style="color: #000000"> </span><span style="color: #A31515">'latlong/schema.arrow'</span><span style="color: #000000">,</span> |
| <span style="color: #000000"> </span><span style="color: #A31515">'latlong/records.arrow'</span> |
| <span style="color: #000000">].</span><span style="color: #795E26">map</span><span style="color: #000000">((</span><span style="color: #001080">file</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span><span style="color: #000000"> </span><span style="color: #795E26">readFileSync</span><span style="color: #000000">(</span><span style="color: #001080">file</span><span style="color: #000000">)));</span> |
| |
| <span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">table</span><span style="color: #000000">.</span><span style="color: #795E26">toString</span><span style="color: #000000">());</span> |
| |
| <span style="color: #008000">/*</span> |
| <span style="color: #008000"> origin_lat, origin_lon</span> |
| <span style="color: #008000">35.393089294433594, -97.6007308959961</span> |
| <span style="color: #008000">35.393089294433594, -97.6007308959961</span> |
| <span style="color: #008000">35.393089294433594, -97.6007308959961</span> |
| <span style="color: #008000">29.533695220947266, -98.46977996826172</span> |
| <span style="color: #008000">29.533695220947266, -98.46977996826172</span> |
| <span style="color: #008000">*/</span> |
| </code></pre> |
| <a href="#create-a-table-from-javascript-arrays" id="create-a-table-from-javascript-arrays" style="color: inherit; text-decoration: none;"> |
| <h3>Create a Table from JavaScript arrays</h3> |
| </a> |
| <pre><code class="language-js"><span style="color: #AF00DB">import</span><span style="color: #000000"> {</span> |
| <span style="color: #000000"> </span><span style="color: #001080">Table</span><span style="color: #000000">,</span> |
| <span style="color: #000000"> </span><span style="color: #001080">FloatVector</span><span style="color: #000000">,</span> |
| <span style="color: #000000"> </span><span style="color: #001080">DateVector</span> |
| <span style="color: #000000">} </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'apache-arrow'</span><span style="color: #000000">;</span> |
| |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">LENGTH</span><span style="color: #000000"> = </span><span style="color: #098658">2000</span><span style="color: #000000">;</span> |
| |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">rainAmounts</span><span style="color: #000000"> = </span><span style="color: #267F99">Float32Array</span><span style="color: #000000">.</span><span style="color: #795E26">from</span><span style="color: #000000">(</span> |
| <span style="color: #000000"> { </span><span style="color: #001080">length:</span><span style="color: #000000"> </span><span style="color: #0070C1">LENGTH</span><span style="color: #000000"> },</span> |
| <span style="color: #000000"> () </span><span style="color: #0000FF">=></span><span style="color: #000000"> </span><span style="color: #267F99">Number</span><span style="color: #000000">((</span><span style="color: #267F99">Math</span><span style="color: #000000">.</span><span style="color: #795E26">random</span><span style="color: #000000">() * </span><span style="color: #098658">20</span><span style="color: #000000">).</span><span style="color: #795E26">toFixed</span><span style="color: #000000">(</span><span style="color: #098658">1</span><span style="color: #000000">)));</span> |
| |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">rainDates</span><span style="color: #000000"> = </span><span style="color: #267F99">Array</span><span style="color: #000000">.</span><span style="color: #795E26">from</span><span style="color: #000000">(</span> |
| <span style="color: #000000"> { </span><span style="color: #001080">length:</span><span style="color: #000000"> </span><span style="color: #0070C1">LENGTH</span><span style="color: #000000"> },</span> |
| <span style="color: #000000"> (</span><span style="color: #001080">_</span><span style="color: #000000">, </span><span style="color: #001080">i</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span><span style="color: #000000"> </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #267F99">Date</span><span style="color: #000000">(</span><span style="color: #267F99">Date</span><span style="color: #000000">.</span><span style="color: #795E26">now</span><span style="color: #000000">() - </span><span style="color: #098658">1000</span><span style="color: #000000"> * </span><span style="color: #098658">60</span><span style="color: #000000"> * </span><span style="color: #098658">60</span><span style="color: #000000"> * </span><span style="color: #098658">24</span><span style="color: #000000"> * </span><span style="color: #001080">i</span><span style="color: #000000">));</span> |
| |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">rainfall</span><span style="color: #000000"> = </span><span style="color: #001080">Table</span><span style="color: #000000">.</span><span style="color: #795E26">new</span><span style="color: #000000">(</span> |
| <span style="color: #000000"> [</span><span style="color: #001080">FloatVector</span><span style="color: #000000">.</span><span style="color: #795E26">from</span><span style="color: #000000">(</span><span style="color: #001080">rainAmounts</span><span style="color: #000000">), </span><span style="color: #001080">DateVector</span><span style="color: #000000">.</span><span style="color: #795E26">from</span><span style="color: #000000">(</span><span style="color: #001080">rainDates</span><span style="color: #000000">)],</span> |
| <span style="color: #000000"> [</span><span style="color: #A31515">'precipitation'</span><span style="color: #000000">, </span><span style="color: #A31515">'date'</span><span style="color: #000000">]</span> |
| <span style="color: #000000">);</span> |
| </code></pre> |
| <a href="#load-data-with-fetch" id="load-data-with-fetch" style="color: inherit; text-decoration: none;"> |
| <h3>Load data with <code>fetch</code></h3> |
| </a> |
| <pre><code class="language-js"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Table</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">"apache-arrow"</span><span style="color: #000000">;</span> |
| |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">table</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">Table</span><span style="color: #000000">.</span><span style="color: #795E26">from</span><span style="color: #000000">(</span><span style="color: #795E26">fetch</span><span style="color: #000000">(</span><span style="color: #A31515">"/simple.arrow"</span><span style="color: #000000">));</span> |
| <span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">table</span><span style="color: #000000">.</span><span style="color: #795E26">toString</span><span style="color: #000000">());</span> |
| |
| </code></pre> |
| <a href="#columns-look-like-js-arrays" id="columns-look-like-js-arrays" style="color: inherit; text-decoration: none;"> |
| <h3>Columns look like JS Arrays</h3> |
| </a> |
| <pre><code class="language-js"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">readFileSync</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'fs'</span><span style="color: #000000">;</span> |
| <span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Table</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'apache-arrow'</span><span style="color: #000000">;</span> |
| |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">table</span><span style="color: #000000"> = </span><span style="color: #001080">Table</span><span style="color: #000000">.</span><span style="color: #795E26">from</span><span style="color: #000000">([</span> |
| <span style="color: #000000"> </span><span style="color: #A31515">'latlong/schema.arrow'</span><span style="color: #000000">,</span> |
| <span style="color: #000000"> </span><span style="color: #A31515">'latlong/records.arrow'</span> |
| <span style="color: #000000">].</span><span style="color: #795E26">map</span><span style="color: #000000">(</span><span style="color: #001080">readFileSync</span><span style="color: #000000">));</span> |
| |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">column</span><span style="color: #000000"> = </span><span style="color: #001080">table</span><span style="color: #000000">.</span><span style="color: #795E26">getColumn</span><span style="color: #000000">(</span><span style="color: #A31515">'origin_lat'</span><span style="color: #000000">);</span> |
| |
| <span style="color: #008000">// Copy the data into a TypedArray</span> |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">typed</span><span style="color: #000000"> = </span><span style="color: #001080">column</span><span style="color: #000000">.</span><span style="color: #795E26">toArray</span><span style="color: #000000">();</span> |
| <span style="color: #795E26">assert</span><span style="color: #000000">(</span><span style="color: #001080">typed</span><span style="color: #000000"> </span><span style="color: #0000FF">instanceof</span><span style="color: #000000"> </span><span style="color: #267F99">Float32Array</span><span style="color: #000000">);</span> |
| |
| <span style="color: #AF00DB">for</span><span style="color: #000000"> (</span><span style="color: #0000FF">let</span><span style="color: #000000"> </span><span style="color: #001080">i</span><span style="color: #000000"> = -</span><span style="color: #098658">1</span><span style="color: #000000">, </span><span style="color: #001080">n</span><span style="color: #000000"> = </span><span style="color: #001080">column</span><span style="color: #000000">.</span><span style="color: #001080">length</span><span style="color: #000000">; ++</span><span style="color: #001080">i</span><span style="color: #000000"> < </span><span style="color: #001080">n</span><span style="color: #000000">;) {</span> |
| <span style="color: #000000"> </span><span style="color: #795E26">assert</span><span style="color: #000000">(</span><span style="color: #001080">column</span><span style="color: #000000">.</span><span style="color: #795E26">get</span><span style="color: #000000">(</span><span style="color: #001080">i</span><span style="color: #000000">) === </span><span style="color: #001080">typed</span><span style="color: #000000">[</span><span style="color: #001080">i</span><span style="color: #000000">]);</span> |
| <span style="color: #000000">}</span> |
| </code></pre> |
| <a href="#usage-with-mapd-core" id="usage-with-mapd-core" style="color: inherit; text-decoration: none;"> |
| <h3>Usage with MapD Core</h3> |
| </a> |
| <pre><code class="language-js"><span style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #001080">MapD</span><span style="color: #000000"> </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'rxjs-mapd'</span><span style="color: #000000">;</span> |
| <span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Table</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'apache-arrow'</span><span style="color: #000000">;</span> |
| |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">port</span><span style="color: #000000"> = </span><span style="color: #098658">9091</span><span style="color: #000000">;</span> |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">host</span><span style="color: #000000"> = </span><span style="color: #A31515">`localhost`</span><span style="color: #000000">;</span> |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">db</span><span style="color: #000000"> = </span><span style="color: #A31515">`mapd`</span><span style="color: #000000">;</span> |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">user</span><span style="color: #000000"> = </span><span style="color: #A31515">`mapd`</span><span style="color: #000000">;</span> |
| <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">password</span><span style="color: #000000"> = </span><span style="color: #A31515">`HyperInteractive`</span><span style="color: #000000">;</span> |
| |
| <span style="color: #001080">MapD</span><span style="color: #000000">.</span><span style="color: #795E26">open</span><span style="color: #000000">(</span><span style="color: #001080">host</span><span style="color: #000000">, </span><span style="color: #001080">port</span><span style="color: #000000">)</span> |
| <span style="color: #000000"> .</span><span style="color: #795E26">connect</span><span style="color: #000000">(</span><span style="color: #001080">db</span><span style="color: #000000">, </span><span style="color: #001080">user</span><span style="color: #000000">, </span><span style="color: #001080">password</span><span style="color: #000000">)</span> |
| <span style="color: #000000"> .</span><span style="color: #795E26">flatMap</span><span style="color: #000000">((</span><span style="color: #001080">session</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span> |
| <span style="color: #000000"> </span><span style="color: #008000">// queryDF returns Arrow buffers</span> |
| <span style="color: #000000"> </span><span style="color: #001080">session</span><span style="color: #000000">.</span><span style="color: #795E26">queryDF</span><span style="color: #000000">(</span><span style="color: #A31515">`</span> |
| <span style="color: #A31515"> SELECT origin_city</span> |
| <span style="color: #A31515"> FROM flights</span> |
| <span style="color: #A31515"> WHERE dest_city ILIKE 'dallas'</span> |
| <span style="color: #A31515"> LIMIT 5`</span> |
| <span style="color: #000000"> ).</span><span style="color: #795E26">disconnect</span><span style="color: #000000">()</span> |
| <span style="color: #000000"> )</span> |
| <span style="color: #000000"> .</span><span style="color: #795E26">map</span><span style="color: #000000">(([</span><span style="color: #001080">schema</span><span style="color: #000000">, </span><span style="color: #001080">records</span><span style="color: #000000">]) </span><span style="color: #0000FF">=></span> |
| <span style="color: #000000"> </span><span style="color: #008000">// Create Arrow Table from results</span> |
| <span style="color: #000000"> </span><span style="color: #001080">Table</span><span style="color: #000000">.</span><span style="color: #795E26">from</span><span style="color: #000000">([</span><span style="color: #001080">schema</span><span style="color: #000000">, </span><span style="color: #001080">records</span><span style="color: #000000">]))</span> |
| <span style="color: #000000"> .</span><span style="color: #795E26">map</span><span style="color: #000000">((</span><span style="color: #001080">table</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span> |
| <span style="color: #000000"> </span><span style="color: #008000">// Stringify the table to CSV with row numbers</span> |
| <span style="color: #000000"> </span><span style="color: #001080">table</span><span style="color: #000000">.</span><span style="color: #795E26">toString</span><span style="color: #000000">({ </span><span style="color: #001080">index:</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span><span style="color: #000000"> }))</span> |
| <span style="color: #000000"> .</span><span style="color: #795E26">subscribe</span><span style="color: #000000">((</span><span style="color: #001080">csvStr</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span> |
| <span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">csvStr</span><span style="color: #000000">));</span> |
| <span style="color: #008000">/*</span> |
| <span style="color: #008000">Index, origin_city</span> |
| <span style="color: #008000"> 0, Oklahoma City</span> |
| <span style="color: #008000"> 1, Oklahoma City</span> |
| <span style="color: #008000"> 2, Oklahoma City</span> |
| <span style="color: #008000"> 3, San Antonio</span> |
| <span style="color: #008000"> 4, San Antonio</span> |
| <span style="color: #008000">*/</span> |
| </code></pre> |
| <a href="#getting-involved" id="getting-involved" style="color: inherit; text-decoration: none;"> |
| <h1>Getting involved</h1> |
| </a> |
| <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><a href="https://issues.apache.org/jira/browse/ARROW">Follow our activity on JIRA</a></li> |
| <li><a href="https://github.com/apache/arrow/tree/master/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://issues.apache.org/jira/browse/ARROW">JIRA |
| 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 JIRA, or email the mailing list |
| <a href="https://mail-archives.apache.org/mod_mbox/arrow-dev/">dev@arrow.apache.org</a></p> |
| <a href="#packaging" id="packaging" style="color: inherit; text-decoration: none;"> |
| <h2>Packaging</h2> |
| </a> |
| <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 style="color: #000000">npm install apache-arrow </span><span style="color: #008000"># <-- combined es2015/UMD + esnext/CommonJS/ESModules/UMD</span> |
| <span style="color: #000000">npm install @apache-arrow/ts </span><span style="color: #008000"># standalone TypeScript package</span> |
| <span style="color: #000000">npm install @apache-arrow/es5-cjs </span><span style="color: #008000"># standalone es5/CommonJS package</span> |
| <span style="color: #000000">npm install @apache-arrow/es5-esm </span><span style="color: #008000"># standalone es5/ESModules package</span> |
| <span style="color: #000000">npm install @apache-arrow/es5-umd </span><span style="color: #008000"># standalone es5/UMD package</span> |
| <span style="color: #000000">npm install @apache-arrow/es2015-cjs </span><span style="color: #008000"># standalone es2015/CommonJS package</span> |
| <span style="color: #000000">npm install @apache-arrow/es2015-esm </span><span style="color: #008000"># standalone es2015/ESModules package</span> |
| <span style="color: #000000">npm install @apache-arrow/es2015-umd </span><span style="color: #008000"># standalone es2015/UMD package</span> |
| <span style="color: #000000">npm install @apache-arrow/esnext-cjs </span><span style="color: #008000"># standalone esNext/CommonJS package</span> |
| <span style="color: #000000">npm install @apache-arrow/esnext-esm </span><span style="color: #008000"># standalone esNext/ESModules package</span> |
| <span style="color: #000000">npm install @apache-arrow/esnext-umd </span><span style="color: #008000"># standalone esNext/UMD package</span> |
| </code></pre> |
| <a href="#why-we-package-like-this" id="why-we-package-like-this" style="color: inherit; text-decoration: none;"> |
| <h3>Why we package like this</h3> |
| </a> |
| <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 href="#people" id="people" style="color: inherit; text-decoration: none;"> |
| <h1>People</h1> |
| </a> |
| <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, Graphistry, Inc., <em>committer</em></li> |
| </ul> |
| <a href="#powered-by-apache-arrow-in-js" id="powered-by-apache-arrow-in-js" style="color: inherit; text-decoration: none;"> |
| <h1>Powered By Apache Arrow in JS</h1> |
| </a> |
| <p>Full list of broader Apache Arrow <a href="https://arrow.apache.org/powered_by/">projects & organizations</a>.</p> |
| <a href="#open-source-projects" id="open-source-projects" style="color: inherit; text-decoration: none;"> |
| <h2>Open Source Projects</h2> |
| </a> |
| <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/graphistry/rxjs-mapd">rxjs-mapd</a> -- A MapD Core node-driver that returns query results as Arrow columns</li> |
| <li><a href="https://github.com/jpmorganchase/perspective">Perspective</a> -- Perspective is a streaming data visualization engine by J.P. Morgan for JavaScript for building real-time & user-configurable analytics entirely in the browser.</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> |
| </ul> |
| <a href="#companies-amp-organizations" id="companies-amp-organizations" style="color: inherit; text-decoration: none;"> |
| <h2>Companies & Organizations</h2> |
| </a> |
| <ul> |
| <li><a href="https://www.ccri.com/">CCRi</a> -- Commonwealth Computer Research Inc, or CCRi, is a Central Virginia based data science and software engineering company</li> |
| <li><a href="https://gpuopenanalytics.com/">GOAI</a> -- GPU Open Analytics Initiative standardizes on Arrow as part of creating common data frameworks that enable developers and statistical researchers to accelerate data science on GPUs</li> |
| <li><a href="https://www.graphistry.com/">Graphistry, Inc.</a> - An end-to-end GPU accelerated visual investigation platform used by teams for security, anti-fraud, and related investigations. Graphistry uses Arrow in its NodeJS GPU backend and client libraries, and is an early contributing member to GOAI and Arrow[JS] working to bring these technologies to the enterprise.</li> |
| </ul> |
| <a href="#license" id="license" style="color: inherit; text-decoration: none;"> |
| <h1>License</h1> |
| </a> |
| <p><a href="https://github.com/apache/arrow/blob/master/LICENSE">Apache 2.0</a></p> |
| </div> |
| </div> |
| <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> |
| <nav class="tsd-navigation primary"> |
| <ul> |
| <li class=" "> |
| <a href="modules.html">Modules</a> |
| </li> |
| <li class=" tsd-kind-module"> |
| <a href="modules/arrow_dom.html">Arrow.dom</a> |
| </li> |
| <li class=" tsd-kind-module"> |
| <a href="modules/arrow_node.html">Arrow.node</a> |
| </li> |
| </ul> |
| </nav> |
| <nav class="tsd-navigation secondary menu-sticky"> |
| <ul class="before-current"> |
| </ul> |
| </nav> |
| </div> |
| </div> |
| </div> |
| <footer class="with-border-bottom"> |
| <div class="container"> |
| <h2>Legend</h2> |
| <div class="tsd-legend-group"> |
| <ul class="tsd-legend"> |
| <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> |
| <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> |
| </ul> |
| <ul class="tsd-legend"> |
| <li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li> |
| </ul> |
| <ul class="tsd-legend"> |
| <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> |
| </ul> |
| </div> |
| </div> |
| </footer> |
| <div class="container tsd-generator"> |
| <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> |
| </div> |
| <div class="overlay"></div> |
| <script src="assets/js/main.js"></script> |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body> |
| </html> |