summaryrefslogtreecommitdiffstats
path: root/docs/sqlglot.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/sqlglot.html79
1 files changed, 38 insertions, 41 deletions
diff --git a/docs/sqlglot.html b/docs/sqlglot.html
index d579823..9c719f7 100644
--- a/docs/sqlglot.html
+++ b/docs/sqlglot.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 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>
@@ -21,47 +21,44 @@
<input type="search" placeholder="Search..." role="searchbox" aria-label="search"
pattern=".+" required>
- <h2>Contents</h2>
- <ul>
- <li><a href="#sqlglot">SQLGlot</a>
- <ul>
- <li><a href="#table-of-contents">Table of Contents</a></li>
- <li><a href="#install">Install</a></li>
- <li><a href="#get-in-touch">Get in Touch</a></li>
- <li><a href="#examples">Examples</a></li>
- <li><a href="#used-by">Used By</a></li>
- <li><a href="#documentation">Documentation</a></li>
- <li><a href="#run-tests-and-lint">Run Tests and Lint</a></li>
- <li><a href="#benchmarks">Benchmarks</a></li>
- <li><a href="#optional-dependencies">Optional Dependencies</a></li>
- </ul></li>
+ <h2>Contents</h2>
+ <ul>
+ <li><a href="#table-of-contents">Table of Contents</a></li>
+ <li><a href="#install">Install</a></li>
+ <li><a href="#get-in-touch">Get in Touch</a></li>
+ <li><a href="#examples">Examples</a></li>
+ <li><a href="#used-by">Used By</a></li>
+ <li><a href="#documentation">Documentation</a></li>
+ <li><a href="#run-tests-and-lint">Run Tests and Lint</a></li>
+ <li><a href="#benchmarks">Benchmarks</a></li>
+ <li><a href="#optional-dependencies">Optional Dependencies</a></li>
</ul>
- <h2>Submodules</h2>
- <ul>
- <li><a href="sqlglot/dataframe.html">dataframe</a></li>
- <li><a href="sqlglot/dialects.html">dialects</a></li>
- <li><a href="sqlglot/diff.html">diff</a></li>
- <li><a href="sqlglot/errors.html">errors</a></li>
- <li><a href="sqlglot/executor.html">executor</a></li>
- <li><a href="sqlglot/expressions.html">expressions</a></li>
- <li><a href="sqlglot/generator.html">generator</a></li>
- <li><a href="sqlglot/helper.html">helper</a></li>
- <li><a href="sqlglot/lineage.html">lineage</a></li>
- <li><a href="sqlglot/optimizer.html">optimizer</a></li>
- <li><a href="sqlglot/parser.html">parser</a></li>
- <li><a href="sqlglot/planner.html">planner</a></li>
- <li><a href="sqlglot/schema.html">schema</a></li>
- <li><a href="sqlglot/serde.html">serde</a></li>
- <li><a href="sqlglot/time.html">time</a></li>
- <li><a href="sqlglot/tokens.html">tokens</a></li>
- <li><a href="sqlglot/transforms.html">transforms</a></li>
- <li><a href="sqlglot/trie.html">trie</a></li>
- </ul>
-
- <h2>API Documentation</h2>
- <ul class="memberlist">
+ <h2>Submodules</h2>
+ <ul>
+ <li><a href="sqlglot/dataframe.html">dataframe</a></li>
+ <li><a href="sqlglot/dialects.html">dialects</a></li>
+ <li><a href="sqlglot/diff.html">diff</a></li>
+ <li><a href="sqlglot/errors.html">errors</a></li>
+ <li><a href="sqlglot/executor.html">executor</a></li>
+ <li><a href="sqlglot/expressions.html">expressions</a></li>
+ <li><a href="sqlglot/generator.html">generator</a></li>
+ <li><a href="sqlglot/helper.html">helper</a></li>
+ <li><a href="sqlglot/lineage.html">lineage</a></li>
+ <li><a href="sqlglot/optimizer.html">optimizer</a></li>
+ <li><a href="sqlglot/parser.html">parser</a></li>
+ <li><a href="sqlglot/planner.html">planner</a></li>
+ <li><a href="sqlglot/schema.html">schema</a></li>
+ <li><a href="sqlglot/serde.html">serde</a></li>
+ <li><a href="sqlglot/time.html">time</a></li>
+ <li><a href="sqlglot/tokens.html">tokens</a></li>
+ <li><a href="sqlglot/transforms.html">transforms</a></li>
+ <li><a href="sqlglot/trie.html">trie</a></li>
+ </ul>
+
+ <h2>API Documentation</h2>
+ <ul class="memberlist">
<li>
<a class="variable" href="#pretty">pretty</a>
</li>
@@ -93,7 +90,7 @@
<section class="module-info">
<a class="pdoc-button git-button" href="https://github.com/tobymao/sqlglot/tree/main/sqlglot/__init__.py">Edit on GitHub</a>
- <div class="docstring"><h1 id="sqlglot">SQLGlot</h1>
+ <div class="docstring"><p><img src="sqlglot.svg" alt="SQLGlot logo" /></p>
<p>SQLGlot is a no-dependency SQL parser, transpiler, optimizer, and engine. It can be used to format SQL or translate between <a href="https://github.com/tobymao/sqlglot/blob/main/sqlglot/dialects/__init__.py">19 different dialects</a> like <a href="https://duckdb.org/">DuckDB</a>, <a href="https://prestodb.io/">Presto</a>, <a href="https://spark.apache.org/">Spark</a>, <a href="https://www.snowflake.com/en/">Snowflake</a>, and <a href="https://cloud.google.com/bigquery/">BigQuery</a>. It aims to read a wide variety of SQL inputs and output syntactically correct SQL in the targeted dialects.</p>
@@ -701,7 +698,7 @@
</span><span id="L-47"><a href="#L-47"><span class="linenos"> 47</span></a> <span class="n">T</span> <span class="o">=</span> <span class="n">t</span><span class="o">.</span><span class="n">TypeVar</span><span class="p">(</span><span class="s2">&quot;T&quot;</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="n">Expression</span><span class="p">)</span>
</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><span id="L-50"><a href="#L-50"><span class="linenos"> 50</span></a><span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;11.4.0&quot;</span>
+</span><span id="L-50"><a href="#L-50"><span class="linenos"> 50</span></a><span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;11.4.4&quot;</span>
</span><span id="L-51"><a href="#L-51"><span class="linenos"> 51</span></a>
</span><span id="L-52"><a href="#L-52"><span class="linenos"> 52</span></a><span class="n">pretty</span> <span class="o">=</span> <span class="kc">False</span>
</span><span id="L-53"><a href="#L-53"><span class="linenos"> 53</span></a><span class="sd">&quot;&quot;&quot;Whether to format generated SQL by default.&quot;&quot;&quot;</span>