Files
greptimedb/operator/statement/ddl/index.html
T

7 lines
9.9 KiB
HTML
Raw 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 `ddl` mod in crate `operator`."><title>operator::statement::ddl - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="operator" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-f7c3ffd8.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"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[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 ddl</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../operator/index.html">operator</a><span class="version">1.3.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module ddl</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="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In operator::<wbr>statement</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" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">operator</a>::<wbr><a href="../index.html">statement</a></div><h1>Module <span>ddl</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/operator/statement/ddl.rs.html#15-3675">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.DdlSubmitOptions.html" title="struct operator::statement::ddl::DdlSubmitOptions">DdlSubmit<wbr>Options</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></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.ALLOWED_FLOW_OPTIONS.html" title="constant operator::statement::ddl::ALLOWED_FLOW_OPTIONS">ALLOWED_<wbr>FLOW_<wbr>OPTIONS</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.build_procedure_id_output.html" title="fn operator::statement::ddl::build_procedure_id_output">build_<wbr>procedure_<wbr>id_<wbr>output</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.column_name_and_type.html" title="fn operator::statement::ddl::column_name_and_type">column_<wbr>name_<wbr>and_<wbr>type</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.convert_identifier.html" title="fn operator::statement::ddl::convert_identifier">convert_<wbr>identifier</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.convert_one_expr.html" title="fn operator::statement::ddl::convert_one_expr">convert_<wbr>one_<wbr>expr</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.convert_value.html" title="fn operator::statement::ddl::convert_value">convert_<wbr>value</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.create_table_info.html" title="fn operator::statement::ddl::create_table_info">create_<wbr>table_<wbr>info</a></dt><dt><a class="fn" href="fn.determine_flow_type_for_source_state.html" title="fn operator::statement::ddl::determine_flow_type_for_source_state">determine_<wbr>flow_<wbr>type_<wbr>for_<wbr>source_<wbr>state</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.ensure_partition_expr_columns_in_target.html" title="fn operator::statement::ddl::ensure_partition_expr_columns_in_target">ensure_<wbr>partition_<wbr>expr_<wbr>columns_<wbr>in_<wbr>target</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.ensure_partition_operand_columns_in_target.html" title="fn operator::statement::ddl::ensure_partition_operand_columns_in_target">ensure_<wbr>partition_<wbr>operand_<wbr>columns_<wbr>in_<wbr>target</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.ensure_table_definition_writable.html" title="fn operator::statement::ddl::ensure_table_definition_writable">ensure_<wbr>table_<wbr>definition_<wbr>writable</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd><a href="fn.ensure_table_writable.html" title="fn operator::statement::ddl::ensure_table_writable"><code>ensure_table_writable</code></a> plus the definition guard for system-defined
tables: user CREATE, ALTER and RENAME-into are rejected so the canonical
schema cannot be squatted or mutated. DROP and TRUNCATE stay allowed — the
next INSERT recreates the table canonically, which is also the recovery
path if the canonical definition changes across an upgrade.</dd><dt><a class="fn" href="fn.ensure_table_writable.html" title="fn operator::statement::ddl::ensure_table_writable">ensure_<wbr>table_<wbr>writable</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Rejects DDL against read-only schemas and computed entity-graph tables.</dd><dt><a class="fn" href="fn.find_partition_columns.html" title="fn operator::statement::ddl::find_partition_columns">find_<wbr>partition_<wbr>columns</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.find_partition_entries.html" title="fn operator::statement::ddl::find_partition_entries">find_<wbr>partition_<wbr>entries</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Parse [Partitions] into a group of partition entries.</dd><dt><a class="fn" href="fn.normalize_flow_bool_option.html" title="fn operator::statement::ddl::normalize_flow_bool_option">normalize_<wbr>flow_<wbr>bool_<wbr>option</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.parse_ddl_options.html" title="fn operator::statement::ddl::parse_ddl_options">parse_<wbr>ddl_<wbr>options</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.parse_partitions.html" title="fn operator::statement::ddl::parse_partitions">parse_<wbr>partitions</a></dt><dd>Parse partition statement [Partitions] into [PartitionExpr] and partition columns.</dd><dt><a class="fn" href="fn.parse_partitions_for_logical_validation.html" title="fn operator::statement::ddl::parse_partitions_for_logical_validation">parse_<wbr>partitions_<wbr>for_<wbr>logical_<wbr>validation</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.supported_flow_options.html" title="fn operator::statement::ddl::supported_flow_options">supported_<wbr>flow_<wbr>options</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.validate_and_collect_partition_columns.html" title="fn operator::statement::ddl::validate_and_collect_partition_columns">validate_<wbr>and_<wbr>collect_<wbr>partition_<wbr>columns</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.validate_and_normalize_annotations.html" title="fn operator::statement::ddl::validate_and_normalize_annotations">validate_<wbr>and_<wbr>normalize_<wbr>annotations</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>CREATE-side annotation validation: one rule source in the table crate,
mapped onto this crates existing error variants so client-visible codes
and messages stay put.</dd><dt><a class="fn" href="fn.validate_and_normalize_flow_options.html" title="fn operator::statement::ddl::validate_and_normalize_flow_options">validate_<wbr>and_<wbr>normalize_<wbr>flow_<wbr>options</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.validate_json2_columns_append_mode.html" title="fn operator::statement::ddl::validate_json2_columns_append_mode">validate_<wbr>json2_<wbr>columns_<wbr>append_<wbr>mode</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.verify_alter.html" title="fn operator::statement::ddl::verify_alter">verify_<wbr>alter</a></dt><dd>Verifies an alter and returns whether it is necessary to perform the alter.</dd></dl></section></div></main></body></html>