Google Git
Sign in
apache/datafusion-python/7db00c74b941ff7c6a9ef8477930f4e4b16df82f/./autoapi/datafusion/expr/index.html
blob: 4cfaadb2f488c05ab1615ca12a64ce6696a50598 [file]
<!DOCTYPE html>
<html lang="en" data-content_root="../../../" data-theme="auto">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>datafusion.expr &#8212; Apache DataFusion in Python documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "auto";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="../../../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../../../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../../../_static/mystnb.11b39860a7a0cbfd473a3ad8a317855267ff0bd372690045ca344a6b62be495e.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=4ae1632d" />
<link rel="stylesheet" type="text/css" href="../../../_static/theme_overrides.css?v=4af573bc" />
<!-- So that users can add custom icons -->
<script src="../../../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'autoapi/datafusion/expr/index';</script>
<script src="../../../_static/toc-toggle.js?v=36375f01"></script>
<link rel="icon" href="../../../_static/favicon.svg"/>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="datafusion.functions" href="../functions/index.html" />
<link rel="prev" title="datafusion.dataframe_formatter" href="../dataframe_formatter/index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="" />
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="auto">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="../../../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="../../../index.html">
<img src="../../../_static/original.svg" class="logo__image only-light" alt="Apache DataFusion in Python"/>
<img src="../../../_static/original_dark.svg" class="logo__image only-dark pst-js-only" alt="Apache DataFusion in Python"/>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../../user-guide/index.html">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../../contributor-guide/index.html">
Contributor Guide
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="../../index.html">
API Reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../../links.html">
Links
</a>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/apache/datafusion-python" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://docs.rs/datafusion/latest/datafusion/" title="Rust API docs (docs.rs)" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-rust fa-lg" aria-hidden="true"></i>
<span class="sr-only">Rust API docs (docs.rs)</span></a>
</li>
</ul></div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../../user-guide/index.html">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../../contributor-guide/index.html">
Contributor Guide
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="../../index.html">
API Reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../../links.html">
Links
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/apache/datafusion-python" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://docs.rs/datafusion/latest/datafusion/" title="Rust API docs (docs.rs)" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-rust fa-lg" aria-hidden="true"></i>
<span class="sr-only">Rust API docs (docs.rs)</span></a>
</li>
</ul></div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links" aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav">
<ul class="current nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-guide/index.html">User Guide</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../user-guide/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../user-guide/basics.html">Concepts</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../user-guide/data-sources.html">Data Sources</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-guide/dataframe/index.html">DataFrames</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/dataframe/rendering.html">DataFrame Rendering</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/dataframe/execution-metrics.html">Execution Metrics</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-guide/common-operations/index.html">Common Operations</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/common-operations/views.html">Registering Views</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/common-operations/basic-info.html">Basic Operations</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/common-operations/select-and-filter.html">Column Selections</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/common-operations/expressions.html">Expressions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/common-operations/joins.html">Joins</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/common-operations/functions.html">Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/common-operations/spark-functions.html">Spark-Compatible Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/common-operations/aggregations.html">Aggregation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/common-operations/windows.html">Window Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/common-operations/udf-and-udfa.html">User-Defined Functions</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-guide/io/index.html">IO</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/io/arrow.html">Arrow</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/io/avro.html">Avro</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/io/csv.html">CSV</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/io/json.html">JSON</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/io/parquet.html">Parquet</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../user-guide/io/table_provider.html">Custom Table Provider</a></li>
</ul>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="../../../user-guide/configuration.html">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../user-guide/distributing-work.html">Distributing work</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../user-guide/sql.html">SQL</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../user-guide/upgrade-guides.html">Upgrade Guides</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../user-guide/ai-coding-assistants.html">Using AI Coding Assistants</a></li>
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../contributor-guide/index.html">Contributor Guide</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../contributor-guide/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributor-guide/ffi.html">Python Extensions</a></li>
</ul>
</details></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="../../index.html">API Reference</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l2 current active has-children"><a class="reference internal" href="../index.html">datafusion</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="../catalog/index.html">datafusion.catalog</a></li>
<li class="toctree-l3"><a class="reference internal" href="../context/index.html">datafusion.context</a></li>
<li class="toctree-l3"><a class="reference internal" href="../dataframe/index.html">datafusion.dataframe</a></li>
<li class="toctree-l3"><a class="reference internal" href="../dataframe_formatter/index.html">datafusion.dataframe_formatter</a></li>
<li class="toctree-l3 current active"><a class="current reference internal" href="#">datafusion.expr</a></li>
<li class="toctree-l3 has-children"><a class="reference internal" href="../functions/index.html">datafusion.functions</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l4"><a class="reference internal" href="../functions/spark/index.html">datafusion.functions.spark</a></li>
</ul>
</details></li>
<li class="toctree-l3 has-children"><a class="reference internal" href="../input/index.html">datafusion.input</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l4"><a class="reference internal" href="../input/base/index.html">datafusion.input.base</a></li>
<li class="toctree-l4"><a class="reference internal" href="../input/location/index.html">datafusion.input.location</a></li>
</ul>
</details></li>
<li class="toctree-l3"><a class="reference internal" href="../io/index.html">datafusion.io</a></li>
<li class="toctree-l3"><a class="reference internal" href="../ipc/index.html">datafusion.ipc</a></li>
<li class="toctree-l3"><a class="reference internal" href="../object_store/index.html">datafusion.object_store</a></li>
<li class="toctree-l3"><a class="reference internal" href="../options/index.html">datafusion.options</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plan/index.html">datafusion.plan</a></li>
<li class="toctree-l3"><a class="reference internal" href="../record_batch/index.html">datafusion.record_batch</a></li>
<li class="toctree-l3"><a class="reference internal" href="../substrait/index.html">datafusion.substrait</a></li>
<li class="toctree-l3"><a class="reference internal" href="../unparser/index.html">datafusion.unparser</a></li>
<li class="toctree-l3"><a class="reference internal" href="../user_defined/index.html">datafusion.user_defined</a></li>
</ul>
</details></li>
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../links.html">Links</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference external" href="https://github.com/apache/datafusion-python">GitHub and Issue Tracker</a></li>
<li class="toctree-l2"><a class="reference external" href="https://docs.rs/datafusion/latest/datafusion/">Rust API Docs</a></li>
<li class="toctree-l2"><a class="reference external" href="https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md">Code of Conduct</a></li>
<li class="toctree-l2"><a class="reference external" href="https://github.com/apache/datafusion-python/tree/main/examples">Examples</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="../../../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="../../index.html" class="nav-link">API Reference</a></li>
<li class="breadcrumb-item"><a href="../index.html" class="nav-link">datafusion</a></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">datafusion.expr</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="module-datafusion.expr">
<span id="datafusion-expr"></span><h1>datafusion.expr<a class="headerlink" href="#module-datafusion.expr" title="Link to this heading">#</a></h1>
<p><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Expr</span></code></a> — the logical expression type used to build DataFusion queries.</p>
<p>An <a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Expr</span></code></a> represents a computation over columns or literals: a
column reference (<code class="docutils literal notranslate"><span class="pre">col(&quot;a&quot;)</span></code>), a literal (<code class="docutils literal notranslate"><span class="pre">lit(5)</span></code>), an operator
combination (<code class="docutils literal notranslate"><span class="pre">col(&quot;a&quot;)</span> <span class="pre">+</span> <span class="pre">lit(1)</span></code>), or the output of a function from
<a class="reference internal" href="../functions/index.html#module-datafusion.functions" title="datafusion.functions"><code class="xref py py-mod docutils literal notranslate"><span class="pre">datafusion.functions</span></code></a>. Expressions are passed to
<a class="reference internal" href="../dataframe/index.html#datafusion.dataframe.DataFrame" title="datafusion.dataframe.DataFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFrame</span></code></a> methods such as
<a class="reference internal" href="../dataframe/index.html#datafusion.dataframe.DataFrame.select" title="datafusion.dataframe.DataFrame.select"><code class="xref py py-meth docutils literal notranslate"><span class="pre">select()</span></code></a>,
<a class="reference internal" href="../dataframe/index.html#datafusion.dataframe.DataFrame.filter" title="datafusion.dataframe.DataFrame.filter"><code class="xref py py-meth docutils literal notranslate"><span class="pre">filter()</span></code></a>,
<a class="reference internal" href="../dataframe/index.html#datafusion.dataframe.DataFrame.aggregate" title="datafusion.dataframe.DataFrame.aggregate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">aggregate()</span></code></a>, and
<a class="reference internal" href="../dataframe/index.html#datafusion.dataframe.DataFrame.sort" title="datafusion.dataframe.DataFrame.sort"><code class="xref py py-meth docutils literal notranslate"><span class="pre">sort()</span></code></a>.</p>
<p>Convenience constructors are re-exported at the package level:
<a class="reference internal" href="../index.html#datafusion.col" title="datafusion.col"><code class="xref py py-func docutils literal notranslate"><span class="pre">datafusion.col()</span></code></a> / <a class="reference internal" href="../index.html#datafusion.column" title="datafusion.column"><code class="xref py py-func docutils literal notranslate"><span class="pre">datafusion.column()</span></code></a> for column references
and <a class="reference internal" href="../index.html#datafusion.lit" title="datafusion.lit"><code class="xref py py-func docutils literal notranslate"><span class="pre">datafusion.lit()</span></code></a> / <a class="reference internal" href="../index.html#datafusion.literal" title="datafusion.literal"><code class="xref py py-func docutils literal notranslate"><span class="pre">datafusion.literal()</span></code></a> for scalar
literals.</p>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">df</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">from_pydict</span><span class="p">({</span><span class="s2">&quot;a&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]})</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">df</span><span class="o">.</span><span class="n">select</span><span class="p">((</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span> <span class="o">*</span> <span class="n">lit</span><span class="p">(</span><span class="mi">10</span><span class="p">))</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s2">&quot;ten_a&quot;</span><span class="p">))</span><span class="o">.</span><span class="n">to_pydict</span><span class="p">()</span>
<span class="go">{&#39;ten_a&#39;: [10, 20, 30]}</span>
</pre></div>
</div>
<p>See <a class="reference internal" href="../../../user-guide/common-operations/expressions.html#expressions"><span class="std std-ref">Expressions</span></a> in the online documentation for details on available
operators and helpers.</p>
<section id="attributes">
<h2>Attributes<a class="headerlink" href="#attributes" title="Link to this heading">#</a></h2>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Aggregate" title="datafusion.expr.Aggregate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Aggregate</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.AggregateFunction" title="datafusion.expr.AggregateFunction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AggregateFunction</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Alias" title="datafusion.expr.Alias"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Alias</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Analyze" title="datafusion.expr.Analyze"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Analyze</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Between" title="datafusion.expr.Between"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Between</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.BinaryExpr" title="datafusion.expr.BinaryExpr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BinaryExpr</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Case" title="datafusion.expr.Case"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Case</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Cast" title="datafusion.expr.Cast"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Cast</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Column" title="datafusion.expr.Column"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Column</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.CopyTo" title="datafusion.expr.CopyTo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CopyTo</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.CreateCatalog" title="datafusion.expr.CreateCatalog"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateCatalog</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.CreateCatalogSchema" title="datafusion.expr.CreateCatalogSchema"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateCatalogSchema</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.CreateExternalTable" title="datafusion.expr.CreateExternalTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateExternalTable</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.CreateFunction" title="datafusion.expr.CreateFunction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateFunction</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.CreateFunctionBody" title="datafusion.expr.CreateFunctionBody"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateFunctionBody</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.CreateIndex" title="datafusion.expr.CreateIndex"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateIndex</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.CreateMemoryTable" title="datafusion.expr.CreateMemoryTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateMemoryTable</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.CreateView" title="datafusion.expr.CreateView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CreateView</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Deallocate" title="datafusion.expr.Deallocate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Deallocate</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.DescribeTable" title="datafusion.expr.DescribeTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DescribeTable</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Distinct" title="datafusion.expr.Distinct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Distinct</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.DmlStatement" title="datafusion.expr.DmlStatement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DmlStatement</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.DropCatalogSchema" title="datafusion.expr.DropCatalogSchema"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DropCatalogSchema</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.DropFunction" title="datafusion.expr.DropFunction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DropFunction</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.DropTable" title="datafusion.expr.DropTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DropTable</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.DropView" title="datafusion.expr.DropView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DropView</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.EXPR_TYPE_ERROR" title="datafusion.expr.EXPR_TYPE_ERROR"><code class="xref py py-obj docutils literal notranslate"><span class="pre">EXPR_TYPE_ERROR</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.EmptyRelation" title="datafusion.expr.EmptyRelation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">EmptyRelation</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Execute" title="datafusion.expr.Execute"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Execute</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Exists" title="datafusion.expr.Exists"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Exists</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Explain" title="datafusion.expr.Explain"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Explain</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Extension" title="datafusion.expr.Extension"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Extension</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.FileType" title="datafusion.expr.FileType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FileType</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Filter" title="datafusion.expr.Filter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Filter</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.HigherOrderFunction" title="datafusion.expr.HigherOrderFunction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HigherOrderFunction</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.ILike" title="datafusion.expr.ILike"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ILike</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.InList" title="datafusion.expr.InList"><code class="xref py py-obj docutils literal notranslate"><span class="pre">InList</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.InSubquery" title="datafusion.expr.InSubquery"><code class="xref py py-obj docutils literal notranslate"><span class="pre">InSubquery</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.IsFalse" title="datafusion.expr.IsFalse"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsFalse</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.IsNotFalse" title="datafusion.expr.IsNotFalse"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNotFalse</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.IsNotNull" title="datafusion.expr.IsNotNull"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNotNull</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.IsNotTrue" title="datafusion.expr.IsNotTrue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNotTrue</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.IsNotUnknown" title="datafusion.expr.IsNotUnknown"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNotUnknown</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.IsNull" title="datafusion.expr.IsNull"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsNull</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.IsTrue" title="datafusion.expr.IsTrue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsTrue</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.IsUnknown" title="datafusion.expr.IsUnknown"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IsUnknown</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Join" title="datafusion.expr.Join"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Join</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.JoinConstraint" title="datafusion.expr.JoinConstraint"><code class="xref py py-obj docutils literal notranslate"><span class="pre">JoinConstraint</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.JoinType" title="datafusion.expr.JoinType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">JoinType</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Lambda" title="datafusion.expr.Lambda"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Lambda</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.LambdaVariable" title="datafusion.expr.LambdaVariable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LambdaVariable</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Like" title="datafusion.expr.Like"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Like</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Limit" title="datafusion.expr.Limit"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Limit</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Literal" title="datafusion.expr.Literal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Literal</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Negative" title="datafusion.expr.Negative"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Negative</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Not" title="datafusion.expr.Not"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Not</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.OperateFunctionArg" title="datafusion.expr.OperateFunctionArg"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OperateFunctionArg</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Partitioning" title="datafusion.expr.Partitioning"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Partitioning</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Placeholder" title="datafusion.expr.Placeholder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Placeholder</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Prepare" title="datafusion.expr.Prepare"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Prepare</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Projection" title="datafusion.expr.Projection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Projection</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.RecursiveQuery" title="datafusion.expr.RecursiveQuery"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RecursiveQuery</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Repartition" title="datafusion.expr.Repartition"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Repartition</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.ScalarSubquery" title="datafusion.expr.ScalarSubquery"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ScalarSubquery</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.ScalarVariable" title="datafusion.expr.ScalarVariable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ScalarVariable</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.SetVariable" title="datafusion.expr.SetVariable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SetVariable</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.SimilarTo" title="datafusion.expr.SimilarTo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SimilarTo</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Sort" title="datafusion.expr.Sort"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Sort</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.SortKey" title="datafusion.expr.SortKey"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SortKey</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Subquery" title="datafusion.expr.Subquery"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Subquery</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.SubqueryAlias" title="datafusion.expr.SubqueryAlias"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubqueryAlias</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.TableScan" title="datafusion.expr.TableScan"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TableScan</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.TransactionAccessMode" title="datafusion.expr.TransactionAccessMode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransactionAccessMode</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.TransactionConclusion" title="datafusion.expr.TransactionConclusion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransactionConclusion</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.TransactionEnd" title="datafusion.expr.TransactionEnd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransactionEnd</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.TransactionIsolationLevel" title="datafusion.expr.TransactionIsolationLevel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransactionIsolationLevel</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.TransactionStart" title="datafusion.expr.TransactionStart"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransactionStart</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.TryCast" title="datafusion.expr.TryCast"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TryCast</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Union" title="datafusion.expr.Union"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Union</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Unnest" title="datafusion.expr.Unnest"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Unnest</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.UnnestExpr" title="datafusion.expr.UnnestExpr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UnnestExpr</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Values" title="datafusion.expr.Values"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Values</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.WindowExpr" title="datafusion.expr.WindowExpr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WindowExpr</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="classes">
<h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">#</a></h2>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.CaseBuilder" title="datafusion.expr.CaseBuilder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CaseBuilder</span></code></a></p></td>
<td><p>Builder class for constructing case statements.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Expr</span></code></a></p></td>
<td><p>Expression object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.GroupingSet" title="datafusion.expr.GroupingSet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GroupingSet</span></code></a></p></td>
<td><p>Factory for creating grouping set expressions.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.SortExpr" title="datafusion.expr.SortExpr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SortExpr</span></code></a></p></td>
<td><p>Used to specify sorting on either a DataFrame or function.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.Window" title="datafusion.expr.Window"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Window</span></code></a></p></td>
<td><p>Define reusable window parameters.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.WindowFrame" title="datafusion.expr.WindowFrame"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WindowFrame</span></code></a></p></td>
<td><p>Defines a window frame for performing window operations.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.WindowFrameBound" title="datafusion.expr.WindowFrameBound"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WindowFrameBound</span></code></a></p></td>
<td><p>Defines a single window frame bound.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="functions">
<h2>Functions<a class="headerlink" href="#functions" title="Link to this heading">#</a></h2>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.coerce_to_expr" title="datafusion.expr.coerce_to_expr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">coerce_to_expr</span></code></a>(→ Expr)</p></td>
<td><p>Coerce a native Python value to an <code class="docutils literal notranslate"><span class="pre">Expr</span></code> literal, passing <code class="docutils literal notranslate"><span class="pre">Expr</span></code> through.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.coerce_to_expr_list" title="datafusion.expr.coerce_to_expr_list"><code class="xref py py-obj docutils literal notranslate"><span class="pre">coerce_to_expr_list</span></code></a>(→ list[Expr])</p></td>
<td><p>Coerce each item in an iterable to <code class="docutils literal notranslate"><span class="pre">Expr</span></code> via <a class="reference internal" href="#datafusion.expr.coerce_to_expr" title="datafusion.expr.coerce_to_expr"><code class="xref py py-func docutils literal notranslate"><span class="pre">coerce_to_expr()</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.coerce_to_expr_or_none" title="datafusion.expr.coerce_to_expr_or_none"><code class="xref py py-obj docutils literal notranslate"><span class="pre">coerce_to_expr_or_none</span></code></a>(→ Expr | None)</p></td>
<td><p>Coerce a value to <code class="docutils literal notranslate"><span class="pre">Expr</span></code> or pass <code class="docutils literal notranslate"><span class="pre">None</span></code> through unchanged.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#datafusion.expr.ensure_expr" title="datafusion.expr.ensure_expr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ensure_expr</span></code></a>(→ datafusion._internal.expr.Expr)</p></td>
<td><p>Return the internal expression from <code class="docutils literal notranslate"><span class="pre">Expr</span></code> or raise <code class="docutils literal notranslate"><span class="pre">TypeError</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#datafusion.expr.ensure_expr_list" title="datafusion.expr.ensure_expr_list"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ensure_expr_list</span></code></a>(→ list[datafusion._internal.expr.Expr])</p></td>
<td><p>Flatten an iterable of expressions, validating each via <code class="docutils literal notranslate"><span class="pre">ensure_expr</span></code>.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="module-contents">
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading">#</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="datafusion.expr.CaseBuilder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CaseBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">case_builder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datafusion._internal.expr.CaseBuilder</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.expr.CaseBuilder" title="Link to this definition">#</a></dt>
<dd><p>Builder class for constructing case statements.</p>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">df</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">from_pydict</span><span class="p">({</span><span class="s2">&quot;a&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]})</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">select</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">dfn</span><span class="o">.</span><span class="n">functions</span><span class="o">.</span><span class="n">case</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">))</span>
<span class="gp">... </span> <span class="o">.</span><span class="n">when</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">lit</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span class="n">lit</span><span class="p">(</span><span class="s2">&quot;One&quot;</span><span class="p">))</span>
<span class="gp">... </span> <span class="o">.</span><span class="n">when</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">lit</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span class="n">lit</span><span class="p">(</span><span class="s2">&quot;Two&quot;</span><span class="p">))</span>
<span class="gp">... </span> <span class="o">.</span><span class="n">otherwise</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">lit</span><span class="p">(</span><span class="s2">&quot;Other&quot;</span><span class="p">))</span>
<span class="gp">... </span> <span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s2">&quot;label&quot;</span><span class="p">)</span>
<span class="gp">... </span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">to_pydict</span><span class="p">()</span>
<span class="go">{&#39;label&#39;: [&#39;One&#39;, &#39;Two&#39;, &#39;Other&#39;]}</span>
</pre></div>
</div>
<p>Constructs a case builder.</p>
<p>This is not typically called by the end user directly. See
<a class="reference internal" href="../functions/index.html#datafusion.functions.case" title="datafusion.functions.case"><code class="xref py py-func docutils literal notranslate"><span class="pre">datafusion.functions.case()</span></code></a> instead.</p>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.CaseBuilder.end">
<span class="sig-name descname"><span class="pre">end</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.CaseBuilder.end" title="Link to this definition">#</a></dt>
<dd><p>Finish building a case statement.</p>
<p>Any non-matching cases will end in a <cite>null</cite> value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.CaseBuilder.otherwise">
<span class="sig-name descname"><span class="pre">otherwise</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">else_expr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.CaseBuilder.otherwise" title="Link to this definition">#</a></dt>
<dd><p>Set a default value for the case statement.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.CaseBuilder.when">
<span class="sig-name descname"><span class="pre">when</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">when_expr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">then_expr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.CaseBuilder" title="datafusion.expr.CaseBuilder"><span class="pre">CaseBuilder</span></a></span></span><a class="headerlink" href="#datafusion.expr.CaseBuilder.when" title="Link to this definition">#</a></dt>
<dd><p>Add a case to match against.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.CaseBuilder.case_builder">
<span class="sig-name descname"><span class="pre">case_builder</span></span><a class="headerlink" href="#datafusion.expr.CaseBuilder.case_builder" title="Link to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="datafusion.expr.Expr">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Expr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datafusion._internal.expr.RawExpr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.expr.Expr" title="Link to this definition">#</a></dt>
<dd><p>Expression object.</p>
<p>Expressions are one of the core concepts in DataFusion. See
<a class="reference internal" href="../../../user-guide/common-operations/expressions.html#expressions"><span class="std std-ref">Expressions</span></a> in the online documentation for more information.</p>
<p>This constructor should not be called by the end user.</p>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__add__">
<span class="sig-name descname"><span class="pre">__add__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__add__" title="Link to this definition">#</a></dt>
<dd><p>Addition operator.</p>
<p>Accepts either an expression or any valid PyArrow scalar literal value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__and__">
<span class="sig-name descname"><span class="pre">__and__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__and__" title="Link to this definition">#</a></dt>
<dd><p>Logical AND.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__eq__">
<span class="sig-name descname"><span class="pre">__eq__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__eq__" title="Link to this definition">#</a></dt>
<dd><p>Equal to.</p>
<p>Accepts either an expression or any valid PyArrow scalar literal value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__ge__">
<span class="sig-name descname"><span class="pre">__ge__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__ge__" title="Link to this definition">#</a></dt>
<dd><p>Greater than or equal to.</p>
<p>Accepts either an expression or any valid PyArrow scalar literal value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__getitem__">
<span class="sig-name descname"><span class="pre">__getitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__getitem__" title="Link to this definition">#</a></dt>
<dd><p>Retrieve sub-object.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">key</span></code> is a string, returns the subfield of the struct.
If <code class="docutils literal notranslate"><span class="pre">key</span></code> is an integer, retrieves the element in the array. Note that the
element index begins at <code class="docutils literal notranslate"><span class="pre">0</span></code>, unlike
<a class="reference internal" href="../functions/index.html#datafusion.functions.array_element" title="datafusion.functions.array_element"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_element()</span></code></a> which begins at <code class="docutils literal notranslate"><span class="pre">1</span></code>.
If <code class="docutils literal notranslate"><span class="pre">key</span></code> is a slice, returns an array that contains a slice of the
original array. Similar to integer indexing, this follows Python convention
where the index begins at <code class="docutils literal notranslate"><span class="pre">0</span></code> unlike
<a class="reference internal" href="../functions/index.html#datafusion.functions.array_slice" title="datafusion.functions.array_slice"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_slice()</span></code></a> which begins at <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__gt__">
<span class="sig-name descname"><span class="pre">__gt__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__gt__" title="Link to this definition">#</a></dt>
<dd><p>Greater than.</p>
<p>Accepts either an expression or any valid PyArrow scalar literal value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__invert__">
<span class="sig-name descname"><span class="pre">__invert__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__invert__" title="Link to this definition">#</a></dt>
<dd><p>Binary not (~).</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__le__">
<span class="sig-name descname"><span class="pre">__le__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__le__" title="Link to this definition">#</a></dt>
<dd><p>Less than or equal to.</p>
<p>Accepts either an expression or any valid PyArrow scalar literal value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__lt__">
<span class="sig-name descname"><span class="pre">__lt__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__lt__" title="Link to this definition">#</a></dt>
<dd><p>Less than.</p>
<p>Accepts either an expression or any valid PyArrow scalar literal value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__mod__">
<span class="sig-name descname"><span class="pre">__mod__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__mod__" title="Link to this definition">#</a></dt>
<dd><p>Modulo operator (%).</p>
<p>Accepts either an expression or any valid PyArrow scalar literal value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__mul__">
<span class="sig-name descname"><span class="pre">__mul__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__mul__" title="Link to this definition">#</a></dt>
<dd><p>Multiplication operator.</p>
<p>Accepts either an expression or any valid PyArrow scalar literal value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__ne__">
<span class="sig-name descname"><span class="pre">__ne__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__ne__" title="Link to this definition">#</a></dt>
<dd><p>Not equal to.</p>
<p>Accepts either an expression or any valid PyArrow scalar literal value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__or__">
<span class="sig-name descname"><span class="pre">__or__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__or__" title="Link to this definition">#</a></dt>
<dd><p>Logical OR.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__reduce__">
<span class="sig-name descname"><span class="pre">__reduce__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">bytes</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">bytes</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.expr.Expr.__reduce__" title="Link to this definition">#</a></dt>
<dd><p>Pickle protocol hook.</p>
<p>Lets expressions be shipped to worker processes via
<code class="xref py py-func docutils literal notranslate"><span class="pre">pickle.dumps()</span></code> / <code class="xref py py-func docutils literal notranslate"><span class="pre">pickle.loads()</span></code>. Built-in functions
and Python UDFs (scalar, aggregate, window) travel inside the
pickle bytes; only FFI-capsule UDFs require pre-registration on
the worker. The worker’s <code class="xref py py-class docutils literal notranslate"><span class="pre">SessionContext</span></code> for resolving
those references is looked up via
<a class="reference internal" href="../ipc/index.html#datafusion.ipc.set_worker_ctx" title="datafusion.ipc.set_worker_ctx"><code class="xref py py-func docutils literal notranslate"><span class="pre">datafusion.ipc.set_worker_ctx()</span></code></a>, falling back to the
global <code class="xref py py-class docutils literal notranslate"><span class="pre">SessionContext</span></code> if none has been installed on
the worker.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Security
<code class="xref py py-func docutils literal notranslate"><span class="pre">pickle.loads()</span></code> on the returned tuple executes
arbitrary Python on the receiver, including any
cloudpickled UDF callable embedded in the payload. Only
unpickle expressions from trusted sources.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Portability
Sender and receiver must run the same Python
<code class="docutils literal notranslate"><span class="pre">(major,</span> <span class="pre">minor)</span></code> version; cloudpickle bytecode is not
portable across minor versions. See <a class="reference internal" href="#datafusion.expr.Expr.to_bytes" title="datafusion.expr.Expr.to_bytes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">to_bytes()</span></code></a> for
details on what travels by value vs. by reference.</p>
</div>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span><span class="w"> </span><span class="nn">pickle</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion</span><span class="w"> </span><span class="kn">import</span> <span class="n">col</span><span class="p">,</span> <span class="n">lit</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">e</span> <span class="o">=</span> <span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span> <span class="o">*</span> <span class="n">lit</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">pickle</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">pickle</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">e</span><span class="p">))</span><span class="o">.</span><span class="n">canonical_name</span><span class="p">()</span>
<span class="go">&#39;a * Int64(2)&#39;</span>
</pre></div>
</div>
<p>The encoding side honors a driver-side sender context installed
via <a class="reference internal" href="../ipc/index.html#datafusion.ipc.set_sender_ctx" title="datafusion.ipc.set_sender_ctx"><code class="xref py py-func docutils literal notranslate"><span class="pre">datafusion.ipc.set_sender_ctx()</span></code></a> — that is how
<code class="xref py py-meth docutils literal notranslate"><span class="pre">SessionContext.with_python_udf_inlining()</span></code> propagates
through <code class="docutils literal notranslate"><span class="pre">pickle.dumps</span></code>. The sender context is read by
<code class="docutils literal notranslate"><span class="pre">__reduce__</span></code>, so <code class="xref py py-func docutils literal notranslate"><span class="pre">copy.copy()</span></code> and <code class="xref py py-func docutils literal notranslate"><span class="pre">copy.deepcopy()</span></code>
— which also go through <code class="docutils literal notranslate"><span class="pre">__reduce__</span></code> — pick it up too.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__repr__">
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.__repr__" title="Link to this definition">#</a></dt>
<dd><p>Generate a string representation of this expression.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__richcmp__">
<span class="sig-name descname"><span class="pre">__richcmp__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">op</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__richcmp__" title="Link to this definition">#</a></dt>
<dd><p>Comparison operator.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__sub__">
<span class="sig-name descname"><span class="pre">__sub__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__sub__" title="Link to this definition">#</a></dt>
<dd><p>Subtraction operator.</p>
<p>Accepts either an expression or any valid PyArrow scalar literal value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__truediv__">
<span class="sig-name descname"><span class="pre">__truediv__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rhs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.__truediv__" title="Link to this definition">#</a></dt>
<dd><p>Division operator.</p>
<p>Accepts either an expression or any valid PyArrow scalar literal value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr._reconstruct">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_reconstruct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proto_bytes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr._reconstruct" title="Link to this definition">#</a></dt>
<dd><p>Internal entry point used by <a class="reference internal" href="#datafusion.expr.Expr.__reduce__" title="datafusion.expr.Expr.__reduce__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__reduce__()</span></code></a> on unpickle.</p>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion</span><span class="w"> </span><span class="kn">import</span> <span class="n">Expr</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">lit</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">blob</span> <span class="o">=</span> <span class="p">(</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="n">lit</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span><span class="o">.</span><span class="n">to_bytes</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">Expr</span><span class="o">.</span><span class="n">_reconstruct</span><span class="p">(</span><span class="n">blob</span><span class="p">)</span><span class="o">.</span><span class="n">canonical_name</span><span class="p">()</span>
<span class="go">&#39;a + Int64(1)&#39;</span>
</pre></div>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.abs">
<span class="sig-name descname"><span class="pre">abs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.abs" title="Link to this definition">#</a></dt>
<dd><p>Return the absolute value of a given number.</p>
<section id="returns">
<h3>Returns:<a class="headerlink" href="#returns" title="Link to this heading">#</a></h3>
<dl class="simple">
<dt>Expr</dt><dd><p>A new expression representing the absolute value of the input expression.</p>
</dd>
</dl>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.acos">
<span class="sig-name descname"><span class="pre">acos</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.acos" title="Link to this definition">#</a></dt>
<dd><p>Returns the arc cosine or inverse cosine of a number.</p>
<section id="id1">
<h3>Returns:<a class="headerlink" href="#id1" title="Link to this heading">#</a></h3>
<dl class="simple">
<dt>Expr</dt><dd><p>A new expression representing the arc cosine of the input expression.</p>
</dd>
</dl>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.acosh">
<span class="sig-name descname"><span class="pre">acosh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.acosh" title="Link to this definition">#</a></dt>
<dd><p>Returns inverse hyperbolic cosine.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.alias">
<span class="sig-name descname"><span class="pre">alias</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.alias" title="Link to this definition">#</a></dt>
<dd><p>Assign a name to the expression.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> – The name to assign to the expression.</p></li>
<li><p><strong>metadata</strong> – Optional metadata to attach to the expression.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A new expression with the assigned name.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.array_dims">
<span class="sig-name descname"><span class="pre">array_dims</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_dims" title="Link to this definition">#</a></dt>
<dd><p>Returns an array of the array’s dimensions.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.array_distinct">
<span class="sig-name descname"><span class="pre">array_distinct</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_distinct" title="Link to this definition">#</a></dt>
<dd><p>Returns distinct values from the array after removing duplicates.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.array_empty">
<span class="sig-name descname"><span class="pre">array_empty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_empty" title="Link to this definition">#</a></dt>
<dd><p>Returns a boolean indicating whether the array is empty.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.array_length">
<span class="sig-name descname"><span class="pre">array_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_length" title="Link to this definition">#</a></dt>
<dd><p>Returns the length of the array.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.array_ndims">
<span class="sig-name descname"><span class="pre">array_ndims</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_ndims" title="Link to this definition">#</a></dt>
<dd><p>Returns the number of dimensions of the array.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.array_pop_back">
<span class="sig-name descname"><span class="pre">array_pop_back</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_pop_back" title="Link to this definition">#</a></dt>
<dd><p>Returns the array without the last element.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.array_pop_front">
<span class="sig-name descname"><span class="pre">array_pop_front</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.array_pop_front" title="Link to this definition">#</a></dt>
<dd><p>Returns the array without the first element.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.arrow_typeof">
<span class="sig-name descname"><span class="pre">arrow_typeof</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.arrow_typeof" title="Link to this definition">#</a></dt>
<dd><p>Returns the Arrow type of the expression.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.ascii">
<span class="sig-name descname"><span class="pre">ascii</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.ascii" title="Link to this definition">#</a></dt>
<dd><p>Returns the numeric code of the first character of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.asin">
<span class="sig-name descname"><span class="pre">asin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.asin" title="Link to this definition">#</a></dt>
<dd><p>Returns the arc sine or inverse sine of a number.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.asinh">
<span class="sig-name descname"><span class="pre">asinh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.asinh" title="Link to this definition">#</a></dt>
<dd><p>Returns inverse hyperbolic sine.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.atan">
<span class="sig-name descname"><span class="pre">atan</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.atan" title="Link to this definition">#</a></dt>
<dd><p>Returns inverse tangent of a number.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.atanh">
<span class="sig-name descname"><span class="pre">atanh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.atanh" title="Link to this definition">#</a></dt>
<dd><p>Returns inverse hyperbolic tangent.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.between">
<span class="sig-name descname"><span class="pre">between</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">low</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">high</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">negated</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.between" title="Link to this definition">#</a></dt>
<dd><p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if this expression is between a given range.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>low</strong> – lower bound of the range (inclusive).</p></li>
<li><p><strong>high</strong> – higher bound of the range (inclusive).</p></li>
<li><p><strong>negated</strong> – negates whether the expression is between a given range</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.bit_length">
<span class="sig-name descname"><span class="pre">bit_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.bit_length" title="Link to this definition">#</a></dt>
<dd><p>Returns the number of bits in the string argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.btrim">
<span class="sig-name descname"><span class="pre">btrim</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.btrim" title="Link to this definition">#</a></dt>
<dd><p>Removes all characters, spaces by default, from both sides of a string.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.canonical_name">
<span class="sig-name descname"><span class="pre">canonical_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.canonical_name" title="Link to this definition">#</a></dt>
<dd><p>Returns a complete string representation of this expression.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.cardinality">
<span class="sig-name descname"><span class="pre">cardinality</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.cardinality" title="Link to this definition">#</a></dt>
<dd><p>Returns the total number of elements in the array.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.cast">
<span class="sig-name descname"><span class="pre">cast</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">to</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.cast" title="Link to this definition">#</a></dt>
<dd><p>Cast to a new data type.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.cbrt">
<span class="sig-name descname"><span class="pre">cbrt</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.cbrt" title="Link to this definition">#</a></dt>
<dd><p>Returns the cube root of a number.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.ceil">
<span class="sig-name descname"><span class="pre">ceil</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.ceil" title="Link to this definition">#</a></dt>
<dd><p>Returns the nearest integer greater than or equal to argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.char_length">
<span class="sig-name descname"><span class="pre">char_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.char_length" title="Link to this definition">#</a></dt>
<dd><p>The number of characters in the <code class="docutils literal notranslate"><span class="pre">string</span></code>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.character_length">
<span class="sig-name descname"><span class="pre">character_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.character_length" title="Link to this definition">#</a></dt>
<dd><p>Returns the number of characters in the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.chr">
<span class="sig-name descname"><span class="pre">chr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.chr" title="Link to this definition">#</a></dt>
<dd><p>Converts the Unicode code point to a UTF8 character.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.column">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">column</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.column" title="Link to this definition">#</a></dt>
<dd><p>Creates a new expression representing a column.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.column_name">
<span class="sig-name descname"><span class="pre">column_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plan</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../plan/index.html#datafusion.plan.LogicalPlan" title="datafusion.plan.LogicalPlan"><span class="pre">datafusion.plan.LogicalPlan</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.column_name" title="Link to this definition">#</a></dt>
<dd><p>Compute the output column name based on the provided logical plan.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.cos">
<span class="sig-name descname"><span class="pre">cos</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.cos" title="Link to this definition">#</a></dt>
<dd><p>Returns the cosine of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.cosh">
<span class="sig-name descname"><span class="pre">cosh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.cosh" title="Link to this definition">#</a></dt>
<dd><p>Returns the hyperbolic cosine of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.cot">
<span class="sig-name descname"><span class="pre">cot</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.cot" title="Link to this definition">#</a></dt>
<dd><p>Returns the cotangent of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.degrees">
<span class="sig-name descname"><span class="pre">degrees</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.degrees" title="Link to this definition">#</a></dt>
<dd><p>Converts the argument from radians to degrees.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.distinct">
<span class="sig-name descname"><span class="pre">distinct</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ExprFuncBuilder</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.distinct" title="Link to this definition">#</a></dt>
<dd><p>Only evaluate distinct values for an aggregate function.</p>
<p>This function will create an <code class="xref py py-class docutils literal notranslate"><span class="pre">ExprFuncBuilder</span></code> that can be used to
set parameters for either window or aggregate functions. If used on any other
type of expression, an error will be generated when <code class="docutils literal notranslate"><span class="pre">build()</span></code> is called.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.empty">
<span class="sig-name descname"><span class="pre">empty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.empty" title="Link to this definition">#</a></dt>
<dd><p>This is an alias for <a class="reference internal" href="#datafusion.expr.Expr.array_empty" title="datafusion.expr.Expr.array_empty"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_empty()</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.exp">
<span class="sig-name descname"><span class="pre">exp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.exp" title="Link to this definition">#</a></dt>
<dd><p>Returns the exponential of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.factorial">
<span class="sig-name descname"><span class="pre">factorial</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.factorial" title="Link to this definition">#</a></dt>
<dd><p>Returns the factorial of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.fill_nan">
<span class="sig-name descname"><span class="pre">fill_nan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.fill_nan" title="Link to this definition">#</a></dt>
<dd><p>Fill NaN values with a provided value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.fill_null">
<span class="sig-name descname"><span class="pre">fill_null</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.fill_null" title="Link to this definition">#</a></dt>
<dd><p>Fill NULL values with a provided value.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.filter">
<span class="sig-name descname"><span class="pre">filter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ExprFuncBuilder</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.filter" title="Link to this definition">#</a></dt>
<dd><p>Filter an aggregate function.</p>
<p>This function will create an <code class="xref py py-class docutils literal notranslate"><span class="pre">ExprFuncBuilder</span></code> that can be used to
set parameters for either window or aggregate functions. If used on any other
type of expression, an error will be generated when <code class="docutils literal notranslate"><span class="pre">build()</span></code> is called.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.flatten">
<span class="sig-name descname"><span class="pre">flatten</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.flatten" title="Link to this definition">#</a></dt>
<dd><p>Flattens an array of arrays into a single array.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.floor">
<span class="sig-name descname"><span class="pre">floor</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.floor" title="Link to this definition">#</a></dt>
<dd><p>Returns the nearest integer less than or equal to the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.from_bytes">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../context/index.html#datafusion.context.SessionContext" title="datafusion.context.SessionContext"><span class="pre">datafusion.context.SessionContext</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.from_bytes" title="Link to this definition">#</a></dt>
<dd><p>Reconstruct an expression from serialized bytes.</p>
<p>Accepts output of <a class="reference internal" href="#datafusion.expr.Expr.to_bytes" title="datafusion.expr.Expr.to_bytes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">to_bytes()</span></code></a> or <code class="xref py py-func docutils literal notranslate"><span class="pre">pickle.dumps()</span></code>.
<code class="docutils literal notranslate"><span class="pre">ctx</span></code> is the <code class="xref py py-class docutils literal notranslate"><span class="pre">SessionContext</span></code> used to resolve any
function references that travel by name (e.g. FFI UDFs, or
Python UDFs sent with inlining disabled via
<code class="xref py py-meth docutils literal notranslate"><span class="pre">SessionContext.with_python_udf_inlining()</span></code>). When
<code class="docutils literal notranslate"><span class="pre">ctx</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code> the worker context installed via
<a class="reference internal" href="../ipc/index.html#datafusion.ipc.set_worker_ctx" title="datafusion.ipc.set_worker_ctx"><code class="xref py py-func docutils literal notranslate"><span class="pre">datafusion.ipc.set_worker_ctx()</span></code></a> is consulted; if no worker
context is installed, the global <code class="xref py py-class docutils literal notranslate"><span class="pre">SessionContext</span></code> is used
(sufficient for built-ins and Python UDFs, plus any UDFs
registered on the global context).</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Security
Decoding may invoke <code class="docutils literal notranslate"><span class="pre">cloudpickle.loads</span></code> on bytes embedded
in the payload, which executes arbitrary Python code. Treat
<code class="docutils literal notranslate"><span class="pre">buf</span></code> as code, not data — only decode bytes you produced
yourself or received from a trusted sender.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Portability
cloudpickle payloads are <strong>not portable across Python
minor versions</strong>. The wire format stamps the sender’s
<code class="docutils literal notranslate"><span class="pre">(major,</span> <span class="pre">minor)</span></code>; if it does not match the current
interpreter, this method raises <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code>
naming both versions. Modules the UDF imports must also
be importable on the receiver — see <a class="reference internal" href="#datafusion.expr.Expr.to_bytes" title="datafusion.expr.Expr.to_bytes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">to_bytes()</span></code></a> for
by-value vs. by-reference details.</p>
</div>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion</span><span class="w"> </span><span class="kn">import</span> <span class="n">Expr</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">lit</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">blob</span> <span class="o">=</span> <span class="p">(</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="n">lit</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span><span class="o">.</span><span class="n">to_bytes</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">Expr</span><span class="o">.</span><span class="n">from_bytes</span><span class="p">(</span><span class="n">blob</span><span class="p">)</span><span class="o">.</span><span class="n">canonical_name</span><span class="p">()</span>
<span class="go">&#39;a + Int64(1)&#39;</span>
</pre></div>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.from_unixtime">
<span class="sig-name descname"><span class="pre">from_unixtime</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.from_unixtime" title="Link to this definition">#</a></dt>
<dd><p>Converts an integer to RFC3339 timestamp format string.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.initcap">
<span class="sig-name descname"><span class="pre">initcap</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.initcap" title="Link to this definition">#</a></dt>
<dd><p>Set the initial letter of each word to capital.</p>
<p>Converts the first letter of each word in <code class="docutils literal notranslate"><span class="pre">string</span></code> to uppercase and the
remaining characters to lowercase.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.is_not_null">
<span class="sig-name descname"><span class="pre">is_not_null</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.is_not_null" title="Link to this definition">#</a></dt>
<dd><p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if this expression is not null.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.is_null">
<span class="sig-name descname"><span class="pre">is_null</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.is_null" title="Link to this definition">#</a></dt>
<dd><p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if this expression is null.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.isnan">
<span class="sig-name descname"><span class="pre">isnan</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.isnan" title="Link to this definition">#</a></dt>
<dd><p>Returns true if a given number is +NaN or -NaN otherwise returns false.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.iszero">
<span class="sig-name descname"><span class="pre">iszero</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.iszero" title="Link to this definition">#</a></dt>
<dd><p>Returns true if a given number is +0.0 or -0.0 otherwise returns false.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.length">
<span class="sig-name descname"><span class="pre">length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.length" title="Link to this definition">#</a></dt>
<dd><p>The number of characters in the <code class="docutils literal notranslate"><span class="pre">string</span></code>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.list_dims">
<span class="sig-name descname"><span class="pre">list_dims</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.list_dims" title="Link to this definition">#</a></dt>
<dd><p>Returns an array of the array’s dimensions.</p>
<p>This is an alias for <a class="reference internal" href="#datafusion.expr.Expr.array_dims" title="datafusion.expr.Expr.array_dims"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_dims()</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.list_distinct">
<span class="sig-name descname"><span class="pre">list_distinct</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.list_distinct" title="Link to this definition">#</a></dt>
<dd><p>Returns distinct values from the array after removing duplicates.</p>
<p>This is an alias for <a class="reference internal" href="#datafusion.expr.Expr.array_distinct" title="datafusion.expr.Expr.array_distinct"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_distinct()</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.list_length">
<span class="sig-name descname"><span class="pre">list_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.list_length" title="Link to this definition">#</a></dt>
<dd><p>Returns the length of the array.</p>
<p>This is an alias for <a class="reference internal" href="#datafusion.expr.Expr.array_length" title="datafusion.expr.Expr.array_length"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_length()</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.list_ndims">
<span class="sig-name descname"><span class="pre">list_ndims</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.list_ndims" title="Link to this definition">#</a></dt>
<dd><p>Returns the number of dimensions of the array.</p>
<p>This is an alias for <a class="reference internal" href="#datafusion.expr.Expr.array_ndims" title="datafusion.expr.Expr.array_ndims"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_ndims()</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.literal">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">literal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.literal" title="Link to this definition">#</a></dt>
<dd><p>Creates a new expression representing a scalar value.</p>
<p><code class="docutils literal notranslate"><span class="pre">value</span></code> must be a valid PyArrow scalar value or easily castable to one.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.literal_with_metadata">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">literal_with_metadata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.literal_with_metadata" title="Link to this definition">#</a></dt>
<dd><p>Creates a new expression representing a scalar value with metadata.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>value</strong> – A valid PyArrow scalar value or easily castable to one.</p></li>
<li><p><strong>metadata</strong> – Metadata to attach to the expression.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.ln">
<span class="sig-name descname"><span class="pre">ln</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.ln" title="Link to this definition">#</a></dt>
<dd><p>Returns the natural logarithm (base e) of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.log10">
<span class="sig-name descname"><span class="pre">log10</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.log10" title="Link to this definition">#</a></dt>
<dd><p>Base 10 logarithm of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.log2">
<span class="sig-name descname"><span class="pre">log2</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.log2" title="Link to this definition">#</a></dt>
<dd><p>Base 2 logarithm of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.lower">
<span class="sig-name descname"><span class="pre">lower</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.lower" title="Link to this definition">#</a></dt>
<dd><p>Converts a string to lowercase.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.ltrim">
<span class="sig-name descname"><span class="pre">ltrim</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.ltrim" title="Link to this definition">#</a></dt>
<dd><p>Removes all characters, spaces by default, from the beginning of a string.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.md5">
<span class="sig-name descname"><span class="pre">md5</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.md5" title="Link to this definition">#</a></dt>
<dd><p>Computes an MD5 128-bit checksum for a string expression.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.null_treatment">
<span class="sig-name descname"><span class="pre">null_treatment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">null_treatment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datafusion.common.NullTreatment</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ExprFuncBuilder</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.null_treatment" title="Link to this definition">#</a></dt>
<dd><p>Set the treatment for <code class="docutils literal notranslate"><span class="pre">null</span></code> values for a window or aggregate function.</p>
<p>This function will create an <code class="xref py py-class docutils literal notranslate"><span class="pre">ExprFuncBuilder</span></code> that can be used to
set parameters for either window or aggregate functions. If used on any other
type of expression, an error will be generated when <code class="docutils literal notranslate"><span class="pre">build()</span></code> is called.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.octet_length">
<span class="sig-name descname"><span class="pre">octet_length</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.octet_length" title="Link to this definition">#</a></dt>
<dd><p>Returns the number of bytes of a string.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.order_by">
<span class="sig-name descname"><span class="pre">order_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">exprs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.expr.SortExpr" title="datafusion.expr.SortExpr"><span class="pre">SortExpr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ExprFuncBuilder</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.order_by" title="Link to this definition">#</a></dt>
<dd><p>Set the ordering for a window or aggregate function.</p>
<p>This function will create an <code class="xref py py-class docutils literal notranslate"><span class="pre">ExprFuncBuilder</span></code> that can be used to
set parameters for either window or aggregate functions. If used on any other
type of expression, an error will be generated when <code class="docutils literal notranslate"><span class="pre">build()</span></code> is called.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.over">
<span class="sig-name descname"><span class="pre">over</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">window</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Window" title="datafusion.expr.Window"><span class="pre">Window</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.over" title="Link to this definition">#</a></dt>
<dd><p>Turn an aggregate function into a window function.</p>
<p>This function turns any aggregate function into a window function. With the
exception of <code class="docutils literal notranslate"><span class="pre">partition_by</span></code>, how each of the parameters is used is determined
by the underlying aggregate function.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>window</strong> – Window definition</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.partition_by">
<span class="sig-name descname"><span class="pre">partition_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">partition_by</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ExprFuncBuilder</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.partition_by" title="Link to this definition">#</a></dt>
<dd><p>Set the partitioning for a window function.</p>
<p>This function will create an <code class="xref py py-class docutils literal notranslate"><span class="pre">ExprFuncBuilder</span></code> that can be used to
set parameters for either window or aggregate functions. If used on any other
type of expression, an error will be generated when <code class="docutils literal notranslate"><span class="pre">build()</span></code> is called.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.python_value">
<span class="sig-name descname"><span class="pre">python_value</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.python_value" title="Link to this definition">#</a></dt>
<dd><p>Extracts the Expr value into <cite>Any</cite>.</p>
<p>This is only valid for literal expressions.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Python object representing literal value of the expression.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.radians">
<span class="sig-name descname"><span class="pre">radians</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.radians" title="Link to this definition">#</a></dt>
<dd><p>Converts the argument from degrees to radians.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.reverse">
<span class="sig-name descname"><span class="pre">reverse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.reverse" title="Link to this definition">#</a></dt>
<dd><p>Reverse the string argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.rex_call_operands">
<span class="sig-name descname"><span class="pre">rex_call_operands</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.expr.Expr.rex_call_operands" title="Link to this definition">#</a></dt>
<dd><p>Return the operands of the expression based on it’s variant type.</p>
<p>Row expressions, Rex(s), operate on the concept of operands. Different
variants of Expressions, Expr(s), store those operands in different
datastructures. This function examines the Expr variant and returns
the operands to the calling logic.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.rex_call_operator">
<span class="sig-name descname"><span class="pre">rex_call_operator</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.rex_call_operator" title="Link to this definition">#</a></dt>
<dd><p>Extracts the operator associated with a row expression type call.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.rex_type">
<span class="sig-name descname"><span class="pre">rex_type</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">datafusion.common.RexType</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.rex_type" title="Link to this definition">#</a></dt>
<dd><p>Return the Rex Type of this expression.</p>
<p>A Rex (Row Expression) specifies a single row of data.That specification
could include user defined functions or types. RexType identifies the
row as one of the possible valid <code class="docutils literal notranslate"><span class="pre">RexType</span></code>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.rtrim">
<span class="sig-name descname"><span class="pre">rtrim</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.rtrim" title="Link to this definition">#</a></dt>
<dd><p>Removes all characters, spaces by default, from the end of a string.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.schema_name">
<span class="sig-name descname"><span class="pre">schema_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.schema_name" title="Link to this definition">#</a></dt>
<dd><p>Returns the name of this expression as it should appear in a schema.</p>
<p>This name will not include any CAST expressions.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.sha224">
<span class="sig-name descname"><span class="pre">sha224</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sha224" title="Link to this definition">#</a></dt>
<dd><p>Computes the SHA-224 hash of a binary string.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.sha256">
<span class="sig-name descname"><span class="pre">sha256</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sha256" title="Link to this definition">#</a></dt>
<dd><p>Computes the SHA-256 hash of a binary string.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.sha384">
<span class="sig-name descname"><span class="pre">sha384</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sha384" title="Link to this definition">#</a></dt>
<dd><p>Computes the SHA-384 hash of a binary string.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.sha512">
<span class="sig-name descname"><span class="pre">sha512</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sha512" title="Link to this definition">#</a></dt>
<dd><p>Computes the SHA-512 hash of a binary string.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.signum">
<span class="sig-name descname"><span class="pre">signum</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.signum" title="Link to this definition">#</a></dt>
<dd><p>Returns the sign of the argument (-1, 0, +1).</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.sin">
<span class="sig-name descname"><span class="pre">sin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sin" title="Link to this definition">#</a></dt>
<dd><p>Returns the sine of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.sinh">
<span class="sig-name descname"><span class="pre">sinh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sinh" title="Link to this definition">#</a></dt>
<dd><p>Returns the hyperbolic sine of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.sort">
<span class="sig-name descname"><span class="pre">sort</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ascending</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nulls_first</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.SortExpr" title="datafusion.expr.SortExpr"><span class="pre">SortExpr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sort" title="Link to this definition">#</a></dt>
<dd><p>Creates a sort <a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Expr</span></code></a> from an existing <a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Expr</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ascending</strong> – If true, sort in ascending order.</p></li>
<li><p><strong>nulls_first</strong> – Return null values first.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.sqrt">
<span class="sig-name descname"><span class="pre">sqrt</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.sqrt" title="Link to this definition">#</a></dt>
<dd><p>Returns the square root of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.string_literal">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">string_literal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.string_literal" title="Link to this definition">#</a></dt>
<dd><p>Creates a new expression representing a UTF8 literal value.</p>
<p>It is different from <cite>literal</cite> because it is pa.string() instead of
pa.string_view()</p>
<p>This is needed for cases where DataFusion is expecting a UTF8 instead of
UTF8View literal, like in:
<a class="github reference external" href="https://github.com/apache/datafusion/blob/86740bfd3d9831d6b7c1d0e1bf4a21d91598a0ac/datafusion/functions/src/core/arrow_cast.rs#L179">apache/datafusion</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.tan">
<span class="sig-name descname"><span class="pre">tan</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.tan" title="Link to this definition">#</a></dt>
<dd><p>Returns the tangent of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.tanh">
<span class="sig-name descname"><span class="pre">tanh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.tanh" title="Link to this definition">#</a></dt>
<dd><p>Returns the hyperbolic tangent of the argument.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.to_bytes">
<span class="sig-name descname"><span class="pre">to_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../context/index.html#datafusion.context.SessionContext" title="datafusion.context.SessionContext"><span class="pre">datafusion.context.SessionContext</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.to_bytes" title="Link to this definition">#</a></dt>
<dd><p>Serialize this expression to bytes for shipping to another process.</p>
<p>Use this — or <code class="xref py py-func docutils literal notranslate"><span class="pre">pickle.dumps()</span></code> — to send an expression to a
worker process for distributed evaluation.</p>
<p>When <code class="docutils literal notranslate"><span class="pre">ctx</span></code> is supplied, encoding routes through that session’s
installed <code class="xref py py-class docutils literal notranslate"><span class="pre">LogicalExtensionCodec</span></code> (so settings like
<code class="xref py py-meth docutils literal notranslate"><span class="pre">SessionContext.with_python_udf_inlining()</span></code> take effect).
When <code class="docutils literal notranslate"><span class="pre">ctx</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the default codec is used (Python UDF
inlining on, no user-installed extension codec).</p>
<p>Built-in functions travel inside the returned bytes. Python UDFs
(scalar, aggregate, window) also inline by default, so the worker
does not need to pre-register them; when the encoding session has
<code class="xref py py-meth docutils literal notranslate"><span class="pre">SessionContext.with_python_udf_inlining()</span></code> set to <code class="docutils literal notranslate"><span class="pre">False</span></code>,
Python UDFs travel by name only and must be registered on the
worker. UDFs imported via the FFI capsule protocol always travel
by name only and must be registered on the worker.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Security
Bytes returned here may embed a cloudpickled Python
callable (when the expression carries a Python UDF).
Reconstructing them via <a class="reference internal" href="#datafusion.expr.Expr.from_bytes" title="datafusion.expr.Expr.from_bytes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">from_bytes()</span></code></a> or
<code class="xref py py-func docutils literal notranslate"><span class="pre">pickle.loads()</span></code> executes arbitrary Python on the
receiver. Only accept payloads from trusted sources.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Portability
cloudpickle serializes Python bytecode, which is <strong>not
stable across Python minor versions</strong>. A payload produced
on Python 3.11 will fail to load on Python 3.12. The
wire format stamps the sender’s <code class="docutils literal notranslate"><span class="pre">(major,</span> <span class="pre">minor)</span></code>;
<a class="reference internal" href="#datafusion.expr.Expr.from_bytes" title="datafusion.expr.Expr.from_bytes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">from_bytes()</span></code></a> raises a <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code> naming
both versions on mismatch.</p>
<p>cloudpickle captures the UDF callable <strong>by value</strong> —
bytecode and closure cells inlined — but names the
callable resolves via <code class="docutils literal notranslate"><span class="pre">import</span></code> are captured <strong>by
reference</strong> (module path only) and must be importable on
the receiver.</p>
<p><strong>Self-contained — works anywhere:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Lambda: bytecode captured inline</span>
<span class="n">udf</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span> <span class="o">*</span> <span class="mi">2</span><span class="p">,</span> <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">()],</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span>
<span class="n">volatility</span><span class="o">=</span><span class="s2">&quot;immutable&quot;</span><span class="p">)</span>
<span class="c1"># Locally-defined function: bytecode captured inline</span>
<span class="k">def</span><span class="w"> </span><span class="nf">double</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>
<span class="k">return</span> <span class="n">x</span> <span class="o">*</span> <span class="mi">2</span>
<span class="n">udf</span><span class="p">(</span><span class="n">double</span><span class="p">,</span> <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">()],</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="n">volatility</span><span class="o">=</span><span class="s2">&quot;immutable&quot;</span><span class="p">)</span>
<span class="c1"># Closure over a local variable: value captured inline</span>
<span class="n">factor</span> <span class="o">=</span> <span class="mi">3</span>
<span class="n">udf</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span> <span class="o">*</span> <span class="n">factor</span><span class="p">,</span> <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">()],</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span>
<span class="n">volatility</span><span class="o">=</span><span class="s2">&quot;immutable&quot;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>Requires matching environment on receiver:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Top-level import: `foo` must be installed on receiver</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">foo</span><span class="w"> </span><span class="kn">import</span> <span class="n">double</span>
<span class="n">udf</span><span class="p">(</span><span class="n">double</span><span class="p">,</span> <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">()],</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span> <span class="n">volatility</span><span class="o">=</span><span class="s2">&quot;immutable&quot;</span><span class="p">)</span>
<span class="c1"># Bound method of an imported class: same caveat</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">mylib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Transformer</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">Transformer</span><span class="p">()</span>
<span class="n">udf</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">transform</span><span class="p">,</span> <span class="p">[</span><span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">()],</span> <span class="n">pa</span><span class="o">.</span><span class="n">int64</span><span class="p">(),</span>
<span class="n">volatility</span><span class="o">=</span><span class="s2">&quot;immutable&quot;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion</span><span class="w"> </span><span class="kn">import</span> <span class="n">col</span><span class="p">,</span> <span class="n">lit</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">blob</span> <span class="o">=</span> <span class="p">(</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="n">lit</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span><span class="o">.</span><span class="n">to_bytes</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="nb">isinstance</span><span class="p">(</span><span class="n">blob</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">)</span>
<span class="go">True</span>
</pre></div>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.to_hex">
<span class="sig-name descname"><span class="pre">to_hex</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.to_hex" title="Link to this definition">#</a></dt>
<dd><p>Converts an integer to a hexadecimal string.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.to_variant">
<span class="sig-name descname"><span class="pre">to_variant</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.to_variant" title="Link to this definition">#</a></dt>
<dd><p>Convert this expression into a python object if possible.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.trim">
<span class="sig-name descname"><span class="pre">trim</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.trim" title="Link to this definition">#</a></dt>
<dd><p>Removes all characters, spaces by default, from both sides of a string.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.try_cast">
<span class="sig-name descname"><span class="pre">try_cast</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">to</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.try_cast" title="Link to this definition">#</a></dt>
<dd><p>Cast to a new data type, returning NULL on failure.</p>
<p>Like <a class="reference internal" href="#datafusion.expr.Expr.cast" title="datafusion.expr.Expr.cast"><code class="xref py py-meth docutils literal notranslate"><span class="pre">cast()</span></code></a> but produces NULL instead of erroring when the
cast cannot be performed for a given row.</p>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">df</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">from_pydict</span><span class="p">({</span><span class="s2">&quot;a&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;oops&quot;</span><span class="p">]})</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">try_cast</span><span class="p">(</span><span class="n">pa</span><span class="o">.</span><span class="n">float64</span><span class="p">())</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s2">&quot;c&quot;</span><span class="p">))</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">collect_column</span><span class="p">(</span><span class="s2">&quot;c&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">as_py</span><span class="p">()</span> <span class="ow">is</span> <span class="kc">None</span>
<span class="go">True</span>
</pre></div>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.types">
<span class="sig-name descname"><span class="pre">types</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">datafusion.common.DataTypeMap</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.types" title="Link to this definition">#</a></dt>
<dd><p>Return the <code class="docutils literal notranslate"><span class="pre">DataTypeMap</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>DataTypeMap which represents the PythonType, Arrow DataType, and
SqlType Enum which this expression represents.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.upper">
<span class="sig-name descname"><span class="pre">upper</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.Expr.upper" title="Link to this definition">#</a></dt>
<dd><p>Converts a string to uppercase.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.variant_name">
<span class="sig-name descname"><span class="pre">variant_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.variant_name" title="Link to this definition">#</a></dt>
<dd><p>Returns the name of the Expr variant.</p>
<p>Ex: <code class="docutils literal notranslate"><span class="pre">IsNotNull</span></code>, <code class="docutils literal notranslate"><span class="pre">Literal</span></code>, <code class="docutils literal notranslate"><span class="pre">BinaryExpr</span></code>, etc</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.Expr.window_frame">
<span class="sig-name descname"><span class="pre">window_frame</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">window_frame</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.WindowFrame" title="datafusion.expr.WindowFrame"><span class="pre">WindowFrame</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ExprFuncBuilder</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.window_frame" title="Link to this definition">#</a></dt>
<dd><p>Set the frame fora window function.</p>
<p>This function will create an <code class="xref py py-class docutils literal notranslate"><span class="pre">ExprFuncBuilder</span></code> that can be used to
set parameters for either window or aggregate functions. If used on any other
type of expression, an error will be generated when <code class="docutils literal notranslate"><span class="pre">build()</span></code> is called.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__radd__">
<span class="sig-name descname"><span class="pre">__radd__</span></span><a class="headerlink" href="#datafusion.expr.Expr.__radd__" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__rand__">
<span class="sig-name descname"><span class="pre">__rand__</span></span><a class="headerlink" href="#datafusion.expr.Expr.__rand__" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__rmod__">
<span class="sig-name descname"><span class="pre">__rmod__</span></span><a class="headerlink" href="#datafusion.expr.Expr.__rmod__" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__rmul__">
<span class="sig-name descname"><span class="pre">__rmul__</span></span><a class="headerlink" href="#datafusion.expr.Expr.__rmul__" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__ror__">
<span class="sig-name descname"><span class="pre">__ror__</span></span><a class="headerlink" href="#datafusion.expr.Expr.__ror__" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__rsub__">
<span class="sig-name descname"><span class="pre">__rsub__</span></span><a class="headerlink" href="#datafusion.expr.Expr.__rsub__" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.Expr.__rtruediv__">
<span class="sig-name descname"><span class="pre">__rtruediv__</span></span><a class="headerlink" href="#datafusion.expr.Expr.__rtruediv__" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.Expr._to_pyarrow_types">
<span class="sig-name descname"><span class="pre">_to_pyarrow_types</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">pyarrow.DataType</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#datafusion.expr.Expr._to_pyarrow_types" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.Expr.expr">
<span class="sig-name descname"><span class="pre">expr</span></span><a class="headerlink" href="#datafusion.expr.Expr.expr" title="Link to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="datafusion.expr.GroupingSet">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">GroupingSet</span></span><a class="headerlink" href="#datafusion.expr.GroupingSet" title="Link to this definition">#</a></dt>
<dd><p>Factory for creating grouping set expressions.</p>
<p>Grouping sets control how
<a class="reference internal" href="../dataframe/index.html#datafusion.dataframe.DataFrame.aggregate" title="datafusion.dataframe.DataFrame.aggregate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">aggregate()</span></code></a> groups rows.
Instead of a single <code class="docutils literal notranslate"><span class="pre">GROUP</span> <span class="pre">BY</span></code>, they produce multiple grouping
levels in one pass — subtotals, cross-tabulations, or arbitrary
column subsets.</p>
<p>Use <a class="reference internal" href="../functions/index.html#datafusion.functions.grouping" title="datafusion.functions.grouping"><code class="xref py py-func docutils literal notranslate"><span class="pre">grouping()</span></code></a> in the aggregate list
to tell which columns are aggregated across in each result row.</p>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.GroupingSet.cube">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cube</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">exprs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.GroupingSet.cube" title="Link to this definition">#</a></dt>
<dd><p>Create a <code class="docutils literal notranslate"><span class="pre">CUBE</span></code> grouping set for use with <code class="docutils literal notranslate"><span class="pre">aggregate()</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">CUBE</span></code> generates all possible subsets of the given column list
as grouping sets. For example, <code class="docutils literal notranslate"><span class="pre">cube(a,</span> <span class="pre">b)</span></code> produces grouping
sets <code class="docutils literal notranslate"><span class="pre">(a,</span> <span class="pre">b)</span></code>, <code class="docutils literal notranslate"><span class="pre">(a)</span></code>, <code class="docutils literal notranslate"><span class="pre">(b)</span></code>, and <code class="docutils literal notranslate"><span class="pre">()</span></code> (grand total).</p>
<p>This is equivalent to <code class="docutils literal notranslate"><span class="pre">GROUP</span> <span class="pre">BY</span> <span class="pre">CUBE(a,</span> <span class="pre">b)</span></code> in SQL.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>*exprs</strong> – Column expressions or column name strings to
include in the cube.</p>
</dd>
</dl>
<p class="rubric">Examples</p>
<p>With a single column, <code class="docutils literal notranslate"><span class="pre">cube</span></code> behaves identically to
<a class="reference internal" href="#datafusion.expr.GroupingSet.rollup" title="datafusion.expr.GroupingSet.rollup"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rollup()</span></code></a>:</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.expr</span><span class="w"> </span><span class="kn">import</span> <span class="n">GroupingSet</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">df</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">from_pydict</span><span class="p">({</span><span class="s2">&quot;a&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">],</span> <span class="s2">&quot;b&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">10</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="mi">30</span><span class="p">]})</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span>
<span class="gp">... </span> <span class="p">[</span><span class="n">GroupingSet</span><span class="o">.</span><span class="n">cube</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">))],</span>
<span class="gp">... </span> <span class="p">[</span><span class="n">dfn</span><span class="o">.</span><span class="n">functions</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;b&quot;</span><span class="p">))</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s2">&quot;s&quot;</span><span class="p">),</span>
<span class="gp">... </span> <span class="n">dfn</span><span class="o">.</span><span class="n">functions</span><span class="o">.</span><span class="n">grouping</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">))],</span>
<span class="gp">... </span><span class="p">)</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">nulls_first</span><span class="o">=</span><span class="kc">False</span><span class="p">))</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">collect_column</span><span class="p">(</span><span class="s2">&quot;s&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">to_pylist</span><span class="p">()</span>
<span class="go">[30, 30, 60]</span>
</pre></div>
</div>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#datafusion.expr.GroupingSet.rollup" title="datafusion.expr.GroupingSet.rollup"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rollup()</span></code></a>, <a class="reference internal" href="#datafusion.expr.GroupingSet.grouping_sets" title="datafusion.expr.GroupingSet.grouping_sets"><code class="xref py py-meth docutils literal notranslate"><span class="pre">grouping_sets()</span></code></a>,
<a class="reference internal" href="../functions/index.html#datafusion.functions.grouping" title="datafusion.functions.grouping"><code class="xref py py-func docutils literal notranslate"><span class="pre">grouping()</span></code></a></p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.GroupingSet.grouping_sets">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">grouping_sets</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">expr_lists</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.GroupingSet.grouping_sets" title="Link to this definition">#</a></dt>
<dd><p>Create explicit grouping sets for use with <code class="docutils literal notranslate"><span class="pre">aggregate()</span></code>.</p>
<p>Each argument is a list of column expressions or column name
strings representing one grouping set. For example,
<code class="docutils literal notranslate"><span class="pre">grouping_sets([a],</span> <span class="pre">[b])</span></code> groups by <code class="docutils literal notranslate"><span class="pre">a</span></code> alone and by <code class="docutils literal notranslate"><span class="pre">b</span></code>
alone in a single query.</p>
<p>This is equivalent to <code class="docutils literal notranslate"><span class="pre">GROUP</span> <span class="pre">BY</span> <span class="pre">GROUPING</span> <span class="pre">SETS</span> <span class="pre">((a),</span> <span class="pre">(b))</span></code> in
SQL.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>*expr_lists</strong> – Each positional argument is a list of
expressions or column name strings forming one
grouping set.</p>
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.expr</span><span class="w"> </span><span class="kn">import</span> <span class="n">GroupingSet</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">df</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">from_pydict</span><span class="p">(</span>
<span class="gp">... </span> <span class="p">{</span><span class="s2">&quot;a&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;x&quot;</span><span class="p">,</span> <span class="s2">&quot;x&quot;</span><span class="p">,</span> <span class="s2">&quot;y&quot;</span><span class="p">],</span> <span class="s2">&quot;b&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;m&quot;</span><span class="p">,</span> <span class="s2">&quot;n&quot;</span><span class="p">,</span> <span class="s2">&quot;m&quot;</span><span class="p">],</span>
<span class="gp">... </span> <span class="s2">&quot;c&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]})</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span>
<span class="gp">... </span> <span class="p">[</span><span class="n">GroupingSet</span><span class="o">.</span><span class="n">grouping_sets</span><span class="p">(</span>
<span class="gp">... </span> <span class="p">[</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)],</span> <span class="p">[</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;b&quot;</span><span class="p">)])],</span>
<span class="gp">... </span> <span class="p">[</span><span class="n">dfn</span><span class="o">.</span><span class="n">functions</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;c&quot;</span><span class="p">))</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s2">&quot;s&quot;</span><span class="p">),</span>
<span class="gp">... </span> <span class="n">dfn</span><span class="o">.</span><span class="n">functions</span><span class="o">.</span><span class="n">grouping</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)),</span>
<span class="gp">... </span> <span class="n">dfn</span><span class="o">.</span><span class="n">functions</span><span class="o">.</span><span class="n">grouping</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;b&quot;</span><span class="p">))],</span>
<span class="gp">... </span><span class="p">)</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">nulls_first</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span>
<span class="gp">... </span> <span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;b&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">nulls_first</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span>
<span class="gp">... </span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">collect_column</span><span class="p">(</span><span class="s2">&quot;s&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">to_pylist</span><span class="p">()</span>
<span class="go">[3, 3, 4, 2]</span>
</pre></div>
</div>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#datafusion.expr.GroupingSet.rollup" title="datafusion.expr.GroupingSet.rollup"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rollup()</span></code></a>, <a class="reference internal" href="#datafusion.expr.GroupingSet.cube" title="datafusion.expr.GroupingSet.cube"><code class="xref py py-meth docutils literal notranslate"><span class="pre">cube()</span></code></a>,
<a class="reference internal" href="../functions/index.html#datafusion.functions.grouping" title="datafusion.functions.grouping"><code class="xref py py-func docutils literal notranslate"><span class="pre">grouping()</span></code></a></p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.GroupingSet.rollup">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rollup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">exprs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.GroupingSet.rollup" title="Link to this definition">#</a></dt>
<dd><p>Create a <code class="docutils literal notranslate"><span class="pre">ROLLUP</span></code> grouping set for use with <code class="docutils literal notranslate"><span class="pre">aggregate()</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">ROLLUP</span></code> generates all prefixes of the given column list as
grouping sets. For example, <code class="docutils literal notranslate"><span class="pre">rollup(a,</span> <span class="pre">b)</span></code> produces grouping
sets <code class="docutils literal notranslate"><span class="pre">(a,</span> <span class="pre">b)</span></code>, <code class="docutils literal notranslate"><span class="pre">(a)</span></code>, and <code class="docutils literal notranslate"><span class="pre">()</span></code> (grand total).</p>
<p>This is equivalent to <code class="docutils literal notranslate"><span class="pre">GROUP</span> <span class="pre">BY</span> <span class="pre">ROLLUP(a,</span> <span class="pre">b)</span></code> in SQL.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>*exprs</strong> – Column expressions or column name strings to
include in the rollup.</p>
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">datafusion.expr</span><span class="w"> </span><span class="kn">import</span> <span class="n">GroupingSet</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">df</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">from_pydict</span><span class="p">({</span><span class="s2">&quot;a&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">],</span> <span class="s2">&quot;b&quot;</span><span class="p">:</span> <span class="p">[</span><span class="mi">10</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="mi">30</span><span class="p">]})</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span>
<span class="gp">... </span> <span class="p">[</span><span class="n">GroupingSet</span><span class="o">.</span><span class="n">rollup</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">))],</span>
<span class="gp">... </span> <span class="p">[</span><span class="n">dfn</span><span class="o">.</span><span class="n">functions</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;b&quot;</span><span class="p">))</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s2">&quot;s&quot;</span><span class="p">),</span>
<span class="gp">... </span> <span class="n">dfn</span><span class="o">.</span><span class="n">functions</span><span class="o">.</span><span class="n">grouping</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">))],</span>
<span class="gp">... </span><span class="p">)</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">dfn</span><span class="o">.</span><span class="n">col</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">nulls_first</span><span class="o">=</span><span class="kc">False</span><span class="p">))</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span><span class="o">.</span><span class="n">collect_column</span><span class="p">(</span><span class="s2">&quot;s&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">to_pylist</span><span class="p">()</span>
<span class="go">[30, 30, 60]</span>
</pre></div>
</div>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#datafusion.expr.GroupingSet.cube" title="datafusion.expr.GroupingSet.cube"><code class="xref py py-meth docutils literal notranslate"><span class="pre">cube()</span></code></a>, <a class="reference internal" href="#datafusion.expr.GroupingSet.grouping_sets" title="datafusion.expr.GroupingSet.grouping_sets"><code class="xref py py-meth docutils literal notranslate"><span class="pre">grouping_sets()</span></code></a>,
<a class="reference internal" href="../functions/index.html#datafusion.functions.grouping" title="datafusion.functions.grouping"><code class="xref py py-func docutils literal notranslate"><span class="pre">grouping()</span></code></a></p>
</div>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="datafusion.expr.SortExpr">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">SortExpr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">ascending</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nulls_first</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.expr.SortExpr" title="Link to this definition">#</a></dt>
<dd><p>Used to specify sorting on either a DataFrame or function.</p>
<p>This constructor should not be called by the end user.</p>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.SortExpr.__repr__">
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.SortExpr.__repr__" title="Link to this definition">#</a></dt>
<dd><p>Generate a string representation of this expression.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.SortExpr.ascending">
<span class="sig-name descname"><span class="pre">ascending</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.expr.SortExpr.ascending" title="Link to this definition">#</a></dt>
<dd><p>Return ascending property.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.SortExpr.expr">
<span class="sig-name descname"><span class="pre">expr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.SortExpr.expr" title="Link to this definition">#</a></dt>
<dd><p>Return the raw expr backing the SortExpr.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.SortExpr.nulls_first">
<span class="sig-name descname"><span class="pre">nulls_first</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.expr.SortExpr.nulls_first" title="Link to this definition">#</a></dt>
<dd><p>Return nulls_first property.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.SortExpr.raw_sort">
<span class="sig-name descname"><span class="pre">raw_sort</span></span><a class="headerlink" href="#datafusion.expr.SortExpr.raw_sort" title="Link to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="datafusion.expr.Window">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Window</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">partition_by</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window_frame</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.WindowFrame" title="datafusion.expr.WindowFrame"><span class="pre">WindowFrame</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order_by</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datafusion.expr.SortExpr" title="datafusion.expr.SortExpr"><span class="pre">SortExpr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#datafusion.expr.SortExpr" title="datafusion.expr.SortExpr"><span class="pre">SortExpr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">null_treatment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datafusion.common.NullTreatment</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.expr.Window" title="Link to this definition">#</a></dt>
<dd><p>Define reusable window parameters.</p>
<p>Construct a window definition.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>partition_by</strong> – Partitions for window operation</p></li>
<li><p><strong>window_frame</strong> – Define the start and end bounds of the window frame</p></li>
<li><p><strong>order_by</strong> – Set ordering</p></li>
<li><p><strong>null_treatment</strong> – Indicate how nulls are to be treated</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.Window._null_treatment">
<span class="sig-name descname"><span class="pre">_null_treatment</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#datafusion.expr.Window._null_treatment" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.Window._order_by">
<span class="sig-name descname"><span class="pre">_order_by</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#datafusion.expr.Window._order_by" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.Window._partition_by">
<span class="sig-name descname"><span class="pre">_partition_by</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#datafusion.expr.Window._partition_by" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.Window._window_frame">
<span class="sig-name descname"><span class="pre">_window_frame</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#datafusion.expr.Window._window_frame" title="Link to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="datafusion.expr.WindowFrame">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">WindowFrame</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_bound</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_bound</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.expr.WindowFrame" title="Link to this definition">#</a></dt>
<dd><p>Defines a window frame for performing window operations.</p>
<p>Construct a window frame using the given parameters.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>units</strong> – Should be one of <code class="docutils literal notranslate"><span class="pre">rows</span></code>, <code class="docutils literal notranslate"><span class="pre">range</span></code>, or <code class="docutils literal notranslate"><span class="pre">groups</span></code>.</p></li>
<li><p><strong>start_bound</strong> – Sets the preceding bound. Must be &gt;= 0. If none, this
will be set to unbounded. If unit type is <code class="docutils literal notranslate"><span class="pre">groups</span></code>, this
parameter must be set.</p></li>
<li><p><strong>end_bound</strong> – Sets the following bound. Must be &gt;= 0. If none, this
will be set to unbounded. If unit type is <code class="docutils literal notranslate"><span class="pre">groups</span></code>, this
parameter must be set.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.WindowFrame.__repr__">
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.WindowFrame.__repr__" title="Link to this definition">#</a></dt>
<dd><p>Print a string representation of the window frame.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.WindowFrame.get_frame_units">
<span class="sig-name descname"><span class="pre">get_frame_units</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.WindowFrame.get_frame_units" title="Link to this definition">#</a></dt>
<dd><p>Returns the window frame units for the bounds.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.WindowFrame.get_lower_bound">
<span class="sig-name descname"><span class="pre">get_lower_bound</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.WindowFrameBound" title="datafusion.expr.WindowFrameBound"><span class="pre">WindowFrameBound</span></a></span></span><a class="headerlink" href="#datafusion.expr.WindowFrame.get_lower_bound" title="Link to this definition">#</a></dt>
<dd><p>Returns starting bound.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.WindowFrame.get_upper_bound">
<span class="sig-name descname"><span class="pre">get_upper_bound</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.WindowFrameBound" title="datafusion.expr.WindowFrameBound"><span class="pre">WindowFrameBound</span></a></span></span><a class="headerlink" href="#datafusion.expr.WindowFrame.get_upper_bound" title="Link to this definition">#</a></dt>
<dd><p>Returns end bound.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.WindowFrame.window_frame">
<span class="sig-name descname"><span class="pre">window_frame</span></span><a class="headerlink" href="#datafusion.expr.WindowFrame.window_frame" title="Link to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="datafusion.expr.WindowFrameBound">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">WindowFrameBound</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">frame_bound</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datafusion._internal.expr.WindowFrameBound</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datafusion.expr.WindowFrameBound" title="Link to this definition">#</a></dt>
<dd><p>Defines a single window frame bound.</p>
<p><a class="reference internal" href="#datafusion.expr.WindowFrame" title="datafusion.expr.WindowFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowFrame</span></code></a> typically requires a start and end bound.</p>
<p>Constructs a window frame bound.</p>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.WindowFrameBound.get_offset">
<span class="sig-name descname"><span class="pre">get_offset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.expr.WindowFrameBound.get_offset" title="Link to this definition">#</a></dt>
<dd><p>Returns the offset of the window frame.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.WindowFrameBound.is_current_row">
<span class="sig-name descname"><span class="pre">is_current_row</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.expr.WindowFrameBound.is_current_row" title="Link to this definition">#</a></dt>
<dd><p>Returns if the frame bound is current row.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.WindowFrameBound.is_following">
<span class="sig-name descname"><span class="pre">is_following</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.expr.WindowFrameBound.is_following" title="Link to this definition">#</a></dt>
<dd><p>Returns if the frame bound is following.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.WindowFrameBound.is_preceding">
<span class="sig-name descname"><span class="pre">is_preceding</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.expr.WindowFrameBound.is_preceding" title="Link to this definition">#</a></dt>
<dd><p>Returns if the frame bound is preceding.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.expr.WindowFrameBound.is_unbounded">
<span class="sig-name descname"><span class="pre">is_unbounded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#datafusion.expr.WindowFrameBound.is_unbounded" title="Link to this definition">#</a></dt>
<dd><p>Returns if the frame bound is unbounded.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="datafusion.expr.WindowFrameBound.frame_bound">
<span class="sig-name descname"><span class="pre">frame_bound</span></span><a class="headerlink" href="#datafusion.expr.WindowFrameBound.frame_bound" title="Link to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="datafusion.expr.coerce_to_expr">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">coerce_to_expr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a></span></span><a class="headerlink" href="#datafusion.expr.coerce_to_expr" title="Link to this definition">#</a></dt>
<dd><p>Coerce a native Python value to an <code class="docutils literal notranslate"><span class="pre">Expr</span></code> literal, passing <code class="docutils literal notranslate"><span class="pre">Expr</span></code> through.</p>
<p>This is the complement of <a class="reference internal" href="#datafusion.expr.ensure_expr" title="datafusion.expr.ensure_expr"><code class="xref py py-func docutils literal notranslate"><span class="pre">ensure_expr()</span></code></a>: where <code class="docutils literal notranslate"><span class="pre">ensure_expr</span></code>
<em>rejects</em> non-<code class="docutils literal notranslate"><span class="pre">Expr</span></code> values, <code class="docutils literal notranslate"><span class="pre">coerce_to_expr</span></code> <em>wraps</em> them via
<a class="reference internal" href="#datafusion.expr.Expr.literal" title="datafusion.expr.Expr.literal"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Expr.literal()</span></code></a> so that functions can accept native Python types
(<code class="docutils literal notranslate"><span class="pre">int</span></code>, <code class="docutils literal notranslate"><span class="pre">float</span></code>, <code class="docutils literal notranslate"><span class="pre">str</span></code>, <code class="docutils literal notranslate"><span class="pre">bool</span></code>, etc.) alongside <code class="docutils literal notranslate"><span class="pre">Expr</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>value</strong> – An <code class="docutils literal notranslate"><span class="pre">Expr</span></code> instance (returned as-is) or a Python literal to wrap.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>An <code class="docutils literal notranslate"><span class="pre">Expr</span></code> representing the value.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="datafusion.expr.coerce_to_expr_list">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">coerce_to_expr_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.expr.coerce_to_expr_list" title="Link to this definition">#</a></dt>
<dd><p>Coerce each item in an iterable to <code class="docutils literal notranslate"><span class="pre">Expr</span></code> via <a class="reference internal" href="#datafusion.expr.coerce_to_expr" title="datafusion.expr.coerce_to_expr"><code class="xref py py-func docutils literal notranslate"><span class="pre">coerce_to_expr()</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>values</strong> – Iterable of <code class="docutils literal notranslate"><span class="pre">Expr</span></code> instances or Python literals to wrap.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list of <code class="docutils literal notranslate"><span class="pre">Expr</span></code> instances.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="datafusion.expr.coerce_to_expr_or_none">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">coerce_to_expr_or_none</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#datafusion.expr.coerce_to_expr_or_none" title="Link to this definition">#</a></dt>
<dd><p>Coerce a value to <code class="docutils literal notranslate"><span class="pre">Expr</span></code> or pass <code class="docutils literal notranslate"><span class="pre">None</span></code> through unchanged.</p>
<p>Same as <a class="reference internal" href="#datafusion.expr.coerce_to_expr" title="datafusion.expr.coerce_to_expr"><code class="xref py py-func docutils literal notranslate"><span class="pre">coerce_to_expr()</span></code></a> but accepts <code class="docutils literal notranslate"><span class="pre">None</span></code> for optional parameters.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>value</strong> – An <code class="docutils literal notranslate"><span class="pre">Expr</span></code> instance, a Python literal to wrap, or <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>An <code class="docutils literal notranslate"><span class="pre">Expr</span></code> representing the value, or <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="datafusion.expr.ensure_expr">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">ensure_expr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">datafusion._internal.expr.Expr</span></span></span><a class="headerlink" href="#datafusion.expr.ensure_expr" title="Link to this definition">#</a></dt>
<dd><p>Return the internal expression from <code class="docutils literal notranslate"><span class="pre">Expr</span></code> or raise <code class="docutils literal notranslate"><span class="pre">TypeError</span></code>.</p>
<p>This helper rejects plain strings and other non-<a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Expr</span></code></a> values so
higher level APIs consistently require explicit <a class="reference internal" href="../index.html#datafusion.col" title="datafusion.col"><code class="xref py py-func docutils literal notranslate"><span class="pre">col()</span></code></a> or
<a class="reference internal" href="../index.html#datafusion.lit" title="datafusion.lit"><code class="xref py py-func docutils literal notranslate"><span class="pre">lit()</span></code></a> expressions.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#datafusion.expr.coerce_to_expr" title="datafusion.expr.coerce_to_expr"><code class="xref py py-func docutils literal notranslate"><span class="pre">coerce_to_expr()</span></code></a> — the opposite behavior: <em>wraps</em> non-<code class="docutils literal notranslate"><span class="pre">Expr</span></code>
values as literals instead of rejecting them.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>value</strong> – Candidate expression or other object.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The internal expression representation.</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>TypeError</strong> – If <code class="docutils literal notranslate"><span class="pre">value</span></code> is not an instance of <a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Expr</span></code></a>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="datafusion.expr.ensure_expr_list">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">ensure_expr_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exprs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">collections.abc.Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">collections.abc.Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><span class="pre">Expr</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">datafusion._internal.expr.Expr</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datafusion.expr.ensure_expr_list" title="Link to this definition">#</a></dt>
<dd><p>Flatten an iterable of expressions, validating each via <code class="docutils literal notranslate"><span class="pre">ensure_expr</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>exprs</strong> – Possibly nested iterable containing expressions.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A flat list of raw expressions.</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>TypeError</strong> – If any item is not an instance of <a class="reference internal" href="#datafusion.expr.Expr" title="datafusion.expr.Expr"><code class="xref py py-class docutils literal notranslate"><span class="pre">Expr</span></code></a>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Aggregate">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Aggregate</span></span><a class="headerlink" href="#datafusion.expr.Aggregate" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.AggregateFunction">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">AggregateFunction</span></span><a class="headerlink" href="#datafusion.expr.AggregateFunction" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Alias">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Alias</span></span><a class="headerlink" href="#datafusion.expr.Alias" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Analyze">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Analyze</span></span><a class="headerlink" href="#datafusion.expr.Analyze" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Between">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Between</span></span><a class="headerlink" href="#datafusion.expr.Between" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.BinaryExpr">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">BinaryExpr</span></span><a class="headerlink" href="#datafusion.expr.BinaryExpr" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Case">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Case</span></span><a class="headerlink" href="#datafusion.expr.Case" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Cast">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Cast</span></span><a class="headerlink" href="#datafusion.expr.Cast" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Column">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Column</span></span><a class="headerlink" href="#datafusion.expr.Column" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.CopyTo">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CopyTo</span></span><a class="headerlink" href="#datafusion.expr.CopyTo" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.CreateCatalog">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateCatalog</span></span><a class="headerlink" href="#datafusion.expr.CreateCatalog" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.CreateCatalogSchema">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateCatalogSchema</span></span><a class="headerlink" href="#datafusion.expr.CreateCatalogSchema" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.CreateExternalTable">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateExternalTable</span></span><a class="headerlink" href="#datafusion.expr.CreateExternalTable" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.CreateFunction">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateFunction</span></span><a class="headerlink" href="#datafusion.expr.CreateFunction" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.CreateFunctionBody">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateFunctionBody</span></span><a class="headerlink" href="#datafusion.expr.CreateFunctionBody" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.CreateIndex">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateIndex</span></span><a class="headerlink" href="#datafusion.expr.CreateIndex" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.CreateMemoryTable">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateMemoryTable</span></span><a class="headerlink" href="#datafusion.expr.CreateMemoryTable" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.CreateView">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">CreateView</span></span><a class="headerlink" href="#datafusion.expr.CreateView" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Deallocate">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Deallocate</span></span><a class="headerlink" href="#datafusion.expr.Deallocate" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.DescribeTable">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">DescribeTable</span></span><a class="headerlink" href="#datafusion.expr.DescribeTable" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Distinct">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Distinct</span></span><a class="headerlink" href="#datafusion.expr.Distinct" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.DmlStatement">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">DmlStatement</span></span><a class="headerlink" href="#datafusion.expr.DmlStatement" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.DropCatalogSchema">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">DropCatalogSchema</span></span><a class="headerlink" href="#datafusion.expr.DropCatalogSchema" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.DropFunction">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">DropFunction</span></span><a class="headerlink" href="#datafusion.expr.DropFunction" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.DropTable">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">DropTable</span></span><a class="headerlink" href="#datafusion.expr.DropTable" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.DropView">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">DropView</span></span><a class="headerlink" href="#datafusion.expr.DropView" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.EXPR_TYPE_ERROR">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">EXPR_TYPE_ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Use</span> <span class="pre">col()/column()</span> <span class="pre">or</span> <span class="pre">lit()/literal()</span> <span class="pre">to</span> <span class="pre">construct</span> <span class="pre">expressions'</span></em><a class="headerlink" href="#datafusion.expr.EXPR_TYPE_ERROR" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.EmptyRelation">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">EmptyRelation</span></span><a class="headerlink" href="#datafusion.expr.EmptyRelation" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Execute">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Execute</span></span><a class="headerlink" href="#datafusion.expr.Execute" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Exists">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Exists</span></span><a class="headerlink" href="#datafusion.expr.Exists" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Explain">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Explain</span></span><a class="headerlink" href="#datafusion.expr.Explain" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Extension">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Extension</span></span><a class="headerlink" href="#datafusion.expr.Extension" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.FileType">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">FileType</span></span><a class="headerlink" href="#datafusion.expr.FileType" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Filter">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Filter</span></span><a class="headerlink" href="#datafusion.expr.Filter" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.HigherOrderFunction">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">HigherOrderFunction</span></span><a class="headerlink" href="#datafusion.expr.HigherOrderFunction" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.ILike">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">ILike</span></span><a class="headerlink" href="#datafusion.expr.ILike" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.InList">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">InList</span></span><a class="headerlink" href="#datafusion.expr.InList" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.InSubquery">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">InSubquery</span></span><a class="headerlink" href="#datafusion.expr.InSubquery" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.IsFalse">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">IsFalse</span></span><a class="headerlink" href="#datafusion.expr.IsFalse" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.IsNotFalse">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">IsNotFalse</span></span><a class="headerlink" href="#datafusion.expr.IsNotFalse" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.IsNotNull">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">IsNotNull</span></span><a class="headerlink" href="#datafusion.expr.IsNotNull" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.IsNotTrue">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">IsNotTrue</span></span><a class="headerlink" href="#datafusion.expr.IsNotTrue" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.IsNotUnknown">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">IsNotUnknown</span></span><a class="headerlink" href="#datafusion.expr.IsNotUnknown" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.IsNull">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">IsNull</span></span><a class="headerlink" href="#datafusion.expr.IsNull" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.IsTrue">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">IsTrue</span></span><a class="headerlink" href="#datafusion.expr.IsTrue" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.IsUnknown">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">IsUnknown</span></span><a class="headerlink" href="#datafusion.expr.IsUnknown" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Join">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Join</span></span><a class="headerlink" href="#datafusion.expr.Join" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.JoinConstraint">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">JoinConstraint</span></span><a class="headerlink" href="#datafusion.expr.JoinConstraint" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.JoinType">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">JoinType</span></span><a class="headerlink" href="#datafusion.expr.JoinType" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Lambda">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Lambda</span></span><a class="headerlink" href="#datafusion.expr.Lambda" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.LambdaVariable">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">LambdaVariable</span></span><a class="headerlink" href="#datafusion.expr.LambdaVariable" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Like">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Like</span></span><a class="headerlink" href="#datafusion.expr.Like" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Limit">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Limit</span></span><a class="headerlink" href="#datafusion.expr.Limit" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Literal">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Literal</span></span><a class="headerlink" href="#datafusion.expr.Literal" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Negative">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Negative</span></span><a class="headerlink" href="#datafusion.expr.Negative" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Not">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Not</span></span><a class="headerlink" href="#datafusion.expr.Not" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.OperateFunctionArg">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">OperateFunctionArg</span></span><a class="headerlink" href="#datafusion.expr.OperateFunctionArg" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Partitioning">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Partitioning</span></span><a class="headerlink" href="#datafusion.expr.Partitioning" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Placeholder">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Placeholder</span></span><a class="headerlink" href="#datafusion.expr.Placeholder" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Prepare">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Prepare</span></span><a class="headerlink" href="#datafusion.expr.Prepare" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Projection">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Projection</span></span><a class="headerlink" href="#datafusion.expr.Projection" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.RecursiveQuery">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">RecursiveQuery</span></span><a class="headerlink" href="#datafusion.expr.RecursiveQuery" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Repartition">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Repartition</span></span><a class="headerlink" href="#datafusion.expr.Repartition" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.ScalarSubquery">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">ScalarSubquery</span></span><a class="headerlink" href="#datafusion.expr.ScalarSubquery" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.ScalarVariable">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">ScalarVariable</span></span><a class="headerlink" href="#datafusion.expr.ScalarVariable" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.SetVariable">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">SetVariable</span></span><a class="headerlink" href="#datafusion.expr.SetVariable" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.SimilarTo">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">SimilarTo</span></span><a class="headerlink" href="#datafusion.expr.SimilarTo" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Sort">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Sort</span></span><a class="headerlink" href="#datafusion.expr.Sort" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.SortKey">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">SortKey</span></span><a class="headerlink" href="#datafusion.expr.SortKey" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Subquery">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Subquery</span></span><a class="headerlink" href="#datafusion.expr.Subquery" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.SubqueryAlias">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">SubqueryAlias</span></span><a class="headerlink" href="#datafusion.expr.SubqueryAlias" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.TableScan">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">TableScan</span></span><a class="headerlink" href="#datafusion.expr.TableScan" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.TransactionAccessMode">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">TransactionAccessMode</span></span><a class="headerlink" href="#datafusion.expr.TransactionAccessMode" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.TransactionConclusion">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">TransactionConclusion</span></span><a class="headerlink" href="#datafusion.expr.TransactionConclusion" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.TransactionEnd">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">TransactionEnd</span></span><a class="headerlink" href="#datafusion.expr.TransactionEnd" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.TransactionIsolationLevel">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">TransactionIsolationLevel</span></span><a class="headerlink" href="#datafusion.expr.TransactionIsolationLevel" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.TransactionStart">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">TransactionStart</span></span><a class="headerlink" href="#datafusion.expr.TransactionStart" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.TryCast">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">TryCast</span></span><a class="headerlink" href="#datafusion.expr.TryCast" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Union">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Union</span></span><a class="headerlink" href="#datafusion.expr.Union" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Unnest">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Unnest</span></span><a class="headerlink" href="#datafusion.expr.Unnest" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.UnnestExpr">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">UnnestExpr</span></span><a class="headerlink" href="#datafusion.expr.UnnestExpr" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.Values">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">Values</span></span><a class="headerlink" href="#datafusion.expr.Values" title="Link to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="datafusion.expr.WindowExpr">
<span class="sig-prename descclassname"><span class="pre">datafusion.expr.</span></span><span class="sig-name descname"><span class="pre">WindowExpr</span></span><a class="headerlink" href="#datafusion.expr.WindowExpr" title="Link to this definition">#</a></dt>
<dd></dd></dl>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="../dataframe_formatter/index.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">datafusion.dataframe_formatter</p>
</div>
</a>
<a class="right-next"
href="../functions/index.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">datafusion.functions</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#attributes">Attributes</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#classes">Classes</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#functions">Functions</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-contents">Module Contents</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CaseBuilder"><code class="docutils literal notranslate"><span class="pre">CaseBuilder</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CaseBuilder.end"><code class="docutils literal notranslate"><span class="pre">CaseBuilder.end()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CaseBuilder.otherwise"><code class="docutils literal notranslate"><span class="pre">CaseBuilder.otherwise()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CaseBuilder.when"><code class="docutils literal notranslate"><span class="pre">CaseBuilder.when()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CaseBuilder.case_builder"><code class="docutils literal notranslate"><span class="pre">CaseBuilder.case_builder</span></code></a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr"><code class="docutils literal notranslate"><span class="pre">Expr</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__add__"><code class="docutils literal notranslate"><span class="pre">Expr.__add__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__and__"><code class="docutils literal notranslate"><span class="pre">Expr.__and__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__eq__"><code class="docutils literal notranslate"><span class="pre">Expr.__eq__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__ge__"><code class="docutils literal notranslate"><span class="pre">Expr.__ge__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__getitem__"><code class="docutils literal notranslate"><span class="pre">Expr.__getitem__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__gt__"><code class="docutils literal notranslate"><span class="pre">Expr.__gt__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__invert__"><code class="docutils literal notranslate"><span class="pre">Expr.__invert__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__le__"><code class="docutils literal notranslate"><span class="pre">Expr.__le__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__lt__"><code class="docutils literal notranslate"><span class="pre">Expr.__lt__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__mod__"><code class="docutils literal notranslate"><span class="pre">Expr.__mod__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__mul__"><code class="docutils literal notranslate"><span class="pre">Expr.__mul__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__ne__"><code class="docutils literal notranslate"><span class="pre">Expr.__ne__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__or__"><code class="docutils literal notranslate"><span class="pre">Expr.__or__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__reduce__"><code class="docutils literal notranslate"><span class="pre">Expr.__reduce__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__repr__"><code class="docutils literal notranslate"><span class="pre">Expr.__repr__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__richcmp__"><code class="docutils literal notranslate"><span class="pre">Expr.__richcmp__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__sub__"><code class="docutils literal notranslate"><span class="pre">Expr.__sub__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__truediv__"><code class="docutils literal notranslate"><span class="pre">Expr.__truediv__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr._reconstruct"><code class="docutils literal notranslate"><span class="pre">Expr._reconstruct()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.abs"><code class="docutils literal notranslate"><span class="pre">Expr.abs()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.acos"><code class="docutils literal notranslate"><span class="pre">Expr.acos()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.acosh"><code class="docutils literal notranslate"><span class="pre">Expr.acosh()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.alias"><code class="docutils literal notranslate"><span class="pre">Expr.alias()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.array_dims"><code class="docutils literal notranslate"><span class="pre">Expr.array_dims()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.array_distinct"><code class="docutils literal notranslate"><span class="pre">Expr.array_distinct()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.array_empty"><code class="docutils literal notranslate"><span class="pre">Expr.array_empty()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.array_length"><code class="docutils literal notranslate"><span class="pre">Expr.array_length()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.array_ndims"><code class="docutils literal notranslate"><span class="pre">Expr.array_ndims()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.array_pop_back"><code class="docutils literal notranslate"><span class="pre">Expr.array_pop_back()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.array_pop_front"><code class="docutils literal notranslate"><span class="pre">Expr.array_pop_front()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.arrow_typeof"><code class="docutils literal notranslate"><span class="pre">Expr.arrow_typeof()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.ascii"><code class="docutils literal notranslate"><span class="pre">Expr.ascii()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.asin"><code class="docutils literal notranslate"><span class="pre">Expr.asin()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.asinh"><code class="docutils literal notranslate"><span class="pre">Expr.asinh()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.atan"><code class="docutils literal notranslate"><span class="pre">Expr.atan()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.atanh"><code class="docutils literal notranslate"><span class="pre">Expr.atanh()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.between"><code class="docutils literal notranslate"><span class="pre">Expr.between()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.bit_length"><code class="docutils literal notranslate"><span class="pre">Expr.bit_length()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.btrim"><code class="docutils literal notranslate"><span class="pre">Expr.btrim()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.canonical_name"><code class="docutils literal notranslate"><span class="pre">Expr.canonical_name()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.cardinality"><code class="docutils literal notranslate"><span class="pre">Expr.cardinality()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.cast"><code class="docutils literal notranslate"><span class="pre">Expr.cast()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.cbrt"><code class="docutils literal notranslate"><span class="pre">Expr.cbrt()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.ceil"><code class="docutils literal notranslate"><span class="pre">Expr.ceil()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.char_length"><code class="docutils literal notranslate"><span class="pre">Expr.char_length()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.character_length"><code class="docutils literal notranslate"><span class="pre">Expr.character_length()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.chr"><code class="docutils literal notranslate"><span class="pre">Expr.chr()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.column"><code class="docutils literal notranslate"><span class="pre">Expr.column()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.column_name"><code class="docutils literal notranslate"><span class="pre">Expr.column_name()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.cos"><code class="docutils literal notranslate"><span class="pre">Expr.cos()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.cosh"><code class="docutils literal notranslate"><span class="pre">Expr.cosh()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.cot"><code class="docutils literal notranslate"><span class="pre">Expr.cot()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.degrees"><code class="docutils literal notranslate"><span class="pre">Expr.degrees()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.distinct"><code class="docutils literal notranslate"><span class="pre">Expr.distinct()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.empty"><code class="docutils literal notranslate"><span class="pre">Expr.empty()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.exp"><code class="docutils literal notranslate"><span class="pre">Expr.exp()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.factorial"><code class="docutils literal notranslate"><span class="pre">Expr.factorial()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.fill_nan"><code class="docutils literal notranslate"><span class="pre">Expr.fill_nan()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.fill_null"><code class="docutils literal notranslate"><span class="pre">Expr.fill_null()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.filter"><code class="docutils literal notranslate"><span class="pre">Expr.filter()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.flatten"><code class="docutils literal notranslate"><span class="pre">Expr.flatten()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.floor"><code class="docutils literal notranslate"><span class="pre">Expr.floor()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.from_bytes"><code class="docutils literal notranslate"><span class="pre">Expr.from_bytes()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.from_unixtime"><code class="docutils literal notranslate"><span class="pre">Expr.from_unixtime()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.initcap"><code class="docutils literal notranslate"><span class="pre">Expr.initcap()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.is_not_null"><code class="docutils literal notranslate"><span class="pre">Expr.is_not_null()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.is_null"><code class="docutils literal notranslate"><span class="pre">Expr.is_null()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.isnan"><code class="docutils literal notranslate"><span class="pre">Expr.isnan()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.iszero"><code class="docutils literal notranslate"><span class="pre">Expr.iszero()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.length"><code class="docutils literal notranslate"><span class="pre">Expr.length()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.list_dims"><code class="docutils literal notranslate"><span class="pre">Expr.list_dims()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.list_distinct"><code class="docutils literal notranslate"><span class="pre">Expr.list_distinct()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.list_length"><code class="docutils literal notranslate"><span class="pre">Expr.list_length()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.list_ndims"><code class="docutils literal notranslate"><span class="pre">Expr.list_ndims()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.literal"><code class="docutils literal notranslate"><span class="pre">Expr.literal()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.literal_with_metadata"><code class="docutils literal notranslate"><span class="pre">Expr.literal_with_metadata()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.ln"><code class="docutils literal notranslate"><span class="pre">Expr.ln()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.log10"><code class="docutils literal notranslate"><span class="pre">Expr.log10()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.log2"><code class="docutils literal notranslate"><span class="pre">Expr.log2()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.lower"><code class="docutils literal notranslate"><span class="pre">Expr.lower()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.ltrim"><code class="docutils literal notranslate"><span class="pre">Expr.ltrim()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.md5"><code class="docutils literal notranslate"><span class="pre">Expr.md5()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.null_treatment"><code class="docutils literal notranslate"><span class="pre">Expr.null_treatment()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.octet_length"><code class="docutils literal notranslate"><span class="pre">Expr.octet_length()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.order_by"><code class="docutils literal notranslate"><span class="pre">Expr.order_by()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.over"><code class="docutils literal notranslate"><span class="pre">Expr.over()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.partition_by"><code class="docutils literal notranslate"><span class="pre">Expr.partition_by()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.python_value"><code class="docutils literal notranslate"><span class="pre">Expr.python_value()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.radians"><code class="docutils literal notranslate"><span class="pre">Expr.radians()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.reverse"><code class="docutils literal notranslate"><span class="pre">Expr.reverse()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.rex_call_operands"><code class="docutils literal notranslate"><span class="pre">Expr.rex_call_operands()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.rex_call_operator"><code class="docutils literal notranslate"><span class="pre">Expr.rex_call_operator()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.rex_type"><code class="docutils literal notranslate"><span class="pre">Expr.rex_type()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.rtrim"><code class="docutils literal notranslate"><span class="pre">Expr.rtrim()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.schema_name"><code class="docutils literal notranslate"><span class="pre">Expr.schema_name()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.sha224"><code class="docutils literal notranslate"><span class="pre">Expr.sha224()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.sha256"><code class="docutils literal notranslate"><span class="pre">Expr.sha256()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.sha384"><code class="docutils literal notranslate"><span class="pre">Expr.sha384()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.sha512"><code class="docutils literal notranslate"><span class="pre">Expr.sha512()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.signum"><code class="docutils literal notranslate"><span class="pre">Expr.signum()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.sin"><code class="docutils literal notranslate"><span class="pre">Expr.sin()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.sinh"><code class="docutils literal notranslate"><span class="pre">Expr.sinh()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.sort"><code class="docutils literal notranslate"><span class="pre">Expr.sort()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.sqrt"><code class="docutils literal notranslate"><span class="pre">Expr.sqrt()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.string_literal"><code class="docutils literal notranslate"><span class="pre">Expr.string_literal()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.tan"><code class="docutils literal notranslate"><span class="pre">Expr.tan()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.tanh"><code class="docutils literal notranslate"><span class="pre">Expr.tanh()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.to_bytes"><code class="docutils literal notranslate"><span class="pre">Expr.to_bytes()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.to_hex"><code class="docutils literal notranslate"><span class="pre">Expr.to_hex()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.to_variant"><code class="docutils literal notranslate"><span class="pre">Expr.to_variant()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.trim"><code class="docutils literal notranslate"><span class="pre">Expr.trim()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.try_cast"><code class="docutils literal notranslate"><span class="pre">Expr.try_cast()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.types"><code class="docutils literal notranslate"><span class="pre">Expr.types()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.upper"><code class="docutils literal notranslate"><span class="pre">Expr.upper()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.variant_name"><code class="docutils literal notranslate"><span class="pre">Expr.variant_name()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.window_frame"><code class="docutils literal notranslate"><span class="pre">Expr.window_frame()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__radd__"><code class="docutils literal notranslate"><span class="pre">Expr.__radd__</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__rand__"><code class="docutils literal notranslate"><span class="pre">Expr.__rand__</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__rmod__"><code class="docutils literal notranslate"><span class="pre">Expr.__rmod__</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__rmul__"><code class="docutils literal notranslate"><span class="pre">Expr.__rmul__</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__ror__"><code class="docutils literal notranslate"><span class="pre">Expr.__ror__</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__rsub__"><code class="docutils literal notranslate"><span class="pre">Expr.__rsub__</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.__rtruediv__"><code class="docutils literal notranslate"><span class="pre">Expr.__rtruediv__</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr._to_pyarrow_types"><code class="docutils literal notranslate"><span class="pre">Expr._to_pyarrow_types</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Expr.expr"><code class="docutils literal notranslate"><span class="pre">Expr.expr</span></code></a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.GroupingSet"><code class="docutils literal notranslate"><span class="pre">GroupingSet</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.GroupingSet.cube"><code class="docutils literal notranslate"><span class="pre">GroupingSet.cube()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.GroupingSet.grouping_sets"><code class="docutils literal notranslate"><span class="pre">GroupingSet.grouping_sets()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.GroupingSet.rollup"><code class="docutils literal notranslate"><span class="pre">GroupingSet.rollup()</span></code></a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.SortExpr"><code class="docutils literal notranslate"><span class="pre">SortExpr</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.SortExpr.__repr__"><code class="docutils literal notranslate"><span class="pre">SortExpr.__repr__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.SortExpr.ascending"><code class="docutils literal notranslate"><span class="pre">SortExpr.ascending()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.SortExpr.expr"><code class="docutils literal notranslate"><span class="pre">SortExpr.expr()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.SortExpr.nulls_first"><code class="docutils literal notranslate"><span class="pre">SortExpr.nulls_first()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.SortExpr.raw_sort"><code class="docutils literal notranslate"><span class="pre">SortExpr.raw_sort</span></code></a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Window"><code class="docutils literal notranslate"><span class="pre">Window</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Window._null_treatment"><code class="docutils literal notranslate"><span class="pre">Window._null_treatment</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Window._order_by"><code class="docutils literal notranslate"><span class="pre">Window._order_by</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Window._partition_by"><code class="docutils literal notranslate"><span class="pre">Window._partition_by</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Window._window_frame"><code class="docutils literal notranslate"><span class="pre">Window._window_frame</span></code></a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowFrame"><code class="docutils literal notranslate"><span class="pre">WindowFrame</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowFrame.__repr__"><code class="docutils literal notranslate"><span class="pre">WindowFrame.__repr__()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowFrame.get_frame_units"><code class="docutils literal notranslate"><span class="pre">WindowFrame.get_frame_units()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowFrame.get_lower_bound"><code class="docutils literal notranslate"><span class="pre">WindowFrame.get_lower_bound()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowFrame.get_upper_bound"><code class="docutils literal notranslate"><span class="pre">WindowFrame.get_upper_bound()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowFrame.window_frame"><code class="docutils literal notranslate"><span class="pre">WindowFrame.window_frame</span></code></a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowFrameBound"><code class="docutils literal notranslate"><span class="pre">WindowFrameBound</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowFrameBound.get_offset"><code class="docutils literal notranslate"><span class="pre">WindowFrameBound.get_offset()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowFrameBound.is_current_row"><code class="docutils literal notranslate"><span class="pre">WindowFrameBound.is_current_row()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowFrameBound.is_following"><code class="docutils literal notranslate"><span class="pre">WindowFrameBound.is_following()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowFrameBound.is_preceding"><code class="docutils literal notranslate"><span class="pre">WindowFrameBound.is_preceding()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowFrameBound.is_unbounded"><code class="docutils literal notranslate"><span class="pre">WindowFrameBound.is_unbounded()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowFrameBound.frame_bound"><code class="docutils literal notranslate"><span class="pre">WindowFrameBound.frame_bound</span></code></a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.coerce_to_expr"><code class="docutils literal notranslate"><span class="pre">coerce_to_expr()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.coerce_to_expr_list"><code class="docutils literal notranslate"><span class="pre">coerce_to_expr_list()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.coerce_to_expr_or_none"><code class="docutils literal notranslate"><span class="pre">coerce_to_expr_or_none()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.ensure_expr"><code class="docutils literal notranslate"><span class="pre">ensure_expr()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.ensure_expr_list"><code class="docutils literal notranslate"><span class="pre">ensure_expr_list()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Aggregate"><code class="docutils literal notranslate"><span class="pre">Aggregate</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.AggregateFunction"><code class="docutils literal notranslate"><span class="pre">AggregateFunction</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Alias"><code class="docutils literal notranslate"><span class="pre">Alias</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Analyze"><code class="docutils literal notranslate"><span class="pre">Analyze</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Between"><code class="docutils literal notranslate"><span class="pre">Between</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.BinaryExpr"><code class="docutils literal notranslate"><span class="pre">BinaryExpr</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Case"><code class="docutils literal notranslate"><span class="pre">Case</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Cast"><code class="docutils literal notranslate"><span class="pre">Cast</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Column"><code class="docutils literal notranslate"><span class="pre">Column</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CopyTo"><code class="docutils literal notranslate"><span class="pre">CopyTo</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CreateCatalog"><code class="docutils literal notranslate"><span class="pre">CreateCatalog</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CreateCatalogSchema"><code class="docutils literal notranslate"><span class="pre">CreateCatalogSchema</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CreateExternalTable"><code class="docutils literal notranslate"><span class="pre">CreateExternalTable</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CreateFunction"><code class="docutils literal notranslate"><span class="pre">CreateFunction</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CreateFunctionBody"><code class="docutils literal notranslate"><span class="pre">CreateFunctionBody</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CreateIndex"><code class="docutils literal notranslate"><span class="pre">CreateIndex</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CreateMemoryTable"><code class="docutils literal notranslate"><span class="pre">CreateMemoryTable</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.CreateView"><code class="docutils literal notranslate"><span class="pre">CreateView</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Deallocate"><code class="docutils literal notranslate"><span class="pre">Deallocate</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.DescribeTable"><code class="docutils literal notranslate"><span class="pre">DescribeTable</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Distinct"><code class="docutils literal notranslate"><span class="pre">Distinct</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.DmlStatement"><code class="docutils literal notranslate"><span class="pre">DmlStatement</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.DropCatalogSchema"><code class="docutils literal notranslate"><span class="pre">DropCatalogSchema</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.DropFunction"><code class="docutils literal notranslate"><span class="pre">DropFunction</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.DropTable"><code class="docutils literal notranslate"><span class="pre">DropTable</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.DropView"><code class="docutils literal notranslate"><span class="pre">DropView</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.EXPR_TYPE_ERROR"><code class="docutils literal notranslate"><span class="pre">EXPR_TYPE_ERROR</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.EmptyRelation"><code class="docutils literal notranslate"><span class="pre">EmptyRelation</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Execute"><code class="docutils literal notranslate"><span class="pre">Execute</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Exists"><code class="docutils literal notranslate"><span class="pre">Exists</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Explain"><code class="docutils literal notranslate"><span class="pre">Explain</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Extension"><code class="docutils literal notranslate"><span class="pre">Extension</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.FileType"><code class="docutils literal notranslate"><span class="pre">FileType</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Filter"><code class="docutils literal notranslate"><span class="pre">Filter</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.HigherOrderFunction"><code class="docutils literal notranslate"><span class="pre">HigherOrderFunction</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.ILike"><code class="docutils literal notranslate"><span class="pre">ILike</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.InList"><code class="docutils literal notranslate"><span class="pre">InList</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.InSubquery"><code class="docutils literal notranslate"><span class="pre">InSubquery</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.IsFalse"><code class="docutils literal notranslate"><span class="pre">IsFalse</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.IsNotFalse"><code class="docutils literal notranslate"><span class="pre">IsNotFalse</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.IsNotNull"><code class="docutils literal notranslate"><span class="pre">IsNotNull</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.IsNotTrue"><code class="docutils literal notranslate"><span class="pre">IsNotTrue</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.IsNotUnknown"><code class="docutils literal notranslate"><span class="pre">IsNotUnknown</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.IsNull"><code class="docutils literal notranslate"><span class="pre">IsNull</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.IsTrue"><code class="docutils literal notranslate"><span class="pre">IsTrue</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.IsUnknown"><code class="docutils literal notranslate"><span class="pre">IsUnknown</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Join"><code class="docutils literal notranslate"><span class="pre">Join</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.JoinConstraint"><code class="docutils literal notranslate"><span class="pre">JoinConstraint</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.JoinType"><code class="docutils literal notranslate"><span class="pre">JoinType</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Lambda"><code class="docutils literal notranslate"><span class="pre">Lambda</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.LambdaVariable"><code class="docutils literal notranslate"><span class="pre">LambdaVariable</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Like"><code class="docutils literal notranslate"><span class="pre">Like</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Limit"><code class="docutils literal notranslate"><span class="pre">Limit</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Literal"><code class="docutils literal notranslate"><span class="pre">Literal</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Negative"><code class="docutils literal notranslate"><span class="pre">Negative</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Not"><code class="docutils literal notranslate"><span class="pre">Not</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.OperateFunctionArg"><code class="docutils literal notranslate"><span class="pre">OperateFunctionArg</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Partitioning"><code class="docutils literal notranslate"><span class="pre">Partitioning</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Placeholder"><code class="docutils literal notranslate"><span class="pre">Placeholder</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Prepare"><code class="docutils literal notranslate"><span class="pre">Prepare</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Projection"><code class="docutils literal notranslate"><span class="pre">Projection</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.RecursiveQuery"><code class="docutils literal notranslate"><span class="pre">RecursiveQuery</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Repartition"><code class="docutils literal notranslate"><span class="pre">Repartition</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.ScalarSubquery"><code class="docutils literal notranslate"><span class="pre">ScalarSubquery</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.ScalarVariable"><code class="docutils literal notranslate"><span class="pre">ScalarVariable</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.SetVariable"><code class="docutils literal notranslate"><span class="pre">SetVariable</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.SimilarTo"><code class="docutils literal notranslate"><span class="pre">SimilarTo</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Sort"><code class="docutils literal notranslate"><span class="pre">Sort</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.SortKey"><code class="docutils literal notranslate"><span class="pre">SortKey</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Subquery"><code class="docutils literal notranslate"><span class="pre">Subquery</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.SubqueryAlias"><code class="docutils literal notranslate"><span class="pre">SubqueryAlias</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.TableScan"><code class="docutils literal notranslate"><span class="pre">TableScan</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.TransactionAccessMode"><code class="docutils literal notranslate"><span class="pre">TransactionAccessMode</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.TransactionConclusion"><code class="docutils literal notranslate"><span class="pre">TransactionConclusion</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.TransactionEnd"><code class="docutils literal notranslate"><span class="pre">TransactionEnd</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.TransactionIsolationLevel"><code class="docutils literal notranslate"><span class="pre">TransactionIsolationLevel</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.TransactionStart"><code class="docutils literal notranslate"><span class="pre">TransactionStart</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.TryCast"><code class="docutils literal notranslate"><span class="pre">TryCast</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Union"><code class="docutils literal notranslate"><span class="pre">Union</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Unnest"><code class="docutils literal notranslate"><span class="pre">Unnest</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.UnnestExpr"><code class="docutils literal notranslate"><span class="pre">UnnestExpr</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.Values"><code class="docutils literal notranslate"><span class="pre">Values</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#datafusion.expr.WindowExpr"><code class="docutils literal notranslate"><span class="pre">WindowExpr</span></code></a></li>
</ul>
</li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<!-- Based on pydata_sphinx_theme/footer.html -->
<footer class="footer mt-5 mt-md-0">
<div class="container">
<div class="footer-item">
<p>Apache Arrow DataFusion, Arrow DataFusion, Apache, the Apache feather logo, and the Apache Arrow DataFusion project logo</p>
<p>are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p>
</div>
</div>
</footer>
</body>
</html>