| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <title>Core Classes — PySpark 3.4.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/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/pyspark.sql/core_classes.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="pyspark.sql.SparkSession" href="api/pyspark.sql.SparkSession.html" /> |
| <link rel="prev" title="Spark SQL" 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="../../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="../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 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="active"> |
| <a href="index.html">Spark SQL</a> |
| <ul> |
| |
| <li class="active"> |
| <a href="">Core Classes</a> |
| </li> |
| |
| <li class=""> |
| <a href="spark_session.html">Spark Session</a> |
| </li> |
| |
| <li class=""> |
| <a href="configuration.html">Configuration</a> |
| </li> |
| |
| <li class=""> |
| <a href="io.html">Input/Output</a> |
| </li> |
| |
| <li class=""> |
| <a href="dataframe.html">DataFrame</a> |
| </li> |
| |
| <li class=""> |
| <a href="column.html">Column</a> |
| </li> |
| |
| <li class=""> |
| <a href="data_types.html">Data Types</a> |
| </li> |
| |
| <li class=""> |
| <a href="row.html">Row</a> |
| </li> |
| |
| <li class=""> |
| <a href="functions.html">Functions</a> |
| </li> |
| |
| <li class=""> |
| <a href="window.html">Window</a> |
| </li> |
| |
| <li class=""> |
| <a href="grouping.html">Grouping</a> |
| </li> |
| |
| <li class=""> |
| <a href="catalog.html">Catalog</a> |
| </li> |
| |
| <li class=""> |
| <a href="avro.html">Avro</a> |
| </li> |
| |
| <li class=""> |
| <a href="observation.html">Observation</a> |
| </li> |
| |
| <li class=""> |
| <a href="udf.html">UDF</a> |
| </li> |
| |
| <li class=""> |
| <a href="protobuf.html">Protobuf</a> |
| </li> |
| |
| </ul> |
| </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="core-classes"> |
| <h1>Core Classes<a class="headerlink" href="#core-classes" title="Permalink to this headline">¶</a></h1> |
| <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.sql.SparkSession.html#pyspark.sql.SparkSession" title="pyspark.sql.SparkSession"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SparkSession</span></code></a>(sparkContext[, jsparkSession, …])</p></td> |
| <td><p>The entry point to programming Spark with the Dataset and DataFrame API.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Catalog.html#pyspark.sql.Catalog" title="pyspark.sql.Catalog"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Catalog</span></code></a>(sparkSession)</p></td> |
| <td><p>User-facing catalog API, accessible through <cite>SparkSession.catalog</cite>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame" title="pyspark.sql.DataFrame"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrame</span></code></a>(jdf, sql_ctx)</p></td> |
| <td><p>A distributed collection of data grouped into named columns.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.html#pyspark.sql.Column" title="pyspark.sql.Column"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column</span></code></a>(jc)</p></td> |
| <td><p>A column in a DataFrame.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Observation.html#pyspark.sql.Observation" title="pyspark.sql.Observation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Observation</span></code></a>([name])</p></td> |
| <td><p>Class to observe (named) metrics on a <a class="reference internal" href="api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame" title="pyspark.sql.DataFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFrame</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Row.html#pyspark.sql.Row" title="pyspark.sql.Row"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Row</span></code></a></p></td> |
| <td><p>A row in <a class="reference internal" href="api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame" title="pyspark.sql.DataFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFrame</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.GroupedData.html#pyspark.sql.GroupedData" title="pyspark.sql.GroupedData"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GroupedData</span></code></a>(jgd, df)</p></td> |
| <td><p>A set of methods for aggregations on a <a class="reference internal" href="api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame" title="pyspark.sql.DataFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFrame</span></code></a>, created by <a class="reference internal" href="api/pyspark.sql.DataFrame.groupBy.html#pyspark.sql.DataFrame.groupBy" title="pyspark.sql.DataFrame.groupBy"><code class="xref py py-func docutils literal notranslate"><span class="pre">DataFrame.groupBy()</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.PandasCogroupedOps.html#pyspark.sql.PandasCogroupedOps" title="pyspark.sql.PandasCogroupedOps"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PandasCogroupedOps</span></code></a>(gd1, gd2)</p></td> |
| <td><p>A logical grouping of two <a class="reference internal" href="api/pyspark.sql.GroupedData.html#pyspark.sql.GroupedData" title="pyspark.sql.GroupedData"><code class="xref py py-class docutils literal notranslate"><span class="pre">GroupedData</span></code></a>, created by <a class="reference internal" href="api/pyspark.sql.GroupedData.cogroup.html#pyspark.sql.GroupedData.cogroup" title="pyspark.sql.GroupedData.cogroup"><code class="xref py py-func docutils literal notranslate"><span class="pre">GroupedData.cogroup()</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.DataFrameNaFunctions.html#pyspark.sql.DataFrameNaFunctions" title="pyspark.sql.DataFrameNaFunctions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrameNaFunctions</span></code></a>(df)</p></td> |
| <td><p>Functionality for working with missing data in <a class="reference internal" href="api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame" title="pyspark.sql.DataFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFrame</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.DataFrameStatFunctions.html#pyspark.sql.DataFrameStatFunctions" title="pyspark.sql.DataFrameStatFunctions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrameStatFunctions</span></code></a>(df)</p></td> |
| <td><p>Functionality for statistic functions with <a class="reference internal" href="api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame" title="pyspark.sql.DataFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFrame</span></code></a>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Window.html#pyspark.sql.Window" title="pyspark.sql.Window"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Window</span></code></a></p></td> |
| <td><p>Utility functions for defining window in DataFrames.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.DataFrameReader.html#pyspark.sql.DataFrameReader" title="pyspark.sql.DataFrameReader"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrameReader</span></code></a>(spark)</p></td> |
| <td><p>Interface used to load a <a class="reference internal" href="api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame" title="pyspark.sql.DataFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFrame</span></code></a> from external storage systems (e.g.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.DataFrameWriter.html#pyspark.sql.DataFrameWriter" title="pyspark.sql.DataFrameWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrameWriter</span></code></a>(df)</p></td> |
| <td><p>Interface used to write a <a class="reference internal" href="api/pyspark.sql.DataFrame.html#pyspark.sql.DataFrame" title="pyspark.sql.DataFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFrame</span></code></a> to external storage systems (e.g.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.DataFrameWriterV2.html#pyspark.sql.DataFrameWriterV2" title="pyspark.sql.DataFrameWriterV2"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataFrameWriterV2</span></code></a>(df, table)</p></td> |
| <td><p>Interface used to write a class:<cite>pyspark.sql.dataframe.DataFrame</cite> to external storage using the v2 API.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.UDFRegistration.html#pyspark.sql.UDFRegistration" title="pyspark.sql.UDFRegistration"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UDFRegistration</span></code></a>(sparkSession)</p></td> |
| <td><p>Wrapper for user-defined function registration.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.udf.UserDefinedFunction.html#pyspark.sql.udf.UserDefinedFunction" title="pyspark.sql.udf.UserDefinedFunction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">udf.UserDefinedFunction</span></code></a>(func[, returnType, …])</p></td> |
| <td><p>User defined function in Python</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class='prev-next-bottom'> |
| |
| <a class='left-prev' id="prev-link" href="index.html" title="previous page">Spark SQL</a> |
| <a class='right-next' id="next-link" href="api/pyspark.sql.SparkSession.html" title="next page">pyspark.sql.SparkSession</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> |
