| |
| |
| |
| <!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.Schema — 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.Schema.html" /> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="pyarrow.ExtensionType" href="pyarrow.ExtensionType.html" /> |
| <link rel="prev" title="pyarrow.Field" href="pyarrow.Field.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 current"><a class="reference internal" href="../api/datatypes.html">Data Types and Schemas</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="../api/datatypes.html#factory-functions">Factory Functions</a></li> |
| <li class="toctree-l4 current"><a class="reference internal" href="../api/datatypes.html#type-classes">Type Classes</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../api/datatypes.html#type-checking">Type Checking</a></li> |
| </ul> |
| </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"><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/datatypes.html">Data Types and Schemas</a> »</li> |
| |
| <li>pyarrow.Schema</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../_sources/python/generated/pyarrow.Schema.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-schema"> |
| <h1>pyarrow.Schema<a class="headerlink" href="#pyarrow-schema" title="Permalink to this headline">¶</a></h1> |
| <dl class="py class"> |
| <dt id="pyarrow.Schema"> |
| <em class="property">class </em><code class="sig-prename descclassname">pyarrow.</code><code class="sig-name descname">Schema</code><a class="headerlink" href="#pyarrow.Schema" 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> |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.__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.Schema.__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.Schema.__init__" title="pyarrow.Schema.__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> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.Schema.add_metadata" title="pyarrow.Schema.add_metadata"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_metadata</span></code></a>(self, metadata)</p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.Schema.append" title="pyarrow.Schema.append"><code class="xref py py-obj docutils literal notranslate"><span class="pre">append</span></code></a>(self, Field field)</p></td> |
| <td><p>Append a field at the end of the schema.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.Schema.empty_table" title="pyarrow.Schema.empty_table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">empty_table</span></code></a>(self)</p></td> |
| <td><p>Provide an empty table according to the schema.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.Schema.equals" title="pyarrow.Schema.equals"><code class="xref py py-obj docutils literal notranslate"><span class="pre">equals</span></code></a>(self, Schema other, …)</p></td> |
| <td><p>Test if this schema is equal to the other</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.Schema.field" title="pyarrow.Schema.field"><code class="xref py py-obj docutils literal notranslate"><span class="pre">field</span></code></a>(self, i)</p></td> |
| <td><p>Select a field by its column name or numeric index.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.Schema.field_by_name" title="pyarrow.Schema.field_by_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">field_by_name</span></code></a>(self, name)</p></td> |
| <td><p>Access a field by its name rather than the column index.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.Schema.from_pandas" title="pyarrow.Schema.from_pandas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_pandas</span></code></a>(type cls, df[, preserve_index])</p></td> |
| <td><p>Returns implied schema from dataframe</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.Schema.get_all_field_indices" title="pyarrow.Schema.get_all_field_indices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_all_field_indices</span></code></a>(self, name)</p></td> |
| <td><p>Return sorted list of indices for fields with the given name</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.Schema.get_field_index" title="pyarrow.Schema.get_field_index"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_field_index</span></code></a>(self, name)</p></td> |
| <td><p>Return index of field with given unique name.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.Schema.insert" title="pyarrow.Schema.insert"><code class="xref py py-obj docutils literal notranslate"><span class="pre">insert</span></code></a>(self, int i, Field field)</p></td> |
| <td><p>Add a field at position i to the schema.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.Schema.remove" title="pyarrow.Schema.remove"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove</span></code></a>(self, int i)</p></td> |
| <td><p>Remove the field at index i from the schema.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.Schema.remove_metadata" title="pyarrow.Schema.remove_metadata"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_metadata</span></code></a>(self)</p></td> |
| <td><p>Create new schema without metadata, if any</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.Schema.serialize" title="pyarrow.Schema.serialize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">serialize</span></code></a>(self[, memory_pool])</p></td> |
| <td><p>Write Schema to Buffer as encapsulated IPC message</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.Schema.set" title="pyarrow.Schema.set"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set</span></code></a>(self, int i, Field field)</p></td> |
| <td><p>Replace a field at position i in the schema.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.Schema.to_string" title="pyarrow.Schema.to_string"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_string</span></code></a>(self[, truncate_metadata, …])</p></td> |
| <td><p>Return human-readable representation of Schema</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.Schema.with_metadata" title="pyarrow.Schema.with_metadata"><code class="xref py py-obj docutils literal notranslate"><span class="pre">with_metadata</span></code></a>(self, metadata)</p></td> |
| <td><p>Add metadata as dict of string keys and values to Schema</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.Schema.metadata" title="pyarrow.Schema.metadata"><code class="xref py py-obj docutils literal notranslate"><span class="pre">metadata</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.Schema.names" title="pyarrow.Schema.names"><code class="xref py py-obj docutils literal notranslate"><span class="pre">names</span></code></a></p></td> |
| <td><p>The schema’s field names.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.Schema.pandas_metadata" title="pyarrow.Schema.pandas_metadata"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas_metadata</span></code></a></p></td> |
| <td><p>Return deserialized-from-JSON pandas metadata field (if it exists)</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.Schema.types" title="pyarrow.Schema.types"><code class="xref py py-obj docutils literal notranslate"><span class="pre">types</span></code></a></p></td> |
| <td><p>The schema’s field types.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.add_metadata"> |
| <code class="sig-name descname">add_metadata</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">self</span></em>, <em class="sig-param"><span class="n">metadata</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.add_metadata" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.append"> |
| <code class="sig-name descname">append</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">Field field</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.append" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Append a field at the end of the schema.</p> |
| <p>In contrast to Python’s <code class="docutils literal notranslate"><span class="pre">list.append()</span></code> it does return a new |
| object, leaving the original Schema unmodified.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>field</strong> (<a class="reference internal" href="pyarrow.Field.html#pyarrow.Field" title="pyarrow.Field"><em>Field</em></a>) – </p> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><strong>schema</strong> (<em>Schema</em>) – New object with appended field.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.empty_table"> |
| <code class="sig-name descname">empty_table</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">self</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.empty_table" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Provide an empty table according to the schema.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><strong>table</strong> (<em>pyarrow.Table</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.equals"> |
| <code class="sig-name descname">equals</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">Schema other</em>, <em class="sig-param">bool check_metadata=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.equals" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Test if this schema is equal to the other</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>other</strong> (<a class="reference internal" href="#pyarrow.Schema" title="pyarrow.Schema"><em>pyarrow.Schema</em></a>) – </p></li> |
| <li><p><strong>check_metadata</strong> (<em>bool</em><em>, </em><em>default False</em>) – Key/value metadata must be equal too</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><strong>is_equal</strong> (<em>bool</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.field"> |
| <code class="sig-name descname">field</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">self</span></em>, <em class="sig-param"><span class="n">i</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.field" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Select a field by its column name or numeric index.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>i</strong> (<em>int</em><em> or </em><em>string</em>) – </p> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><em>pyarrow.Field</em></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.field_by_name"> |
| <code class="sig-name descname">field_by_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">self</span></em>, <em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.field_by_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Access a field by its name rather than the column index.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – </p> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><strong>field</strong> (<em>pyarrow.Field</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.from_pandas"> |
| <code class="sig-name descname">from_pandas</code><span class="sig-paren">(</span><em class="sig-param">type cls</em>, <em class="sig-param">df</em>, <em class="sig-param">preserve_index=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.from_pandas" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns implied schema from dataframe</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>df</strong> (<em>pandas.DataFrame</em>) – </p></li> |
| <li><p><strong>preserve_index</strong> (<em>bool</em><em>, </em><em>default True</em>) – Whether to store the index as an additional column (or columns, for |
| MultiIndex) in the resulting <cite>Table</cite>. |
| The default of None will store the index as a column, except for |
| RangeIndex which is stored as metadata only. Use |
| <code class="docutils literal notranslate"><span class="pre">preserve_index=True</span></code> to force it to be stored as a column.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><em>pyarrow.Schema</em></p> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span> |
| <span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pyarrow</span> <span class="k">as</span> <span class="nn">pa</span> |
| <span class="gp">>>> </span><span class="n">df</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">({</span> |
| <span class="go"> ... 'int': [1, 2],</span> |
| <span class="go"> ... 'str': ['a', 'b']</span> |
| <span class="go"> ... })</span> |
| <span class="gp">>>> </span><span class="n">pa</span><span class="o">.</span><span class="n">Schema</span><span class="o">.</span><span class="n">from_pandas</span><span class="p">(</span><span class="n">df</span><span class="p">)</span> |
| <span class="go">int: int64</span> |
| <span class="go">str: string</span> |
| <span class="go">__index_level_0__: int64</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.get_all_field_indices"> |
| <code class="sig-name descname">get_all_field_indices</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">self</span></em>, <em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.get_all_field_indices" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return sorted list of indices for fields with the given name</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.get_field_index"> |
| <code class="sig-name descname">get_field_index</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">self</span></em>, <em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.get_field_index" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return index of field with given unique name. Returns -1 if not found |
| or if duplicated</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.insert"> |
| <code class="sig-name descname">insert</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">int i</em>, <em class="sig-param">Field field</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.insert" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Add a field at position i to the schema.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>i</strong> (<em>int</em>) – </p></li> |
| <li><p><strong>field</strong> (<a class="reference internal" href="pyarrow.Field.html#pyarrow.Field" title="pyarrow.Field"><em>Field</em></a>) – </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><strong>schema</strong> (<em>Schema</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyarrow.Schema.metadata"> |
| <code class="sig-name descname">metadata</code><a class="headerlink" href="#pyarrow.Schema.metadata" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyarrow.Schema.names"> |
| <code class="sig-name descname">names</code><a class="headerlink" href="#pyarrow.Schema.names" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The schema’s field names.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><em>list of str</em></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyarrow.Schema.pandas_metadata"> |
| <code class="sig-name descname">pandas_metadata</code><a class="headerlink" href="#pyarrow.Schema.pandas_metadata" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return deserialized-from-JSON pandas metadata field (if it exists)</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.remove"> |
| <code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">int i</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.remove" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Remove the field at index i from the schema.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>i</strong> (<em>int</em>) – </p> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><strong>schema</strong> (<em>Schema</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.remove_metadata"> |
| <code class="sig-name descname">remove_metadata</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">self</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.remove_metadata" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Create new schema without metadata, if any</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><strong>schema</strong> (<em>pyarrow.Schema</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.serialize"> |
| <code class="sig-name descname">serialize</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">self</span></em>, <em class="sig-param"><span class="n">memory_pool</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.serialize" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Write Schema to Buffer as encapsulated IPC message</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>memory_pool</strong> (<a class="reference internal" href="pyarrow.MemoryPool.html#pyarrow.MemoryPool" title="pyarrow.MemoryPool"><em>MemoryPool</em></a><em>, </em><em>default None</em>) – Uses default memory pool if not specified</p> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><strong>serialized</strong> (<em>Buffer</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.set"> |
| <code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">int i</em>, <em class="sig-param">Field field</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.set" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Replace a field at position i in the schema.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>i</strong> (<em>int</em>) – </p></li> |
| <li><p><strong>field</strong> (<a class="reference internal" href="pyarrow.Field.html#pyarrow.Field" title="pyarrow.Field"><em>Field</em></a>) – </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><strong>schema</strong> (<em>Schema</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.to_string"> |
| <code class="sig-name descname">to_string</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">self</span></em>, <em class="sig-param"><span class="n">truncate_metadata</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">show_field_metadata</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">show_schema_metadata</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.to_string" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return human-readable representation of Schema</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>truncate_metadata</strong> (<em>boolean</em><em>, </em><em>default True</em>) – Limit metadata key/value display to a single line of ~80 characters |
| or less</p></li> |
| <li><p><strong>show_field_metadata</strong> (<em>boolean</em><em>, </em><em>default True</em>) – Display Field-level KeyValueMetadata</p></li> |
| <li><p><strong>show_schema_metadata</strong> (<em>boolean</em><em>, </em><em>default True</em>) – Display Schema-level KeyValueMetadata</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><strong>str</strong> (<em>the formatted output</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt id="pyarrow.Schema.types"> |
| <code class="sig-name descname">types</code><a class="headerlink" href="#pyarrow.Schema.types" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The schema’s field types.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p><em>list of DataType</em></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt id="pyarrow.Schema.with_metadata"> |
| <code class="sig-name descname">with_metadata</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">self</span></em>, <em class="sig-param"><span class="n">metadata</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Schema.with_metadata" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Add metadata as dict of string keys and values to Schema</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>metadata</strong> (<em>dict</em>) – Keys and values must be string-like / coercible to bytes</p> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p><strong>schema</strong> (<em>pyarrow.Schema</em>)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="pyarrow.ExtensionType.html" class="btn btn-neutral float-right" title="pyarrow.ExtensionType" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="pyarrow.Field.html" class="btn btn-neutral float-left" title="pyarrow.Field" 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> |
| |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
