greptimedb/common_meta/ddl/create_flow/index.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 `create_flow` mod in crate `common_meta`."><title>common_meta::ddl::create_flow - 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-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="common_meta" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.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-417ebf0a.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 create_flow</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../common_meta/index.html">common_<wbr>meta</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module create_<wbr>flow</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="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</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 common_<wbr>meta::<wbr>ddl</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">common_meta</a>::<wbr><a href="../index.html">ddl</a></div><h1>Module <span>create_<wbr>flow</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_meta/ddl/create_flow.rs.html#15-960">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="metadata/index.html" title="mod common_meta::ddl::create_flow::metadata">metadata</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.CreateFlowData.html" title="struct common_meta::ddl::create_flow::CreateFlowData">Create<wbr>Flow<wbr>Data</a></dt><dd>The serializable data.</dd><dt><a class="struct" href="struct.CreateFlowProcedure.html" title="struct common_meta::ddl::create_flow::CreateFlowProcedure">Create<wbr>Flow<wbr>Procedure</a></dt><dd>The procedure of flow creation.</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.CreateFlowState.html" title="enum common_meta::ddl::create_flow::CreateFlowState">Create<wbr>Flow<wbr>State</a></dt><dd>The state of <a href="struct.CreateFlowProcedure.html" title="struct common_meta::ddl::create_flow::CreateFlowProcedure">CreateFlowProcedure</a>.</dd><dt><a class="enum" href="enum.FlowType.html" title="enum common_meta::ddl::create_flow::FlowType">Flow<wbr>Type</a></dt><dd>The type of flow.</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.DEFER_ON_MISSING_SOURCE_KEY.html" title="constant common_meta::ddl::create_flow::DEFER_ON_MISSING_SOURCE_KEY">DEFER_<wbr>ON_<wbr>MISSING_<wbr>SOURCE_<wbr>KEY</a></dt><dd>The flow option key for creating pending flow metadata when source tables do not exist.</dd><dt><a class="constant" href="constant.FLOW_EXPERIMENTAL_ENABLE_INCREMENTAL_READ_KEY.html" title="constant common_meta::ddl::create_flow::FLOW_EXPERIMENTAL_ENABLE_INCREMENTAL_READ_KEY">FLOW_<wbr>EXPERIMENTAL_<wbr>ENABLE_<wbr>INCREMENTAL_<wbr>READ_<wbr>KEY</a></dt><dt><a class="constant" href="constant.FLOW_EXPERIMENTAL_ENABLE_INCREMENTAL_READ_SEQUENCE_RANGE.html" title="constant common_meta::ddl::create_flow::FLOW_EXPERIMENTAL_ENABLE_INCREMENTAL_READ_SEQUENCE_RANGE">FLOW_<wbr>EXPERIMENTAL_<wbr>ENABLE_<wbr>INCREMENTAL_<wbr>READ_<wbr>SEQUENCE_<wbr>RANGE</a></dt><dd>Reserved internal value for flows requiring exact sequence ranges.</dd><dt><a class="constant" href="constant.FLOW_SCHEDULED_TIME_MILLIS_EXTENSION_KEY.html" title="constant common_meta::ddl::create_flow::FLOW_SCHEDULED_TIME_MILLIS_EXTENSION_KEY">FLOW_<wbr>SCHEDULED_<wbr>TIME_<wbr>MILLIS_<wbr>EXTENSION_<wbr>KEY</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INTERNAL_EVAL_OFFSET_KEY.html" title="constant common_meta::ddl::create_flow::INTERNAL_EVAL_OFFSET_KEY">INTERNAL_<wbr>EVAL_<wbr>OFFSET_<wbr>KEY</a></dt><dd>Internal transient key used to pass the typed <code>EVAL OFFSET</code> (whole seconds)
from the operator to meta through <code>CreateFlowExpr.flow_options</code>. Inserted by
the operator only after user option validation; parsed and stripped by
<code>CreateFlowTask::try_from</code>. Must never be accepted as a user-provided option
and must never be persisted into <code>FlowInfoValue.options</code> or be visible in
user runtime options / SHOW CREATE.</dd><dt><a class="constant" href="constant.INTERNAL_EVAL_SCHEDULE_KEY.html" title="constant common_meta::ddl::create_flow::INTERNAL_EVAL_SCHEDULE_KEY">INTERNAL_<wbr>EVAL_<wbr>SCHEDULE_<wbr>KEY</a></dt><dd>Internal transient key used to pass the serialized <code>FlowScheduleConfig</code> from
meta to flownode through <code>CreateRequest.flow_options</code>. This key must never
be accepted as a user-provided option and must never be persisted into
<code>FlowInfoValue.options</code>.
TODO(discord9): Replace this transient flow_options transport with a typed
field in the flow create request.</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.ceil_to_boundary.html" title="fn common_meta::ddl::create_flow::ceil_to_boundary">ceil_<wbr>to_<wbr>boundary</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Computes the ceiling of <code>time</code> to the next schedule boundary aligned with <code>anchor + k * interval</code>.
All values are Unix timestamps in seconds.</dd><dt><a class="fn" href="fn.ceil_to_whole_sec.html" title="fn common_meta::ddl::create_flow::ceil_to_whole_sec">ceil_<wbr>to_<wbr>whole_<wbr>sec</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Rounds a <code>Utc</code> instant up to the next whole second (Unix seconds), with
nanosecond precision.</dd><dt><a class="fn" href="fn.ceil_whole_sec_from_parts.html" title="fn common_meta::ddl::create_flow::ceil_whole_sec_from_parts">ceil_<wbr>whole_<wbr>sec_<wbr>from_<wbr>parts</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Pure ceiling computation factored out of <a href="fn.ceil_to_whole_sec.html" title="fn common_meta::ddl::create_flow::ceil_to_whole_sec"><code>ceil_to_whole_sec</code></a> so the
overflow path is testable: <code>chrono::DateTime&lt;Utc&gt;</code> cannot represent
instants near <code>i64::MAX</code> seconds, but the arithmetic below guards it anyway.</dd><dt><a class="fn" href="fn.defer_on_missing_source.html" title="fn common_meta::ddl::create_flow::defer_on_missing_source">defer_<wbr>on_<wbr>missing_<wbr>source</a></dt><dt><a class="fn" href="fn.effective_eval_schedule_from_flow_info.html" title="fn common_meta::ddl::create_flow::effective_eval_schedule_from_flow_info">effective_<wbr>eval_<wbr>schedule_<wbr>from_<wbr>flow_<wbr>info</a></dt><dd>Returns the effective typed schedule config for flow metadata.</dd><dt><a class="fn" href="fn.get_flow_type_from_options.html" title="fn common_meta::ddl::create_flow::get_flow_type_from_options">get_<wbr>flow_<wbr>type_<wbr>from_<wbr>options</a></dt><dt><a class="fn" href="fn.resolve_schedule_defaults_into_task.html" title="fn common_meta::ddl::create_flow::resolve_schedule_defaults_into_task">resolve_<wbr>schedule_<wbr>defaults_<wbr>into_<wbr>task</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Resolve <code>FlowScheduleConfig</code> into <code>task.eval_schedule</code>.</dd><dt><a class="fn" href="fn.user_runtime_flow_options.html" title="fn common_meta::ddl::create_flow::user_runtime_flow_options">user_<wbr>runtime_<wbr>flow_<wbr>options</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.validate_flow_options.html" title="fn common_meta::ddl::create_flow::validate_flow_options">validate_<wbr>flow_<wbr>options</a></dt><dt><a class="fn" href="fn.without_scheduled_time_extension.html" title="fn common_meta::ddl::create_flow::without_scheduled_time_extension">without_<wbr>scheduled_<wbr>time_<wbr>extension</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>