blob: e7085ecfae70a8d7b54abae7662f886677cb28e6 [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>Input/Output &#8212; PySpark 3.2.3 documentation</title>
<link rel="stylesheet" href="../../_static/css/index.73d71520a4ca3b99cfee5594769eaaae.css">
<link rel="stylesheet"
href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet"
href="../../_static/vendor/open-sans_all/1.44.1/index.css">
<link rel="stylesheet"
href="../../_static/vendor/lato_latin-ext/1.44.1/index.css">
<link rel="stylesheet" href="../../_static/basic.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/pyspark.css" />
<link rel="preload" as="script" href="../../_static/js/index.3da636dd464baa7582d2.js">
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<script src="../../_static/copybutton.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="pyspark.pandas.range" href="api/pyspark.pandas.range.html" />
<link rel="prev" title="Pandas API on Spark" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en" />
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main">
<div class="container-xl">
<a class="navbar-brand" href="../../index.html">
<img src="../../_static/spark-logo-reverse.png" class="logo" alt="logo" />
</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-menu" aria-controls="navbar-menu" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar-menu" class="col-lg-9 collapse navbar-collapse">
<ul id="navbar-main-elements" class="navbar-nav mr-auto">
<li class="nav-item ">
<a class="nav-link" href="../../getting_started/index.html">Getting Started</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../user_guide/index.html">User Guide</a>
</li>
<li class="nav-item active">
<a class="nav-link" href="../index.html">API Reference</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../development/index.html">Development</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../migration_guide/index.html">Migration Guide</a>
</li>
</ul>
<ul class="navbar-nav">
</ul>
</div>
</div>
</nav>
<div class="container-xl">
<div class="row">
<div class="col-12 col-md-3 bd-sidebar"><form class="bd-search d-flex align-items-center" action="../../search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form>
<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
<ul class="nav bd-sidenav">
<li class="">
<a href="../pyspark.sql.html">Spark SQL</a>
</li>
<li class="active">
<a href="index.html">Pandas API on Spark</a>
<ul>
<li class="active">
<a href="">Input/Output</a>
</li>
<li class="">
<a href="general_functions.html">General functions</a>
</li>
<li class="">
<a href="series.html">Series</a>
</li>
<li class="">
<a href="frame.html">DataFrame</a>
</li>
<li class="">
<a href="indexing.html">Index objects</a>
</li>
<li class="">
<a href="window.html">Window</a>
</li>
<li class="">
<a href="groupby.html">GroupBy</a>
</li>
<li class="">
<a href="ml.html">Machine Learning utilities</a>
</li>
<li class="">
<a href="extensions.html">Extensions</a>
</li>
</ul>
</li>
<li class="">
<a href="../pyspark.ss.html">Structured Streaming</a>
</li>
<li class="">
<a href="../pyspark.ml.html">MLlib (DataFrame-based)</a>
</li>
<li class="">
<a href="../pyspark.streaming.html">Spark Streaming</a>
</li>
<li class="">
<a href="../pyspark.mllib.html">MLlib (RDD-based)</a>
</li>
<li class="">
<a href="../pyspark.html">Spark Core</a>
</li>
<li class="">
<a href="../pyspark.resource.html">Resource Management</a>
</li>
</ul>
</nav>
</div>
<div class="d-none d-xl-block col-xl-2 bd-toc">
<div class="tocsection onthispage pt-5 pb-3">
<i class="fas fa-list"></i> On this page
</div>
<nav id="bd-toc-nav">
<ul class="nav section-nav flex-column">
<li class="nav-item toc-entry toc-h2">
<a href="#data-generator" class="nav-link">Data Generator</a>
</li>
<li class="nav-item toc-entry toc-h2">
<a href="#spark-metastore-table" class="nav-link">Spark Metastore Table</a>
</li>
<li class="nav-item toc-entry toc-h2">
<a href="#delta-lake" class="nav-link">Delta Lake</a>
</li>
<li class="nav-item toc-entry toc-h2">
<a href="#parquet" class="nav-link">Parquet</a>
</li>
<li class="nav-item toc-entry toc-h2">
<a href="#orc" class="nav-link">ORC</a>
</li>
<li class="nav-item toc-entry toc-h2">
<a href="#generic-spark-i-o" class="nav-link">Generic Spark I/O</a>
</li>
<li class="nav-item toc-entry toc-h2">
<a href="#flat-file-csv" class="nav-link">Flat File / CSV</a>
</li>
<li class="nav-item toc-entry toc-h2">
<a href="#clipboard" class="nav-link">Clipboard</a>
</li>
<li class="nav-item toc-entry toc-h2">
<a href="#excel" class="nav-link">Excel</a>
</li>
<li class="nav-item toc-entry toc-h2">
<a href="#json" class="nav-link">JSON</a>
</li>
<li class="nav-item toc-entry toc-h2">
<a href="#html" class="nav-link">HTML</a>
</li>
<li class="nav-item toc-entry toc-h2">
<a href="#sql" class="nav-link">SQL</a>
</li>
</ul>
</nav>
</div>
<main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
<div>
<div class="section" id="input-output">
<span id="api-io"></span><h1>Input/Output<a class="headerlink" href="#input-output" title="Permalink to this headline"></a></h1>
<div class="section" id="data-generator">
<h2>Data Generator<a class="headerlink" href="#data-generator" title="Permalink to this headline"></a></h2>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.pandas.range.html#pyspark.pandas.range" title="pyspark.pandas.range"><code class="xref py py-obj docutils literal notranslate"><span class="pre">range</span></code></a>(start[, end, step, num_partitions])</p></td>
<td><p>Create a DataFrame with some range of numbers.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="spark-metastore-table">
<h2>Spark Metastore Table<a class="headerlink" href="#spark-metastore-table" title="Permalink to this headline"></a></h2>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.pandas.read_table.html#pyspark.pandas.read_table" title="pyspark.pandas.read_table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_table</span></code></a>(name[, index_col])</p></td>
<td><p>Read a Spark table and return a DataFrame.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.pandas.DataFrame.to_table.html#pyspark.pandas.DataFrame.to_table" title="pyspark.pandas.DataFrame.to_table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.to_table</span></code></a>(name[, format, mode, …])</p></td>
<td><p>Write the DataFrame into a Spark table.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="delta-lake">
<h2>Delta Lake<a class="headerlink" href="#delta-lake" title="Permalink to this headline"></a></h2>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.pandas.read_delta.html#pyspark.pandas.read_delta" title="pyspark.pandas.read_delta"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_delta</span></code></a>(path[, version, timestamp, index_col])</p></td>
<td><p>Read a Delta Lake table on some file system and return a DataFrame.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.pandas.DataFrame.to_delta.html#pyspark.pandas.DataFrame.to_delta" title="pyspark.pandas.DataFrame.to_delta"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.to_delta</span></code></a>(path[, mode, …])</p></td>
<td><p>Write the DataFrame out as a Delta Lake table.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="parquet">
<h2>Parquet<a class="headerlink" href="#parquet" title="Permalink to this headline"></a></h2>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.pandas.read_parquet.html#pyspark.pandas.read_parquet" title="pyspark.pandas.read_parquet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_parquet</span></code></a>(path[, columns, index_col, …])</p></td>
<td><p>Load a parquet object from the file path, returning a DataFrame.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.pandas.DataFrame.to_parquet.html#pyspark.pandas.DataFrame.to_parquet" title="pyspark.pandas.DataFrame.to_parquet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.to_parquet</span></code></a>(path[, mode, …])</p></td>
<td><p>Write the DataFrame out as a Parquet file or directory.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="orc">
<h2>ORC<a class="headerlink" href="#orc" title="Permalink to this headline"></a></h2>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.pandas.read_orc.html#pyspark.pandas.read_orc" title="pyspark.pandas.read_orc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_orc</span></code></a>(path[, columns, index_col])</p></td>
<td><p>Load an ORC object from the file path, returning a DataFrame.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.pandas.DataFrame.to_orc.html#pyspark.pandas.DataFrame.to_orc" title="pyspark.pandas.DataFrame.to_orc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.to_orc</span></code></a>(path[, mode, …])</p></td>
<td><p>Write the DataFrame out as a ORC file or directory.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="generic-spark-i-o">
<h2>Generic Spark I/O<a class="headerlink" href="#generic-spark-i-o" title="Permalink to this headline"></a></h2>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.pandas.read_spark_io.html#pyspark.pandas.read_spark_io" title="pyspark.pandas.read_spark_io"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_spark_io</span></code></a>([path, format, schema, index_col])</p></td>
<td><p>Load a DataFrame from a Spark data source.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.pandas.DataFrame.to_spark_io.html#pyspark.pandas.DataFrame.to_spark_io" title="pyspark.pandas.DataFrame.to_spark_io"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.to_spark_io</span></code></a>([path, format, mode, …])</p></td>
<td><p>Write the DataFrame out to a Spark data source.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="flat-file-csv">
<h2>Flat File / CSV<a class="headerlink" href="#flat-file-csv" title="Permalink to this headline"></a></h2>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.pandas.read_csv.html#pyspark.pandas.read_csv" title="pyspark.pandas.read_csv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_csv</span></code></a>(path[, sep, header, names, …])</p></td>
<td><p>Read CSV (comma-separated) file into DataFrame or Series.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.pandas.DataFrame.to_csv.html#pyspark.pandas.DataFrame.to_csv" title="pyspark.pandas.DataFrame.to_csv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.to_csv</span></code></a>([path, sep, na_rep, …])</p></td>
<td><p>Write object to a comma-separated values (csv) file.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="clipboard">
<h2>Clipboard<a class="headerlink" href="#clipboard" title="Permalink to this headline"></a></h2>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.pandas.read_clipboard.html#pyspark.pandas.read_clipboard" title="pyspark.pandas.read_clipboard"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_clipboard</span></code></a>([sep])</p></td>
<td><p>Read text from clipboard and pass to read_csv.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.pandas.DataFrame.to_clipboard.html#pyspark.pandas.DataFrame.to_clipboard" title="pyspark.pandas.DataFrame.to_clipboard"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.to_clipboard</span></code></a>([excel, sep])</p></td>
<td><p>Copy object to the system clipboard.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="excel">
<h2>Excel<a class="headerlink" href="#excel" title="Permalink to this headline"></a></h2>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.pandas.read_excel.html#pyspark.pandas.read_excel" title="pyspark.pandas.read_excel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_excel</span></code></a>(io[, sheet_name, header, names, …])</p></td>
<td><p>Read an Excel file into a pandas-on-Spark DataFrame or Series.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.pandas.DataFrame.to_excel.html#pyspark.pandas.DataFrame.to_excel" title="pyspark.pandas.DataFrame.to_excel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.to_excel</span></code></a>(excel_writer[, …])</p></td>
<td><p>Write object to an Excel sheet.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="json">
<h2>JSON<a class="headerlink" href="#json" title="Permalink to this headline"></a></h2>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.pandas.read_json.html#pyspark.pandas.read_json" title="pyspark.pandas.read_json"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_json</span></code></a>(path[, lines, index_col])</p></td>
<td><p>Convert a JSON string to DataFrame.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.pandas.DataFrame.to_json.html#pyspark.pandas.DataFrame.to_json" title="pyspark.pandas.DataFrame.to_json"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.to_json</span></code></a>([path, compression, …])</p></td>
<td><p>Convert the object to a JSON string.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="html">
<h2>HTML<a class="headerlink" href="#html" title="Permalink to this headline"></a></h2>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.pandas.read_html.html#pyspark.pandas.read_html" title="pyspark.pandas.read_html"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_html</span></code></a>(io[, match, flavor, header, …])</p></td>
<td><p>Read HTML tables into a <code class="docutils literal notranslate"><span class="pre">list</span></code> of <code class="docutils literal notranslate"><span class="pre">DataFrame</span></code> objects.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.pandas.DataFrame.to_html.html#pyspark.pandas.DataFrame.to_html" title="pyspark.pandas.DataFrame.to_html"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame.to_html</span></code></a>([buf, columns, col_space, …])</p></td>
<td><p>Render a DataFrame as an HTML table.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="sql">
<h2>SQL<a class="headerlink" href="#sql" title="Permalink to this headline"></a></h2>
<table class="longtable table autosummary">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.pandas.read_sql_table.html#pyspark.pandas.read_sql_table" title="pyspark.pandas.read_sql_table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_sql_table</span></code></a>(table_name, con[, schema, …])</p></td>
<td><p>Read SQL database table into a DataFrame.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.pandas.read_sql_query.html#pyspark.pandas.read_sql_query" title="pyspark.pandas.read_sql_query"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_sql_query</span></code></a>(sql, con[, index_col])</p></td>
<td><p>Read SQL query into a DataFrame.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.pandas.read_sql.html#pyspark.pandas.read_sql" title="pyspark.pandas.read_sql"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_sql</span></code></a>(sql, con[, index_col, columns])</p></td>
<td><p>Read SQL query or database table into a DataFrame.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class='prev-next-bottom'>
<a class='left-prev' id="prev-link" href="index.html" title="previous page">Pandas API on Spark</a>
<a class='right-next' id="next-link" href="api/pyspark.pandas.range.html" title="next page">pyspark.pandas.range</a>
</div>
</main>
</div>
</div>
<script src="../../_static/js/index.3da636dd464baa7582d2.js"></script>
<footer class="footer mt-5 mt-md-0">
<div class="container">
<p>
&copy; Copyright .<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.4.<br/>
</p>
</div>
</footer>
</body>
</html>