rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2025-12-22 22:20:02 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
greptimedb/query/sql/index.html
github-merge-queue[bot] 7afe7cfeb8 Deploying to gh-pages from @ GreptimeTeam/greptimedb@a8b512dded 🚀
2025-12-22 06:16:12 +00:00

3 lines
19 KiB
HTML
Raw Permalink Blame History

<!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 `sql` mod in crate `query`."><title>query::sql - 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="query" 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 sql</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../query/index.html">query</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 sql</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#statics" title="Statics">Statics</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 query</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">query</a></div><h1>Module <span>sql</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/query/sql.rs.html#15-1481">Source</a> </span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="show_create_table/index.html" title="mod query::sql::show_create_table">show_<wbr>create_<wbr>table</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Implementation of <code>SHOW CREATE TABLE</code> statement.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.COLUMN_COLLATION_COLUMN.html" title="constant query::sql::COLUMN_COLLATION_COLUMN">COLUMN_<wbr>COLLATION_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.COLUMN_COMMENT_COLUMN.html" title="constant query::sql::COLUMN_COMMENT_COLUMN">COLUMN_<wbr>COMMENT_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.COLUMN_DEFAULT_COLUMN.html" title="constant query::sql::COLUMN_DEFAULT_COLUMN">COLUMN_<wbr>DEFAULT_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.COLUMN_EXTRA_COLUMN.html" title="constant query::sql::COLUMN_EXTRA_COLUMN">COLUMN_<wbr>EXTRA_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.COLUMN_GREPTIME_TYPE_COLUMN.html" title="constant query::sql::COLUMN_GREPTIME_TYPE_COLUMN">COLUMN_<wbr>GREPTIME_<wbr>TYPE_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.COLUMN_KEY_COLUMN.html" title="constant query::sql::COLUMN_KEY_COLUMN">COLUMN_<wbr>KEY_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.COLUMN_NAME_COLUMN.html" title="constant query::sql::COLUMN_NAME_COLUMN">COLUMN_<wbr>NAME_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.COLUMN_NULLABLE_COLUMN.html" title="constant query::sql::COLUMN_NULLABLE_COLUMN">COLUMN_<wbr>NULLABLE_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.COLUMN_PRIVILEGES_COLUMN.html" title="constant query::sql::COLUMN_PRIVILEGES_COLUMN">COLUMN_<wbr>PRIVILEGES_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.COLUMN_SEMANTIC_TYPE_COLUMN.html" title="constant query::sql::COLUMN_SEMANTIC_TYPE_COLUMN">COLUMN_<wbr>SEMANTIC_<wbr>TYPE_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.COLUMN_TYPE_COLUMN.html" title="constant query::sql::COLUMN_TYPE_COLUMN">COLUMN_<wbr>TYPE_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.FIELD_COLUMN.html" title="constant query::sql::FIELD_COLUMN">FIELD_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.FLOWS_COLUMN.html" title="constant query::sql::FLOWS_COLUMN">FLOWS_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INDEX_CARDINALITY_COLUMN.html" title="constant query::sql::INDEX_CARDINALITY_COLUMN">INDEX_<wbr>CARDINALITY_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INDEX_COLUMN_NAME_COLUMN.html" title="constant query::sql::INDEX_COLUMN_NAME_COLUMN">INDEX_<wbr>COLUMN_<wbr>NAME_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INDEX_COMMENT_COLUMN.html" title="constant query::sql::INDEX_COMMENT_COLUMN">INDEX_<wbr>COMMENT_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INDEX_EXPRESSION_COLUMN.html" title="constant query::sql::INDEX_EXPRESSION_COLUMN">INDEX_<wbr>EXPRESSION_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INDEX_INDEX_TYPE_COLUMN.html" title="constant query::sql::INDEX_INDEX_TYPE_COLUMN">INDEX_<wbr>INDEX_<wbr>TYPE_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INDEX_KEY_NAME_COLUMN.html" title="constant query::sql::INDEX_KEY_NAME_COLUMN">INDEX_<wbr>KEY_<wbr>NAME_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INDEX_NONT_UNIQUE_COLUMN.html" title="constant query::sql::INDEX_NONT_UNIQUE_COLUMN">INDEX_<wbr>NONT_<wbr>UNIQUE_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INDEX_PACKED_COLUMN.html" title="constant query::sql::INDEX_PACKED_COLUMN">INDEX_<wbr>PACKED_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INDEX_SEQ_IN_INDEX_COLUMN.html" title="constant query::sql::INDEX_SEQ_IN_INDEX_COLUMN">INDEX_<wbr>SEQ_<wbr>IN_<wbr>INDEX_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INDEX_SUB_PART_COLUMN.html" title="constant query::sql::INDEX_SUB_PART_COLUMN">INDEX_<wbr>SUB_<wbr>PART_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INDEX_TABLE_COLUMN.html" title="constant query::sql::INDEX_TABLE_COLUMN">INDEX_<wbr>TABLE_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>SHOW index columns</dd><dt><a class="constant" href="constant.INDEX_VISIBLE_COLUMN.html" title="constant query::sql::INDEX_VISIBLE_COLUMN">INDEX_<wbr>VISIBLE_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.NO_STR.html" title="constant query::sql::NO_STR">NO_STR</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.OPTIONS_COLUMN.html" title="constant query::sql::OPTIONS_COLUMN">OPTIONS_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.PRI_KEY.html" title="constant query::sql::PRI_KEY">PRI_KEY</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.SCHEMAS_COLUMN.html" title="constant query::sql::SCHEMAS_COLUMN">SCHEMAS_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.TABLE_TYPE_COLUMN.html" title="constant query::sql::TABLE_TYPE_COLUMN">TABLE_<wbr>TYPE_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.TIME_INDEX.html" title="constant query::sql::TIME_INDEX">TIME_<wbr>INDEX</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.VIEWS_COLUMN.html" title="constant query::sql::VIEWS_COLUMN">VIEWS_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.YES_STR.html" title="constant query::sql::YES_STR">YES_STR</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><dl class="item-table"><dt><a class="static" href="static.DESCRIBE_TABLE_OUTPUT_SCHEMA.html" title="static query::sql::DESCRIBE_TABLE_OUTPUT_SCHEMA">DESCRIBE_<wbr>TABLE_<wbr>OUTPUT_<wbr>SCHEMA</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="static" href="static.SHOW_CREATE_DATABASE_OUTPUT_SCHEMA.html" title="static query::sql::SHOW_CREATE_DATABASE_OUTPUT_SCHEMA">SHOW_<wbr>CREATE_<wbr>DATABASE_<wbr>OUTPUT_<wbr>SCHEMA</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="static" href="static.SHOW_CREATE_FLOW_OUTPUT_SCHEMA.html" title="static query::sql::SHOW_CREATE_FLOW_OUTPUT_SCHEMA">SHOW_<wbr>CREATE_<wbr>FLOW_<wbr>OUTPUT_<wbr>SCHEMA</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="static" href="static.SHOW_CREATE_TABLE_OUTPUT_SCHEMA.html" title="static query::sql::SHOW_CREATE_TABLE_OUTPUT_SCHEMA">SHOW_<wbr>CREATE_<wbr>TABLE_<wbr>OUTPUT_<wbr>SCHEMA</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="static" href="static.SHOW_CREATE_VIEW_OUTPUT_SCHEMA.html" title="static query::sql::SHOW_CREATE_VIEW_OUTPUT_SCHEMA">SHOW_<wbr>CREATE_<wbr>VIEW_<wbr>OUTPUT_<wbr>SCHEMA</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></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.check_file_to_table_schema_compatibility.html" title="fn query::sql::check_file_to_table_schema_compatibility">check_<wbr>file_<wbr>to_<wbr>table_<wbr>schema_<wbr>compatibility</a></dt><dd>This function checks if the column schemas from a file can be matched with
the column schemas of a table.</dd><dt><a class="fn" href="fn.create_table_stmt.html" title="fn query::sql::create_table_stmt">create_<wbr>table_<wbr>stmt</a></dt><dd>Create a CreateTable statement from table info.</dd><dt><a class="fn" href="fn.describe_column_defaults.html" title="fn query::sql::describe_column_defaults">describe_<wbr>column_<wbr>defaults</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.describe_column_keys.html" title="fn query::sql::describe_column_keys">describe_<wbr>column_<wbr>keys</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.describe_column_names.html" title="fn query::sql::describe_column_names">describe_<wbr>column_<wbr>names</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.describe_column_nullables.html" title="fn query::sql::describe_column_nullables">describe_<wbr>column_<wbr>nullables</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.describe_column_semantic_types.html" title="fn query::sql::describe_column_semantic_types">describe_<wbr>column_<wbr>semantic_<wbr>types</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.describe_column_types.html" title="fn query::sql::describe_column_types">describe_<wbr>column_<wbr>types</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.describe_table.html" title="fn query::sql::describe_table">describe_<wbr>table</a></dt><dt><a class="fn" href="fn.file_column_schemas_to_table.html" title="fn query::sql::file_column_schemas_to_table">file_<wbr>column_<wbr>schemas_<wbr>to_<wbr>table</a></dt><dt><a class="fn" href="fn.infer_file_table_schema.html" title="fn query::sql::infer_file_table_schema">infer_<wbr>file_<wbr>table_<wbr>schema</a></dt><dt><a class="fn" href="fn.null.html" title="fn query::sql::null">null</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.parse_file_table_format.html" title="fn query::sql::parse_file_table_format">parse_<wbr>file_<wbr>table_<wbr>format</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.prepare_file_table_files.html" title="fn query::sql::prepare_file_table_files">prepare_<wbr>file_<wbr>table_<wbr>files</a></dt><dt><a class="fn" href="fn.query_from_information_schema_table.html" title="fn query::sql::query_from_information_schema_table">query_<wbr>from_<wbr>information_<wbr>schema_<wbr>table</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Cast a <code>show</code> statement execution into a query from tables in <code>information_schema</code>.</dd><dt><a class="fn" href="fn.replace_column_in_expr.html" title="fn query::sql::replace_column_in_expr">replace_<wbr>column_<wbr>in_<wbr>expr</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Replaces column identifier references in a SQL expression.
Used for backward compatibility where old column names should work with new ones.</dd><dt><a class="fn" href="fn.show_charsets.html" title="fn query::sql::show_charsets">show_<wbr>charsets</a></dt><dd>Execute <code>SHOW CHARSET</code> statement and returns the <code>Output</code> if success.</dd><dt><a class="fn" href="fn.show_collations.html" title="fn query::sql::show_collations">show_<wbr>collations</a></dt><dd>Execute <code>SHOW COLLATION</code> statement and returns the <code>Output</code> if success.</dd><dt><a class="fn" href="fn.show_columns.html" title="fn query::sql::show_columns">show_<wbr>columns</a></dt><dd>Execute <code>SHOW COLUMNS</code> statement.</dd><dt><a class="fn" href="fn.show_create_database.html" title="fn query::sql::show_create_database">show_<wbr>create_<wbr>database</a></dt><dt><a class="fn" href="fn.show_create_flow.html" title="fn query::sql::show_create_flow">show_<wbr>create_<wbr>flow</a></dt><dt><a class="fn" href="fn.show_create_foreign_table_for_pg.html" title="fn query::sql::show_create_foreign_table_for_pg">show_<wbr>create_<wbr>foreign_<wbr>table_<wbr>for_<wbr>pg</a></dt><dt><a class="fn" href="fn.show_create_table.html" title="fn query::sql::show_create_table">show_<wbr>create_<wbr>table</a></dt><dt><a class="fn" href="fn.show_create_view.html" title="fn query::sql::show_create_view">show_<wbr>create_<wbr>view</a></dt><dt><a class="fn" href="fn.show_databases.html" title="fn query::sql::show_databases">show_<wbr>databases</a></dt><dt><a class="fn" href="fn.show_flows.html" title="fn query::sql::show_flows">show_<wbr>flows</a></dt><dd>Execute <a href="../../sql/statements/show/struct.ShowFlows.html" title="struct sql::statements::show::ShowFlows"><code>ShowFlows</code></a> statement and return the <a href="../../common_query/struct.Output.html" title="struct common_query::Output"><code>Output</code></a> if success.</dd><dt><a class="fn" href="fn.show_index.html" title="fn query::sql::show_index">show_<wbr>index</a></dt><dd>Execute <code>SHOW INDEX</code> statement.</dd><dt><a class="fn" href="fn.show_processlist.html" title="fn query::sql::show_processlist">show_<wbr>processlist</a></dt><dt><a class="fn" href="fn.show_region.html" title="fn query::sql::show_region">show_<wbr>region</a></dt><dd>Execute <code>SHOW REGION</code> statement.</dd><dt><a class="fn" href="fn.show_search_path.html" title="fn query::sql::show_search_path">show_<wbr>search_<wbr>path</a></dt><dt><a class="fn" href="fn.show_status.html" title="fn query::sql::show_status">show_<wbr>status</a></dt><dt><a class="fn" href="fn.show_table_status.html" title="fn query::sql::show_table_status">show_<wbr>table_<wbr>status</a></dt><dd>Execute <a href="../../sql/statements/show/struct.ShowTableStatus.html" title="struct sql::statements::show::ShowTableStatus"><code>ShowTableStatus</code></a> statement and return the <a href="../../common_query/struct.Output.html" title="struct common_query::Output"><code>Output</code></a> if success.</dd><dt><a class="fn" href="fn.show_tables.html" title="fn query::sql::show_tables">show_<wbr>tables</a></dt><dd>Execute <a href="../../sql/statements/show/struct.ShowTables.html" title="struct sql::statements::show::ShowTables"><code>ShowTables</code></a> statement and return the <a href="../../common_query/struct.Output.html" title="struct common_query::Output"><code>Output</code></a> if success.</dd><dt><a class="fn" href="fn.show_variable.html" title="fn query::sql::show_variable">show_<wbr>variable</a></dt><dt><a class="fn" href="fn.show_views.html" title="fn query::sql::show_views">show_<wbr>views</a></dt><dd>Execute <a href="../../sql/statements/show/struct.ShowViews.html" title="struct sql::statements::show::ShowViews"><code>ShowViews</code></a> statement and return the <a href="../../common_query/struct.Output.html" title="struct common_query::Output"><code>Output</code></a> if success.</dd></dl></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink