http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.open_stream.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.open_stream.html b/docs/python/generated/pyarrow.open_stream.html index d27f284..b8307bc 100644 --- a/docs/python/generated/pyarrow.open_stream.html +++ b/docs/python/generated/pyarrow.open_stream.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -101,11 +102,11 @@ <li> - <a href="pyarrow.open_file.html" title="Previous Chapter: pyarrow.open_file"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.open_file</span> + <a href="pyarrow.open_file.html" title="Previous Chapter: pyarrow.open_file"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.open_...</span> </a> </li> <li> - <a href="pyarrow.read_message.html" title="Next Chapter: pyarrow.read_message"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.read_message »</span> + <a href="pyarrow.read_message.html" title="Next Chapter: pyarrow.read_message"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.read_... »</span> </a> </li>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/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 index 6a9c471..48a5aeb 100644 --- a/docs/python/generated/pyarrow.parquet.ParquetDataset.html +++ b/docs/python/generated/pyarrow.parquet.ParquetDataset.html @@ -31,7 +31,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="pyarrow.parquet.ParquetFile" href="pyarrow.parquet.ParquetFile.html" /> - <link rel="prev" title="pyarrow.Schema" href="pyarrow.Schema.html" /> + <link rel="prev" title="pyarrow.plasma.PlasmaBuffer" href="pyarrow.plasma.PlasmaBuffer.html" /> <meta charset='utf-8'> <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -101,7 +102,7 @@ <li> - <a href="pyarrow.Schema.html" title="Previous Chapter: pyarrow.Schema"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.Schema</span> + <a href="pyarrow.plasma.PlasmaBuffer.html" title="Previous Chapter: pyarrow.plasma.PlasmaBuffer"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.plasm...</span> </a> </li> <li> @@ -153,7 +154,7 @@ consisting of multiple files and partitions in subdirectories</p> <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 +<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 @@ -180,17 +181,20 @@ metadata parameter</li> <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><a class="reference internal" href="#pyarrow.parquet.ParquetDataset.read" title="pyarrow.parquet.ParquetDataset.read"><code class="xref py py-obj docutils literal"><span class="pre">read</span></code></a>([columns, nthreads])</td> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.parquet.ParquetDataset.read" title="pyarrow.parquet.ParquetDataset.read"><code class="xref py py-obj docutils literal"><span class="pre">read</span></code></a>([columns, nthreads, use_pandas_metadata])</td> <td>Read multiple Parquet files as a single pyarrow.Table</td> </tr> -<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.parquet.ParquetDataset.validate_schemas" title="pyarrow.parquet.ParquetDataset.validate_schemas"><code class="xref py py-obj docutils literal"><span class="pre">validate_schemas</span></code></a>()</td> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.parquet.ParquetDataset.read_pandas" title="pyarrow.parquet.ParquetDataset.read_pandas"><code class="xref py py-obj docutils literal"><span class="pre">read_pandas</span></code></a>(**kwargs)</td> +<td>Read dataset including pandas metadata, if any.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.parquet.ParquetDataset.validate_schemas" title="pyarrow.parquet.ParquetDataset.validate_schemas"><code class="xref py py-obj docutils literal"><span class="pre">validate_schemas</span></code></a>()</td> <td></td> </tr> </tbody> </table> <dl class="method"> <dt id="pyarrow.parquet.ParquetDataset.read"> -<code class="descname">read</code><span class="sig-paren">(</span><em>columns=None</em>, <em>nthreads=1</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#ParquetDataset.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.ParquetDataset.read" title="Permalink to this definition">¶</a></dt> +<code class="descname">read</code><span class="sig-paren">(</span><em>columns=None</em>, <em>nthreads=1</em>, <em>use_pandas_metadata=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#ParquetDataset.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.ParquetDataset.read" title="Permalink to this definition">¶</a></dt> <dd><p>Read multiple Parquet files as a single pyarrow.Table</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> @@ -200,6 +204,7 @@ metadata parameter</li> <li><strong>columns</strong> (<em>List</em><em>[</em><em>str</em><em>]</em><em></em>) – Names of columns to 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>use_pandas_metadata</strong> (<em>bool</em><em>, </em><em>default False</em>) – Passed through to each dataset piece</li> </ul> </td> </tr> @@ -211,6 +216,21 @@ file source is threadsafe</li> </dd></dl> <dl class="method"> +<dt id="pyarrow.parquet.ParquetDataset.read_pandas"> +<code class="descname">read_pandas</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#ParquetDataset.read_pandas"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.ParquetDataset.read_pandas" title="Permalink to this definition">¶</a></dt> +<dd><p>Read dataset including pandas metadata, if any. Other arguments passed +through to ParquetDataset.read, see docstring for further details</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">Returns:</th><td class="field-body"><em>pyarrow.Table</em> – Content of the file as a table (of columns)</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> <dt id="pyarrow.parquet.ParquetDataset.validate_schemas"> <code class="descname">validate_schemas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#ParquetDataset.validate_schemas"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.ParquetDataset.validate_schemas" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/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 index 6308e31..ba9d189 100644 --- a/docs/python/generated/pyarrow.parquet.ParquetFile.html +++ b/docs/python/generated/pyarrow.parquet.ParquetFile.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -143,7 +144,7 @@ <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> +<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>, <em>common_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>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> <p>Reader interface for a single Parquet file</p> <table class="docutils field-list" frame="void" rules="none"> @@ -154,6 +155,8 @@ <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> +<li><strong>common_metadata</strong> (<em>ParquetFileMetadata</em><em>, </em><em>default None</em>) – Will be used in reads for pandas schema metadata if not found in the +main file’s metadata, no other uses at the moment</li> </ul> </td> </tr> @@ -161,7 +164,7 @@ see pyarrow.io.PythonFileInterface or pyarrow.io.BufferReader.</li> </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> +<code class="descname">__init__</code><span class="sig-paren">(</span><em>source</em>, <em>metadata=None</em>, <em>common_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> @@ -171,16 +174,13 @@ see pyarrow.io.PythonFileInterface or pyarrow.io.BufferReader.</li> <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> +<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, common_metadata])</td> <td></td> </tr> -<tr class="row-even"><td><a class="reference internal" href="#pyarrow.parquet.ParquetFile.read" title="pyarrow.parquet.ParquetFile.read"><code class="xref py py-obj docutils literal"><span class="pre">read</span></code></a>([columns, nthreads])</td> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.parquet.ParquetFile.read" title="pyarrow.parquet.ParquetFile.read"><code class="xref py py-obj docutils literal"><span class="pre">read</span></code></a>([columns, nthreads, use_pandas_metadata])</td> <td>Read a Table from Parquet format</td> </tr> -<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.parquet.ParquetFile.read_pandas" title="pyarrow.parquet.ParquetFile.read_pandas"><code class="xref py py-obj docutils literal"><span class="pre">read_pandas</span></code></a>([columns, nthreads])</td> -<td></td> -</tr> -<tr class="row-even"><td><a class="reference internal" href="#pyarrow.parquet.ParquetFile.read_row_group" title="pyarrow.parquet.ParquetFile.read_row_group"><code class="xref py py-obj docutils literal"><span class="pre">read_row_group</span></code></a>(i[, columns, nthreads])</td> +<tr class="row-odd"><td><a class="reference internal" href="#pyarrow.parquet.ParquetFile.read_row_group" title="pyarrow.parquet.ParquetFile.read_row_group"><code class="xref py py-obj docutils literal"><span class="pre">read_row_group</span></code></a>(i[, columns, nthreads, ...])</td> <td>Read a single row group from a Parquet file</td> </tr> </tbody> @@ -215,7 +215,7 @@ see pyarrow.io.PythonFileInterface or pyarrow.io.BufferReader.</li> <dl class="method"> <dt id="pyarrow.parquet.ParquetFile.read"> -<code class="descname">read</code><span class="sig-paren">(</span><em>columns=None</em>, <em>nthreads=1</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#ParquetFile.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.ParquetFile.read" title="Permalink to this definition">¶</a></dt> +<code class="descname">read</code><span class="sig-paren">(</span><em>columns=None</em>, <em>nthreads=1</em>, <em>use_pandas_metadata=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#ParquetFile.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.ParquetFile.read" 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" /> @@ -225,6 +225,8 @@ 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. If > 1, requires that the underlying file source is threadsafe</li> +<li><strong>use_pandas_metadata</strong> (<em>boolean</em><em>, </em><em>default False</em>) – If True and file has custom pandas schema metadata, ensure that +index columns are also loaded</li> </ul> </td> </tr> @@ -236,13 +238,8 @@ underlying file source is threadsafe</li> </dd></dl> <dl class="method"> -<dt id="pyarrow.parquet.ParquetFile.read_pandas"> -<code class="descname">read_pandas</code><span class="sig-paren">(</span><em>columns=None</em>, <em>nthreads=1</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#ParquetFile.read_pandas"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.ParquetFile.read_pandas" title="Permalink to this definition">¶</a></dt> -<dd></dd></dl> - -<dl class="method"> <dt id="pyarrow.parquet.ParquetFile.read_row_group"> -<code class="descname">read_row_group</code><span class="sig-paren">(</span><em>i</em>, <em>columns=None</em>, <em>nthreads=1</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#ParquetFile.read_row_group"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.ParquetFile.read_row_group" title="Permalink to this definition">¶</a></dt> +<code class="descname">read_row_group</code><span class="sig-paren">(</span><em>i</em>, <em>columns=None</em>, <em>nthreads=1</em>, <em>use_pandas_metadata=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#ParquetFile.read_row_group"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.ParquetFile.read_row_group" title="Permalink to this definition">¶</a></dt> <dd><p>Read a single row group from a Parquet file</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> @@ -252,6 +249,8 @@ underlying file source is threadsafe</li> <li><strong>columns</strong> (<em>list</em>) – If not None, only these columns will be read from the row group.</li> <li><strong>nthreads</strong> (<em>int</em><em>, </em><em>default 1</em>) – Number of columns to read in parallel. If > 1, requires that the underlying file source is threadsafe</li> +<li><strong>use_pandas_metadata</strong> (<em>boolean</em><em>, </em><em>default False</em>) – If True and file has custom pandas schema metadata, ensure that +index columns are also loaded</li> </ul> </td> </tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.parquet.read_metadata.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.parquet.read_metadata.html b/docs/python/generated/pyarrow.parquet.read_metadata.html new file mode 100644 index 0000000..7ea7dd4 --- /dev/null +++ b/docs/python/generated/pyarrow.parquet.read_metadata.html @@ -0,0 +1,181 @@ +<!DOCTYPE html> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>pyarrow.parquet.read_metadata — pyarrow documentation</title> + + <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <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/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> + <script type="text/javascript" src="../_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> + <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="pyarrow.parquet.read_pandas" href="pyarrow.parquet.read_pandas.html" /> + <link rel="prev" title="pyarrow.parquet.read_table" href="pyarrow.parquet.read_table.html" /> +<meta charset='utf-8'> +<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> +<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> +<meta name="apple-mobile-web-app-capable" content="yes"> + + </head> + <body role="document"> + + <div id="navbar" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <!-- .btn-navbar is used as the toggle for collapsed navbar content --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="../index.html"> + pyarrow</a> + <span class="navbar-text navbar-version pull-left"><b></b></span> + </div> + + <div class="collapse navbar-collapse nav-collapse"> + <ul class="nav navbar-nav"> + + + <li class="dropdown globaltoc-container"> + <a role="button" + id="dLabelGlobalToc" + data-toggle="dropdown" + data-target="#" + href="../index.html">Site <b class="caret"></b></a> + <ul class="dropdown-menu globaltoc" + role="menu" + aria-labelledby="dLabelGlobalToc"><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="../development.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +</ul> +</li> + + <li class="dropdown"> + <a role="button" + id="dLabelLocalToc" + data-toggle="dropdown" + data-target="#" + href="#">Page <b class="caret"></b></a> + <ul class="dropdown-menu localtoc" + role="menu" + aria-labelledby="dLabelLocalToc"><ul> +<li><a class="reference internal" href="#">pyarrow.parquet.read_metadata</a></li> +</ul> +</ul> +</li> + + + + + + <li> + <a href="pyarrow.parquet.read_table.html" title="Previous Chapter: pyarrow.parquet.read_table"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.parqu...</span> + </a> + </li> + <li> + <a href="pyarrow.parquet.read_pandas.html" title="Next Chapter: pyarrow.parquet.read_pandas"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.parqu... »</span> + </a> + </li> + + + + + + <li class="hidden-sm"> +<div id="sourcelink"> + <a href="../_sources/generated/pyarrow.parquet.read_metadata.rst.txt" + rel="nofollow">Source</a> +</div></li> + + </ul> + + + +<form class="navbar-form navbar-right" action="../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search" /> + </div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> +</form> + + </div> + </div> + </div> + +<div class="container"> + <div class="row"> + <div class="col-md-12 content"> + + <div class="section" id="pyarrow-parquet-read-metadata"> +<h1>pyarrow.parquet.read_metadata<a class="headerlink" href="#pyarrow-parquet-read-metadata" title="Permalink to this headline">¶</a></h1> +<dl class="function"> +<dt id="pyarrow.parquet.read_metadata"> +<code class="descclassname">pyarrow.parquet.</code><code class="descname">read_metadata</code><span class="sig-paren">(</span><em>where</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#read_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.read_metadata" title="Permalink to this definition">¶</a></dt> +<dd><p>Read FileMetadata from footer of 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"><strong>where</strong> (<a class="reference internal" href="pyarrow.string.html#pyarrow.string" title="pyarrow.string"><em>string</em></a><em> (</em><em>filepath</em><em>) or </em><em>file-like object</em>) – </td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>metadata</strong> (<em>FileMetadata</em>)</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + + </div> +</div> +<footer class="footer"> + <div class="container"> + <p class="pull-right"> + <a href="#">Back to top</a> + + </p> + <p> + © Copyright 2016-2017 Apache Software Foundation.<br/> + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.5.5.<br/> + </p> + </div> +</footer> + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.parquet.read_pandas.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.parquet.read_pandas.html b/docs/python/generated/pyarrow.parquet.read_pandas.html new file mode 100644 index 0000000..597a0e6 --- /dev/null +++ b/docs/python/generated/pyarrow.parquet.read_pandas.html @@ -0,0 +1,193 @@ +<!DOCTYPE html> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>pyarrow.parquet.read_pandas — pyarrow documentation</title> + + <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <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/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> + <script type="text/javascript" src="../_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> + <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="pyarrow.parquet.read_schema" href="pyarrow.parquet.read_schema.html" /> + <link rel="prev" title="pyarrow.parquet.read_metadata" href="pyarrow.parquet.read_metadata.html" /> +<meta charset='utf-8'> +<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> +<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> +<meta name="apple-mobile-web-app-capable" content="yes"> + + </head> + <body role="document"> + + <div id="navbar" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <!-- .btn-navbar is used as the toggle for collapsed navbar content --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="../index.html"> + pyarrow</a> + <span class="navbar-text navbar-version pull-left"><b></b></span> + </div> + + <div class="collapse navbar-collapse nav-collapse"> + <ul class="nav navbar-nav"> + + + <li class="dropdown globaltoc-container"> + <a role="button" + id="dLabelGlobalToc" + data-toggle="dropdown" + data-target="#" + href="../index.html">Site <b class="caret"></b></a> + <ul class="dropdown-menu globaltoc" + role="menu" + aria-labelledby="dLabelGlobalToc"><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="../development.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +</ul> +</li> + + <li class="dropdown"> + <a role="button" + id="dLabelLocalToc" + data-toggle="dropdown" + data-target="#" + href="#">Page <b class="caret"></b></a> + <ul class="dropdown-menu localtoc" + role="menu" + aria-labelledby="dLabelLocalToc"><ul> +<li><a class="reference internal" href="#">pyarrow.parquet.read_pandas</a></li> +</ul> +</ul> +</li> + + + + + + <li> + <a href="pyarrow.parquet.read_metadata.html" title="Previous Chapter: pyarrow.parquet.read_metadata"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.parqu...</span> + </a> + </li> + <li> + <a href="pyarrow.parquet.read_schema.html" title="Next Chapter: pyarrow.parquet.read_schema"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.parqu... »</span> + </a> + </li> + + + + + + <li class="hidden-sm"> +<div id="sourcelink"> + <a href="../_sources/generated/pyarrow.parquet.read_pandas.rst.txt" + rel="nofollow">Source</a> +</div></li> + + </ul> + + + +<form class="navbar-form navbar-right" action="../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search" /> + </div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> +</form> + + </div> + </div> + </div> + +<div class="container"> + <div class="row"> + <div class="col-md-12 content"> + + <div class="section" id="pyarrow-parquet-read-pandas"> +<h1>pyarrow.parquet.read_pandas<a class="headerlink" href="#pyarrow-parquet-read-pandas" title="Permalink to this headline">¶</a></h1> +<dl class="function"> +<dt id="pyarrow.parquet.read_pandas"> +<code class="descclassname">pyarrow.parquet.</code><code class="descname">read_pandas</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_pandas"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.read_pandas" title="Permalink to this definition">¶</a></dt> +<dd><p>Read a Table from Parquet format, also reading DataFrame index values if +known in the file metadata</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. 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, including DataFrame indexes +as Columns.</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + + </div> +</div> +<footer class="footer"> + <div class="container"> + <p class="pull-right"> + <a href="#">Back to top</a> + + </p> + <p> + © Copyright 2016-2017 Apache Software Foundation.<br/> + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.5.5.<br/> + </p> + </div> +</footer> + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.parquet.read_schema.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.parquet.read_schema.html b/docs/python/generated/pyarrow.parquet.read_schema.html new file mode 100644 index 0000000..260b25c --- /dev/null +++ b/docs/python/generated/pyarrow.parquet.read_schema.html @@ -0,0 +1,181 @@ +<!DOCTYPE html> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>pyarrow.parquet.read_schema — pyarrow documentation</title> + + <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <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/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> + <script type="text/javascript" src="../_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> + <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="pyarrow.parquet.write_metadata" href="pyarrow.parquet.write_metadata.html" /> + <link rel="prev" title="pyarrow.parquet.read_pandas" href="pyarrow.parquet.read_pandas.html" /> +<meta charset='utf-8'> +<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> +<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> +<meta name="apple-mobile-web-app-capable" content="yes"> + + </head> + <body role="document"> + + <div id="navbar" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <!-- .btn-navbar is used as the toggle for collapsed navbar content --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="../index.html"> + pyarrow</a> + <span class="navbar-text navbar-version pull-left"><b></b></span> + </div> + + <div class="collapse navbar-collapse nav-collapse"> + <ul class="nav navbar-nav"> + + + <li class="dropdown globaltoc-container"> + <a role="button" + id="dLabelGlobalToc" + data-toggle="dropdown" + data-target="#" + href="../index.html">Site <b class="caret"></b></a> + <ul class="dropdown-menu globaltoc" + role="menu" + aria-labelledby="dLabelGlobalToc"><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="../development.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +</ul> +</li> + + <li class="dropdown"> + <a role="button" + id="dLabelLocalToc" + data-toggle="dropdown" + data-target="#" + href="#">Page <b class="caret"></b></a> + <ul class="dropdown-menu localtoc" + role="menu" + aria-labelledby="dLabelLocalToc"><ul> +<li><a class="reference internal" href="#">pyarrow.parquet.read_schema</a></li> +</ul> +</ul> +</li> + + + + + + <li> + <a href="pyarrow.parquet.read_pandas.html" title="Previous Chapter: pyarrow.parquet.read_pandas"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.parqu...</span> + </a> + </li> + <li> + <a href="pyarrow.parquet.write_metadata.html" title="Next Chapter: pyarrow.parquet.write_metadata"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.parqu... »</span> + </a> + </li> + + + + + + <li class="hidden-sm"> +<div id="sourcelink"> + <a href="../_sources/generated/pyarrow.parquet.read_schema.rst.txt" + rel="nofollow">Source</a> +</div></li> + + </ul> + + + +<form class="navbar-form navbar-right" action="../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search" /> + </div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> +</form> + + </div> + </div> + </div> + +<div class="container"> + <div class="row"> + <div class="col-md-12 content"> + + <div class="section" id="pyarrow-parquet-read-schema"> +<h1>pyarrow.parquet.read_schema<a class="headerlink" href="#pyarrow-parquet-read-schema" title="Permalink to this headline">¶</a></h1> +<dl class="function"> +<dt id="pyarrow.parquet.read_schema"> +<code class="descclassname">pyarrow.parquet.</code><code class="descname">read_schema</code><span class="sig-paren">(</span><em>where</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyarrow/parquet.html#read_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyarrow.parquet.read_schema" title="Permalink to this definition">¶</a></dt> +<dd><p>Read effective Arrow schema from Parquet file metadata</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>where</strong> (<a class="reference internal" href="pyarrow.string.html#pyarrow.string" title="pyarrow.string"><em>string</em></a><em> (</em><em>filepath</em><em>) or </em><em>file-like object</em>) – </td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>schema</strong> (<em>pyarrow.Schema</em>)</td> +</tr> +</tbody> +</table> +</dd></dl> + +</div> + + + </div> + + </div> +</div> +<footer class="footer"> + <div class="container"> + <p class="pull-right"> + <a href="#">Back to top</a> + + </p> + <p> + © Copyright 2016-2017 Apache Software Foundation.<br/> + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.5.5.<br/> + </p> + </div> +</footer> + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/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 index 97b35ea..af69d52 100644 --- a/docs/python/generated/pyarrow.parquet.read_table.html +++ b/docs/python/generated/pyarrow.parquet.read_table.html @@ -30,7 +30,7 @@ <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> - <link rel="next" title="pyarrow.parquet.write_metadata" href="pyarrow.parquet.write_metadata.html" /> + <link rel="next" title="pyarrow.parquet.read_metadata" href="pyarrow.parquet.read_metadata.html" /> <link rel="prev" title="pyarrow.parquet.ParquetFile" href="pyarrow.parquet.ParquetFile.html" /> <meta charset='utf-8'> <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -105,7 +106,7 @@ </a> </li> <li> - <a href="pyarrow.parquet.write_metadata.html" title="Next Chapter: pyarrow.parquet.write_metadata"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.parqu... »</span> + <a href="pyarrow.parquet.read_metadata.html" title="Next Chapter: pyarrow.parquet.read_metadata"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.parqu... »</span> </a> </li> @@ -143,7 +144,7 @@ <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> +<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>, <em>use_pandas_metadata=False</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" /> @@ -157,6 +158,8 @@ buffers, see pyarrow.io.PythonFileInterface or pyarrow.io.BufferReader.</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> +<li><strong>use_pandas_metadata</strong> (<em>boolean</em><em>, </em><em>default False</em>) – If True and file has custom pandas schema metadata, ensure that +index columns are also loaded</li> </ul> </td> </tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/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 index 1d38fa1..06f8564 100644 --- a/docs/python/generated/pyarrow.parquet.write_metadata.html +++ b/docs/python/generated/pyarrow.parquet.write_metadata.html @@ -31,7 +31,7 @@ <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.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" /> + <link rel="prev" title="pyarrow.parquet.read_schema" href="pyarrow.parquet.read_schema.html" /> <meta charset='utf-8'> <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -101,7 +102,7 @@ <li> - <a href="pyarrow.parquet.read_table.html" title="Previous Chapter: pyarrow.parquet.read_table"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.parqu...</span> + <a href="pyarrow.parquet.read_schema.html" title="Previous Chapter: pyarrow.parquet.read_schema"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.parqu...</span> </a> </li> <li> @@ -143,16 +144,19 @@ <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> +<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>, <em>use_deprecated_int96_timestamps=False</em>, <em>coerce_timestamps=None</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>schema</strong> (<em>pyarrow.Schema</em>) – </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> +<li><strong>use_deprecated_int96_timestamps</strong> (<em>boolean</em><em>, </em><em>default False</em>) – Write nanosecond resolution timestamps to INT96 Parquet format</li> +<li><strong>coerce_timestamps</strong> (<a class="reference internal" href="pyarrow.string.html#pyarrow.string" title="pyarrow.string"><em>string</em></a><em>, </em><em>default None</em>) – Cast timestamps a particular resolution. +Valid values: {None, ‘ms’, ‘us’}</li> </ul> </td> </tr> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/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 index 8153d99..01cb3f8 100644 --- a/docs/python/generated/pyarrow.parquet.write_table.html +++ b/docs/python/generated/pyarrow.parquet.write_table.html @@ -73,7 +73,8 @@ <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> <li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> -<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> @@ -143,7 +144,7 @@ <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> +<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>use_deprecated_int96_timestamps=False</em>, <em>coerce_timestamps=None</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" /> @@ -157,6 +158,9 @@ 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>use_deprecated_int96_timestamps</strong> (<em>boolean</em><em>, </em><em>default False</em>) – Write nanosecond resolution timestamps to INT96 Parquet format</li> +<li><strong>coerce_timestamps</strong> (<a class="reference internal" href="pyarrow.string.html#pyarrow.string" title="pyarrow.string"><em>string</em></a><em>, </em><em>default None</em>) – Cast timestamps a particular resolution. +Valid values: {None, ‘ms’, ‘us’}</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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.plasma.ObjectID.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.plasma.ObjectID.html b/docs/python/generated/pyarrow.plasma.ObjectID.html new file mode 100644 index 0000000..14cef79 --- /dev/null +++ b/docs/python/generated/pyarrow.plasma.ObjectID.html @@ -0,0 +1,204 @@ +<!DOCTYPE html> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>pyarrow.plasma.ObjectID — pyarrow documentation</title> + + <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <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/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> + <script type="text/javascript" src="../_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> + <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="pyarrow.plasma.PlasmaClient" href="pyarrow.plasma.PlasmaClient.html" /> + <link rel="prev" title="pyarrow.lib.Schema" href="pyarrow.lib.Schema.html" /> +<meta charset='utf-8'> +<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> +<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> +<meta name="apple-mobile-web-app-capable" content="yes"> + + </head> + <body role="document"> + + <div id="navbar" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <!-- .btn-navbar is used as the toggle for collapsed navbar content --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="../index.html"> + pyarrow</a> + <span class="navbar-text navbar-version pull-left"><b></b></span> + </div> + + <div class="collapse navbar-collapse nav-collapse"> + <ul class="nav navbar-nav"> + + + <li class="dropdown globaltoc-container"> + <a role="button" + id="dLabelGlobalToc" + data-toggle="dropdown" + data-target="#" + href="../index.html">Site <b class="caret"></b></a> + <ul class="dropdown-menu globaltoc" + role="menu" + aria-labelledby="dLabelGlobalToc"><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="../development.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +</ul> +</li> + + <li class="dropdown"> + <a role="button" + id="dLabelLocalToc" + data-toggle="dropdown" + data-target="#" + href="#">Page <b class="caret"></b></a> + <ul class="dropdown-menu localtoc" + role="menu" + aria-labelledby="dLabelLocalToc"><ul> +<li><a class="reference internal" href="#">pyarrow.plasma.ObjectID</a></li> +</ul> +</ul> +</li> + + + + + + <li> + <a href="pyarrow.lib.Schema.html" title="Previous Chapter: pyarrow.lib.Schema"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.lib.S...</span> + </a> + </li> + <li> + <a href="pyarrow.plasma.PlasmaClient.html" title="Next Chapter: pyarrow.plasma.PlasmaClient"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.plasm... »</span> + </a> + </li> + + + + + + <li class="hidden-sm"> +<div id="sourcelink"> + <a href="../_sources/generated/pyarrow.plasma.ObjectID.rst.txt" + rel="nofollow">Source</a> +</div></li> + + </ul> + + + +<form class="navbar-form navbar-right" action="../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search" /> + </div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> +</form> + + </div> + </div> + </div> + +<div class="container"> + <div class="row"> + <div class="col-md-12 content"> + + <div class="section" id="pyarrow-plasma-objectid"> +<h1>pyarrow.plasma.ObjectID<a class="headerlink" href="#pyarrow-plasma-objectid" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.plasma.ObjectID"> +<em class="property">class </em><code class="descclassname">pyarrow.plasma.</code><code class="descname">ObjectID</code><a class="headerlink" href="#pyarrow.plasma.ObjectID" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> +<p>An ObjectID represents a string of bytes used to identify Plasma objects.</p> +<dl class="method"> +<dt id="pyarrow.plasma.ObjectID.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.plasma.ObjectID.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>Initialize self. See help(type(self)) for accurate signature.</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table 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.plasma.ObjectID.binary" title="pyarrow.plasma.ObjectID.binary"><code class="xref py py-obj docutils literal"><span class="pre">binary</span></code></a>(self)</td> +<td>Return the binary representation of this ObjectID.</td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="pyarrow.plasma.ObjectID.binary"> +<code class="descname">binary</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.plasma.ObjectID.binary" title="Permalink to this definition">¶</a></dt> +<dd><p>Return the binary representation of this ObjectID.</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">Returns:</th><td class="field-body"><em>bytes</em> – Binary representation of the ObjectID.</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> +</div> +<footer class="footer"> + <div class="container"> + <p class="pull-right"> + <a href="#">Back to top</a> + + </p> + <p> + © Copyright 2016-2017 Apache Software Foundation.<br/> + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.5.5.<br/> + </p> + </div> +</footer> + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4d4a3202/docs/python/generated/pyarrow.plasma.PlasmaBuffer.html ---------------------------------------------------------------------- diff --git a/docs/python/generated/pyarrow.plasma.PlasmaBuffer.html b/docs/python/generated/pyarrow.plasma.PlasmaBuffer.html new file mode 100644 index 0000000..b649589 --- /dev/null +++ b/docs/python/generated/pyarrow.plasma.PlasmaBuffer.html @@ -0,0 +1,236 @@ +<!DOCTYPE html> + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>pyarrow.plasma.PlasmaBuffer — pyarrow documentation</title> + + <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <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/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> + <script type="text/javascript" src="../_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> + <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="pyarrow.parquet.ParquetDataset" href="pyarrow.parquet.ParquetDataset.html" /> + <link rel="prev" title="pyarrow.plasma.PlasmaClient" href="pyarrow.plasma.PlasmaClient.html" /> +<meta charset='utf-8'> +<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> +<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> +<meta name="apple-mobile-web-app-capable" content="yes"> + + </head> + <body role="document"> + + <div id="navbar" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <!-- .btn-navbar is used as the toggle for collapsed navbar content --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="../index.html"> + pyarrow</a> + <span class="navbar-text navbar-version pull-left"><b></b></span> + </div> + + <div class="collapse navbar-collapse nav-collapse"> + <ul class="nav navbar-nav"> + + + <li class="dropdown globaltoc-container"> + <a role="button" + id="dLabelGlobalToc" + data-toggle="dropdown" + data-target="#" + href="../index.html">Site <b class="caret"></b></a> + <ul class="dropdown-menu globaltoc" + role="menu" + aria-labelledby="dLabelGlobalToc"><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="../development.html">Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data.html">In-Memory Data Model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../ipc.html">IPC: Fast Streaming and Serialization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../filesystems.html">File System Interfaces</a></li> +<li class="toctree-l1"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../pandas.html">Using PyArrow with pandas</a></li> +<li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> +</ul> +</ul> +</li> + + <li class="dropdown"> + <a role="button" + id="dLabelLocalToc" + data-toggle="dropdown" + data-target="#" + href="#">Page <b class="caret"></b></a> + <ul class="dropdown-menu localtoc" + role="menu" + aria-labelledby="dLabelLocalToc"><ul> +<li><a class="reference internal" href="#">pyarrow.plasma.PlasmaBuffer</a></li> +</ul> +</ul> +</li> + + + + + + <li> + <a href="pyarrow.plasma.PlasmaClient.html" title="Previous Chapter: pyarrow.plasma.PlasmaClient"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« pyarrow.plasm...</span> + </a> + </li> + <li> + <a href="pyarrow.parquet.ParquetDataset.html" title="Next Chapter: pyarrow.parquet.ParquetDataset"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">pyarrow.parqu... »</span> + </a> + </li> + + + + + + <li class="hidden-sm"> +<div id="sourcelink"> + <a href="../_sources/generated/pyarrow.plasma.PlasmaBuffer.rst.txt" + rel="nofollow">Source</a> +</div></li> + + </ul> + + + +<form class="navbar-form navbar-right" action="../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search" /> + </div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> +</form> + + </div> + </div> + </div> + +<div class="container"> + <div class="row"> + <div class="col-md-12 content"> + + <div class="section" id="pyarrow-plasma-plasmabuffer"> +<h1>pyarrow.plasma.PlasmaBuffer<a class="headerlink" href="#pyarrow-plasma-plasmabuffer" title="Permalink to this headline">¶</a></h1> +<dl class="class"> +<dt id="pyarrow.plasma.PlasmaBuffer"> +<em class="property">class </em><code class="descclassname">pyarrow.plasma.</code><code class="descname">PlasmaBuffer</code><a class="headerlink" href="#pyarrow.plasma.PlasmaBuffer" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">pyarrow.lib.Buffer</span></code></p> +<p>This is the type returned by calls to get with a PlasmaClient.</p> +<p>We define our own class instead of directly returning a buffer object so +that we can add a custom destructor which notifies Plasma that the object +is no longer being used, so the memory in the Plasma store backing the +object can potentially be freed.</p> +<dl class="attribute"> +<dt id="pyarrow.plasma.PlasmaBuffer.object_id"> +<code class="descname">object_id</code><a class="headerlink" href="#pyarrow.plasma.PlasmaBuffer.object_id" title="Permalink to this definition">¶</a></dt> +<dd><p><em>ObjectID</em> – The ID of the object in the buffer.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="pyarrow.plasma.PlasmaBuffer.client"> +<code class="descname">client</code><a class="headerlink" href="#pyarrow.plasma.PlasmaBuffer.client" title="Permalink to this definition">¶</a></dt> +<dd><p><em>PlasmaClient</em> – The PlasmaClient that we use to communicate with the store and manager.</p> +</dd></dl> + +<dl class="method"> +<dt id="pyarrow.plasma.PlasmaBuffer.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.plasma.PlasmaBuffer.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>Initialize self. See help(type(self)) for accurate signature.</p> +</dd></dl> + +<p class="rubric">Methods</p> +<table 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.plasma.PlasmaBuffer.to_pybytes" title="pyarrow.plasma.PlasmaBuffer.to_pybytes"><code class="xref py py-obj docutils literal"><span class="pre">to_pybytes</span></code></a>(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><a class="reference internal" href="#pyarrow.plasma.PlasmaBuffer.parent" title="pyarrow.plasma.PlasmaBuffer.parent"><code class="xref py py-obj docutils literal"><span class="pre">parent</span></code></a></td> +<td></td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#pyarrow.plasma.PlasmaBuffer.size" title="pyarrow.plasma.PlasmaBuffer.size"><code class="xref py py-obj docutils literal"><span class="pre">size</span></code></a></td> +<td></td> +</tr> +</tbody> +</table> +<dl class="attribute"> +<dt id="pyarrow.plasma.PlasmaBuffer.parent"> +<code class="descname">parent</code><a class="headerlink" href="#pyarrow.plasma.PlasmaBuffer.parent" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="pyarrow.plasma.PlasmaBuffer.size"> +<code class="descname">size</code><a class="headerlink" href="#pyarrow.plasma.PlasmaBuffer.size" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="pyarrow.plasma.PlasmaBuffer.to_pybytes"> +<code class="descname">to_pybytes</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.plasma.PlasmaBuffer.to_pybytes" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +</div> + + + </div> + + </div> +</div> +<footer class="footer"> + <div class="container"> + <p class="pull-right"> + <a href="#">Back to top</a> + + </p> + <p> + © Copyright 2016-2017 Apache Software Foundation.<br/> + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.5.5.<br/> + </p> + </div> +</footer> + </body> +</html> \ No newline at end of file
