Files
greptimedb/common_meta/reconciliation/utils/index.html
2026-05-15 04:01:35 +00:00

3 lines
10 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 `utils` mod in crate `common_meta`."><title>common_meta::reconciliation::utils - 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="common_meta" 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 utils</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.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module utils</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="#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>reconciliation</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">reconciliation</a></div><h1>Module <span>utils</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/reconciliation/utils.rs.html#15-1283">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.Context.html" title="struct common_meta::reconciliation::utils::Context">Context</a></dt><dt><a class="struct" href="struct.LogicalTableMeta.html" title="struct common_meta::reconciliation::utils::LogicalTableMeta">Logical<wbr>Table<wbr>Meta</a></dt><dd>Metadata for an inflight logical table subprocedure.</dd><dt><a class="struct" href="struct.PartialRegionMetadata.html" title="struct common_meta::reconciliation::utils::PartialRegionMetadata">Partial<wbr>Region<wbr>Metadata</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.PartialSuccessResult.html" title="struct common_meta::reconciliation::utils::PartialSuccessResult">Partial<wbr>Success<wbr>Result</a></dt><dd>The result of waiting for inflight subprocedures.</dd><dt><a class="struct" href="struct.PhysicalTableMeta.html" title="struct common_meta::reconciliation::utils::PhysicalTableMeta">Physical<wbr>Table<wbr>Meta</a></dt><dd>Metadata for an inflight physical table subprocedure.</dd><dt><a class="struct" href="struct.ReconcileCatalogMetrics.html" title="struct common_meta::reconciliation::utils::ReconcileCatalogMetrics">Reconcile<wbr>Catalog<wbr>Metrics</a></dt><dd>The metrics of reconciling catalog.</dd><dt><a class="struct" href="struct.ReconcileDatabaseMeta.html" title="struct common_meta::reconciliation::utils::ReconcileDatabaseMeta">Reconcile<wbr>Database<wbr>Meta</a></dt><dd>Metadata for an inflight database subprocedure.</dd><dt><a class="struct" href="struct.ReconcileDatabaseMetrics.html" title="struct common_meta::reconciliation::utils::ReconcileDatabaseMetrics">Reconcile<wbr>Database<wbr>Metrics</a></dt><dd>The metrics of reconciling database.</dd><dt><a class="struct" href="struct.ReconcileLogicalTableMetrics.html" title="struct common_meta::reconciliation::utils::ReconcileLogicalTableMetrics">Reconcile<wbr>Logical<wbr>Table<wbr>Metrics</a></dt><dd>The metrics of reconciling logical tables.</dd><dt><a class="struct" href="struct.ReconcileTableMetrics.html" title="struct common_meta::reconciliation::utils::ReconcileTableMetrics">Reconcile<wbr>Table<wbr>Metrics</a></dt><dd>The metrics of reconciling physical tables.</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.ResolveColumnMetadataResult.html" title="enum common_meta::reconciliation::utils::ResolveColumnMetadataResult">Resolve<wbr>Column<wbr>Metadata<wbr>Result</a></dt><dd>The result of resolving column metadata.</dd><dt><a class="enum" href="enum.SubprocedureMeta.html" title="enum common_meta::reconciliation::utils::SubprocedureMeta">Subprocedure<wbr>Meta</a></dt><dd>The inflight subprocedure metadata.</dd><dt><a class="enum" href="enum.WaitForInflightSubproceduresResult.html" title="enum common_meta::reconciliation::utils::WaitForInflightSubproceduresResult">Wait<wbr>ForInflight<wbr>Subprocedures<wbr>Result</a></dt><dd>The result of waiting for inflight subprocedures.</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_METADATA_CONSISTENT.html" title="constant common_meta::reconciliation::utils::COLUMN_METADATA_CONSISTENT">COLUMN_<wbr>METADATA_<wbr>CONSISTENT</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.COLUMN_METADATA_INCONSISTENT.html" title="constant common_meta::reconciliation::utils::COLUMN_METADATA_INCONSISTENT">COLUMN_<wbr>METADATA_<wbr>INCONSISTENT</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.CREATE_TABLES.html" title="constant common_meta::reconciliation::utils::CREATE_TABLES">CREATE_<wbr>TABLES</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.UPDATE_TABLE_INFO.html" title="constant common_meta::reconciliation::utils::UPDATE_TABLE_INFO">UPDATE_<wbr>TABLE_<wbr>INFO</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_column_metadata_from_table_info.html" title="fn common_meta::reconciliation::utils::build_column_metadata_from_table_info">build_<wbr>column_<wbr>metadata_<wbr>from_<wbr>table_<wbr>info</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Constructs a vector of [<code>ColumnMetadata</code>] from the provided table information.</dd><dt><a class="fn" href="fn.build_table_meta_from_column_metadatas.html" title="fn common_meta::reconciliation::utils::build_table_meta_from_column_metadatas">build_<wbr>table_<wbr>meta_<wbr>from_<wbr>column_<wbr>metadatas</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Builds a [<code>TableMeta</code>] from the provided [<code>ColumnMetadata</code>]s.</dd><dt><a class="fn" href="fn.check_column_metadata_invariants.html" title="fn common_meta::reconciliation::utils::check_column_metadata_invariants">check_<wbr>column_<wbr>metadata_<wbr>invariants</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Checks whether the schema invariants hold between the existing and new column metadata.</dd><dt><a class="fn" href="fn.check_column_metadatas_consistent.html" title="fn common_meta::reconciliation::utils::check_column_metadatas_consistent">check_<wbr>column_<wbr>metadatas_<wbr>consistent</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Checks if the column metadatas are consistent.</dd><dt><a class="fn" href="fn.need_update_logical_table_info.html" title="fn common_meta::reconciliation::utils::need_update_logical_table_info">need_<wbr>update_<wbr>logical_<wbr>table_<wbr>info</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Returns true if the logical table info needs to be updated.</dd><dt><a class="fn" href="fn.resolve_column_metadatas_with_latest.html" title="fn common_meta::reconciliation::utils::resolve_column_metadatas_with_latest">resolve_<wbr>column_<wbr>metadatas_<wbr>with_<wbr>latest</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Resolves column metadata inconsistencies among the given region metadatas
by selecting the column metadata with the highest schema version.</dd><dt><a class="fn" href="fn.resolve_column_metadatas_with_metasrv.html" title="fn common_meta::reconciliation::utils::resolve_column_metadatas_with_metasrv">resolve_<wbr>column_<wbr>metadatas_<wbr>with_<wbr>metasrv</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Resolves column metadata inconsistencies among the given region metadatas
by using the column metadata from the metasrv as the source of truth.</dd><dt><a class="fn" href="fn.wait_for_inflight_subprocedures.html" title="fn common_meta::reconciliation::utils::wait_for_inflight_subprocedures">wait_<wbr>for_<wbr>inflight_<wbr>subprocedures</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Wait for inflight subprocedures.</dd></dl></section></div></main></body></html>