| <!-- Generated by pkgdown: do not edit by hand --> |
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Open a multi-file dataset — open_dataset • Arrow R Package</title> |
| |
| |
| <!-- jquery --> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script> |
| <!-- Bootstrap --> |
| <link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/cosmo/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" /> |
| |
| |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script> |
| |
| <!-- bootstrap-toc --> |
| <link rel="stylesheet" href="../bootstrap-toc.css"> |
| <script src="../bootstrap-toc.js"></script> |
| |
| <!-- Font Awesome icons --> |
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" /> |
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" /> |
| |
| <!-- clipboard.js --> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script> |
| |
| <!-- headroom.js --> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script> |
| |
| <!-- pkgdown --> |
| <link href="../pkgdown.css" rel="stylesheet"> |
| <script src="../pkgdown.js"></script> |
| |
| |
| |
| |
| <script src="../extra.js"></script> |
| |
| <meta property="og:title" content="Open a multi-file dataset — open_dataset" /> |
| <meta property="og:description" content="Arrow Datasets allow you to query against data that has been split across |
| multiple files. This sharding of data may indicate partitioning, which |
| can accelerate queries that only touch some partitions (files). Call |
| open_dataset() to point to a directory of data files and return a |
| Dataset, then use dplyr methods to query it." /> |
| |
| |
| |
| |
| <!-- mathjax --> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script> |
| |
| <!--[if lt IE 9]> |
| <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> |
| <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> |
| <![endif]--> |
| |
| <!-- Matomo -->
|
| <script>
|
| var _paq = window._paq = window._paq || [];
|
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
|
| _paq.push(["setDoNotTrack", true]);
|
| _paq.push(["disableCookies"]);
|
| _paq.push(['trackPageView']);
|
| _paq.push(['enableLinkTracking']);
|
| (function() {
|
| var u="https://analytics.apache.org/";
|
| _paq.push(['setTrackerUrl', u+'matomo.php']);
|
| _paq.push(['setSiteId', '20']);
|
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
|
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
|
| })();
|
| </script>
|
| <!-- End Matomo Code -->
|
|
|
| </head>
|
| |
| <body data-spy="scroll" data-target="#toc"> |
| <div class="container template-reference-topic"> |
| <header> |
| <div class="navbar navbar-default navbar-fixed-top" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <span class="navbar-brand"> |
| <a class="navbar-link" href="../index.html">Arrow R Package</a> |
| <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">4.0.1</span> |
| </span> |
| </div> |
| |
| <div id="navbar" class="navbar-collapse collapse"> |
| <ul class="nav navbar-nav"> |
| <li> |
| <a href="https://arrow.apache.org/">❯❯❯</a> |
| </li> |
| <li> |
| <a href="../articles/arrow.html">Get started</a> |
| </li> |
| <li> |
| <a href="../reference/index.html">Reference</a> |
| </li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false"> |
| Articles |
| |
| <span class="caret"></span> |
| </a> |
| <ul class="dropdown-menu" role="menu"> |
| <li> |
| <a href="../articles/install.html">Installing the Arrow Package on Linux</a> |
| </li> |
| <li> |
| <a href="../articles/dataset.html">Working with Arrow Datasets and dplyr</a> |
| </li> |
| <li> |
| <a href="../articles/fs.html">Working with Cloud Storage (S3)</a> |
| </li> |
| <li> |
| <a href="../articles/python.html">Apache Arrow in Python and R with reticulate</a> |
| </li> |
| <li> |
| <a href="../articles/flight.html">Connecting to Flight RPC Servers</a> |
| </li> |
| <li> |
| <a href="../articles/developing.html">Arrow R Developer Guide</a> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <a href="../news/index.html">Changelog</a> |
| </li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false"> |
| Project docs |
| |
| <span class="caret"></span> |
| </a> |
| <ul class="dropdown-menu" role="menu"> |
| <li> |
| <a href="https://arrow.apache.org/docs/format/README.html">Specification</a> |
| </li> |
| <li> |
| <a href="https://arrow.apache.org/docs/c_glib">C GLib</a> |
| </li> |
| <li> |
| <a href="https://arrow.apache.org/docs/cpp">C++</a> |
| </li> |
| <li> |
| <a href="https://arrow.apache.org/docs/java">Java</a> |
| </li> |
| <li> |
| <a href="https://arrow.apache.org/docs/js">JavaScript</a> |
| </li> |
| <li> |
| <a href="https://arrow.apache.org/docs/python">Python</a> |
| </li> |
| <li> |
| <a href="../index.html">R</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="nav navbar-nav navbar-right"> |
| |
| </ul> |
| |
| </div><!--/.nav-collapse --> |
| </div><!--/.container --> |
| </div><!--/.navbar --> |
| |
| |
| |
| </header> |
| |
| <div class="row"> |
| <div class="col-md-9 contents"> |
| <div class="page-header"> |
| <h1>Open a multi-file dataset</h1> |
| <small class="dont-index">Source: <a href='https://github.com/apache/arrow/blob/master/r/R/dataset.R'><code>R/dataset.R</code></a></small> |
| <div class="hidden name"><code>open_dataset.Rd</code></div> |
| </div> |
| |
| <div class="ref-description"> |
| <p>Arrow Datasets allow you to query against data that has been split across |
| multiple files. This sharding of data may indicate partitioning, which |
| can accelerate queries that only touch some partitions (files). Call |
| <code>open_dataset()</code> to point to a directory of data files and return a |
| <code>Dataset</code>, then use <code>dplyr</code> methods to query it.</p> |
| </div> |
| |
| <pre class="usage"><span class='fu'>open_dataset</span><span class='op'>(</span> |
| <span class='va'>sources</span>, |
| schema <span class='op'>=</span> <span class='cn'>NULL</span>, |
| partitioning <span class='op'>=</span> <span class='fu'><a href='hive_partition.html'>hive_partition</a></span><span class='op'>(</span><span class='op'>)</span>, |
| unify_schemas <span class='op'>=</span> <span class='cn'>NULL</span>, |
| <span class='va'>...</span> |
| <span class='op'>)</span></pre> |
| |
| <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2> |
| <table class="ref-arguments"> |
| <colgroup><col class="name" /><col class="desc" /></colgroup> |
| <tr> |
| <th>sources</th> |
| <td><p>One of:</p><ul> |
| <li><p>a string path or URI to a directory containing data files</p></li> |
| <li><p>a string path or URI to a single file</p></li> |
| <li><p>a character vector of paths or URIs to individual data files</p></li> |
| <li><p>a list of <code>Dataset</code> objects as created by this function</p></li> |
| <li><p>a list of <code>DatasetFactory</code> objects as created by <code><a href='dataset_factory.html'>dataset_factory()</a></code>.</p></li> |
| </ul> |
| |
| <p>When <code>sources</code> is a vector of file URIs, they must all use the same protocol |
| and point to files located in the same file system and having the same |
| format.</p></td> |
| </tr> |
| <tr> |
| <th>schema</th> |
| <td><p><a href='Schema.html'>Schema</a> for the <code>Dataset</code>. If <code>NULL</code> (the default), the schema |
| will be inferred from the data sources.</p></td> |
| </tr> |
| <tr> |
| <th>partitioning</th> |
| <td><p>When <code>sources</code> is a directory path/URI, one of:</p><ul> |
| <li><p>a <code>Schema</code>, in which case the file paths relative to <code>sources</code> will be |
| parsed, and path segments will be matched with the schema fields. For |
| example, <code><a href='Schema.html'>schema(year = int16(), month = int8())</a></code> would create partitions |
| for file paths like <code>"2019/01/file.parquet"</code>, <code>"2019/02/file.parquet"</code>, |
| etc.</p></li> |
| <li><p>a character vector that defines the field names corresponding to those |
| path segments (that is, you're providing the names that would correspond |
| to a <code>Schema</code> but the types will be autodetected)</p></li> |
| <li><p>a <code>HivePartitioning</code> or <code>HivePartitioningFactory</code>, as returned |
| by <code><a href='hive_partition.html'>hive_partition()</a></code> which parses explicit or autodetected fields from |
| Hive-style path segments</p></li> |
| <li><p><code>NULL</code> for no partitioning</p></li> |
| </ul> |
| |
| <p>The default is to autodetect Hive-style partitions. When <code>sources</code> is not a |
| directory path/URI, <code>partitioning</code> is ignored.</p></td> |
| </tr> |
| <tr> |
| <th>unify_schemas</th> |
| <td><p>logical: should all data fragments (files, <code>Dataset</code>s) |
| be scanned in order to create a unified schema from them? If <code>FALSE</code>, only |
| the first fragment will be inspected for its schema. Use this fast path |
| when you know and trust that all fragments have an identical schema. |
| The default is <code>FALSE</code> when creating a dataset from a directory path/URI or |
| vector of file paths/URIs (because there may be many files and scanning may |
| be slow) but <code>TRUE</code> when <code>sources</code> is a list of <code>Dataset</code>s (because there |
| should be few <code>Dataset</code>s in the list and their <code>Schema</code>s are already in |
| memory).</p></td> |
| </tr> |
| <tr> |
| <th>...</th> |
| <td><p>additional arguments passed to <code><a href='dataset_factory.html'>dataset_factory()</a></code> when <code>sources</code> |
| is a directory path/URI or vector of file paths/URIs, otherwise ignored. |
| These may include <code>format</code> to indicate the file format, or other |
| format-specific options.</p></td> |
| </tr> |
| </table> |
| |
| <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2> |
| |
| <p>A <a href='Dataset.html'>Dataset</a> R6 object. Use <code>dplyr</code> methods on it to query the data, |
| or call <code><a href='Scanner.html'>$NewScan()</a></code> to construct a query directly.</p> |
| <h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2> |
| |
| <div class='dont-index'><p><code><a href='../articles/dataset.html'>vignette("dataset", package = "arrow")</a></code></p></div> |
| |
| </div> |
| <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar"> |
| <nav id="toc" data-toggle="toc" class="sticky-top"> |
| <h2 data-toc-skip>Contents</h2> |
| </nav> |
| </div> |
| </div> |
| |
| |
| <footer> |
| <div class="copyright"> |
| <p>Developed by Neal Richardson, Ian Cook, Jonathan Keane, Romain François, Jeroen Ooms, Apache Arrow.</p> |
| </div> |
| |
| <div class="pkgdown"> |
| <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p> |
| </div> |
| |
| </footer> |
| </div> |
| |
| |
| |
| |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script> </body> |
| </html> |
| |
| |