| |
| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" > |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>pyarrow.dataset.FileSystemFactoryOptions — Apache Arrow v2.0.0</title> |
| |
| |
| |
| <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
| |
| |
| |
| |
| |
| |
| |
| <!--[if lt IE 9]> |
| <script src="../../_static/js/html5shiv.min.js"></script> |
| <![endif]--> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/jquery.js"></script> |
| <script src="../../_static/underscore.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../_static/js/theme.js"></script> |
| |
| |
| <link rel="canonical" href="https://arrow.apache.org/docs/python/generated/pyarrow.dataset.FileSystemFactoryOptions.html" /> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="pyarrow.dataset.FileSystemDatasetFactory" href="pyarrow.dataset.FileSystemDatasetFactory.html" /> |
| <link rel="prev" title="pyarrow.dataset.FileSystemDataset" href="pyarrow.dataset.FileSystemDataset.html" /> |
|
|
|
|
| <!-- 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 class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../index.html" class="icon icon-home" alt="Documentation Home"> Apache Arrow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 2.0.0 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <p class="caption"><span class="caption-text">Specifications and Protocols</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/Versioning.html">Format Versioning and Stability</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/Columnar.html">Arrow Columnar Format</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/Flight.html">Arrow Flight RPC</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/Integration.html">Integration Testing</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/CDataInterface.html">The Arrow C data interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/CStreamInterface.html">The Arrow C stream interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../format/Other.html">Other Data Structures</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Libraries</span></p> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../status.html">Implementation Status</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/docs/c_glib/">C/GLib</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../cpp/index.html">C++</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://github.com/apache/arrow/blob/master/csharp/README.md">C#</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://godoc.org/github.com/apache/arrow/go/arrow">Go</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../java/index.html">Java</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/docs/js/">JavaScript</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://github.com/apache/arrow/blob/master/matlab/README.md">MATLAB</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Python</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../install.html">Installing PyArrow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../data.html">Data Types and In-Memory Data Model</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../compute.html">Compute Functions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../ipc.html">Streaming, Serialization, and IPC</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../filesystems.html">Filesystem Interface</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../filesystems_deprecated.html">Filesystem Interface (legacy)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../numpy.html">NumPy Integration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../pandas.html">Pandas Integration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../timestamps.html">Timestamps</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../csv.html">Reading CSV files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../feather.html">Feather File Format</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../json.html">Reading JSON files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../dataset.html">Tabular Datasets</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../cuda.html">CUDA Integration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../extending_types.html">Extending pyarrow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../extending.html">Using pyarrow from C++ and Cython Code</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="../api/datatypes.html">Data Types and Schemas</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../api/arrays.html">Arrays and Scalars</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../api/memory.html">Buffers and Memory</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../api/compute.html">Compute Functions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../api/files.html">Streams and File Access</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../api/tables.html">Tables and Tensors</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../api/ipc.html">Serialization and IPC</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../api/flight.html">Arrow Flight</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../api/formats.html">Tabular File Formats</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../api/filesystems.html">Filesystems</a></li> |
| <li class="toctree-l3 current"><a class="reference internal" href="../api/dataset.html">Dataset</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="../api/dataset.html#factory-functions">Factory functions</a></li> |
| <li class="toctree-l4 current"><a class="reference internal" href="../api/dataset.html#classes">Classes</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../api/plasma.html">Plasma In-Memory Object Store</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../api/cuda.html">CUDA Integration</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../api/misc.html">Miscellaneous</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../benchmarks.html">Benchmarks</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/docs/r/">R</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://github.com/apache/arrow/blob/master/ruby/README.md">Ruby</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://docs.rs/crate/arrow/">Rust</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Development</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../developers/contributing.html">Contributing to Apache Arrow</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../developers/cpp/index.html">C++ Development</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../developers/python.html">Python Development</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../developers/archery.html">Daily Development using Archery</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../developers/crossbow.html">Packaging and Testing with Crossbow</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../developers/docker.html">Running Docker Builds</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../developers/benchmarks.html">Benchmarks</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../index.html">Apache Arrow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../index.html" class="icon icon-home"></a> »</li> |
| |
| <li><a href="../index.html">Python bindings</a> »</li> |
| |
| <li><a href="../api.html">API Reference</a> »</li> |
| |
| <li><a href="../api/dataset.html">Dataset</a> »</li> |
| |
| <li>pyarrow.dataset.FileSystemFactoryOptions</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../_sources/python/generated/pyarrow.dataset.FileSystemFactoryOptions.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="pyarrow-dataset-filesystemfactoryoptions"> |
| <h1>pyarrow.dataset.FileSystemFactoryOptions<a class="headerlink" href="#pyarrow-dataset-filesystemfactoryoptions" title="Permalink to this headline">¶</a></h1> |
| <dl class="py class"> |
| <dt id="pyarrow.dataset.FileSystemFactoryOptions"> |
| <em class="property">class </em><code class="sig-prename descclassname">pyarrow.dataset.</code><code class="sig-name descname">FileSystemFactoryOptions</code><a class="headerlink" href="#pyarrow.dataset.FileSystemFactoryOptions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pyarrow.lib._Weakrefable</span></code></p> |
| <p>Influences the discovery of filesystem paths.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>partition_base_dir</strong> (<em>str</em><em>, </em><em>optional</em>) – For the purposes of applying the partitioning, paths will be |
| stripped of the partition_base_dir. Files not matching the |
| partition_base_dir prefix will be skipped for partitioning discovery. |
| The ignored files will still be part of the Dataset, but will not |
| have partition information.</p></li> |
| <li><p><strong>partitioning</strong> (<em>Partitioning/PartitioningFactory</em><em>, </em><em>optional</em>) – Apply the Partitioning to every discovered Fragment. See Partitioning or |
| PartitioningFactory documentation.</p></li> |
| <li><p><strong>exclude_invalid_files</strong> (<em>bool</em><em>, </em><em>optional</em><em> (</em><em>default True</em><em>)</em>) – If True, invalid files will be excluded (file format specific check). |
| This will incur IO for each files in a serial and single threaded |
| fashion. Disabling this feature will skip the IO, but unsupported |
| files may be present in the Dataset (resulting in an error at scan |
| time).</p></li> |
| <li><p><strong>selector_ignore_prefixes</strong> (<em>list</em><em>, </em><em>optional</em>) – When discovering from a Selector (and not from an explicit file list), |
| ignore files and directories matching any of these prefixes. |
| By default this is [‘.’, ‘_’].</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt id="pyarrow.dataset.FileSystemFactoryOptions.__init__"> |
| <code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.dataset.FileSystemFactoryOptions.__init__" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Initialize self. See help(type(self)) for accurate signature.</p> |
| </dd></dl> |
| |
| <p class="rubric">Methods</p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.dataset.FileSystemFactoryOptions.__init__" title="pyarrow.dataset.FileSystemFactoryOptions.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(*args, **kwargs)</p></td> |
| <td><p>Initialize self.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p class="rubric">Attributes</p> |
| <table class="longtable docutils align-default"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.dataset.FileSystemFactoryOptions.exclude_invalid_files" title="pyarrow.dataset.FileSystemFactoryOptions.exclude_invalid_files"><code class="xref py py-obj docutils literal notranslate"><span class="pre">exclude_invalid_files</span></code></a></p></td> |
| <td><p>Whether to exclude invalid files.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.dataset.FileSystemFactoryOptions.partition_base_dir" title="pyarrow.dataset.FileSystemFactoryOptions.partition_base_dir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">partition_base_dir</span></code></a></p></td> |
| <td><p>Base directory to strip paths before applying the partitioning.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.dataset.FileSystemFactoryOptions.partitioning" title="pyarrow.dataset.FileSystemFactoryOptions.partitioning"><code class="xref py py-obj docutils literal notranslate"><span class="pre">partitioning</span></code></a></p></td> |
| <td><p>Partitioning to apply to discovered files.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.dataset.FileSystemFactoryOptions.partitioning_factory" title="pyarrow.dataset.FileSystemFactoryOptions.partitioning_factory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">partitioning_factory</span></code></a></p></td> |
| <td><p>PartitioningFactory to apply to discovered files and discover a Partitioning.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.dataset.FileSystemFactoryOptions.selector_ignore_prefixes" title="pyarrow.dataset.FileSystemFactoryOptions.selector_ignore_prefixes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">selector_ignore_prefixes</span></code></a></p></td> |
| <td><p>List of prefixes.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="py attribute"> |
| <dt id="pyarrow.dataset.FileSystemFactoryOptions.exclude_invalid_files"> |
| <code class="sig-name descname">exclude_invalid_files</code><a class="headerlink" href="#pyarrow.dataset.FileSystemFactoryOptions.exclude_invalid_files" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Whether to exclude invalid files.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyarrow.dataset.FileSystemFactoryOptions.partition_base_dir"> |
| <code class="sig-name descname">partition_base_dir</code><a class="headerlink" href="#pyarrow.dataset.FileSystemFactoryOptions.partition_base_dir" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Base directory to strip paths before applying the partitioning.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyarrow.dataset.FileSystemFactoryOptions.partitioning"> |
| <code class="sig-name descname">partitioning</code><a class="headerlink" href="#pyarrow.dataset.FileSystemFactoryOptions.partitioning" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Partitioning to apply to discovered files.</p> |
| <p>NOTE: setting this property will overwrite partitioning_factory.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyarrow.dataset.FileSystemFactoryOptions.partitioning_factory"> |
| <code class="sig-name descname">partitioning_factory</code><a class="headerlink" href="#pyarrow.dataset.FileSystemFactoryOptions.partitioning_factory" title="Permalink to this definition">¶</a></dt> |
| <dd><p>PartitioningFactory to apply to discovered files and |
| discover a Partitioning.</p> |
| <p>NOTE: setting this property will overwrite partitioning.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyarrow.dataset.FileSystemFactoryOptions.selector_ignore_prefixes"> |
| <code class="sig-name descname">selector_ignore_prefixes</code><a class="headerlink" href="#pyarrow.dataset.FileSystemFactoryOptions.selector_ignore_prefixes" title="Permalink to this definition">¶</a></dt> |
| <dd><p>List of prefixes. Files matching one of those prefixes will be |
| ignored by the discovery process.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="pyarrow.dataset.FileSystemDatasetFactory.html" class="btn btn-neutral float-right" title="pyarrow.dataset.FileSystemDatasetFactory" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="pyarrow.dataset.FileSystemDataset.html" class="btn btn-neutral float-left" title="pyarrow.dataset.FileSystemDataset" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| © Copyright 2016-2019 Apache Software Foundation |
| |
| </p> |
| </div> |
| |
| |
| |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a |
| |
| <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> |
| |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body> |
| </html> |
