Files
greptimedb/common_sql/convert/index.html
2025-12-31 10:47:16 +00:00

8 lines
10 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `convert` mod in crate `common_sql`."><title>common_sql::convert - 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="common_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 convert</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../common_sql/index.html">common_<wbr>sql</a><span class="version">1.0.0-beta.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module convert</a></h2><h3><a href="#macros">Module Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li><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 common_<wbr>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">common_sql</a></div><h1>Module <span>convert</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/common_sql/convert.rs.html#15-1088">Source</a> </span></div><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.parse_number_to_value.html" title="macro common_sql::convert::parse_number_to_value">parse_<wbr>number_<wbr>to_<wbr>value</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><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 common_sql::convert::ColumnDef">Column<wbr>Def</a></dt><dd>SQL column definition</dd><dt><a class="struct" href="struct.ColumnOptionDef.html" title="struct common_sql::convert::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 common_sql::convert::Function">Function</a></dt><dd>A function call</dd><dt><a class="struct" href="struct.Ident.html" title="struct common_sql::convert::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 common_sql::convert::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></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 common_sql::convert::BinaryOperator">Binary<wbr>Operator</a></dt><dd>Binary operators</dd><dt><a class="enum" href="enum.ColumnOption.html" title="enum common_sql::convert::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 common_sql::convert::DataType">Data<wbr>Type</a></dt><dd>SQL data types</dd><dt><a class="enum" href="enum.Expr.html" title="enum common_sql::convert::Expr">Expr</a></dt><dd>An SQL expression of any type.</dd><dt><a class="enum" href="enum.FunctionArg.html" title="enum common_sql::convert::FunctionArg">Function<wbr>Arg</a></dt><dt><a class="enum" href="enum.FunctionArgExpr.html" title="enum common_sql::convert::FunctionArgExpr">Function<wbr>ArgExpr</a></dt><dt><a class="enum" href="enum.FunctionArguments.html" title="enum common_sql::convert::FunctionArguments">Function<wbr>Arguments</a></dt><dd>The arguments passed to a function call.</dd><dt><a class="enum" href="enum.SqlOption.html" title="enum common_sql::convert::SqlOption">SqlOption</a></dt><dt><a class="enum" href="enum.SqlValue.html" title="enum common_sql::convert::SqlValue">SqlValue</a></dt><dd>Primitive SQL values such as number and string</dd><dt><a class="enum" href="enum.TableConstraint.html" title="enum common_sql::convert::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 common_sql::convert::TimezoneInfo">Timezone<wbr>Info</a></dt><dd>Timestamp and Time data types information about TimeZone formatting.</dd><dt><a class="enum" href="enum.UnaryOperator.html" title="enum common_sql::convert::UnaryOperator">Unary<wbr>Operator</a></dt><dd>Unary operators</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.Visit.html" title="trait common_sql::convert::Visit">Visit</a></dt><dd>A type that can be visited by a <a href="trait.Visitor.html" title="trait common_sql::convert::Visitor"><code>Visitor</code></a>. See <a href="trait.Visitor.html" title="trait common_sql::convert::Visitor"><code>Visitor</code></a> for
recursively visiting parsed SQL statements.</dd><dt><a class="trait" href="trait.VisitMut.html" title="trait common_sql::convert::VisitMut">Visit<wbr>Mut</a></dt><dd>A type that can be visited by a <a href="trait.VisitorMut.html" title="trait common_sql::convert::VisitorMut"><code>VisitorMut</code></a>. See <a href="trait.VisitorMut.html" title="trait common_sql::convert::VisitorMut"><code>VisitorMut</code></a> for
recursively visiting parsed SQL statements.</dd><dt><a class="trait" href="trait.Visitor.html" title="trait common_sql::convert::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 common_sql::convert::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.auto_cast_to_numeric.html" title="fn common_sql::convert::auto_cast_to_numeric">auto_<wbr>cast_<wbr>to_<wbr>numeric</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Casts string to value of specified numeric data type.
If the string cannot be parsed, returns an error.</dd><dt><a class="fn" href="fn.deserialize_default_constraint.html" title="fn common_sql::convert::deserialize_default_constraint">deserialize_<wbr>default_<wbr>constraint</a></dt><dd>Deserialize default constraint from json bytes</dd><dt><a class="fn" href="fn.parse_hex_string.html" title="fn common_sql::convert::parse_hex_string">parse_<wbr>hex_<wbr>string</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.parse_sql_number.html" title="fn common_sql::convert::parse_sql_number">parse_<wbr>sql_<wbr>number</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.parse_string_to_value.html" title="fn common_sql::convert::parse_string_to_value">parse_<wbr>string_<wbr>to_<wbr>value</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.sql_number_to_value.html" title="fn common_sql::convert::sql_number_to_value">sql_<wbr>number_<wbr>to_<wbr>value</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Convert a sql value into datatypes value</dd><dt><a class="fn" href="fn.sql_value_to_value.html" title="fn common_sql::convert::sql_value_to_value">sql_<wbr>value_<wbr>to_<wbr>value</a></dt><dd>Converts SQL value to value according to the data type.
If <code>auto_string_to_numeric</code> is true, tries to cast the string value to numeric values,
and returns error if the cast fails.</dd><dt><a class="fn" href="fn.visit_expressions_mut.html" title="fn common_sql::convert::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 common_sql::convert::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>