| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <title>Column — PySpark 3.3.1 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.sql.Column.alias" href="api/pyspark.sql.Column.alias.html" /> |
| <link rel="prev" title="pyspark.sql.DataFrameStatFunctions.sampleBy" href="api/pyspark.sql.DataFrameStatFunctions.sampleBy.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="active"> |
| <a href="index.html">Spark SQL</a> |
| <ul> |
| |
| <li class=""> |
| <a href="core_classes.html">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="active"> |
| <a href="">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="observation.html">Observation</a> |
| </li> |
| |
| <li class=""> |
| <a href="avro.html">Avro</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</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"> |
| |
| |
| <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="column"> |
| <h1>Column<a class="headerlink" href="#column" 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.Column.alias.html#pyspark.sql.Column.alias" title="pyspark.sql.Column.alias"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.alias</span></code></a>(*alias, **kwargs)</p></td> |
| <td><p>Returns this column aliased with a new name or names (in the case of expressions that return more than one column, such as explode).</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.asc.html#pyspark.sql.Column.asc" title="pyspark.sql.Column.asc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.asc</span></code></a>()</p></td> |
| <td><p>Returns a sort expression based on ascending order of the column.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.asc_nulls_first.html#pyspark.sql.Column.asc_nulls_first" title="pyspark.sql.Column.asc_nulls_first"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.asc_nulls_first</span></code></a>()</p></td> |
| <td><p>Returns a sort expression based on ascending order of the column, and null values return before non-null values.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.asc_nulls_last.html#pyspark.sql.Column.asc_nulls_last" title="pyspark.sql.Column.asc_nulls_last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.asc_nulls_last</span></code></a>()</p></td> |
| <td><p>Returns a sort expression based on ascending order of the column, and null values appear after non-null values.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.astype.html#pyspark.sql.Column.astype" title="pyspark.sql.Column.astype"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.astype</span></code></a>(dataType)</p></td> |
| <td><p><code class="xref py py-func docutils literal notranslate"><span class="pre">astype()</span></code> is an alias for <code class="xref py py-func docutils literal notranslate"><span class="pre">cast()</span></code>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.between.html#pyspark.sql.Column.between" title="pyspark.sql.Column.between"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.between</span></code></a>(lowerBound, upperBound)</p></td> |
| <td><p>True if the current column is between the lower bound and upper bound, inclusive.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.bitwiseAND.html#pyspark.sql.Column.bitwiseAND" title="pyspark.sql.Column.bitwiseAND"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.bitwiseAND</span></code></a>(other)</p></td> |
| <td><p>Compute bitwise AND of this expression with another expression.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.bitwiseOR.html#pyspark.sql.Column.bitwiseOR" title="pyspark.sql.Column.bitwiseOR"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.bitwiseOR</span></code></a>(other)</p></td> |
| <td><p>Compute bitwise OR of this expression with another expression.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.bitwiseXOR.html#pyspark.sql.Column.bitwiseXOR" title="pyspark.sql.Column.bitwiseXOR"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.bitwiseXOR</span></code></a>(other)</p></td> |
| <td><p>Compute bitwise XOR of this expression with another expression.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.cast.html#pyspark.sql.Column.cast" title="pyspark.sql.Column.cast"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.cast</span></code></a>(dataType)</p></td> |
| <td><p>Casts the column into type <code class="docutils literal notranslate"><span class="pre">dataType</span></code>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.contains.html#pyspark.sql.Column.contains" title="pyspark.sql.Column.contains"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.contains</span></code></a>(other)</p></td> |
| <td><p>Contains the other element.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.desc.html#pyspark.sql.Column.desc" title="pyspark.sql.Column.desc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.desc</span></code></a>()</p></td> |
| <td><p>Returns a sort expression based on the descending order of the column.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.desc_nulls_first.html#pyspark.sql.Column.desc_nulls_first" title="pyspark.sql.Column.desc_nulls_first"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.desc_nulls_first</span></code></a>()</p></td> |
| <td><p>Returns a sort expression based on the descending order of the column, and null values appear before non-null values.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.desc_nulls_last.html#pyspark.sql.Column.desc_nulls_last" title="pyspark.sql.Column.desc_nulls_last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.desc_nulls_last</span></code></a>()</p></td> |
| <td><p>Returns a sort expression based on the descending order of the column, and null values appear after non-null values.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.dropFields.html#pyspark.sql.Column.dropFields" title="pyspark.sql.Column.dropFields"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.dropFields</span></code></a>(*fieldNames)</p></td> |
| <td><p>An expression that drops fields in <code class="xref py py-class docutils literal notranslate"><span class="pre">StructType</span></code> by name.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.endswith.html#pyspark.sql.Column.endswith" title="pyspark.sql.Column.endswith"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.endswith</span></code></a>(other)</p></td> |
| <td><p>String ends with.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.eqNullSafe.html#pyspark.sql.Column.eqNullSafe" title="pyspark.sql.Column.eqNullSafe"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.eqNullSafe</span></code></a>(other)</p></td> |
| <td><p>Equality test that is safe for null values.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.getField.html#pyspark.sql.Column.getField" title="pyspark.sql.Column.getField"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.getField</span></code></a>(name)</p></td> |
| <td><p>An expression that gets a field by name in a <code class="xref py py-class docutils literal notranslate"><span class="pre">StructType</span></code>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.getItem.html#pyspark.sql.Column.getItem" title="pyspark.sql.Column.getItem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.getItem</span></code></a>(key)</p></td> |
| <td><p>An expression that gets an item at position <code class="docutils literal notranslate"><span class="pre">ordinal</span></code> out of a list, or gets an item by key out of a dict.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.ilike.html#pyspark.sql.Column.ilike" title="pyspark.sql.Column.ilike"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.ilike</span></code></a>(other)</p></td> |
| <td><p>SQL ILIKE expression (case insensitive LIKE).</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.isNotNull.html#pyspark.sql.Column.isNotNull" title="pyspark.sql.Column.isNotNull"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.isNotNull</span></code></a>()</p></td> |
| <td><p>True if the current expression is NOT null.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.isNull.html#pyspark.sql.Column.isNull" title="pyspark.sql.Column.isNull"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.isNull</span></code></a>()</p></td> |
| <td><p>True if the current expression is null.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.isin.html#pyspark.sql.Column.isin" title="pyspark.sql.Column.isin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.isin</span></code></a>(*cols)</p></td> |
| <td><p>A boolean expression that is evaluated to true if the value of this expression is contained by the evaluated values of the arguments.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.like.html#pyspark.sql.Column.like" title="pyspark.sql.Column.like"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.like</span></code></a>(other)</p></td> |
| <td><p>SQL like expression.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.name.html#pyspark.sql.Column.name" title="pyspark.sql.Column.name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.name</span></code></a>(*alias, **kwargs)</p></td> |
| <td><p><code class="xref py py-func docutils literal notranslate"><span class="pre">name()</span></code> is an alias for <code class="xref py py-func docutils literal notranslate"><span class="pre">alias()</span></code>.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.otherwise.html#pyspark.sql.Column.otherwise" title="pyspark.sql.Column.otherwise"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.otherwise</span></code></a>(value)</p></td> |
| <td><p>Evaluates a list of conditions and returns one of multiple possible result expressions.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.over.html#pyspark.sql.Column.over" title="pyspark.sql.Column.over"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.over</span></code></a>(window)</p></td> |
| <td><p>Define a windowing column.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.rlike.html#pyspark.sql.Column.rlike" title="pyspark.sql.Column.rlike"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.rlike</span></code></a>(other)</p></td> |
| <td><p>SQL RLIKE expression (LIKE with Regex).</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.startswith.html#pyspark.sql.Column.startswith" title="pyspark.sql.Column.startswith"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.startswith</span></code></a>(other)</p></td> |
| <td><p>String starts with.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.substr.html#pyspark.sql.Column.substr" title="pyspark.sql.Column.substr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.substr</span></code></a>(startPos, length)</p></td> |
| <td><p>Return a <a class="reference internal" href="api/pyspark.sql.Column.html#pyspark.sql.Column" title="pyspark.sql.Column"><code class="xref py py-class docutils literal notranslate"><span class="pre">Column</span></code></a> which is a substring of the column.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="api/pyspark.sql.Column.when.html#pyspark.sql.Column.when" title="pyspark.sql.Column.when"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.when</span></code></a>(condition, value)</p></td> |
| <td><p>Evaluates a list of conditions and returns one of multiple possible result expressions.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="api/pyspark.sql.Column.withField.html#pyspark.sql.Column.withField" title="pyspark.sql.Column.withField"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column.withField</span></code></a>(fieldName, col)</p></td> |
| <td><p>An expression that adds/replaces a field in <code class="xref py py-class docutils literal notranslate"><span class="pre">StructType</span></code> by name.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class='prev-next-bottom'> |
| |
| <a class='left-prev' id="prev-link" href="api/pyspark.sql.DataFrameStatFunctions.sampleBy.html" title="previous page">pyspark.sql.DataFrameStatFunctions.sampleBy</a> |
| <a class='right-next' id="next-link" href="api/pyspark.sql.Column.alias.html" title="next page">pyspark.sql.Column.alias</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> |
