http://git-wip-us.apache.org/repos/asf/arrow-site/blob/679f060e/docs/python/generated/pyarrow.ArrayValue.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.ArrayValue.html b/docs/python/generated/pyarrow.ArrayValue.html new file mode 100644 index 0000000..aa9f4d9 --- /dev/null +++ b/docs/python/generated/pyarrow.ArrayValue.html @@ -0,0 +1,292 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>pyarrow.ArrayValue — pyarrow documentation</title> + + + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="pyarrow documentation" href="../index.html"/> + <link rel="up" title="API Reference" href="../api.html"/> + <link rel="next" title="pyarrow.BooleanValue" href="pyarrow.BooleanValue.html"/> + <link rel="prev" title="pyarrow.Scalar" href="pyarrow.Scalar.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + + <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"> pyarrow + + + + </a> + + + + + + + +<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">Getting Started</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Pandas Interface</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File interfaces and Memory Maps</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading/Writing Parquet files</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-and-schema-factory-functions">Type and Schema Factory Functions</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../api.html#scalar-value-types">Scalar Value Types</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.NA.html">pyarrow.NA</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.NAType.html">pyarrow.NAType</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Scalar.html">pyarrow.Scalar</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.ArrayValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.BooleanValue.html">pyarrow.BooleanValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int8Value.html">pyarrow.Int8Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int16Value.html">pyarrow.Int16Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int32Value.html">pyarrow.Int32Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int64Value.html">pyarrow.Int64Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt8Value.html">pyarrow.UInt8Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt16Value.html">pyarrow.UInt16Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt32Value.html">pyarrow.UInt32Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt64Value.html">pyarrow.UInt64Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.FloatValue.html">pyarrow.FloatValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.DoubleValue.html">pyarrow.DoubleValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.ListValue.html">pyarrow.ListValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.BinaryValue.html">pyarrow.BinaryValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.StringValue.html">pyarrow.StringValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.FixedSizeBinaryValue.html">pyarrow.FixedSizeBinaryValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Date32Value.html">pyarrow.Date32Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Date64Value.html">pyarrow.Date64Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.TimestampValue.html">pyarrow.TimestampValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.DecimalValue.html">pyarrow.DecimalValue</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#array-types-and-constructors">Array Types and Constructors</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tables-and-record-batches">Tables and Record Batches</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tensor-type-and-functions">Tensor type and Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#input-output-and-shared-memory">Input / Output and Shared Memory</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#interprocess-communication-and-messaging">Interprocess Communication and Messaging</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#memory-pools">Memory Pools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-classes">Type Classes</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#apache-parquet">Apache Parquet</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +<p class="caption"><span class="caption-text">Additional Features</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../jemalloc.html">jemalloc MemoryPool</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">pyarrow</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">Docs</a> »</li> + + <li><a href="../api.html">API Reference</a> »</li> + + <li>pyarrow.ArrayValue</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.ArrayValue.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-arrayvalue"> +<h1>pyarrow.ArrayValue<a class="headerlink" href="#pyarrow-arrayvalue" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.ArrayValue"> +<em class="property">class </em><code class="descclassname">pyarrow.</code><code class="descname">ArrayValue</code><a class="headerlink" href="#pyarrow.ArrayValue" title="Permalink to this definition">¶</a></dt> +<dd><dl class="method"> +<dt id="pyarrow.ArrayValue.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.ArrayValue.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>x.__init__(...) initializes x; see help(type(x)) for signature</p> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + <div class="articleComments"> + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="pyarrow.BooleanValue.html" class="btn btn-neutral float-right" title="pyarrow.BooleanValue" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.Scalar.html" class="btn btn-neutral" title="pyarrow.Scalar" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2016 Apache Software Foundation. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/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"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/679f060e/docs/python/generated/pyarrow.BinaryArray.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.BinaryArray.html b/docs/python/generated/pyarrow.BinaryArray.html new file mode 100644 index 0000000..8a4148c --- /dev/null +++ b/docs/python/generated/pyarrow.BinaryArray.html @@ -0,0 +1,337 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>pyarrow.BinaryArray — pyarrow documentation</title> + + + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="pyarrow documentation" href="../index.html"/> + <link rel="up" title="API Reference" href="../api.html"/> + <link rel="next" title="pyarrow.FixedSizeBinaryArray" href="pyarrow.FixedSizeBinaryArray.html"/> + <link rel="prev" title="pyarrow.UInt64Array" href="pyarrow.UInt64Array.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + + <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"> pyarrow + + + + </a> + + + + + + + +<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">Getting Started</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Pandas Interface</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File interfaces and Memory Maps</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading/Writing Parquet files</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-and-schema-factory-functions">Type and Schema Factory Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#scalar-value-types">Scalar Value Types</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../api.html#array-types-and-constructors">Array Types and Constructors</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.array.html">pyarrow.array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Array.html">pyarrow.Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.BooleanArray.html">pyarrow.BooleanArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.DictionaryArray.html">pyarrow.DictionaryArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.FloatingPointArray.html">pyarrow.FloatingPointArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.IntegerArray.html">pyarrow.IntegerArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int8Array.html">pyarrow.Int8Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int16Array.html">pyarrow.Int16Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int32Array.html">pyarrow.Int32Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int64Array.html">pyarrow.Int64Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.NullArray.html">pyarrow.NullArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.NumericArray.html">pyarrow.NumericArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt8Array.html">pyarrow.UInt8Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt16Array.html">pyarrow.UInt16Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt32Array.html">pyarrow.UInt32Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt64Array.html">pyarrow.UInt64Array</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.BinaryArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.FixedSizeBinaryArray.html">pyarrow.FixedSizeBinaryArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.StringArray.html">pyarrow.StringArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Time32Array.html">pyarrow.Time32Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Time64Array.html">pyarrow.Time64Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Date32Array.html">pyarrow.Date32Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Date64Array.html">pyarrow.Date64Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.TimestampArray.html">pyarrow.TimestampArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.DecimalArray.html">pyarrow.DecimalArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.ListArray.html">pyarrow.ListArray</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tables-and-record-batches">Tables and Record Batches</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tensor-type-and-functions">Tensor type and Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#input-output-and-shared-memory">Input / Output and Shared Memory</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#interprocess-communication-and-messaging">Interprocess Communication and Messaging</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#memory-pools">Memory Pools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-classes">Type Classes</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#apache-parquet">Apache Parquet</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +<p class="caption"><span class="caption-text">Additional Features</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../jemalloc.html">jemalloc MemoryPool</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">pyarrow</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">Docs</a> »</li> + + <li><a href="../api.html">API Reference</a> »</li> + + <li>pyarrow.BinaryArray</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.BinaryArray.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-binaryarray"> +<h1>pyarrow.BinaryArray<a class="headerlink" href="#pyarrow-binaryarray" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.BinaryArray"> +<em class="property">class </em><code class="descclassname">pyarrow.</code><code class="descname">BinaryArray</code><a class="headerlink" href="#pyarrow.BinaryArray" title="Permalink to this definition">¶</a></dt> +<dd><dl class="method"> +<dt id="pyarrow.BinaryArray.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.BinaryArray.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>x.__init__(...) initializes x; see help(type(x)) for signature</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">equals</span></code>(self, Array other)</td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">from_pandas</span></code>(obj[, mask, timestamps_to_ms])</td> +<td>Convert pandas.Series to an Arrow Array.</td> +</tr> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">isnull</span></code>(self)</td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">slice</span></code>(self[, offset, length])</td> +<td>Compute zero-copy slice of this array</td> +</tr> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">to_pandas</span></code>(self)</td> +<td>Convert to an array object suitable for use in pandas</td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">to_pylist</span></code>(self)</td> +<td>Convert to an list of native Python objects.</td> +</tr> +</tbody> +</table> +<p class="rubric">Attributes</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">null_count</span></code></td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">type</span></code></td> +<td></td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + <div class="articleComments"> + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="pyarrow.FixedSizeBinaryArray.html" class="btn btn-neutral float-right" title="pyarrow.FixedSizeBinaryArray" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.UInt64Array.html" class="btn btn-neutral" title="pyarrow.UInt64Array" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2016 Apache Software Foundation. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/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"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/679f060e/docs/python/generated/pyarrow.BinaryValue.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.BinaryValue.html b/docs/python/generated/pyarrow.BinaryValue.html new file mode 100644 index 0000000..d98fbf2 --- /dev/null +++ b/docs/python/generated/pyarrow.BinaryValue.html @@ -0,0 +1,304 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>pyarrow.BinaryValue — pyarrow documentation</title> + + + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="pyarrow documentation" href="../index.html"/> + <link rel="up" title="API Reference" href="../api.html"/> + <link rel="next" title="pyarrow.StringValue" href="pyarrow.StringValue.html"/> + <link rel="prev" title="pyarrow.ListValue" href="pyarrow.ListValue.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + + <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"> pyarrow + + + + </a> + + + + + + + +<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">Getting Started</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Pandas Interface</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File interfaces and Memory Maps</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading/Writing Parquet files</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-and-schema-factory-functions">Type and Schema Factory Functions</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../api.html#scalar-value-types">Scalar Value Types</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.NA.html">pyarrow.NA</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.NAType.html">pyarrow.NAType</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Scalar.html">pyarrow.Scalar</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.ArrayValue.html">pyarrow.ArrayValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.BooleanValue.html">pyarrow.BooleanValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int8Value.html">pyarrow.Int8Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int16Value.html">pyarrow.Int16Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int32Value.html">pyarrow.Int32Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int64Value.html">pyarrow.Int64Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt8Value.html">pyarrow.UInt8Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt16Value.html">pyarrow.UInt16Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt32Value.html">pyarrow.UInt32Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt64Value.html">pyarrow.UInt64Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.FloatValue.html">pyarrow.FloatValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.DoubleValue.html">pyarrow.DoubleValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.ListValue.html">pyarrow.ListValue</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.BinaryValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.StringValue.html">pyarrow.StringValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.FixedSizeBinaryValue.html">pyarrow.FixedSizeBinaryValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Date32Value.html">pyarrow.Date32Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Date64Value.html">pyarrow.Date64Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.TimestampValue.html">pyarrow.TimestampValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.DecimalValue.html">pyarrow.DecimalValue</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#array-types-and-constructors">Array Types and Constructors</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tables-and-record-batches">Tables and Record Batches</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tensor-type-and-functions">Tensor type and Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#input-output-and-shared-memory">Input / Output and Shared Memory</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#interprocess-communication-and-messaging">Interprocess Communication and Messaging</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#memory-pools">Memory Pools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-classes">Type Classes</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#apache-parquet">Apache Parquet</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +<p class="caption"><span class="caption-text">Additional Features</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../jemalloc.html">jemalloc MemoryPool</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">pyarrow</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">Docs</a> »</li> + + <li><a href="../api.html">API Reference</a> »</li> + + <li>pyarrow.BinaryValue</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.BinaryValue.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-binaryvalue"> +<h1>pyarrow.BinaryValue<a class="headerlink" href="#pyarrow-binaryvalue" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.BinaryValue"> +<em class="property">class </em><code class="descclassname">pyarrow.</code><code class="descname">BinaryValue</code><a class="headerlink" href="#pyarrow.BinaryValue" title="Permalink to this definition">¶</a></dt> +<dd><dl class="method"> +<dt id="pyarrow.BinaryValue.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.BinaryValue.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>x.__init__(...) initializes x; see help(type(x)) for signature</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">as_py</span></code>(self)</td> +<td></td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + <div class="articleComments"> + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="pyarrow.StringValue.html" class="btn btn-neutral float-right" title="pyarrow.StringValue" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.ListValue.html" class="btn btn-neutral" title="pyarrow.ListValue" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2016 Apache Software Foundation. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/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"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/679f060e/docs/python/generated/pyarrow.BooleanArray.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.BooleanArray.html b/docs/python/generated/pyarrow.BooleanArray.html new file mode 100644 index 0000000..b8a86ba --- /dev/null +++ b/docs/python/generated/pyarrow.BooleanArray.html @@ -0,0 +1,337 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>pyarrow.BooleanArray — pyarrow documentation</title> + + + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="pyarrow documentation" href="../index.html"/> + <link rel="up" title="API Reference" href="../api.html"/> + <link rel="next" title="pyarrow.DictionaryArray" href="pyarrow.DictionaryArray.html"/> + <link rel="prev" title="pyarrow.Array" href="pyarrow.Array.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + + <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"> pyarrow + + + + </a> + + + + + + + +<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">Getting Started</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Pandas Interface</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File interfaces and Memory Maps</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading/Writing Parquet files</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-and-schema-factory-functions">Type and Schema Factory Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#scalar-value-types">Scalar Value Types</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../api.html#array-types-and-constructors">Array Types and Constructors</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.array.html">pyarrow.array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Array.html">pyarrow.Array</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.BooleanArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.DictionaryArray.html">pyarrow.DictionaryArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.FloatingPointArray.html">pyarrow.FloatingPointArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.IntegerArray.html">pyarrow.IntegerArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int8Array.html">pyarrow.Int8Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int16Array.html">pyarrow.Int16Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int32Array.html">pyarrow.Int32Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int64Array.html">pyarrow.Int64Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.NullArray.html">pyarrow.NullArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.NumericArray.html">pyarrow.NumericArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt8Array.html">pyarrow.UInt8Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt16Array.html">pyarrow.UInt16Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt32Array.html">pyarrow.UInt32Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt64Array.html">pyarrow.UInt64Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.BinaryArray.html">pyarrow.BinaryArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.FixedSizeBinaryArray.html">pyarrow.FixedSizeBinaryArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.StringArray.html">pyarrow.StringArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Time32Array.html">pyarrow.Time32Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Time64Array.html">pyarrow.Time64Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Date32Array.html">pyarrow.Date32Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Date64Array.html">pyarrow.Date64Array</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.TimestampArray.html">pyarrow.TimestampArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.DecimalArray.html">pyarrow.DecimalArray</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.ListArray.html">pyarrow.ListArray</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tables-and-record-batches">Tables and Record Batches</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tensor-type-and-functions">Tensor type and Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#input-output-and-shared-memory">Input / Output and Shared Memory</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#interprocess-communication-and-messaging">Interprocess Communication and Messaging</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#memory-pools">Memory Pools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-classes">Type Classes</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#apache-parquet">Apache Parquet</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +<p class="caption"><span class="caption-text">Additional Features</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../jemalloc.html">jemalloc MemoryPool</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">pyarrow</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">Docs</a> »</li> + + <li><a href="../api.html">API Reference</a> »</li> + + <li>pyarrow.BooleanArray</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.BooleanArray.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-booleanarray"> +<h1>pyarrow.BooleanArray<a class="headerlink" href="#pyarrow-booleanarray" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.BooleanArray"> +<em class="property">class </em><code class="descclassname">pyarrow.</code><code class="descname">BooleanArray</code><a class="headerlink" href="#pyarrow.BooleanArray" title="Permalink to this definition">¶</a></dt> +<dd><dl class="method"> +<dt id="pyarrow.BooleanArray.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.BooleanArray.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>x.__init__(...) initializes x; see help(type(x)) for signature</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">equals</span></code>(self, Array other)</td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">from_pandas</span></code>(obj[, mask, timestamps_to_ms])</td> +<td>Convert pandas.Series to an Arrow Array.</td> +</tr> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">isnull</span></code>(self)</td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">slice</span></code>(self[, offset, length])</td> +<td>Compute zero-copy slice of this array</td> +</tr> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">to_pandas</span></code>(self)</td> +<td>Convert to an array object suitable for use in pandas</td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">to_pylist</span></code>(self)</td> +<td>Convert to an list of native Python objects.</td> +</tr> +</tbody> +</table> +<p class="rubric">Attributes</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">null_count</span></code></td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">type</span></code></td> +<td></td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + <div class="articleComments"> + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="pyarrow.DictionaryArray.html" class="btn btn-neutral float-right" title="pyarrow.DictionaryArray" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.Array.html" class="btn btn-neutral" title="pyarrow.Array" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2016 Apache Software Foundation. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/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"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/679f060e/docs/python/generated/pyarrow.BooleanValue.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.BooleanValue.html b/docs/python/generated/pyarrow.BooleanValue.html new file mode 100644 index 0000000..0cf44a8 --- /dev/null +++ b/docs/python/generated/pyarrow.BooleanValue.html @@ -0,0 +1,304 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>pyarrow.BooleanValue — pyarrow documentation</title> + + + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="pyarrow documentation" href="../index.html"/> + <link rel="up" title="API Reference" href="../api.html"/> + <link rel="next" title="pyarrow.Int8Value" href="pyarrow.Int8Value.html"/> + <link rel="prev" title="pyarrow.ArrayValue" href="pyarrow.ArrayValue.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + + <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"> pyarrow + + + + </a> + + + + + + + +<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">Getting Started</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Pandas Interface</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File interfaces and Memory Maps</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading/Writing Parquet files</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-and-schema-factory-functions">Type and Schema Factory Functions</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../api.html#scalar-value-types">Scalar Value Types</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.NA.html">pyarrow.NA</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.NAType.html">pyarrow.NAType</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Scalar.html">pyarrow.Scalar</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.ArrayValue.html">pyarrow.ArrayValue</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.BooleanValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int8Value.html">pyarrow.Int8Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int16Value.html">pyarrow.Int16Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int32Value.html">pyarrow.Int32Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Int64Value.html">pyarrow.Int64Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt8Value.html">pyarrow.UInt8Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt16Value.html">pyarrow.UInt16Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt32Value.html">pyarrow.UInt32Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt64Value.html">pyarrow.UInt64Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.FloatValue.html">pyarrow.FloatValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.DoubleValue.html">pyarrow.DoubleValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.ListValue.html">pyarrow.ListValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.BinaryValue.html">pyarrow.BinaryValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.StringValue.html">pyarrow.StringValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.FixedSizeBinaryValue.html">pyarrow.FixedSizeBinaryValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Date32Value.html">pyarrow.Date32Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Date64Value.html">pyarrow.Date64Value</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.TimestampValue.html">pyarrow.TimestampValue</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.DecimalValue.html">pyarrow.DecimalValue</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#array-types-and-constructors">Array Types and Constructors</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tables-and-record-batches">Tables and Record Batches</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tensor-type-and-functions">Tensor type and Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#input-output-and-shared-memory">Input / Output and Shared Memory</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#interprocess-communication-and-messaging">Interprocess Communication and Messaging</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#memory-pools">Memory Pools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-classes">Type Classes</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#apache-parquet">Apache Parquet</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +<p class="caption"><span class="caption-text">Additional Features</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../jemalloc.html">jemalloc MemoryPool</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">pyarrow</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">Docs</a> »</li> + + <li><a href="../api.html">API Reference</a> »</li> + + <li>pyarrow.BooleanValue</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.BooleanValue.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-booleanvalue"> +<h1>pyarrow.BooleanValue<a class="headerlink" href="#pyarrow-booleanvalue" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.BooleanValue"> +<em class="property">class </em><code class="descclassname">pyarrow.</code><code class="descname">BooleanValue</code><a class="headerlink" href="#pyarrow.BooleanValue" title="Permalink to this definition">¶</a></dt> +<dd><dl class="method"> +<dt id="pyarrow.BooleanValue.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.BooleanValue.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>x.__init__(...) initializes x; see help(type(x)) for signature</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">as_py</span></code>(self)</td> +<td></td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + <div class="articleComments"> + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="pyarrow.Int8Value.html" class="btn btn-neutral float-right" title="pyarrow.Int8Value" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.ArrayValue.html" class="btn btn-neutral" title="pyarrow.ArrayValue" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2016 Apache Software Foundation. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/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"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/679f060e/docs/python/generated/pyarrow.Buffer.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.Buffer.html b/docs/python/generated/pyarrow.Buffer.html new file mode 100644 index 0000000..bed62e3 --- /dev/null +++ b/docs/python/generated/pyarrow.Buffer.html @@ -0,0 +1,304 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>pyarrow.Buffer — pyarrow documentation</title> + + + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="pyarrow documentation" href="../index.html"/> + <link rel="up" title="API Reference" href="../api.html"/> + <link rel="next" title="pyarrow.BufferReader" href="pyarrow.BufferReader.html"/> + <link rel="prev" title="pyarrow.read_tensor" href="pyarrow.read_tensor.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + + <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"> pyarrow + + + + </a> + + + + + + + +<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">Getting Started</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Pandas Interface</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File interfaces and Memory Maps</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading/Writing Parquet files</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-and-schema-factory-functions">Type and Schema Factory Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#scalar-value-types">Scalar Value Types</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#array-types-and-constructors">Array Types and Constructors</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tables-and-record-batches">Tables and Record Batches</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tensor-type-and-functions">Tensor type and Functions</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../api.html#input-output-and-shared-memory">Input / Output and Shared Memory</a><ul class="current"> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.Buffer</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.BufferReader.html">pyarrow.BufferReader</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.InMemoryOutputStream.html">pyarrow.InMemoryOutputStream</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.NativeFile.html">pyarrow.NativeFile</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.MemoryMappedFile.html">pyarrow.MemoryMappedFile</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.memory_map.html">pyarrow.memory_map</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.create_memory_map.html">pyarrow.create_memory_map</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.PythonFile.html">pyarrow.PythonFile</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#interprocess-communication-and-messaging">Interprocess Communication and Messaging</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#memory-pools">Memory Pools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-classes">Type Classes</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#apache-parquet">Apache Parquet</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +<p class="caption"><span class="caption-text">Additional Features</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../jemalloc.html">jemalloc MemoryPool</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">pyarrow</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">Docs</a> »</li> + + <li><a href="../api.html">API Reference</a> »</li> + + <li>pyarrow.Buffer</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.Buffer.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-buffer"> +<h1>pyarrow.Buffer<a class="headerlink" href="#pyarrow-buffer" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.Buffer"> +<em class="property">class </em><code class="descclassname">pyarrow.</code><code class="descname">Buffer</code><a class="headerlink" href="#pyarrow.Buffer" title="Permalink to this definition">¶</a></dt> +<dd><dl class="method"> +<dt id="pyarrow.Buffer.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.Buffer.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>x.__init__(...) initializes x; see help(type(x)) for signature</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">to_pybytes</span></code>(self)</td> +<td></td> +</tr> +</tbody> +</table> +<p class="rubric">Attributes</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">parent</span></code></td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">size</span></code></td> +<td></td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + <div class="articleComments"> + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="pyarrow.BufferReader.html" class="btn btn-neutral float-right" title="pyarrow.BufferReader" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.read_tensor.html" class="btn btn-neutral" title="pyarrow.read_tensor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2016 Apache Software Foundation. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/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"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/679f060e/docs/python/generated/pyarrow.BufferReader.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.BufferReader.html b/docs/python/generated/pyarrow.BufferReader.html new file mode 100644 index 0000000..223ff72 --- /dev/null +++ b/docs/python/generated/pyarrow.BufferReader.html @@ -0,0 +1,322 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>pyarrow.BufferReader — pyarrow documentation</title> + + + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="pyarrow documentation" href="../index.html"/> + <link rel="up" title="API Reference" href="../api.html"/> + <link rel="next" title="pyarrow.InMemoryOutputStream" href="pyarrow.InMemoryOutputStream.html"/> + <link rel="prev" title="pyarrow.Buffer" href="pyarrow.Buffer.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + + <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"> pyarrow + + + + </a> + + + + + + + +<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">Getting Started</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../install.html">Install PyArrow</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Pandas Interface</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File interfaces and Memory Maps</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading/Writing Parquet files</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-and-schema-factory-functions">Type and Schema Factory Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#scalar-value-types">Scalar Value Types</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#array-types-and-constructors">Array Types and Constructors</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tables-and-record-batches">Tables and Record Batches</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#tensor-type-and-functions">Tensor type and Functions</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../api.html#input-output-and-shared-memory">Input / Output and Shared Memory</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.Buffer.html">pyarrow.Buffer</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.BufferReader</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.InMemoryOutputStream.html">pyarrow.InMemoryOutputStream</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.NativeFile.html">pyarrow.NativeFile</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.MemoryMappedFile.html">pyarrow.MemoryMappedFile</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.memory_map.html">pyarrow.memory_map</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.create_memory_map.html">pyarrow.create_memory_map</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.PythonFile.html">pyarrow.PythonFile</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#interprocess-communication-and-messaging">Interprocess Communication and Messaging</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#memory-pools">Memory Pools</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#type-classes">Type Classes</a></li> +<li class="toctree-l2"><a class="reference internal" href="../api.html#apache-parquet">Apache Parquet</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +<p class="caption"><span class="caption-text">Additional Features</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../jemalloc.html">jemalloc MemoryPool</a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">pyarrow</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">Docs</a> »</li> + + <li><a href="../api.html">API Reference</a> »</li> + + <li>pyarrow.BufferReader</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.BufferReader.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-bufferreader"> +<h1>pyarrow.BufferReader<a class="headerlink" href="#pyarrow-bufferreader" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.BufferReader"> +<em class="property">class </em><code class="descclassname">pyarrow.</code><code class="descname">BufferReader</code><a class="headerlink" href="#pyarrow.BufferReader" title="Permalink to this definition">¶</a></dt> +<dd><p>Zero-copy reader from objects convertible to Arrow buffer</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>obj</strong> (<em>Python bytes</em><em> or </em><em>pyarrow.io.Buffer</em>) – </td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="pyarrow.BufferReader.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.BufferReader.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>x.__init__(...) initializes x; see help(type(x)) for signature</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">close</span></code>(self)</td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">download</span></code>(self, stream_or_path[, buffer_size])</td> +<td>Read file completely to local path (rather than reading completely into memory).</td> +</tr> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">read</span></code>(self[, nbytes])</td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">read_buffer</span></code>(self[, nbytes])</td> +<td></td> +</tr> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">seek</span></code>(self, int64_t position)</td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">size</span></code>(self)</td> +<td></td> +</tr> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">tell</span></code>(self)</td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">upload</span></code>(self, stream[, buffer_size])</td> +<td>Pipe file-like object to file</td> +</tr> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">write</span></code>(self, data)</td> +<td>Write byte from any object implementing buffer protocol (bytes,</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + <div class="articleComments"> + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="pyarrow.InMemoryOutputStream.html" class="btn btn-neutral float-right" title="pyarrow.InMemoryOutputStream" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.Buffer.html" class="btn btn-neutral" title="pyarrow.Buffer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2016 Apache Software Foundation. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/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"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML";></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
