| |
| |
| |
| <!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.LocalFileSystem — 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.LocalFileSystem.html" /> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="Tables and Tensors" href="../api/tables.html" /> |
| <link rel="prev" title="pyarrow.CompressedOutputStream" href="pyarrow.CompressedOutputStream.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 current"><a class="reference internal" href="../api/files.html">Streams and File Access</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="../api/files.html#factory-functions">Factory Functions</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../api/files.html#stream-classes">Stream Classes</a></li> |
| <li class="toctree-l4 current"><a class="reference internal" href="../api/files.html#file-systems">File Systems</a></li> |
| </ul> |
| </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"><a class="reference internal" href="../api/dataset.html">Dataset</a></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/files.html">Streams and File Access</a> »</li> |
| |
| <li>pyarrow.LocalFileSystem</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../_sources/python/generated/pyarrow.LocalFileSystem.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-localfilesystem"> |
| <h1>pyarrow.LocalFileSystem<a class="headerlink" href="#pyarrow-localfilesystem" title="Permalink to this headline">¶</a></h1> |
| <dl class="py class"> |
| <dt id="pyarrow.LocalFileSystem"> |
| <em class="property">class </em><code class="sig-prename descclassname">pyarrow.</code><code class="sig-name descname">LocalFileSystem</code><a class="reference internal" href="../../_modules/pyarrow/filesystem.html#LocalFileSystem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pyarrow.filesystem.FileSystem</span></code></p> |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.__init__"> |
| <code class="sig-name descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyarrow/filesystem.html#LocalFileSystem.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.__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.LocalFileSystem.__init__" title="pyarrow.LocalFileSystem.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>()</p></td> |
| <td><p>Initialize self.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.cat" title="pyarrow.LocalFileSystem.cat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cat</span></code></a>(path)</p></td> |
| <td><p>Return contents of file as a bytes object.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.delete" title="pyarrow.LocalFileSystem.delete"><code class="xref py py-obj docutils literal notranslate"><span class="pre">delete</span></code></a>(path[, recursive])</p></td> |
| <td><p>Delete the indicated file or directory.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.disk_usage" title="pyarrow.LocalFileSystem.disk_usage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">disk_usage</span></code></a>(path)</p></td> |
| <td><p>Compute bytes used by all contents under indicated path in file tree.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.exists" title="pyarrow.LocalFileSystem.exists"><code class="xref py py-obj docutils literal notranslate"><span class="pre">exists</span></code></a>(path)</p></td> |
| <td><p>Return True if path exists.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.get_instance" title="pyarrow.LocalFileSystem.get_instance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_instance</span></code></a>()</p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.isdir" title="pyarrow.LocalFileSystem.isdir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isdir</span></code></a>(path)</p></td> |
| <td><p>Return True if path is a directory.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.isfile" title="pyarrow.LocalFileSystem.isfile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isfile</span></code></a>(path)</p></td> |
| <td><p>Return True if path is a file.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.ls" title="pyarrow.LocalFileSystem.ls"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ls</span></code></a>(path)</p></td> |
| <td><p>Return list of file paths.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.mkdir" title="pyarrow.LocalFileSystem.mkdir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mkdir</span></code></a>(path[, create_parents])</p></td> |
| <td><p>Create a directory.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.mv" title="pyarrow.LocalFileSystem.mv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mv</span></code></a>(path, new_path)</p></td> |
| <td><p>Alias for FileSystem.rename.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.open" title="pyarrow.LocalFileSystem.open"><code class="xref py py-obj docutils literal notranslate"><span class="pre">open</span></code></a>(path[, mode])</p></td> |
| <td><p>Open file for reading or writing.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.read_parquet" title="pyarrow.LocalFileSystem.read_parquet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_parquet</span></code></a>(path[, columns, metadata, …])</p></td> |
| <td><p>Read Parquet data from path in file system.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.rename" title="pyarrow.LocalFileSystem.rename"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rename</span></code></a>(path, new_path)</p></td> |
| <td><p>Rename file, like UNIX mv command.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.rm" title="pyarrow.LocalFileSystem.rm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rm</span></code></a>(path[, recursive])</p></td> |
| <td><p>Alias for FileSystem.delete.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.stat" title="pyarrow.LocalFileSystem.stat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stat</span></code></a>(path)</p></td> |
| <td><p>Information about a filesystem entry.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.LocalFileSystem.walk" title="pyarrow.LocalFileSystem.walk"><code class="xref py py-obj docutils literal notranslate"><span class="pre">walk</span></code></a>(path)</p></td> |
| <td><p>Directory tree generator, see os.walk.</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.LocalFileSystem.pathsep" title="pyarrow.LocalFileSystem.pathsep"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pathsep</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.cat"> |
| <code class="sig-name descname">cat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.cat" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return contents of file as a bytes object.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>path</strong> (<em>str</em>) – File path to read content from.</p> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><strong>contents</strong> (<em>bytes</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.delete"> |
| <code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">recursive</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.delete" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Delete the indicated file or directory.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>path</strong> (<em>str</em>) – Path to delete.</p></li> |
| <li><p><strong>recursive</strong> (<em>bool</em><em>, </em><em>default False</em>) – If True, also delete child paths for directories.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.disk_usage"> |
| <code class="sig-name descname">disk_usage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.disk_usage" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Compute bytes used by all contents under indicated path in file tree.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>path</strong> (<em>str</em>) – Can be a file path or directory.</p> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><strong>usage</strong> (<em>int</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.exists"> |
| <code class="sig-name descname">exists</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyarrow/filesystem.html#LocalFileSystem.exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.exists" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return True if path exists.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>path</strong> (<em>str</em>) – Path to check.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.get_instance"> |
| <em class="property">classmethod </em><code class="sig-name descname">get_instance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyarrow/filesystem.html#LocalFileSystem.get_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.get_instance" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.isdir"> |
| <code class="sig-name descname">isdir</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyarrow/filesystem.html#LocalFileSystem.isdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.isdir" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return True if path is a directory.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>path</strong> (<em>str</em>) – Path to check.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.isfile"> |
| <code class="sig-name descname">isfile</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyarrow/filesystem.html#LocalFileSystem.isfile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.isfile" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return True if path is a file.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>path</strong> (<em>str</em>) – Path to check.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.ls"> |
| <code class="sig-name descname">ls</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyarrow/filesystem.html#LocalFileSystem.ls"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.ls" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return list of file paths.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>path</strong> (<em>str</em>) – Directory to list contents from.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.mkdir"> |
| <code class="sig-name descname">mkdir</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">create_parents</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyarrow/filesystem.html#LocalFileSystem.mkdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.mkdir" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Create a directory.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>path</strong> (<em>str</em>) – Path to the directory.</p></li> |
| <li><p><strong>create_parents</strong> (<em>bool</em><em>, </em><em>default True</em>) – If the parent directories don’t exists create them as well.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.mv"> |
| <code class="sig-name descname">mv</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">new_path</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.mv" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Alias for FileSystem.rename.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.open"> |
| <code class="sig-name descname">open</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">mode</span><span class="o">=</span><span class="default_value">'rb'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyarrow/filesystem.html#LocalFileSystem.open"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.open" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Open file for reading or writing.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.pathsep"> |
| <em class="property">property </em><code class="sig-name descname">pathsep</code><a class="headerlink" href="#pyarrow.LocalFileSystem.pathsep" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.read_parquet"> |
| <code class="sig-name descname">read_parquet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">columns</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metadata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">schema</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">use_threads</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">use_pandas_metadata</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.read_parquet" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Read Parquet data from path in file system. Can read from a single file |
| or a directory of files.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>path</strong> (<em>str</em>) – Single file path or directory</p></li> |
| <li><p><strong>columns</strong> (<em>List</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Subset of columns to read.</p></li> |
| <li><p><strong>metadata</strong> (<em>pyarrow.parquet.FileMetaData</em>) – Known metadata to validate files against.</p></li> |
| <li><p><strong>schema</strong> (<em>pyarrow.parquet.Schema</em>) – Known schema to validate files against. Alternative to metadata |
| argument.</p></li> |
| <li><p><strong>use_threads</strong> (<em>bool</em><em>, </em><em>default True</em>) – Perform multi-threaded column reads.</p></li> |
| <li><p><strong>use_pandas_metadata</strong> (<em>bool</em><em>, </em><em>default False</em>) – If True and file has custom pandas schema metadata, ensure that |
| index columns are also loaded.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><strong>table</strong> (<em>pyarrow.Table</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.rename"> |
| <code class="sig-name descname">rename</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">new_path</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.rename" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Rename file, like UNIX mv command.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>path</strong> (<em>str</em>) – Path to alter.</p></li> |
| <li><p><strong>new_path</strong> (<em>str</em>) – Path to move to.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.rm"> |
| <code class="sig-name descname">rm</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">recursive</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.rm" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Alias for FileSystem.delete.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.stat"> |
| <code class="sig-name descname">stat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.LocalFileSystem.stat" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Information about a filesystem entry.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><strong>stat</strong> (<em>dict</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.LocalFileSystem.walk"> |
| <code class="sig-name descname">walk</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyarrow/filesystem.html#LocalFileSystem.walk"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.LocalFileSystem.walk" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Directory tree generator, see os.walk.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="../api/tables.html" class="btn btn-neutral float-right" title="Tables and Tensors" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="pyarrow.CompressedOutputStream.html" class="btn btn-neutral float-left" title="pyarrow.CompressedOutputStream" 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> |
