http://git-wip-us.apache.org/repos/asf/arrow-site/blob/679f060e/docs/python/generated/pyarrow.list_.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.list_.html b/docs/python/generated/pyarrow.list_.html new file mode 100644 index 0000000..a8ad220 --- /dev/null +++ b/docs/python/generated/pyarrow.list_.html @@ -0,0 +1,290 @@ + + +<!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.list_ — 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.struct" href="pyarrow.struct.html"/> + <link rel="prev" title="pyarrow.decimal" href="pyarrow.decimal.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 current"><a class="reference internal" href="../api.html#type-and-schema-factory-functions">Type and Schema Factory Functions</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.null.html">pyarrow.null</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.bool_.html">pyarrow.bool_</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.int8.html">pyarrow.int8</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.int16.html">pyarrow.int16</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.int32.html">pyarrow.int32</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.int64.html">pyarrow.int64</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.uint8.html">pyarrow.uint8</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.uint16.html">pyarrow.uint16</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.uint32.html">pyarrow.uint32</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.uint64.html">pyarrow.uint64</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.float16.html">pyarrow.float16</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.float32.html">pyarrow.float32</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.float64.html">pyarrow.float64</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.time32.html">pyarrow.time32</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.time64.html">pyarrow.time64</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.timestamp.html">pyarrow.timestamp</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.date32.html">pyarrow.date32</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.date64.html">pyarrow.date64</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.binary.html">pyarrow.binary</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.string.html">pyarrow.string</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.decimal.html">pyarrow.decimal</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.list_</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.struct.html">pyarrow.struct</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.dictionary.html">pyarrow.dictionary</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.field.html">pyarrow.field</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.schema.html">pyarrow.schema</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.from_numpy_dtype.html">pyarrow.from_numpy_dtype</a></li> +</ul> +</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"><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.list_</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.list_.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-list"> +<h1>pyarrow.list_<a class="headerlink" href="#pyarrow-list" title="Permalink to this headline">¶</a></h1> +<dl class="function"> +<dt id="pyarrow.list_"> +<code class="descclassname">pyarrow.</code><code class="descname">list_</code><span class="sig-paren">(</span><em>DataType value_type</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.list_" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</div> + + + </div> + <div class="articleComments"> + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="pyarrow.struct.html" class="btn btn-neutral float-right" title="pyarrow.struct" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.decimal.html" class="btn btn-neutral" title="pyarrow.decimal" 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.memory_map.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.memory_map.html b/docs/python/generated/pyarrow.memory_map.html new file mode 100644 index 0000000..5df473a --- /dev/null +++ b/docs/python/generated/pyarrow.memory_map.html @@ -0,0 +1,287 @@ + + +<!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.memory_map — 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.create_memory_map" href="pyarrow.create_memory_map.html"/> + <link rel="prev" title="pyarrow.MemoryMappedFile" href="pyarrow.MemoryMappedFile.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"><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 current"><a class="current reference internal" href="#">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.memory_map</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.memory_map.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-memory-map"> +<h1>pyarrow.memory_map<a class="headerlink" href="#pyarrow-memory-map" title="Permalink to this headline">¶</a></h1> +<dl class="function"> +<dt id="pyarrow.memory_map"> +<code class="descclassname">pyarrow.</code><code class="descname">memory_map</code><span class="sig-paren">(</span><em>path</em>, <em>mode='r'</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.memory_map" title="Permalink to this definition">¶</a></dt> +<dd><p>Open memory map at file path. Size of the memory map cannot change</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"><ul class="first simple"> +<li><strong>path</strong> (<a class="reference internal" href="pyarrow.string.html#pyarrow.string" title="pyarrow.string"><em>string</em></a>) – </li> +<li><strong>mode</strong> (<em>{'r'</em><em>, </em><em>'w'}</em><em>, </em><em>default 'r'</em>) – </li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><strong>mmap</strong> (<em>MemoryMappedFile</em>)</p> +</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.create_memory_map.html" class="btn btn-neutral float-right" title="pyarrow.create_memory_map" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.MemoryMappedFile.html" class="btn btn-neutral" title="pyarrow.MemoryMappedFile" 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.null.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.null.html b/docs/python/generated/pyarrow.null.html new file mode 100644 index 0000000..39a4399 --- /dev/null +++ b/docs/python/generated/pyarrow.null.html @@ -0,0 +1,290 @@ + + +<!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.null — 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.bool_" href="pyarrow.bool_.html"/> + <link rel="prev" title="API Reference" href="../api.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 current"><a class="reference internal" href="../api.html#type-and-schema-factory-functions">Type and Schema Factory Functions</a><ul class="current"> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.null</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.bool_.html">pyarrow.bool_</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.int8.html">pyarrow.int8</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.int16.html">pyarrow.int16</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.int32.html">pyarrow.int32</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.int64.html">pyarrow.int64</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.uint8.html">pyarrow.uint8</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.uint16.html">pyarrow.uint16</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.uint32.html">pyarrow.uint32</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.uint64.html">pyarrow.uint64</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.float16.html">pyarrow.float16</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.float32.html">pyarrow.float32</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.float64.html">pyarrow.float64</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.time32.html">pyarrow.time32</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.time64.html">pyarrow.time64</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.timestamp.html">pyarrow.timestamp</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.date32.html">pyarrow.date32</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.date64.html">pyarrow.date64</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.binary.html">pyarrow.binary</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.string.html">pyarrow.string</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.decimal.html">pyarrow.decimal</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.list_.html">pyarrow.list_</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.struct.html">pyarrow.struct</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.dictionary.html">pyarrow.dictionary</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.field.html">pyarrow.field</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.schema.html">pyarrow.schema</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.from_numpy_dtype.html">pyarrow.from_numpy_dtype</a></li> +</ul> +</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"><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.null</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.null.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-null"> +<h1>pyarrow.null<a class="headerlink" href="#pyarrow-null" title="Permalink to this headline">¶</a></h1> +<dl class="function"> +<dt id="pyarrow.null"> +<code class="descclassname">pyarrow.</code><code class="descname">null</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.null" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</div> + + + </div> + <div class="articleComments"> + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="pyarrow.bool_.html" class="btn btn-neutral float-right" title="pyarrow.bool_" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../api.html" class="btn btn-neutral" title="API Reference" 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.parquet.ParquetDataset.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.parquet.ParquetDataset.html b/docs/python/generated/pyarrow.parquet.ParquetDataset.html new file mode 100644 index 0000000..bec8787 --- /dev/null +++ b/docs/python/generated/pyarrow.parquet.ParquetDataset.html @@ -0,0 +1,311 @@ + + +<!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.parquet.ParquetDataset — 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.parquet.ParquetFile" href="pyarrow.parquet.ParquetFile.html"/> + <link rel="prev" title="pyarrow.Schema" href="pyarrow.Schema.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"><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 current"><a class="reference internal" href="../api.html#apache-parquet">Apache Parquet</a><ul class="current"> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.parquet.ParquetDataset</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ParquetFile.html">pyarrow.parquet.ParquetFile</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.read_table.html">pyarrow.parquet.read_table</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.write_metadata.html">pyarrow.parquet.write_metadata</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.write_table.html">pyarrow.parquet.write_table</a></li> +</ul> +</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.parquet.ParquetDataset</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.parquet.ParquetDataset.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-parquet-parquetdataset"> +<h1>pyarrow.parquet.ParquetDataset<a class="headerlink" href="#pyarrow-parquet-parquetdataset" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.parquet.ParquetDataset"> +<em class="property">class </em><code class="descclassname">pyarrow.parquet.</code><code class="descname">ParquetDataset</code><span class="sig-paren">(</span><em>path_or_paths</em>, <em>filesystem=None</em>, <em>schema=None</em>, <em>metadata=None</em>, <em>split_row_groups=False</em>, <em>validate_schema=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#ParquetDataset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.ParquetDataset" title="Permalink to this definition">¶</a></dt> +<dd><p>Encapsulates details of reading a complete Parquet dataset possibly +consisting of multiple files and partitions in subdirectories</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"><ul class="first last simple"> +<li><strong>path_or_paths</strong> (<em>str</em><em> or </em><em>List</em><em>[</em><em>str</em><em>]</em><em></em>) – A directory name, single file name, or list of file names</li> +<li><strong>filesystem</strong> (<em>Filesystem</em><em>, </em><em>default None</em>) – If nothing passed, paths assumed to be found in the local on-disk +filesystem</li> +<li><strong>metadata</strong> (<em>pyarrow.parquet.FileMetaData</em>) – Use metadata obtained elsewhere to validate file schemas</li> +<li><strong>schema</strong> (<em>pyarrow.parquet.Schema</em>) – Use schema obtained elsewhere to validate file schemas. Alternative to +metadata parameter</li> +<li><strong>split_row_groups</strong> (<em>boolean</em><em>, </em><em>default False</em>) – Divide files into pieces for each row group in the file</li> +<li><strong>validate_schema</strong> (<em>boolean</em><em>, </em><em>default True</em>) – Check that individual file schemas are all the same / compatible</li> +</ul> +</td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="pyarrow.parquet.ParquetDataset.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><em>path_or_paths</em>, <em>filesystem=None</em>, <em>schema=None</em>, <em>metadata=None</em>, <em>split_row_groups=False</em>, <em>validate_schema=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#ParquetDataset.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.ParquetDataset.__init__" title="Permalink to this definition">¶</a></dt> +<dd></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><a class="reference internal" href="#pyarrow.parquet.ParquetDataset.__init__" title="pyarrow.parquet.ParquetDataset.__init__"><code class="xref py py-obj docutils literal"><span class="pre">__init__</span></code></a>(path_or_paths[, filesystem, ...])</td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">read</span></code>([columns, nthreads])</td> +<td>Read multiple Parquet files as a single pyarrow.Table</td> +</tr> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">validate_schemas</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.parquet.ParquetFile.html" class="btn btn-neutral float-right" title="pyarrow.parquet.ParquetFile" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.Schema.html" class="btn btn-neutral" title="pyarrow.Schema" 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.parquet.ParquetFile.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.parquet.ParquetFile.html b/docs/python/generated/pyarrow.parquet.ParquetFile.html new file mode 100644 index 0000000..1aaf78d --- /dev/null +++ b/docs/python/generated/pyarrow.parquet.ParquetFile.html @@ -0,0 +1,323 @@ + + +<!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.parquet.ParquetFile — 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.parquet.read_table" href="pyarrow.parquet.read_table.html"/> + <link rel="prev" title="pyarrow.parquet.ParquetDataset" href="pyarrow.parquet.ParquetDataset.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"><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 current"><a class="reference internal" href="../api.html#apache-parquet">Apache Parquet</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ParquetDataset.html">pyarrow.parquet.ParquetDataset</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.parquet.ParquetFile</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.read_table.html">pyarrow.parquet.read_table</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.write_metadata.html">pyarrow.parquet.write_metadata</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.write_table.html">pyarrow.parquet.write_table</a></li> +</ul> +</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.parquet.ParquetFile</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.parquet.ParquetFile.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-parquet-parquetfile"> +<h1>pyarrow.parquet.ParquetFile<a class="headerlink" href="#pyarrow-parquet-parquetfile" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.parquet.ParquetFile"> +<em class="property">class </em><code class="descclassname">pyarrow.parquet.</code><code class="descname">ParquetFile</code><span class="sig-paren">(</span><em>source</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#ParquetFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.ParquetFile" title="Permalink to this definition">¶</a></dt> +<dd><p>Reader interface for a single Parquet file</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"><ul class="first last simple"> +<li><strong>source</strong> (<em>str</em><em> or </em><em>pyarrow.io.NativeFile</em>) – Readable source. For passing Python file objects or byte buffers, +see pyarrow.io.PythonFileInterface or pyarrow.io.BufferReader.</li> +<li><strong>metadata</strong> (<em>ParquetFileMetadata</em><em>, </em><em>default None</em>) – Use existing metadata object, rather than reading from file.</li> +</ul> +</td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="pyarrow.parquet.ParquetFile.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><em>source</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#ParquetFile.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.ParquetFile.__init__" title="Permalink to this definition">¶</a></dt> +<dd></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><a class="reference internal" href="#pyarrow.parquet.ParquetFile.__init__" title="pyarrow.parquet.ParquetFile.__init__"><code class="xref py py-obj docutils literal"><span class="pre">__init__</span></code></a>(source[, metadata])</td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">read</span></code>([columns, nthreads])</td> +<td>Read a Table from Parquet format</td> +</tr> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">read_row_group</span></code>(i[, columns, nthreads])</td> +<td>Read a single row group from a Parquet file</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">metadata</span></code></td> +<td></td> +</tr> +<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">num_row_groups</span></code></td> +<td></td> +</tr> +<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">schema</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.parquet.read_table.html" class="btn btn-neutral float-right" title="pyarrow.parquet.read_table" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.parquet.ParquetDataset.html" class="btn btn-neutral" title="pyarrow.parquet.ParquetDataset" 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.parquet.read_table.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.parquet.read_table.html b/docs/python/generated/pyarrow.parquet.read_table.html new file mode 100644 index 0000000..83c2bb3 --- /dev/null +++ b/docs/python/generated/pyarrow.parquet.read_table.html @@ -0,0 +1,289 @@ + + +<!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.parquet.read_table — 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.parquet.write_metadata" href="pyarrow.parquet.write_metadata.html"/> + <link rel="prev" title="pyarrow.parquet.ParquetFile" href="pyarrow.parquet.ParquetFile.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"><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 current"><a class="reference internal" href="../api.html#apache-parquet">Apache Parquet</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ParquetDataset.html">pyarrow.parquet.ParquetDataset</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ParquetFile.html">pyarrow.parquet.ParquetFile</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.parquet.read_table</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.write_metadata.html">pyarrow.parquet.write_metadata</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.write_table.html">pyarrow.parquet.write_table</a></li> +</ul> +</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.parquet.read_table</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.parquet.read_table.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-parquet-read-table"> +<h1>pyarrow.parquet.read_table<a class="headerlink" href="#pyarrow-parquet-read-table" title="Permalink to this headline">¶</a></h1> +<dl class="function"> +<dt id="pyarrow.parquet.read_table"> +<code class="descclassname">pyarrow.parquet.</code><code class="descname">read_table</code><span class="sig-paren">(</span><em>source</em>, <em>columns=None</em>, <em>nthreads=1</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#read_table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.read_table" title="Permalink to this definition">¶</a></dt> +<dd><p>Read a Table from Parquet format</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"><ul class="first simple"> +<li><strong>source</strong> (<em>str</em><em> or </em><em>pyarrow.io.NativeFile</em>) – Location of Parquet dataset. If a string passed, can be a single file +name or directory name. For passing Python file objects or byte +buffers, see pyarrow.io.PythonFileInterface or pyarrow.io.BufferReader.</li> +<li><strong>columns</strong> (<em>list</em>) – If not None, only these columns will be read from the file.</li> +<li><strong>nthreads</strong> (<em>int</em><em>, </em><em>default 1</em>) – Number of columns to read in parallel. Requires that the underlying +file source is threadsafe</li> +<li><strong>metadata</strong> (<em>FileMetaData</em>) – If separately computed</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><em>pyarrow.Table</em> – Content of the file as a table (of columns)</p> +</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.parquet.write_metadata.html" class="btn btn-neutral float-right" title="pyarrow.parquet.write_metadata" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.parquet.ParquetFile.html" class="btn btn-neutral" title="pyarrow.parquet.ParquetFile" 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.parquet.write_metadata.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.parquet.write_metadata.html b/docs/python/generated/pyarrow.parquet.write_metadata.html new file mode 100644 index 0000000..d3ef08d --- /dev/null +++ b/docs/python/generated/pyarrow.parquet.write_metadata.html @@ -0,0 +1,282 @@ + + +<!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.parquet.write_metadata — 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.parquet.write_table" href="pyarrow.parquet.write_table.html"/> + <link rel="prev" title="pyarrow.parquet.read_table" href="pyarrow.parquet.read_table.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"><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 current"><a class="reference internal" href="../api.html#apache-parquet">Apache Parquet</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ParquetDataset.html">pyarrow.parquet.ParquetDataset</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ParquetFile.html">pyarrow.parquet.ParquetFile</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.read_table.html">pyarrow.parquet.read_table</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.parquet.write_metadata</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.write_table.html">pyarrow.parquet.write_table</a></li> +</ul> +</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.parquet.write_metadata</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.parquet.write_metadata.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-parquet-write-metadata"> +<h1>pyarrow.parquet.write_metadata<a class="headerlink" href="#pyarrow-parquet-write-metadata" title="Permalink to this headline">¶</a></h1> +<dl class="function"> +<dt id="pyarrow.parquet.write_metadata"> +<code class="descclassname">pyarrow.parquet.</code><code class="descname">write_metadata</code><span class="sig-paren">(</span><em>schema</em>, <em>where</em>, <em>version='1.0'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#write_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.write_metadata" title="Permalink to this definition">¶</a></dt> +<dd><p>Write metadata-only Parquet file from schema</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"><ul class="first last simple"> +<li><strong>schema</strong> (<a class="reference internal" href="pyarrow.Schema.html#pyarrow.Schema" title="pyarrow.Schema"><em>pyarrow.Schema</em></a>) – </li> +<li><strong>where</strong> (<a class="reference internal" href="pyarrow.string.html#pyarrow.string" title="pyarrow.string"><em>string</em></a><em> or </em><em>pyarrow.io.NativeFile</em>) – </li> +<li><strong>version</strong> (<em>{"1.0"</em><em>, </em><em>"2.0"}</em><em>, </em><em>default "1.0"</em>) – The Parquet format version, defaults to 1.0</li> +</ul> +</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.parquet.write_table.html" class="btn btn-neutral float-right" title="pyarrow.parquet.write_table" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.parquet.read_table.html" class="btn btn-neutral" title="pyarrow.parquet.read_table" 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.parquet.write_table.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.parquet.write_table.html b/docs/python/generated/pyarrow.parquet.write_table.html new file mode 100644 index 0000000..37400f2 --- /dev/null +++ b/docs/python/generated/pyarrow.parquet.write_table.html @@ -0,0 +1,287 @@ + + +<!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.parquet.write_table — 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="Getting Involved" href="../getting_involved.html"/> + <link rel="prev" title="pyarrow.parquet.write_metadata" href="pyarrow.parquet.write_metadata.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"><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 current"><a class="reference internal" href="../api.html#apache-parquet">Apache Parquet</a><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ParquetDataset.html">pyarrow.parquet.ParquetDataset</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ParquetFile.html">pyarrow.parquet.ParquetFile</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.read_table.html">pyarrow.parquet.read_table</a></li> +<li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.write_metadata.html">pyarrow.parquet.write_metadata</a></li> +<li class="toctree-l3 current"><a class="current reference internal" href="#">pyarrow.parquet.write_table</a></li> +</ul> +</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.parquet.write_table</li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/generated/pyarrow.parquet.write_table.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-parquet-write-table"> +<h1>pyarrow.parquet.write_table<a class="headerlink" href="#pyarrow-parquet-write-table" title="Permalink to this headline">¶</a></h1> +<dl class="function"> +<dt id="pyarrow.parquet.write_table"> +<code class="descclassname">pyarrow.parquet.</code><code class="descname">write_table</code><span class="sig-paren">(</span><em>table</em>, <em>where</em>, <em>row_group_size=None</em>, <em>version='1.0'</em>, <em>use_dictionary=True</em>, <em>compression='snappy'</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#write_table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.write_table" title="Permalink to this definition">¶</a></dt> +<dd><p>Write a Table to Parquet format</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"><ul class="first last simple"> +<li><strong>table</strong> (<a class="reference internal" href="pyarrow.Table.html#pyarrow.Table" title="pyarrow.Table"><em>pyarrow.Table</em></a>) – </li> +<li><strong>where</strong> (<a class="reference internal" href="pyarrow.string.html#pyarrow.string" title="pyarrow.string"><em>string</em></a><em> or </em><em>pyarrow.io.NativeFile</em>) – </li> +<li><strong>row_group_size</strong> (<em>int</em><em>, </em><em>default None</em>) – The maximum number of rows in each Parquet RowGroup. As a default, +we will write a single RowGroup per file.</li> +<li><strong>version</strong> (<em>{"1.0"</em><em>, </em><em>"2.0"}</em><em>, </em><em>default "1.0"</em>) – The Parquet format version, defaults to 1.0</li> +<li><strong>use_dictionary</strong> (<em>bool</em><em> or </em><em>list</em>) – Specify if we should use dictionary encoding in general or only for +some columns.</li> +<li><strong>compression</strong> (<em>str</em><em> or </em><em>dict</em>) – Specify the compression codec, either on a general basis or per-column.</li> +</ul> +</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="../getting_involved.html" class="btn btn-neutral float-right" title="Getting Involved" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="pyarrow.parquet.write_metadata.html" class="btn btn-neutral" title="pyarrow.parquet.write_metadata" 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
