| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <title>API Reference — PySpark 3.4.2 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/copybutton.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/clipboard.min.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="canonical" href="https://spark.apache.org/docs/latest/api/python/reference/index.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="Spark SQL" href="pyspark.sql/index.html" /> |
| <link rel="prev" title="FAQ" href="../user_guide/pandas_on_spark/faq.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="../index.html">Overview</a> |
| </li> |
| |
| <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 Guides</a> |
| </li> |
| |
| <li class="nav-item active"> |
| <a class="nav-link" href="">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 Guides</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/index.html">Spark SQL</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="pyspark.pandas/index.html">Pandas API on Spark</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="pyspark.ss/index.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 (Legacy)</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> |
| |
| |
| |
| <li class=""> |
| <a href="pyspark.errors.html">Errors</a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| </ul> |
| |
| </nav> |
| </div> |
| |
| |
| |
| <div class="d-none d-xl-block col-xl-2 bd-toc"> |
| |
| |
| <nav id="bd-toc-nav"> |
| <ul class="nav section-nav flex-column"> |
| |
| </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="api-reference"> |
| <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1> |
| <p>This page lists an overview of all public PySpark modules, classes, functions and methods.</p> |
| <p>Pandas API on Spark follows the API specifications of latest pandas release.</p> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="pyspark.sql/index.html">Spark SQL</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/core_classes.html">Core Classes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/spark_session.html">Spark Session</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/configuration.html">Configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/io.html">Input/Output</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/dataframe.html">DataFrame</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/column.html">Column</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/data_types.html">Data Types</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/row.html">Row</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/functions.html">Functions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/window.html">Window</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/grouping.html">Grouping</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/catalog.html">Catalog</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/avro.html">Avro</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/observation.html">Observation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/udf.html">UDF</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.sql/protobuf.html">Protobuf</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="pyspark.pandas/index.html">Pandas API on Spark</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.pandas/io.html">Input/Output</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.pandas/general_functions.html">General functions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.pandas/series.html">Series</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.pandas/frame.html">DataFrame</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.pandas/indexing.html">Index objects</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.pandas/window.html">Window</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.pandas/groupby.html">GroupBy</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.pandas/resampling.html">Resampling</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.pandas/ml.html">Machine Learning utilities</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.pandas/extensions.html">Extensions</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="pyspark.ss/index.html">Structured Streaming</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ss/core_classes.html">Core Classes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ss/io.html">Input/Output</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ss/query_management.html">Query Management</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="pyspark.ml.html">MLlib (DataFrame-based)</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#pipeline-apis">Pipeline APIs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#parameters">Parameters</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#feature">Feature</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#classification">Classification</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#clustering">Clustering</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#functions">Functions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#vector-and-matrix">Vector and Matrix</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#recommendation">Recommendation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#regression">Regression</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#statistics">Statistics</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#tuning">Tuning</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#evaluation">Evaluation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#frequency-pattern-mining">Frequency Pattern Mining</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#image">Image</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#distributor">Distributor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.ml.html#utilities">Utilities</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="pyspark.streaming.html">Spark Streaming (Legacy)</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.streaming.html#core-classes">Core Classes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.streaming.html#streaming-management">Streaming Management</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.streaming.html#input-and-output">Input and Output</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.streaming.html#transformations-and-actions">Transformations and Actions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.streaming.html#kinesis">Kinesis</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="pyspark.mllib.html">MLlib (RDD-based)</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.mllib.html#classification">Classification</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.mllib.html#clustering">Clustering</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.mllib.html#evaluation">Evaluation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.mllib.html#feature">Feature</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.mllib.html#frequency-pattern-mining">Frequency Pattern Mining</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.mllib.html#vector-and-matrix">Vector and Matrix</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.mllib.html#random">Random</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.mllib.html#recommendation">Recommendation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.mllib.html#regression">Regression</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.mllib.html#statistics">Statistics</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.mllib.html#tree">Tree</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.mllib.html#utilities">Utilities</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="pyspark.html">Spark Core</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.html#public-classes">Public Classes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.html#spark-context-apis">Spark Context APIs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.html#rdd-apis">RDD APIs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.html#broadcast-and-accumulator">Broadcast and Accumulator</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.html#management">Management</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="pyspark.resource.html">Resource Management</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.resource.html#core-classes">Core Classes</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="pyspark.errors.html">Errors</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.errors.html#classes">Classes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="pyspark.errors.html#methods">Methods</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class='prev-next-bottom'> |
| |
| <a class='left-prev' id="prev-link" href="../user_guide/pandas_on_spark/faq.html" title="previous page">FAQ</a> |
| <a class='right-next' id="next-link" href="pyspark.sql/index.html" title="next page">Spark SQL</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> |
| © Copyright .<br/> |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.4.<br/> |
| </p> |
| </div> |
| </footer> |
| </body> |
| </html> |
