| <!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>SQL — 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="Upgrade Guides" href="upgrade-guides.html" /> |
| <link rel="prev" title="Configuration" href="configuration.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="current nav bd-sidenav"> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="introduction.html"> |
| Introduction |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="basics.html"> |
| Concepts |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="data-sources.html"> |
| Data Sources |
| </a> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="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="dataframe/rendering.html"> |
| HTML Rendering in Jupyter |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="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="common-operations/views.html"> |
| Registering Views |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="common-operations/basic-info.html"> |
| Basic Operations |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="common-operations/select-and-filter.html"> |
| Column Selections |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="common-operations/expressions.html"> |
| Expressions |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="common-operations/joins.html"> |
| Joins |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="common-operations/functions.html"> |
| Functions |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="common-operations/aggregations.html"> |
| Aggregation |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="common-operations/windows.html"> |
| Window Functions |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="common-operations/udf-and-udfa.html"> |
| User-Defined Functions |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="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="io/arrow.html"> |
| Arrow |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="io/avro.html"> |
| Avro |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="io/csv.html"> |
| CSV |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="io/json.html"> |
| JSON |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="io/parquet.html"> |
| Parquet |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="io/table_provider.html"> |
| Custom Table Provider |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="configuration.html"> |
| Configuration |
| </a> |
| </li> |
| <li class="toctree-l1 current active"> |
| <a class="current reference internal" href="#"> |
| SQL |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="upgrade-guides.html"> |
| Upgrade Guides |
| </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="nav bd-sidenav"> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../autoapi/index.html"> |
| API Reference |
| </a> |
| <input 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> |
| <li class="toctree-l2 has-children"> |
| <a class="reference internal" href="../autoapi/datafusion/index.html"> |
| datafusion |
| </a> |
| <input 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> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/catalog/index.html"> |
| datafusion.catalog |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/context/index.html"> |
| datafusion.context |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/dataframe/index.html"> |
| datafusion.dataframe |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/dataframe_formatter/index.html"> |
| datafusion.dataframe_formatter |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/expr/index.html"> |
| datafusion.expr |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/functions/index.html"> |
| datafusion.functions |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/html_formatter/index.html"> |
| datafusion.html_formatter |
| </a> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../autoapi/datafusion/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="../autoapi/datafusion/input/base/index.html"> |
| datafusion.input.base |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../autoapi/datafusion/input/location/index.html"> |
| datafusion.input.location |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/io/index.html"> |
| datafusion.io |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/object_store/index.html"> |
| datafusion.object_store |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/options/index.html"> |
| datafusion.options |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/plan/index.html"> |
| datafusion.plan |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/record_batch/index.html"> |
| datafusion.record_batch |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/substrait/index.html"> |
| datafusion.substrait |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/unparser/index.html"> |
| datafusion.unparser |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/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="#parameterized-queries"> |
| Parameterized queries |
| </a> |
| </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="sql"> |
| <h1>SQL<a class="headerlink" href="#sql" title="Link to this heading">¶</a></h1> |
| <p>DataFusion also offers a SQL API, read the full reference <a class="reference external" href="https://arrow.apache.org/datafusion/user-guide/sql/index.html">here</a></p> |
| <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="kn">import</span><span class="w"> </span><span class="nn">datafusion</span> |
| |
| <span class="n">In</span> <span class="p">[</span><span class="mi">2</span><span class="p">]:</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">DataFrame</span><span class="p">,</span> <span class="n">SessionContext</span> |
| |
| <span class="c1"># create a context</span> |
| <span class="n">In</span> <span class="p">[</span><span class="mi">3</span><span class="p">]:</span> <span class="n">ctx</span> <span class="o">=</span> <span class="n">datafusion</span><span class="o">.</span><span class="n">SessionContext</span><span class="p">()</span> |
| |
| <span class="c1"># register a CSV</span> |
| <span class="n">In</span> <span class="p">[</span><span class="mi">4</span><span class="p">]:</span> <span class="n">ctx</span><span class="o">.</span><span class="n">register_csv</span><span class="p">(</span><span class="s2">"pokemon"</span><span class="p">,</span> <span class="s2">"pokemon.csv"</span><span class="p">)</span> |
| |
| <span class="c1"># create a new statement via SQL</span> |
| <span class="n">In</span> <span class="p">[</span><span class="mi">5</span><span class="p">]:</span> <span class="n">df</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span><span class="s1">'SELECT "Attack"+"Defense", "Attack"-"Defense" FROM pokemon'</span><span class="p">)</span> |
| |
| <span class="c1"># collect and convert to pandas DataFrame</span> |
| <span class="n">In</span> <span class="p">[</span><span class="mi">6</span><span class="p">]:</span> <span class="n">df</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">()</span> |
| <span class="n">Out</span><span class="p">[</span><span class="mi">6</span><span class="p">]:</span> |
| <span class="n">pokemon</span><span class="o">.</span><span class="n">Attack</span> <span class="o">+</span> <span class="n">pokemon</span><span class="o">.</span><span class="n">Defense</span> <span class="n">pokemon</span><span class="o">.</span><span class="n">Attack</span> <span class="o">-</span> <span class="n">pokemon</span><span class="o">.</span><span class="n">Defense</span> |
| <span class="mi">0</span> <span class="mi">98</span> <span class="mi">0</span> |
| <span class="mi">1</span> <span class="mi">125</span> <span class="o">-</span><span class="mi">1</span> |
| <span class="mi">2</span> <span class="mi">165</span> <span class="o">-</span><span class="mi">1</span> |
| <span class="mi">3</span> <span class="mi">223</span> <span class="o">-</span><span class="mi">23</span> |
| <span class="mi">4</span> <span class="mi">95</span> <span class="mi">9</span> |
| <span class="o">..</span> <span class="o">...</span> <span class="o">...</span> |
| <span class="mi">158</span> <span class="mi">190</span> <span class="mi">10</span> |
| <span class="mi">159</span> <span class="mi">109</span> <span class="mi">19</span> |
| <span class="mi">160</span> <span class="mi">149</span> <span class="mi">19</span> |
| <span class="mi">161</span> <span class="mi">229</span> <span class="mi">39</span> |
| <span class="mi">162</span> <span class="mi">200</span> <span class="mi">20</span> |
| |
| <span class="p">[</span><span class="mi">163</span> <span class="n">rows</span> <span class="n">x</span> <span class="mi">2</span> <span class="n">columns</span><span class="p">]</span> |
| </pre></div> |
| </div> |
| <section id="parameterized-queries"> |
| <h2>Parameterized queries<a class="headerlink" href="#parameterized-queries" title="Link to this heading">¶</a></h2> |
| <p>In DataFusion-Python 51.0.0 we introduced the ability to pass parameters |
| in a SQL query. These are similar in concept to |
| <a class="reference external" href="https://datafusion.apache.org/user-guide/sql/prepared_statements.html">prepared statements</a>, |
| but allow passing named parameters into a SQL query. Consider this simple |
| example.</p> |
| <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">7</span><span class="p">]:</span> <span class="k">def</span><span class="w"> </span><span class="nf">show_attacks</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n">SessionContext</span><span class="p">,</span> <span class="n">threshold</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| <span class="o">...</span><span class="p">:</span> <span class="n">ctx</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span> |
| <span class="o">...</span><span class="p">:</span> <span class="s1">'SELECT "Name", "Attack" FROM pokemon WHERE "Attack" > $val'</span><span class="p">,</span> <span class="n">val</span><span class="o">=</span><span class="n">threshold</span> |
| <span class="o">...</span><span class="p">:</span> <span class="p">)</span><span class="o">.</span><span class="n">show</span><span class="p">(</span><span class="n">num</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span> |
| <span class="o">...</span><span class="p">:</span> <span class="n">show_attacks</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="mi">75</span><span class="p">)</span> |
| <span class="o">...</span><span class="p">:</span> |
| <span class="n">DataFrame</span><span class="p">()</span> |
| <span class="o">+---------------------------+--------+</span> |
| <span class="o">|</span> <span class="n">Name</span> <span class="o">|</span> <span class="n">Attack</span> <span class="o">|</span> |
| <span class="o">+---------------------------+--------+</span> |
| <span class="o">|</span> <span class="n">Venusaur</span> <span class="o">|</span> <span class="mi">82</span> <span class="o">|</span> |
| <span class="o">|</span> <span class="n">VenusaurMega</span> <span class="n">Venusaur</span> <span class="o">|</span> <span class="mi">100</span> <span class="o">|</span> |
| <span class="o">|</span> <span class="n">Charizard</span> <span class="o">|</span> <span class="mi">84</span> <span class="o">|</span> |
| <span class="o">|</span> <span class="n">CharizardMega</span> <span class="n">Charizard</span> <span class="n">X</span> <span class="o">|</span> <span class="mi">130</span> <span class="o">|</span> |
| <span class="o">|</span> <span class="n">CharizardMega</span> <span class="n">Charizard</span> <span class="n">Y</span> <span class="o">|</span> <span class="mi">104</span> <span class="o">|</span> |
| <span class="o">+---------------------------+--------+</span> |
| </pre></div> |
| </div> |
| <p>When passing parameters like the example above we convert the Python objects |
| into their string representation. We also have special case handling |
| for <a class="reference internal" href="../autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame" title="datafusion.dataframe.DataFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFrame</span></code></a> objects, since they cannot simply |
| be turned into string representations for an SQL query. In these cases we |
| will register a temporary view in the <a class="reference internal" href="../autoapi/datafusion/context/index.html#datafusion.context.SessionContext" title="datafusion.context.SessionContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">SessionContext</span></code></a> |
| using a generated table name.</p> |
| <p>The formatting for passing string replacement objects is to precede the |
| variable name with a single <code class="docutils literal notranslate"><span class="pre">$</span></code>. This works for all dialects in |
| the SQL parser except <code class="docutils literal notranslate"><span class="pre">hive</span></code> and <code class="docutils literal notranslate"><span class="pre">mysql</span></code>. Since these dialects do not |
| support named placeholders, we are unable to do this type of replacement. |
| We recommend either switching to another dialect or using Python |
| f-string style replacement.</p> |
| <div class="admonition warning"> |
| <p class="admonition-title">Warning</p> |
| <p>To support DataFrame parameterized queries, your session must support |
| registration of temporary views. The default |
| <a class="reference internal" href="../autoapi/datafusion/catalog/index.html#datafusion.catalog.CatalogProvider" title="datafusion.catalog.CatalogProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">CatalogProvider</span></code></a> and |
| <a class="reference internal" href="../autoapi/datafusion/catalog/index.html#datafusion.catalog.SchemaProvider" title="datafusion.catalog.SchemaProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaProvider</span></code></a> do have this capability. |
| If you have implemented custom providers, it is important that temporary |
| views do not persist across <a class="reference internal" href="../autoapi/datafusion/context/index.html#datafusion.context.SessionContext" title="datafusion.context.SessionContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">SessionContext</span></code></a> |
| or you may get unintended consequences.</p> |
| </div> |
| <p>The following example shows passing in both a <a class="reference internal" href="../autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame" title="datafusion.dataframe.DataFrame"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFrame</span></code></a> |
| object as well as a Python object to be used in parameterized replacement.</p> |
| <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">8</span><span class="p">]:</span> <span class="k">def</span><span class="w"> </span><span class="nf">show_column</span><span class="p">(</span> |
| <span class="o">...</span><span class="p">:</span> <span class="n">ctx</span><span class="p">:</span> <span class="n">SessionContext</span><span class="p">,</span> <span class="n">column</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">df</span><span class="p">:</span> <span class="n">DataFrame</span><span class="p">,</span> <span class="n">threshold</span><span class="p">:</span> <span class="nb">int</span> |
| <span class="o">...</span><span class="p">:</span> <span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| <span class="o">...</span><span class="p">:</span> <span class="n">ctx</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span> |
| <span class="o">...</span><span class="p">:</span> <span class="s1">'SELECT "Name", $col FROM $df WHERE $col > $val'</span><span class="p">,</span> |
| <span class="o">...</span><span class="p">:</span> <span class="n">col</span><span class="o">=</span><span class="n">column</span><span class="p">,</span> |
| <span class="o">...</span><span class="p">:</span> <span class="n">df</span><span class="o">=</span><span class="n">df</span><span class="p">,</span> |
| <span class="o">...</span><span class="p">:</span> <span class="n">val</span><span class="o">=</span><span class="n">threshold</span><span class="p">,</span> |
| <span class="o">...</span><span class="p">:</span> <span class="p">)</span><span class="o">.</span><span class="n">show</span><span class="p">(</span><span class="n">num</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span> |
| <span class="o">...</span><span class="p">:</span> <span class="n">df</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">table</span><span class="p">(</span><span class="s2">"pokemon"</span><span class="p">)</span> |
| <span class="o">...</span><span class="p">:</span> <span class="n">show_column</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="s1">'"Defense"'</span><span class="p">,</span> <span class="n">df</span><span class="p">,</span> <span class="mi">75</span><span class="p">)</span> |
| <span class="o">...</span><span class="p">:</span> |
| <span class="n">DataFrame</span><span class="p">()</span> |
| <span class="o">+---------------------------+---------+</span> |
| <span class="o">|</span> <span class="n">Name</span> <span class="o">|</span> <span class="n">Defense</span> <span class="o">|</span> |
| <span class="o">+---------------------------+---------+</span> |
| <span class="o">|</span> <span class="n">Venusaur</span> <span class="o">|</span> <span class="mi">83</span> <span class="o">|</span> |
| <span class="o">|</span> <span class="n">VenusaurMega</span> <span class="n">Venusaur</span> <span class="o">|</span> <span class="mi">123</span> <span class="o">|</span> |
| <span class="o">|</span> <span class="n">Charizard</span> <span class="o">|</span> <span class="mi">78</span> <span class="o">|</span> |
| <span class="o">|</span> <span class="n">CharizardMega</span> <span class="n">Charizard</span> <span class="n">X</span> <span class="o">|</span> <span class="mi">111</span> <span class="o">|</span> |
| <span class="o">|</span> <span class="n">CharizardMega</span> <span class="n">Charizard</span> <span class="n">Y</span> <span class="o">|</span> <span class="mi">78</span> <span class="o">|</span> |
| <span class="o">+---------------------------+---------+</span> |
| </pre></div> |
| </div> |
| <p>The approach implemented for conversion of variables into a SQL query |
| relies on string conversion. This has the potential for data loss, |
| specifically for cases like floating point numbers. If you need to pass |
| variables into a parameterized query and it is important to maintain the |
| original value without conversion to a string, then you can use the |
| optional parameter <code class="docutils literal notranslate"><span class="pre">param_values</span></code> to specify these. This parameter |
| expects a dictionary mapping from the parameter name to a Python |
| object. Those objects will be cast into a |
| <a class="reference external" href="https://arrow.apache.org/docs/python/generated/pyarrow.Scalar.html">PyArrow Scalar Value</a>.</p> |
| <p>Using <code class="docutils literal notranslate"><span class="pre">param_values</span></code> will rely on the SQL dialect you have configured |
| for your session. This can be set using the <a class="reference internal" href="configuration.html#configuration"><span class="std std-ref">configuration options</span></a> |
| of your <a class="reference internal" href="../autoapi/datafusion/context/index.html#datafusion.context.SessionContext" title="datafusion.context.SessionContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">SessionContext</span></code></a>. Similar to how |
| <a class="reference external" href="https://datafusion.apache.org/user-guide/sql/prepared_statements.html">prepared statements</a> |
| work, these parameters are limited to places where you would pass in a |
| scalar value, such as a comparison.</p> |
| <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">9</span><span class="p">]:</span> <span class="k">def</span><span class="w"> </span><span class="nf">param_attacks</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n">SessionContext</span><span class="p">,</span> <span class="n">threshold</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| <span class="o">...</span><span class="p">:</span> <span class="n">ctx</span><span class="o">.</span><span class="n">sql</span><span class="p">(</span> |
| <span class="o">...</span><span class="p">:</span> <span class="s1">'SELECT "Name", "Attack" FROM pokemon WHERE "Attack" > $val'</span><span class="p">,</span> |
| <span class="o">...</span><span class="p">:</span> <span class="n">param_values</span><span class="o">=</span><span class="p">{</span><span class="s2">"val"</span><span class="p">:</span> <span class="n">threshold</span><span class="p">},</span> |
| <span class="o">...</span><span class="p">:</span> <span class="p">)</span><span class="o">.</span><span class="n">show</span><span class="p">(</span><span class="n">num</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span> |
| <span class="o">...</span><span class="p">:</span> <span class="n">param_attacks</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="mi">75</span><span class="p">)</span> |
| <span class="o">...</span><span class="p">:</span> |
| <span class="n">DataFrame</span><span class="p">()</span> |
| <span class="o">+---------------------------+--------+</span> |
| <span class="o">|</span> <span class="n">Name</span> <span class="o">|</span> <span class="n">Attack</span> <span class="o">|</span> |
| <span class="o">+---------------------------+--------+</span> |
| <span class="o">|</span> <span class="n">Venusaur</span> <span class="o">|</span> <span class="mi">82</span> <span class="o">|</span> |
| <span class="o">|</span> <span class="n">VenusaurMega</span> <span class="n">Venusaur</span> <span class="o">|</span> <span class="mi">100</span> <span class="o">|</span> |
| <span class="o">|</span> <span class="n">Charizard</span> <span class="o">|</span> <span class="mi">84</span> <span class="o">|</span> |
| <span class="o">|</span> <span class="n">CharizardMega</span> <span class="n">Charizard</span> <span class="n">X</span> <span class="o">|</span> <span class="mi">130</span> <span class="o">|</span> |
| <span class="o">|</span> <span class="n">CharizardMega</span> <span class="n">Charizard</span> <span class="n">Y</span> <span class="o">|</span> <span class="mi">104</span> <span class="o">|</span> |
| <span class="o">+---------------------------+--------+</span> |
| </pre></div> |
| </div> |
| </section> |
| </section> |
| |
| |
| </div> |
| |
| |
| <!-- Previous / next buttons --> |
| <div class='prev-next-area'> |
| <a class='left-prev' id="prev-link" href="configuration.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">Configuration</p> |
| </div> |
| </a> |
| <a class='right-next' id="next-link" href="upgrade-guides.html" title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">Upgrade Guides</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> |
