| <!DOCTYPE html> |
| |
| <html lang="en" data-content_root="../../../"> |
| <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 — Apache Arrow DataFusion documentation</title> |
| |
| <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> |
| <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> |
| |
| |
| <link rel="stylesheet" |
| href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> |
| <link rel="preload" as="font" type="font/woff2" crossorigin |
| href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> |
| <link rel="preload" as="font" type="font/woff2" crossorigin |
| href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> |
| |
| |
| |
| |
| |
| <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=8f2a1f02" /> |
| <link rel="stylesheet" type="text/css" href="../../../_static/styles/pydata-sphinx-theme.css?v=1140d252" /> |
| <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css?v=4ae1632d" /> |
| <link rel="stylesheet" type="text/css" href="../../../_static/theme_overrides.css?v=dca7052a" /> |
| |
| <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> |
| |
| <script src="../../../_static/documentation_options.js?v=8a448e45"></script> |
| <script src="../../../_static/doctools.js?v=9bcbadda"></script> |
| <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script> |
| <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"> |
| |
| |
| <!-- Google Analytics --> |
| |
| </head> |
| <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80"> |
| |
| <div class="container-fluid" id="banner"></div> |
| |
| |
| |
| |
| <div class="container-xl"> |
| <div class="row"> |
| |
| |
| <!-- Only show if we have sidebars configured, else just a small margin --> |
| <div class="col-12 col-md-3 bd-sidebar"> |
| <div class="sidebar-start-items"> |
| <a class="navbar-brand" href="../../../index.html"> |
| <img src="../../../_static/images/2x_bgwhite_original.png" class="logo" alt="logo"> |
| </a> |
| |
| <form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> |
| <i class="icon fas fa-search"></i> |
| <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" > |
| </form> |
| |
| <nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation"> |
| <div class="bd-toc-item active"> |
| |
| <p aria-level="2" class="caption" role="heading"> |
| <span class="caption-text"> |
| LINKS |
| </span> |
| </p> |
| <ul class="nav bd-sidenav"> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://github.com/apache/datafusion-python"> |
| Github and Issue Tracker |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://docs.rs/datafusion/latest/datafusion/"> |
| Rust's API Docs |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md"> |
| Code of conduct |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://github.com/apache/datafusion-python/tree/main/examples"> |
| Examples |
| </a> |
| </li> |
| </ul> |
| <p aria-level="2" class="caption" role="heading"> |
| <span class="caption-text"> |
| USER GUIDE |
| </span> |
| </p> |
| <ul class="nav bd-sidenav"> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../../user-guide/introduction.html"> |
| Introduction |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../../user-guide/basics.html"> |
| Concepts |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../../user-guide/data-sources.html"> |
| Data Sources |
| </a> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../../../user-guide/dataframe/index.html"> |
| DataFrames |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/> |
| <label for="toctree-checkbox-1"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/dataframe/rendering.html"> |
| HTML Rendering in Jupyter |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../../../user-guide/common-operations/index.html"> |
| Common Operations |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/> |
| <label for="toctree-checkbox-2"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/common-operations/views.html"> |
| Registering Views |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/common-operations/basic-info.html"> |
| Basic Operations |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/common-operations/select-and-filter.html"> |
| Column Selections |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/common-operations/expressions.html"> |
| Expressions |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/common-operations/joins.html"> |
| Joins |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/common-operations/functions.html"> |
| Functions |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/common-operations/aggregations.html"> |
| Aggregation |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/common-operations/windows.html"> |
| Window Functions |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/common-operations/udf-and-udfa.html"> |
| User-Defined Functions |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../../../user-guide/io/index.html"> |
| IO |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/> |
| <label for="toctree-checkbox-3"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/io/arrow.html"> |
| Arrow |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/io/avro.html"> |
| Avro |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/io/csv.html"> |
| CSV |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/io/json.html"> |
| JSON |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/io/parquet.html"> |
| Parquet |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../../../user-guide/io/table_provider.html"> |
| Custom Table Provider |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../../user-guide/configuration.html"> |
| Configuration |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../../user-guide/sql.html"> |
| SQL |
| </a> |
| </li> |
| </ul> |
| <p aria-level="2" class="caption" role="heading"> |
| <span class="caption-text"> |
| CONTRIBUTOR GUIDE |
| </span> |
| </p> |
| <ul class="nav bd-sidenav"> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../../contributor-guide/introduction.html"> |
| Introduction |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../../../contributor-guide/ffi.html"> |
| Python Extensions |
| </a> |
| </li> |
| </ul> |
| <p aria-level="2" class="caption" role="heading"> |
| <span class="caption-text"> |
| API |
| </span> |
| </p> |
| <ul class="current nav bd-sidenav"> |
| <li class="toctree-l1 current active has-children"> |
| <a class="reference internal" href="../../index.html"> |
| API Reference |
| </a> |
| <input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/> |
| <label for="toctree-checkbox-4"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul class="current"> |
| <li class="toctree-l2 current active has-children"> |
| <a class="reference internal" href="../index.html"> |
| datafusion |
| </a> |
| <input checked="" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/> |
| <label for="toctree-checkbox-5"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <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"> |
| <a class="reference internal" href="../functions/index.html"> |
| datafusion.functions |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../html_formatter/index.html"> |
| datafusion.html_formatter |
| </a> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../input/index.html"> |
| datafusion.input |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/> |
| <label for="toctree-checkbox-6"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <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> |
| </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="../object_store/index.html"> |
| datafusion.object_store |
| </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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| |
| |
| </div> |
| </nav> |
| </div> |
| <div class="sidebar-end-items"> |
| </div> |
| </div> |
| |
| |
| |
| |
| <div class="d-none d-xl-block col-xl-2 bd-toc"> |
| |
| |
| <div class="toc-item"> |
| |
| <div class="tocsection onthispage pt-5 pb-3"> |
| <i class="fas fa-list"></i> On this page |
| </div> |
| |
| <nav id="bd-toc-nav"> |
| <ul class="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.__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.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.display_name"> |
| <code class="docutils literal notranslate"> |
| <span class="pre"> |
| Expr.display_name() |
| </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_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_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.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.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.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.GroupingSet"> |
| <code class="docutils literal notranslate"> |
| <span class="pre"> |
| GroupingSet |
| </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.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 class="toc-item"> |
| |
| </div> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main"> |
| |
| <div> |
| |
| <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>This module supports expressions, one of the core concepts in DataFusion.</p> |
| <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 more details.</p> |
| <section id="attributes"> |
| <h2>Attributes<a class="headerlink" href="#attributes" title="Link to this heading">¶</a></h2> |
| <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.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></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.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> |
| </section> |
| <section id="classes"> |
| <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶</a></h2> |
| <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.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-even"><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-odd"><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-even"><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> |
| </section> |
| <section id="functions"> |
| <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading">¶</a></h2> |
| <table class="autosummary longtable table autosummary"> |
| <tbody> |
| <tr class="row-odd"><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-even"><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> |
| </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>An example usage would be as follows:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">datafusion.functions</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">f</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">lit</span><span class="p">,</span> <span class="n">col</span> |
| <span class="n">df</span><span class="o">.</span><span class="n">select</span><span class="p">(</span> |
| <span class="n">f</span><span class="o">.</span><span class="n">case</span><span class="p">(</span><span class="n">col</span><span class="p">(</span><span class="s2">"column_a"</span><span class="p">))</span> |
| <span class="o">.</span><span class="n">when</span><span class="p">(</span><span class="n">lit</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="n">lit</span><span class="p">(</span><span class="s2">"One"</span><span class="p">))</span> |
| <span class="o">.</span><span class="n">when</span><span class="p">(</span><span class="n">lit</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span> <span class="n">lit</span><span class="p">(</span><span class="s2">"Two"</span><span class="p">))</span> |
| <span class="o">.</span><span class="n">otherwise</span><span class="p">(</span><span class="n">lit</span><span class="p">(</span><span class="s2">"Unknown"</span><span class="p">))</span> |
| <span class="p">)</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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.__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">→</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">→</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">→</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">→</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.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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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.display_name"> |
| <span class="sig-name descname"><span class="pre">display_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#datafusion.expr.Expr.display_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.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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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_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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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 a PyObject.</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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="reference external" href="https://github.com/apache/datafusion/blob/86740bfd3d9831d6b7c1d0e1bf4a21d91598a0ac/datafusion/functions/src/core/arrow_cast.rs#L179">https://github.com/apache/datafusion/blob/86740bfd3d9831d6b7c1d0e1bf4a21d91598a0ac/datafusion/functions/src/core/arrow_cast.rs#L179</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">→</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">→</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_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">→</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">→</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">→</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.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">→</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">→</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">→</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">→</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.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">→</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">→</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">→</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">→</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 >= 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 >= 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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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">→</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.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">→</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> |
| <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">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">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">→</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.GroupingSet"> |
| <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></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.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> |
| |
| |
| </div> |
| |
| |
| <!-- Previous / next buttons --> |
| <div class='prev-next-area'> |
| <a class='left-prev' id="prev-link" href="../dataframe_formatter/index.html" title="previous page"> |
| <i class="fas 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' id="next-link" 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="fas fa-angle-right"></i> |
| </a> |
| </div> |
| |
| </main> |
| |
| |
| </div> |
| </div> |
| |
| <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> |
| |
| <!-- Based on pydata_sphinx_theme/footer.html --> |
| <footer class="footer mt-5 mt-md-0"> |
| <div class="container"> |
| |
| <div class="footer-item"> |
| <p class="copyright"> |
| © Copyright 2019-2024, Apache Software Foundation.<br> |
| </p> |
| </div> |
| |
| <div class="footer-item"> |
| <p class="sphinx-version"> |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br> |
| </p> |
| </div> |
| |
| <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> |
