Files
greptimedb/sql/ast/index.html
2025-12-25 05:03:15 +00:00

5 lines
8.2 KiB
HTML

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `ast` mod in crate `sql`."><title>sql::ast - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="sql" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module ast</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../sql/index.html">sql</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module ast</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate sql</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">sql</a></div><h1>Module <span>ast</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/sql/ast.rs.html#15-34">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.ColumnDef.html" title="struct sql::ast::ColumnDef">Column<wbr>Def</a></dt><dd>SQL column definition</dd><dt><a class="struct" href="struct.ColumnOptionDef.html" title="struct sql::ast::ColumnOptionDef">Column<wbr>Option<wbr>Def</a></dt><dd>An optionally-named <code>ColumnOption</code>: <code>[ CONSTRAINT &lt;name&gt; ] &lt;column-option&gt;</code>.</dd><dt><a class="struct" href="struct.Function.html" title="struct sql::ast::Function">Function</a></dt><dd>A function call</dd><dt><a class="struct" href="struct.Ident.html" title="struct sql::ast::Ident">Ident</a></dt><dd>An identifier, decomposed into its value or character data and the quote style.</dd><dt><a class="struct" href="struct.ObjectName.html" title="struct sql::ast::ObjectName">Object<wbr>Name</a></dt><dd>A name of a table, view, custom type, etc., possibly multi-part, i.e. db.schema.obj</dd><dt><a class="struct" href="struct.ValueWithSpan.html" title="struct sql::ast::ValueWithSpan">Value<wbr>With<wbr>Span</a></dt><dd>Wraps a primitive SQL <a href="enum.Value.html" title="enum sql::ast::Value"><code>Value</code></a> with its [<code>Span</code>] location</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.BinaryOperator.html" title="enum sql::ast::BinaryOperator">Binary<wbr>Operator</a></dt><dd>Binary operators</dd><dt><a class="enum" href="enum.ColumnOption.html" title="enum sql::ast::ColumnOption">Column<wbr>Option</a></dt><dd><code>ColumnOption</code>s are modifiers that follow a column definition in a <code>CREATE TABLE</code> statement.</dd><dt><a class="enum" href="enum.DataType.html" title="enum sql::ast::DataType">Data<wbr>Type</a></dt><dd>SQL data types</dd><dt><a class="enum" href="enum.Expr.html" title="enum sql::ast::Expr">Expr</a></dt><dd>An SQL expression of any type.</dd><dt><a class="enum" href="enum.FunctionArg.html" title="enum sql::ast::FunctionArg">Function<wbr>Arg</a></dt><dt><a class="enum" href="enum.FunctionArgExpr.html" title="enum sql::ast::FunctionArgExpr">Function<wbr>ArgExpr</a></dt><dt><a class="enum" href="enum.FunctionArguments.html" title="enum sql::ast::FunctionArguments">Function<wbr>Arguments</a></dt><dd>The arguments passed to a function call.</dd><dt><a class="enum" href="enum.ObjectNamePart.html" title="enum sql::ast::ObjectNamePart">Object<wbr>Name<wbr>Part</a></dt><dd>A single part of an ObjectName</dd><dt><a class="enum" href="enum.SqlOption.html" title="enum sql::ast::SqlOption">SqlOption</a></dt><dt><a class="enum" href="enum.TableConstraint.html" title="enum sql::ast::TableConstraint">Table<wbr>Constraint</a></dt><dd>A table-level constraint, specified in a <code>CREATE TABLE</code> or an
<code>ALTER TABLE ADD &lt;constraint&gt;</code> statement.</dd><dt><a class="enum" href="enum.TimezoneInfo.html" title="enum sql::ast::TimezoneInfo">Timezone<wbr>Info</a></dt><dd>Timestamp and Time data types information about TimeZone formatting.</dd><dt><a class="enum" href="enum.Value.html" title="enum sql::ast::Value">Value</a></dt><dd>Primitive SQL values such as number and string</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.ObjectNamePartExt.html" title="trait sql::ast::ObjectNamePartExt">Object<wbr>Name<wbr>Part<wbr>Ext</a></dt><dt><a class="trait" href="trait.Visit.html" title="trait sql::ast::Visit">Visit</a></dt><dd>A type that can be visited by a <a href="trait.Visitor.html" title="trait sql::ast::Visitor"><code>Visitor</code></a>. See <a href="trait.Visitor.html" title="trait sql::ast::Visitor"><code>Visitor</code></a> for
recursively visiting parsed SQL statements.</dd><dt><a class="trait" href="trait.VisitMut.html" title="trait sql::ast::VisitMut">Visit<wbr>Mut</a></dt><dd>A type that can be visited by a <a href="trait.VisitorMut.html" title="trait sql::ast::VisitorMut"><code>VisitorMut</code></a>. See <a href="trait.VisitorMut.html" title="trait sql::ast::VisitorMut"><code>VisitorMut</code></a> for
recursively visiting parsed SQL statements.</dd><dt><a class="trait" href="trait.Visitor.html" title="trait sql::ast::Visitor">Visitor</a></dt><dd>A visitor that can be used to walk an AST tree.</dd><dt><a class="trait" href="trait.VisitorMut.html" title="trait sql::ast::VisitorMut">Visitor<wbr>Mut</a></dt><dd>A visitor that can be used to mutate an AST tree.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.visit_expressions_mut.html" title="fn sql::ast::visit_expressions_mut">visit_<wbr>expressions_<wbr>mut</a></dt><dd>Invokes the provided closure iteratively with a mutable reference to all expressions
present in <code>v</code>.</dd><dt><a class="fn" href="fn.visit_statements_mut.html" title="fn sql::ast::visit_statements_mut">visit_<wbr>statements_<wbr>mut</a></dt><dd>Invokes the provided closure on all statements (e.g. <code>SELECT</code>, <code>CREATE TABLE</code>, etc) present in <code>v</code></dd></dl></section></div></main></body></html>