diff options
Diffstat (limited to 'docs/sqlglot/optimizer/optimizer.html')
| -rw-r--r-- | docs/sqlglot/optimizer/optimizer.html | 232 |
1 files changed, 117 insertions, 115 deletions
diff --git a/docs/sqlglot/optimizer/optimizer.html b/docs/sqlglot/optimizer/optimizer.html index e6bbae7..28abdf8 100644 --- a/docs/sqlglot/optimizer/optimizer.html +++ b/docs/sqlglot/optimizer/optimizer.html @@ -3,7 +3,7 @@ <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="generator" content="pdoc 13.0.0"/> + <meta name="generator" content="pdoc 13.0.1"/> <title>sqlglot.optimizer.optimizer API documentation</title> <style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style> @@ -28,8 +28,8 @@ - <h2>API Documentation</h2> - <ul class="memberlist"> + <h2>API Documentation</h2> + <ul class="memberlist"> <li> <a class="function" href="#optimize">optimize</a> </li> @@ -79,74 +79,76 @@ </span><span id="L-21"><a href="#L-21"><span class="linenos">21</span></a><span class="kn">from</span> <span class="nn">sqlglot.optimizer.pushdown_projections</span> <span class="kn">import</span> <span class="n">pushdown_projections</span> </span><span id="L-22"><a href="#L-22"><span class="linenos">22</span></a><span class="kn">from</span> <span class="nn">sqlglot.optimizer.qualify_columns</span> <span class="kn">import</span> <span class="n">qualify_columns</span><span class="p">,</span> <span class="n">validate_qualify_columns</span> </span><span id="L-23"><a href="#L-23"><span class="linenos">23</span></a><span class="kn">from</span> <span class="nn">sqlglot.optimizer.qualify_tables</span> <span class="kn">import</span> <span class="n">qualify_tables</span> -</span><span id="L-24"><a href="#L-24"><span class="linenos">24</span></a><span class="kn">from</span> <span class="nn">sqlglot.optimizer.unnest_subqueries</span> <span class="kn">import</span> <span class="n">unnest_subqueries</span> -</span><span id="L-25"><a href="#L-25"><span class="linenos">25</span></a><span class="kn">from</span> <span class="nn">sqlglot.schema</span> <span class="kn">import</span> <span class="n">ensure_schema</span> -</span><span id="L-26"><a href="#L-26"><span class="linenos">26</span></a> -</span><span id="L-27"><a href="#L-27"><span class="linenos">27</span></a><span class="n">RULES</span> <span class="o">=</span> <span class="p">(</span> -</span><span id="L-28"><a href="#L-28"><span class="linenos">28</span></a> <span class="n">lower_identities</span><span class="p">,</span> -</span><span id="L-29"><a href="#L-29"><span class="linenos">29</span></a> <span class="n">qualify_tables</span><span class="p">,</span> -</span><span id="L-30"><a href="#L-30"><span class="linenos">30</span></a> <span class="n">isolate_table_selects</span><span class="p">,</span> -</span><span id="L-31"><a href="#L-31"><span class="linenos">31</span></a> <span class="n">qualify_columns</span><span class="p">,</span> -</span><span id="L-32"><a href="#L-32"><span class="linenos">32</span></a> <span class="n">expand_laterals</span><span class="p">,</span> -</span><span id="L-33"><a href="#L-33"><span class="linenos">33</span></a> <span class="n">pushdown_projections</span><span class="p">,</span> -</span><span id="L-34"><a href="#L-34"><span class="linenos">34</span></a> <span class="n">validate_qualify_columns</span><span class="p">,</span> -</span><span id="L-35"><a href="#L-35"><span class="linenos">35</span></a> <span class="n">normalize</span><span class="p">,</span> -</span><span id="L-36"><a href="#L-36"><span class="linenos">36</span></a> <span class="n">unnest_subqueries</span><span class="p">,</span> -</span><span id="L-37"><a href="#L-37"><span class="linenos">37</span></a> <span class="n">expand_multi_table_selects</span><span class="p">,</span> -</span><span id="L-38"><a href="#L-38"><span class="linenos">38</span></a> <span class="n">pushdown_predicates</span><span class="p">,</span> -</span><span id="L-39"><a href="#L-39"><span class="linenos">39</span></a> <span class="n">optimize_joins</span><span class="p">,</span> -</span><span id="L-40"><a href="#L-40"><span class="linenos">40</span></a> <span class="n">eliminate_subqueries</span><span class="p">,</span> -</span><span id="L-41"><a href="#L-41"><span class="linenos">41</span></a> <span class="n">merge_subqueries</span><span class="p">,</span> -</span><span id="L-42"><a href="#L-42"><span class="linenos">42</span></a> <span class="n">eliminate_joins</span><span class="p">,</span> -</span><span id="L-43"><a href="#L-43"><span class="linenos">43</span></a> <span class="n">eliminate_ctes</span><span class="p">,</span> -</span><span id="L-44"><a href="#L-44"><span class="linenos">44</span></a> <span class="n">annotate_types</span><span class="p">,</span> -</span><span id="L-45"><a href="#L-45"><span class="linenos">45</span></a> <span class="n">canonicalize</span><span class="p">,</span> -</span><span id="L-46"><a href="#L-46"><span class="linenos">46</span></a><span class="p">)</span> -</span><span id="L-47"><a href="#L-47"><span class="linenos">47</span></a> -</span><span id="L-48"><a href="#L-48"><span class="linenos">48</span></a> -</span><span id="L-49"><a href="#L-49"><span class="linenos">49</span></a><span class="k">def</span> <span class="nf">optimize</span><span class="p">(</span> -</span><span id="L-50"><a href="#L-50"><span class="linenos">50</span></a> <span class="n">expression</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">exp</span><span class="o">.</span><span class="n">Expression</span><span class="p">,</span> -</span><span id="L-51"><a href="#L-51"><span class="linenos">51</span></a> <span class="n">schema</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">dict</span> <span class="o">|</span> <span class="n">Schema</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> -</span><span id="L-52"><a href="#L-52"><span class="linenos">52</span></a> <span class="n">db</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> -</span><span id="L-53"><a href="#L-53"><span class="linenos">53</span></a> <span class="n">catalog</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> -</span><span id="L-54"><a href="#L-54"><span class="linenos">54</span></a> <span class="n">dialect</span><span class="p">:</span> <span class="n">DialectType</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> -</span><span id="L-55"><a href="#L-55"><span class="linenos">55</span></a> <span class="n">rules</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="n">RULES</span><span class="p">,</span> -</span><span id="L-56"><a href="#L-56"><span class="linenos">56</span></a> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span> -</span><span id="L-57"><a href="#L-57"><span class="linenos">57</span></a><span class="p">):</span> -</span><span id="L-58"><a href="#L-58"><span class="linenos">58</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="L-59"><a href="#L-59"><span class="linenos">59</span></a><span class="sd"> Rewrite a sqlglot AST into an optimized form.</span> -</span><span id="L-60"><a href="#L-60"><span class="linenos">60</span></a> -</span><span id="L-61"><a href="#L-61"><span class="linenos">61</span></a><span class="sd"> Args:</span> -</span><span id="L-62"><a href="#L-62"><span class="linenos">62</span></a><span class="sd"> expression: expression to optimize</span> -</span><span id="L-63"><a href="#L-63"><span class="linenos">63</span></a><span class="sd"> schema: database schema.</span> -</span><span id="L-64"><a href="#L-64"><span class="linenos">64</span></a><span class="sd"> This can either be an instance of `sqlglot.optimizer.Schema` or a mapping in one of</span> -</span><span id="L-65"><a href="#L-65"><span class="linenos">65</span></a><span class="sd"> the following forms:</span> -</span><span id="L-66"><a href="#L-66"><span class="linenos">66</span></a><span class="sd"> 1. {table: {col: type}}</span> -</span><span id="L-67"><a href="#L-67"><span class="linenos">67</span></a><span class="sd"> 2. {db: {table: {col: type}}}</span> -</span><span id="L-68"><a href="#L-68"><span class="linenos">68</span></a><span class="sd"> 3. {catalog: {db: {table: {col: type}}}}</span> -</span><span id="L-69"><a href="#L-69"><span class="linenos">69</span></a><span class="sd"> If no schema is provided then the default schema defined at `sqlgot.schema` will be used</span> -</span><span id="L-70"><a href="#L-70"><span class="linenos">70</span></a><span class="sd"> db: specify the default database, as might be set by a `USE DATABASE db` statement</span> -</span><span id="L-71"><a href="#L-71"><span class="linenos">71</span></a><span class="sd"> catalog: specify the default catalog, as might be set by a `USE CATALOG c` statement</span> -</span><span id="L-72"><a href="#L-72"><span class="linenos">72</span></a><span class="sd"> dialect: The dialect to parse the sql string.</span> -</span><span id="L-73"><a href="#L-73"><span class="linenos">73</span></a><span class="sd"> rules: sequence of optimizer rules to use.</span> -</span><span id="L-74"><a href="#L-74"><span class="linenos">74</span></a><span class="sd"> Many of the rules require tables and columns to be qualified.</span> -</span><span id="L-75"><a href="#L-75"><span class="linenos">75</span></a><span class="sd"> Do not remove qualify_tables or qualify_columns from the sequence of rules unless you know</span> -</span><span id="L-76"><a href="#L-76"><span class="linenos">76</span></a><span class="sd"> what you're doing!</span> -</span><span id="L-77"><a href="#L-77"><span class="linenos">77</span></a><span class="sd"> **kwargs: If a rule has a keyword argument with a same name in **kwargs, it will be passed in.</span> -</span><span id="L-78"><a href="#L-78"><span class="linenos">78</span></a><span class="sd"> Returns:</span> -</span><span id="L-79"><a href="#L-79"><span class="linenos">79</span></a><span class="sd"> sqlglot.Expression: optimized expression</span> -</span><span id="L-80"><a href="#L-80"><span class="linenos">80</span></a><span class="sd"> """</span> -</span><span id="L-81"><a href="#L-81"><span class="linenos">81</span></a> <span class="n">schema</span> <span class="o">=</span> <span class="n">ensure_schema</span><span class="p">(</span><span class="n">schema</span> <span class="ow">or</span> <span class="n">sqlglot</span><span class="o">.</span><span class="n">schema</span><span class="p">)</span> -</span><span id="L-82"><a href="#L-82"><span class="linenos">82</span></a> <span class="n">possible_kwargs</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"db"</span><span class="p">:</span> <span class="n">db</span><span class="p">,</span> <span class="s2">"catalog"</span><span class="p">:</span> <span class="n">catalog</span><span class="p">,</span> <span class="s2">"schema"</span><span class="p">:</span> <span class="n">schema</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">}</span> -</span><span id="L-83"><a href="#L-83"><span class="linenos">83</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">exp</span><span class="o">.</span><span class="n">maybe_parse</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="n">dialect</span><span class="o">=</span><span class="n">dialect</span><span class="p">,</span> <span class="n">copy</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> -</span><span id="L-84"><a href="#L-84"><span class="linenos">84</span></a> <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="n">rules</span><span class="p">:</span> -</span><span id="L-85"><a href="#L-85"><span class="linenos">85</span></a> <span class="c1"># Find any additional rule parameters, beyond `expression`</span> -</span><span id="L-86"><a href="#L-86"><span class="linenos">86</span></a> <span class="n">rule_params</span> <span class="o">=</span> <span class="n">rule</span><span class="o">.</span><span class="vm">__code__</span><span class="o">.</span><span class="n">co_varnames</span> -</span><span id="L-87"><a href="#L-87"><span class="linenos">87</span></a> <span class="n">rule_kwargs</span> <span class="o">=</span> <span class="p">{</span> -</span><span id="L-88"><a href="#L-88"><span class="linenos">88</span></a> <span class="n">param</span><span class="p">:</span> <span class="n">possible_kwargs</span><span class="p">[</span><span class="n">param</span><span class="p">]</span> <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">rule_params</span> <span class="k">if</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">possible_kwargs</span> -</span><span id="L-89"><a href="#L-89"><span class="linenos">89</span></a> <span class="p">}</span> -</span><span id="L-90"><a href="#L-90"><span class="linenos">90</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">rule</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="o">**</span><span class="n">rule_kwargs</span><span class="p">)</span> -</span><span id="L-91"><a href="#L-91"><span class="linenos">91</span></a> <span class="k">return</span> <span class="n">expression</span> +</span><span id="L-24"><a href="#L-24"><span class="linenos">24</span></a><span class="kn">from</span> <span class="nn">sqlglot.optimizer.simplify</span> <span class="kn">import</span> <span class="n">simplify</span> +</span><span id="L-25"><a href="#L-25"><span class="linenos">25</span></a><span class="kn">from</span> <span class="nn">sqlglot.optimizer.unnest_subqueries</span> <span class="kn">import</span> <span class="n">unnest_subqueries</span> +</span><span id="L-26"><a href="#L-26"><span class="linenos">26</span></a><span class="kn">from</span> <span class="nn">sqlglot.schema</span> <span class="kn">import</span> <span class="n">ensure_schema</span> +</span><span id="L-27"><a href="#L-27"><span class="linenos">27</span></a> +</span><span id="L-28"><a href="#L-28"><span class="linenos">28</span></a><span class="n">RULES</span> <span class="o">=</span> <span class="p">(</span> +</span><span id="L-29"><a href="#L-29"><span class="linenos">29</span></a> <span class="n">lower_identities</span><span class="p">,</span> +</span><span id="L-30"><a href="#L-30"><span class="linenos">30</span></a> <span class="n">qualify_tables</span><span class="p">,</span> +</span><span id="L-31"><a href="#L-31"><span class="linenos">31</span></a> <span class="n">isolate_table_selects</span><span class="p">,</span> +</span><span id="L-32"><a href="#L-32"><span class="linenos">32</span></a> <span class="n">qualify_columns</span><span class="p">,</span> +</span><span id="L-33"><a href="#L-33"><span class="linenos">33</span></a> <span class="n">expand_laterals</span><span class="p">,</span> +</span><span id="L-34"><a href="#L-34"><span class="linenos">34</span></a> <span class="n">pushdown_projections</span><span class="p">,</span> +</span><span id="L-35"><a href="#L-35"><span class="linenos">35</span></a> <span class="n">validate_qualify_columns</span><span class="p">,</span> +</span><span id="L-36"><a href="#L-36"><span class="linenos">36</span></a> <span class="n">normalize</span><span class="p">,</span> +</span><span id="L-37"><a href="#L-37"><span class="linenos">37</span></a> <span class="n">unnest_subqueries</span><span class="p">,</span> +</span><span id="L-38"><a href="#L-38"><span class="linenos">38</span></a> <span class="n">expand_multi_table_selects</span><span class="p">,</span> +</span><span id="L-39"><a href="#L-39"><span class="linenos">39</span></a> <span class="n">pushdown_predicates</span><span class="p">,</span> +</span><span id="L-40"><a href="#L-40"><span class="linenos">40</span></a> <span class="n">optimize_joins</span><span class="p">,</span> +</span><span id="L-41"><a href="#L-41"><span class="linenos">41</span></a> <span class="n">eliminate_subqueries</span><span class="p">,</span> +</span><span id="L-42"><a href="#L-42"><span class="linenos">42</span></a> <span class="n">merge_subqueries</span><span class="p">,</span> +</span><span id="L-43"><a href="#L-43"><span class="linenos">43</span></a> <span class="n">eliminate_joins</span><span class="p">,</span> +</span><span id="L-44"><a href="#L-44"><span class="linenos">44</span></a> <span class="n">eliminate_ctes</span><span class="p">,</span> +</span><span id="L-45"><a href="#L-45"><span class="linenos">45</span></a> <span class="n">annotate_types</span><span class="p">,</span> +</span><span id="L-46"><a href="#L-46"><span class="linenos">46</span></a> <span class="n">canonicalize</span><span class="p">,</span> +</span><span id="L-47"><a href="#L-47"><span class="linenos">47</span></a> <span class="n">simplify</span><span class="p">,</span> +</span><span id="L-48"><a href="#L-48"><span class="linenos">48</span></a><span class="p">)</span> +</span><span id="L-49"><a href="#L-49"><span class="linenos">49</span></a> +</span><span id="L-50"><a href="#L-50"><span class="linenos">50</span></a> +</span><span id="L-51"><a href="#L-51"><span class="linenos">51</span></a><span class="k">def</span> <span class="nf">optimize</span><span class="p">(</span> +</span><span id="L-52"><a href="#L-52"><span class="linenos">52</span></a> <span class="n">expression</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">exp</span><span class="o">.</span><span class="n">Expression</span><span class="p">,</span> +</span><span id="L-53"><a href="#L-53"><span class="linenos">53</span></a> <span class="n">schema</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">dict</span> <span class="o">|</span> <span class="n">Schema</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> +</span><span id="L-54"><a href="#L-54"><span class="linenos">54</span></a> <span class="n">db</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> +</span><span id="L-55"><a href="#L-55"><span class="linenos">55</span></a> <span class="n">catalog</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> +</span><span id="L-56"><a href="#L-56"><span class="linenos">56</span></a> <span class="n">dialect</span><span class="p">:</span> <span class="n">DialectType</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> +</span><span id="L-57"><a href="#L-57"><span class="linenos">57</span></a> <span class="n">rules</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="n">RULES</span><span class="p">,</span> +</span><span id="L-58"><a href="#L-58"><span class="linenos">58</span></a> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span> +</span><span id="L-59"><a href="#L-59"><span class="linenos">59</span></a><span class="p">):</span> +</span><span id="L-60"><a href="#L-60"><span class="linenos">60</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="L-61"><a href="#L-61"><span class="linenos">61</span></a><span class="sd"> Rewrite a sqlglot AST into an optimized form.</span> +</span><span id="L-62"><a href="#L-62"><span class="linenos">62</span></a> +</span><span id="L-63"><a href="#L-63"><span class="linenos">63</span></a><span class="sd"> Args:</span> +</span><span id="L-64"><a href="#L-64"><span class="linenos">64</span></a><span class="sd"> expression: expression to optimize</span> +</span><span id="L-65"><a href="#L-65"><span class="linenos">65</span></a><span class="sd"> schema: database schema.</span> +</span><span id="L-66"><a href="#L-66"><span class="linenos">66</span></a><span class="sd"> This can either be an instance of `sqlglot.optimizer.Schema` or a mapping in one of</span> +</span><span id="L-67"><a href="#L-67"><span class="linenos">67</span></a><span class="sd"> the following forms:</span> +</span><span id="L-68"><a href="#L-68"><span class="linenos">68</span></a><span class="sd"> 1. {table: {col: type}}</span> +</span><span id="L-69"><a href="#L-69"><span class="linenos">69</span></a><span class="sd"> 2. {db: {table: {col: type}}}</span> +</span><span id="L-70"><a href="#L-70"><span class="linenos">70</span></a><span class="sd"> 3. {catalog: {db: {table: {col: type}}}}</span> +</span><span id="L-71"><a href="#L-71"><span class="linenos">71</span></a><span class="sd"> If no schema is provided then the default schema defined at `sqlgot.schema` will be used</span> +</span><span id="L-72"><a href="#L-72"><span class="linenos">72</span></a><span class="sd"> db: specify the default database, as might be set by a `USE DATABASE db` statement</span> +</span><span id="L-73"><a href="#L-73"><span class="linenos">73</span></a><span class="sd"> catalog: specify the default catalog, as might be set by a `USE CATALOG c` statement</span> +</span><span id="L-74"><a href="#L-74"><span class="linenos">74</span></a><span class="sd"> dialect: The dialect to parse the sql string.</span> +</span><span id="L-75"><a href="#L-75"><span class="linenos">75</span></a><span class="sd"> rules: sequence of optimizer rules to use.</span> +</span><span id="L-76"><a href="#L-76"><span class="linenos">76</span></a><span class="sd"> Many of the rules require tables and columns to be qualified.</span> +</span><span id="L-77"><a href="#L-77"><span class="linenos">77</span></a><span class="sd"> Do not remove qualify_tables or qualify_columns from the sequence of rules unless you know</span> +</span><span id="L-78"><a href="#L-78"><span class="linenos">78</span></a><span class="sd"> what you're doing!</span> +</span><span id="L-79"><a href="#L-79"><span class="linenos">79</span></a><span class="sd"> **kwargs: If a rule has a keyword argument with a same name in **kwargs, it will be passed in.</span> +</span><span id="L-80"><a href="#L-80"><span class="linenos">80</span></a><span class="sd"> Returns:</span> +</span><span id="L-81"><a href="#L-81"><span class="linenos">81</span></a><span class="sd"> sqlglot.Expression: optimized expression</span> +</span><span id="L-82"><a href="#L-82"><span class="linenos">82</span></a><span class="sd"> """</span> +</span><span id="L-83"><a href="#L-83"><span class="linenos">83</span></a> <span class="n">schema</span> <span class="o">=</span> <span class="n">ensure_schema</span><span class="p">(</span><span class="n">schema</span> <span class="ow">or</span> <span class="n">sqlglot</span><span class="o">.</span><span class="n">schema</span><span class="p">,</span> <span class="n">dialect</span><span class="o">=</span><span class="n">dialect</span><span class="p">)</span> +</span><span id="L-84"><a href="#L-84"><span class="linenos">84</span></a> <span class="n">possible_kwargs</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"db"</span><span class="p">:</span> <span class="n">db</span><span class="p">,</span> <span class="s2">"catalog"</span><span class="p">:</span> <span class="n">catalog</span><span class="p">,</span> <span class="s2">"schema"</span><span class="p">:</span> <span class="n">schema</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">}</span> +</span><span id="L-85"><a href="#L-85"><span class="linenos">85</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">exp</span><span class="o">.</span><span class="n">maybe_parse</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="n">dialect</span><span class="o">=</span><span class="n">dialect</span><span class="p">,</span> <span class="n">copy</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> +</span><span id="L-86"><a href="#L-86"><span class="linenos">86</span></a> <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="n">rules</span><span class="p">:</span> +</span><span id="L-87"><a href="#L-87"><span class="linenos">87</span></a> <span class="c1"># Find any additional rule parameters, beyond `expression`</span> +</span><span id="L-88"><a href="#L-88"><span class="linenos">88</span></a> <span class="n">rule_params</span> <span class="o">=</span> <span class="n">rule</span><span class="o">.</span><span class="vm">__code__</span><span class="o">.</span><span class="n">co_varnames</span> +</span><span id="L-89"><a href="#L-89"><span class="linenos">89</span></a> <span class="n">rule_kwargs</span> <span class="o">=</span> <span class="p">{</span> +</span><span id="L-90"><a href="#L-90"><span class="linenos">90</span></a> <span class="n">param</span><span class="p">:</span> <span class="n">possible_kwargs</span><span class="p">[</span><span class="n">param</span><span class="p">]</span> <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">rule_params</span> <span class="k">if</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">possible_kwargs</span> +</span><span id="L-91"><a href="#L-91"><span class="linenos">91</span></a> <span class="p">}</span> +</span><span id="L-92"><a href="#L-92"><span class="linenos">92</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">rule</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="o">**</span><span class="n">rule_kwargs</span><span class="p">)</span> +</span><span id="L-93"><a href="#L-93"><span class="linenos">93</span></a> <span class="k">return</span> <span class="n">expression</span> </span></pre></div> @@ -156,55 +158,55 @@ <div class="attr function"> <span class="def">def</span> - <span class="name">optimize</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">expression</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n"><a href="../expressions.html#Expression">sqlglot.expressions.Expression</a></span>,</span><span class="param"> <span class="n">schema</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">dict</span><span class="p">,</span> <span class="n"><a href="../schema.html#Schema">sqlglot.schema.Schema</a></span><span class="p">,</span> <span class="n">NoneType</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">db</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">catalog</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">dialect</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n"><a href="../dialects/dialect.html#Dialect">sqlglot.dialects.dialect.Dialect</a></span><span class="p">,</span> <span class="n">Type</span><span class="p">[</span><span class="n"><a href="../dialects/dialect.html#Dialect">sqlglot.dialects.dialect.Dialect</a></span><span class="p">],</span> <span class="n">NoneType</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">rules</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="o"><</span><span class="n">function</span> <span class="n">lower_identities</span> <span class="n">at</span> <span class="mh">0x7fb8b87bc1f0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">qualify_tables</span> <span class="n">at</span> <span class="mh">0x7fb8b87be8c0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">isolate_table_selects</span> <span class="n">at</span> <span class="mh">0x7fb8b87bc160</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">qualify_columns</span> <span class="n">at</span> <span class="mh">0x7fb8b87bd7e0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">expand_laterals</span> <span class="n">at</span> <span class="mh">0x7fb8b87afeb0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">pushdown_projections</span> <span class="n">at</span> <span class="mh">0x7fb8b87be290</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">validate_qualify_columns</span> <span class="n">at</span> <span class="mh">0x7fb8b87bd870</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">normalize</span> <span class="n">at</span> <span class="mh">0x7fb8b87adea0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">unnest_subqueries</span> <span class="n">at</span> <span class="mh">0x7fb8b87be9e0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">expand_multi_table_selects</span> <span class="n">at</span> <span class="mh">0x7fb8b87bc0d0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">pushdown_predicates</span> <span class="n">at</span> <span class="mh">0x7fb8b87bd2d0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">optimize_joins</span> <span class="n">at</span> <span class="mh">0x7fb8b87bd000</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">eliminate_subqueries</span> <span class="n">at</span> <span class="mh">0x7fb8b87afac0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">merge_subqueries</span> <span class="n">at</span> <span class="mh">0x7fb8b87bc4c0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">eliminate_joins</span> <span class="n">at</span> <span class="mh">0x7fb8b87adcf0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">eliminate_ctes</span> <span class="n">at</span> <span class="mh">0x7fb8b87adbd0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">annotate_types</span> <span class="n">at</span> <span class="mh">0x7fb8b87465f0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">canonicalize</span> <span class="n">at</span> <span class="mh">0x7fb8b87ad6c0</span><span class="o">></span><span class="p">)</span>,</span><span class="param"> <span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span> + <span class="name">optimize</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="n">expression</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n"><a href="../expressions.html#Expression">sqlglot.expressions.Expression</a></span>,</span><span class="param"> <span class="n">schema</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">dict</span><span class="p">,</span> <span class="n"><a href="../schema.html#Schema">sqlglot.schema.Schema</a></span><span class="p">,</span> <span class="n">NoneType</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">db</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">catalog</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">dialect</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n"><a href="../dialects/dialect.html#Dialect">sqlglot.dialects.dialect.Dialect</a></span><span class="p">,</span> <span class="n">Type</span><span class="p">[</span><span class="n"><a href="../dialects/dialect.html#Dialect">sqlglot.dialects.dialect.Dialect</a></span><span class="p">],</span> <span class="n">NoneType</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">rules</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="o"><</span><span class="n">function</span> <span class="n">lower_identities</span> <span class="n">at</span> <span class="mh">0x7f0637f3d360</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">qualify_tables</span> <span class="n">at</span> <span class="mh">0x7f0637f3fa30</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">isolate_table_selects</span> <span class="n">at</span> <span class="mh">0x7f0637f3d240</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">qualify_columns</span> <span class="n">at</span> <span class="mh">0x7f0637f3e950</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">expand_laterals</span> <span class="n">at</span> <span class="mh">0x7f0637f3d000</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">pushdown_projections</span> <span class="n">at</span> <span class="mh">0x7f0637f3f400</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">validate_qualify_columns</span> <span class="n">at</span> <span class="mh">0x7f0637f3e9e0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">normalize</span> <span class="n">at</span> <span class="mh">0x7f0637eeae60</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">unnest_subqueries</span> <span class="n">at</span> <span class="mh">0x7f0637f3fb50</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">expand_multi_table_selects</span> <span class="n">at</span> <span class="mh">0x7f0637f3d1b0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">pushdown_predicates</span> <span class="n">at</span> <span class="mh">0x7f0637f3e4d0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">optimize_joins</span> <span class="n">at</span> <span class="mh">0x7f0637f3e0e0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">eliminate_subqueries</span> <span class="n">at</span> <span class="mh">0x7f0637f3cc10</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">merge_subqueries</span> <span class="n">at</span> <span class="mh">0x7f0637f3d630</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">eliminate_joins</span> <span class="n">at</span> <span class="mh">0x7f0637eead40</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">eliminate_ctes</span> <span class="n">at</span> <span class="mh">0x7f0637eeac20</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">annotate_types</span> <span class="n">at</span> <span class="mh">0x7f0637ec7490</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">canonicalize</span> <span class="n">at</span> <span class="mh">0x7f0637eea680</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">function</span> <span class="n">simplify</span> <span class="n">at</span> <span class="mh">0x7f0637eeaf80</span><span class="o">></span><span class="p">)</span>,</span><span class="param"> <span class="o">**</span><span class="n">kwargs</span></span><span class="return-annotation">):</span></span> <label class="view-source-button" for="optimize-view-source"><span>View Source</span></label> </div> <a class="headerlink" href="#optimize"></a> - <div class="pdoc-code codehilite"><pre><span></span><span id="optimize-50"><a href="#optimize-50"><span class="linenos">50</span></a><span class="k">def</span> <span class="nf">optimize</span><span class="p">(</span> -</span><span id="optimize-51"><a href="#optimize-51"><span class="linenos">51</span></a> <span class="n">expression</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">exp</span><span class="o">.</span><span class="n">Expression</span><span class="p">,</span> -</span><span id="optimize-52"><a href="#optimize-52"><span class="linenos">52</span></a> <span class="n">schema</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">dict</span> <span class="o">|</span> <span class="n">Schema</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> -</span><span id="optimize-53"><a href="#optimize-53"><span class="linenos">53</span></a> <span class="n">db</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> -</span><span id="optimize-54"><a href="#optimize-54"><span class="linenos">54</span></a> <span class="n">catalog</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> -</span><span id="optimize-55"><a href="#optimize-55"><span class="linenos">55</span></a> <span class="n">dialect</span><span class="p">:</span> <span class="n">DialectType</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> -</span><span id="optimize-56"><a href="#optimize-56"><span class="linenos">56</span></a> <span class="n">rules</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="n">RULES</span><span class="p">,</span> -</span><span id="optimize-57"><a href="#optimize-57"><span class="linenos">57</span></a> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span> -</span><span id="optimize-58"><a href="#optimize-58"><span class="linenos">58</span></a><span class="p">):</span> -</span><span id="optimize-59"><a href="#optimize-59"><span class="linenos">59</span></a><span class="w"> </span><span class="sd">"""</span> -</span><span id="optimize-60"><a href="#optimize-60"><span class="linenos">60</span></a><span class="sd"> Rewrite a sqlglot AST into an optimized form.</span> -</span><span id="optimize-61"><a href="#optimize-61"><span class="linenos">61</span></a> -</span><span id="optimize-62"><a href="#optimize-62"><span class="linenos">62</span></a><span class="sd"> Args:</span> -</span><span id="optimize-63"><a href="#optimize-63"><span class="linenos">63</span></a><span class="sd"> expression: expression to optimize</span> -</span><span id="optimize-64"><a href="#optimize-64"><span class="linenos">64</span></a><span class="sd"> schema: database schema.</span> -</span><span id="optimize-65"><a href="#optimize-65"><span class="linenos">65</span></a><span class="sd"> This can either be an instance of `sqlglot.optimizer.Schema` or a mapping in one of</span> -</span><span id="optimize-66"><a href="#optimize-66"><span class="linenos">66</span></a><span class="sd"> the following forms:</span> -</span><span id="optimize-67"><a href="#optimize-67"><span class="linenos">67</span></a><span class="sd"> 1. {table: {col: type}}</span> -</span><span id="optimize-68"><a href="#optimize-68"><span class="linenos">68</span></a><span class="sd"> 2. {db: {table: {col: type}}}</span> -</span><span id="optimize-69"><a href="#optimize-69"><span class="linenos">69</span></a><span class="sd"> 3. {catalog: {db: {table: {col: type}}}}</span> -</span><span id="optimize-70"><a href="#optimize-70"><span class="linenos">70</span></a><span class="sd"> If no schema is provided then the default schema defined at `sqlgot.schema` will be used</span> -</span><span id="optimize-71"><a href="#optimize-71"><span class="linenos">71</span></a><span class="sd"> db: specify the default database, as might be set by a `USE DATABASE db` statement</span> -</span><span id="optimize-72"><a href="#optimize-72"><span class="linenos">72</span></a><span class="sd"> catalog: specify the default catalog, as might be set by a `USE CATALOG c` statement</span> -</span><span id="optimize-73"><a href="#optimize-73"><span class="linenos">73</span></a><span class="sd"> dialect: The dialect to parse the sql string.</span> -</span><span id="optimize-74"><a href="#optimize-74"><span class="linenos">74</span></a><span class="sd"> rules: sequence of optimizer rules to use.</span> -</span><span id="optimize-75"><a href="#optimize-75"><span class="linenos">75</span></a><span class="sd"> Many of the rules require tables and columns to be qualified.</span> -</span><span id="optimize-76"><a href="#optimize-76"><span class="linenos">76</span></a><span class="sd"> Do not remove qualify_tables or qualify_columns from the sequence of rules unless you know</span> -</span><span id="optimize-77"><a href="#optimize-77"><span class="linenos">77</span></a><span class="sd"> what you're doing!</span> -</span><span id="optimize-78"><a href="#optimize-78"><span class="linenos">78</span></a><span class="sd"> **kwargs: If a rule has a keyword argument with a same name in **kwargs, it will be passed in.</span> -</span><span id="optimize-79"><a href="#optimize-79"><span class="linenos">79</span></a><span class="sd"> Returns:</span> -</span><span id="optimize-80"><a href="#optimize-80"><span class="linenos">80</span></a><span class="sd"> sqlglot.Expression: optimized expression</span> -</span><span id="optimize-81"><a href="#optimize-81"><span class="linenos">81</span></a><span class="sd"> """</span> -</span><span id="optimize-82"><a href="#optimize-82"><span class="linenos">82</span></a> <span class="n">schema</span> <span class="o">=</span> <span class="n">ensure_schema</span><span class="p">(</span><span class="n">schema</span> <span class="ow">or</span> <span class="n">sqlglot</span><span class="o">.</span><span class="n">schema</span><span class="p">)</span> -</span><span id="optimize-83"><a href="#optimize-83"><span class="linenos">83</span></a> <span class="n">possible_kwargs</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"db"</span><span class="p">:</span> <span class="n">db</span><span class="p">,</span> <span class="s2">"catalog"</span><span class="p">:</span> <span class="n">catalog</span><span class="p">,</span> <span class="s2">"schema"</span><span class="p">:</span> <span class="n">schema</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">}</span> -</span><span id="optimize-84"><a href="#optimize-84"><span class="linenos">84</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">exp</span><span class="o">.</span><span class="n">maybe_parse</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="n">dialect</span><span class="o">=</span><span class="n">dialect</span><span class="p">,</span> <span class="n">copy</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> -</span><span id="optimize-85"><a href="#optimize-85"><span class="linenos">85</span></a> <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="n">rules</span><span class="p">:</span> -</span><span id="optimize-86"><a href="#optimize-86"><span class="linenos">86</span></a> <span class="c1"># Find any additional rule parameters, beyond `expression`</span> -</span><span id="optimize-87"><a href="#optimize-87"><span class="linenos">87</span></a> <span class="n">rule_params</span> <span class="o">=</span> <span class="n">rule</span><span class="o">.</span><span class="vm">__code__</span><span class="o">.</span><span class="n">co_varnames</span> -</span><span id="optimize-88"><a href="#optimize-88"><span class="linenos">88</span></a> <span class="n">rule_kwargs</span> <span class="o">=</span> <span class="p">{</span> -</span><span id="optimize-89"><a href="#optimize-89"><span class="linenos">89</span></a> <span class="n">param</span><span class="p">:</span> <span class="n">possible_kwargs</span><span class="p">[</span><span class="n">param</span><span class="p">]</span> <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">rule_params</span> <span class="k">if</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">possible_kwargs</span> -</span><span id="optimize-90"><a href="#optimize-90"><span class="linenos">90</span></a> <span class="p">}</span> -</span><span id="optimize-91"><a href="#optimize-91"><span class="linenos">91</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">rule</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="o">**</span><span class="n">rule_kwargs</span><span class="p">)</span> -</span><span id="optimize-92"><a href="#optimize-92"><span class="linenos">92</span></a> <span class="k">return</span> <span class="n">expression</span> + <div class="pdoc-code codehilite"><pre><span></span><span id="optimize-52"><a href="#optimize-52"><span class="linenos">52</span></a><span class="k">def</span> <span class="nf">optimize</span><span class="p">(</span> +</span><span id="optimize-53"><a href="#optimize-53"><span class="linenos">53</span></a> <span class="n">expression</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">exp</span><span class="o">.</span><span class="n">Expression</span><span class="p">,</span> +</span><span id="optimize-54"><a href="#optimize-54"><span class="linenos">54</span></a> <span class="n">schema</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">dict</span> <span class="o">|</span> <span class="n">Schema</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> +</span><span id="optimize-55"><a href="#optimize-55"><span class="linenos">55</span></a> <span class="n">db</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> +</span><span id="optimize-56"><a href="#optimize-56"><span class="linenos">56</span></a> <span class="n">catalog</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> +</span><span id="optimize-57"><a href="#optimize-57"><span class="linenos">57</span></a> <span class="n">dialect</span><span class="p">:</span> <span class="n">DialectType</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> +</span><span id="optimize-58"><a href="#optimize-58"><span class="linenos">58</span></a> <span class="n">rules</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">t</span><span class="o">.</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="n">RULES</span><span class="p">,</span> +</span><span id="optimize-59"><a href="#optimize-59"><span class="linenos">59</span></a> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span> +</span><span id="optimize-60"><a href="#optimize-60"><span class="linenos">60</span></a><span class="p">):</span> +</span><span id="optimize-61"><a href="#optimize-61"><span class="linenos">61</span></a><span class="w"> </span><span class="sd">"""</span> +</span><span id="optimize-62"><a href="#optimize-62"><span class="linenos">62</span></a><span class="sd"> Rewrite a sqlglot AST into an optimized form.</span> +</span><span id="optimize-63"><a href="#optimize-63"><span class="linenos">63</span></a> +</span><span id="optimize-64"><a href="#optimize-64"><span class="linenos">64</span></a><span class="sd"> Args:</span> +</span><span id="optimize-65"><a href="#optimize-65"><span class="linenos">65</span></a><span class="sd"> expression: expression to optimize</span> +</span><span id="optimize-66"><a href="#optimize-66"><span class="linenos">66</span></a><span class="sd"> schema: database schema.</span> +</span><span id="optimize-67"><a href="#optimize-67"><span class="linenos">67</span></a><span class="sd"> This can either be an instance of `sqlglot.optimizer.Schema` or a mapping in one of</span> +</span><span id="optimize-68"><a href="#optimize-68"><span class="linenos">68</span></a><span class="sd"> the following forms:</span> +</span><span id="optimize-69"><a href="#optimize-69"><span class="linenos">69</span></a><span class="sd"> 1. {table: {col: type}}</span> +</span><span id="optimize-70"><a href="#optimize-70"><span class="linenos">70</span></a><span class="sd"> 2. {db: {table: {col: type}}}</span> +</span><span id="optimize-71"><a href="#optimize-71"><span class="linenos">71</span></a><span class="sd"> 3. {catalog: {db: {table: {col: type}}}}</span> +</span><span id="optimize-72"><a href="#optimize-72"><span class="linenos">72</span></a><span class="sd"> If no schema is provided then the default schema defined at `sqlgot.schema` will be used</span> +</span><span id="optimize-73"><a href="#optimize-73"><span class="linenos">73</span></a><span class="sd"> db: specify the default database, as might be set by a `USE DATABASE db` statement</span> +</span><span id="optimize-74"><a href="#optimize-74"><span class="linenos">74</span></a><span class="sd"> catalog: specify the default catalog, as might be set by a `USE CATALOG c` statement</span> +</span><span id="optimize-75"><a href="#optimize-75"><span class="linenos">75</span></a><span class="sd"> dialect: The dialect to parse the sql string.</span> +</span><span id="optimize-76"><a href="#optimize-76"><span class="linenos">76</span></a><span class="sd"> rules: sequence of optimizer rules to use.</span> +</span><span id="optimize-77"><a href="#optimize-77"><span class="linenos">77</span></a><span class="sd"> Many of the rules require tables and columns to be qualified.</span> +</span><span id="optimize-78"><a href="#optimize-78"><span class="linenos">78</span></a><span class="sd"> Do not remove qualify_tables or qualify_columns from the sequence of rules unless you know</span> +</span><span id="optimize-79"><a href="#optimize-79"><span class="linenos">79</span></a><span class="sd"> what you're doing!</span> +</span><span id="optimize-80"><a href="#optimize-80"><span class="linenos">80</span></a><span class="sd"> **kwargs: If a rule has a keyword argument with a same name in **kwargs, it will be passed in.</span> +</span><span id="optimize-81"><a href="#optimize-81"><span class="linenos">81</span></a><span class="sd"> Returns:</span> +</span><span id="optimize-82"><a href="#optimize-82"><span class="linenos">82</span></a><span class="sd"> sqlglot.Expression: optimized expression</span> +</span><span id="optimize-83"><a href="#optimize-83"><span class="linenos">83</span></a><span class="sd"> """</span> +</span><span id="optimize-84"><a href="#optimize-84"><span class="linenos">84</span></a> <span class="n">schema</span> <span class="o">=</span> <span class="n">ensure_schema</span><span class="p">(</span><span class="n">schema</span> <span class="ow">or</span> <span class="n">sqlglot</span><span class="o">.</span><span class="n">schema</span><span class="p">,</span> <span class="n">dialect</span><span class="o">=</span><span class="n">dialect</span><span class="p">)</span> +</span><span id="optimize-85"><a href="#optimize-85"><span class="linenos">85</span></a> <span class="n">possible_kwargs</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"db"</span><span class="p">:</span> <span class="n">db</span><span class="p">,</span> <span class="s2">"catalog"</span><span class="p">:</span> <span class="n">catalog</span><span class="p">,</span> <span class="s2">"schema"</span><span class="p">:</span> <span class="n">schema</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">}</span> +</span><span id="optimize-86"><a href="#optimize-86"><span class="linenos">86</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">exp</span><span class="o">.</span><span class="n">maybe_parse</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="n">dialect</span><span class="o">=</span><span class="n">dialect</span><span class="p">,</span> <span class="n">copy</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> +</span><span id="optimize-87"><a href="#optimize-87"><span class="linenos">87</span></a> <span class="k">for</span> <span class="n">rule</span> <span class="ow">in</span> <span class="n">rules</span><span class="p">:</span> +</span><span id="optimize-88"><a href="#optimize-88"><span class="linenos">88</span></a> <span class="c1"># Find any additional rule parameters, beyond `expression`</span> +</span><span id="optimize-89"><a href="#optimize-89"><span class="linenos">89</span></a> <span class="n">rule_params</span> <span class="o">=</span> <span class="n">rule</span><span class="o">.</span><span class="vm">__code__</span><span class="o">.</span><span class="n">co_varnames</span> +</span><span id="optimize-90"><a href="#optimize-90"><span class="linenos">90</span></a> <span class="n">rule_kwargs</span> <span class="o">=</span> <span class="p">{</span> +</span><span id="optimize-91"><a href="#optimize-91"><span class="linenos">91</span></a> <span class="n">param</span><span class="p">:</span> <span class="n">possible_kwargs</span><span class="p">[</span><span class="n">param</span><span class="p">]</span> <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">rule_params</span> <span class="k">if</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">possible_kwargs</span> +</span><span id="optimize-92"><a href="#optimize-92"><span class="linenos">92</span></a> <span class="p">}</span> +</span><span id="optimize-93"><a href="#optimize-93"><span class="linenos">93</span></a> <span class="n">expression</span> <span class="o">=</span> <span class="n">rule</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="o">**</span><span class="n">rule_kwargs</span><span class="p">)</span> +</span><span id="optimize-94"><a href="#optimize-94"><span class="linenos">94</span></a> <span class="k">return</span> <span class="n">expression</span> </span></pre></div> |