Files
greptimedb/common_meta/index.html
2026-05-12 10:47:44 +00:00

2 lines
14 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 `common_meta` crate."><title>common_meta - 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="../crates.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 crate"><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="#">Crate common_meta</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"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>common_<wbr>meta</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/lib.rs.html#15-59">Source</a> </span></div><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.RegionIdent"><code>pub use instruction::<a class="struct" href="instruction/struct.RegionIdent.html" title="struct common_meta::instruction::RegionIdent">RegionIdent</a>;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="cache/index.html" title="mod common_meta::cache">cache</a></dt><dt><a class="mod" href="cache_invalidator/index.html" title="mod common_meta::cache_invalidator">cache_<wbr>invalidator</a></dt><dt><a class="mod" href="cluster/index.html" title="mod common_meta::cluster">cluster</a></dt><dt><a class="mod" href="datanode/index.html" title="mod common_meta::datanode">datanode</a></dt><dt><a class="mod" href="ddl/index.html" title="mod common_meta::ddl">ddl</a></dt><dt><a class="mod" href="ddl_manager/index.html" title="mod common_meta::ddl_manager">ddl_<wbr>manager</a></dt><dt><a class="mod" href="distributed_time_constants/index.html" title="mod common_meta::distributed_time_constants">distributed_<wbr>time_<wbr>constants</a></dt><dt><a class="mod" href="election/index.html" title="mod common_meta::election">election</a></dt><dt><a class="mod" href="error/index.html" title="mod common_meta::error">error</a></dt><dt><a class="mod" href="flow_name/index.html" title="mod common_meta::flow_name">flow_<wbr>name</a></dt><dt><a class="mod" href="heartbeat/index.html" title="mod common_meta::heartbeat">heartbeat</a></dt><dt><a class="mod" href="instruction/index.html" title="mod common_meta::instruction">instruction</a></dt><dt><a class="mod" href="key/index.html" title="mod common_meta::key">key</a></dt><dd>This mod defines all the keys used in the metadata store (Metasrv).
Specifically, there are these kinds of keys:</dd><dt><a class="mod" href="kv_backend/index.html" title="mod common_meta::kv_backend">kv_<wbr>backend</a></dt><dt><a class="mod" href="leadership_notifier/index.html" title="mod common_meta::leadership_notifier">leadership_<wbr>notifier</a></dt><dt><a class="mod" href="lock_key/index.html" title="mod common_meta::lock_key">lock_<wbr>key</a></dt><dt><a class="mod" href="metrics/index.html" title="mod common_meta::metrics">metrics</a></dt><dt><a class="mod" href="node_expiry_listener/index.html" title="mod common_meta::node_expiry_listener">node_<wbr>expiry_<wbr>listener</a></dt><dt><a class="mod" href="node_manager/index.html" title="mod common_meta::node_manager">node_<wbr>manager</a></dt><dt><a class="mod" href="peer/index.html" title="mod common_meta::peer">peer</a></dt><dt><a class="mod" href="poison_key/index.html" title="mod common_meta::poison_key">poison_<wbr>key</a></dt><dt><a class="mod" href="procedure_executor/index.html" title="mod common_meta::procedure_executor">procedure_<wbr>executor</a></dt><dt><a class="mod" href="range_stream/index.html" title="mod common_meta::range_stream">range_<wbr>stream</a></dt><dt><a class="mod" href="reconciliation/index.html" title="mod common_meta::reconciliation">reconciliation</a></dt><dt><a class="mod" href="region_keeper/index.html" title="mod common_meta::region_keeper">region_<wbr>keeper</a></dt><dt><a class="mod" href="region_registry/index.html" title="mod common_meta::region_registry">region_<wbr>registry</a></dt><dt><a class="mod" href="rpc/index.html" title="mod common_meta::rpc">rpc</a></dt><dt><a class="mod" href="sequence/index.html" title="mod common_meta::sequence">sequence</a></dt><dt><a class="mod" href="snapshot/index.html" title="mod common_meta::snapshot">snapshot</a></dt><dt><a class="mod" href="state_store/index.html" title="mod common_meta::state_store">state_<wbr>store</a></dt><dt><a class="mod" href="stats/index.html" title="mod common_meta::stats">stats</a></dt><dt><a class="mod" href="test_util/index.html" title="mod common_meta::test_util">test_<wbr>util</a></dt><dt><a class="mod" href="util/index.html" title="mod common_meta::util">util</a></dt><dt><a class="mod" href="wal_provider/index.html" title="mod common_meta::wal_provider">wal_<wbr>provider</a></dt></dl><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.ensure_values.html" title="macro common_meta::ensure_values">ensure_<wbr>values</a></dt><dt><a class="macro" href="macro.impl_metadata_value.html" title="macro common_meta::impl_metadata_value">impl_<wbr>metadata_<wbr>value</a></dt><dt><a class="macro" href="macro.impl_optional_metadata_value.html" title="macro common_meta::impl_optional_metadata_value">impl_<wbr>optional_<wbr>metadata_<wbr>value</a></dt><dt><a class="macro" href="macro.maybe_skip_etcd_tls_integration_test.html" title="macro common_meta::maybe_skip_etcd_tls_integration_test">maybe_<wbr>skip_<wbr>etcd_<wbr>tls_<wbr>integration_<wbr>test</a></dt><dd>Skip the test if the environment variable <code>GT_ETCD_TLS_ENDPOINTS</code> is not set.</dd><dt><a class="macro" href="macro.maybe_skip_mysql_integration_test.html" title="macro common_meta::maybe_skip_mysql_integration_test">maybe_<wbr>skip_<wbr>mysql_<wbr>integration_<wbr>test</a></dt><dd>Skip the test if the environment variable <code>GT_MYSQL_ENDPOINTS</code> is not set.</dd><dt><a class="macro" href="macro.maybe_skip_postgres15_integration_test.html" title="macro common_meta::maybe_skip_postgres15_integration_test">maybe_<wbr>skip_<wbr>postgres15_<wbr>integration_<wbr>test</a></dt><dd>Skip the test if the environment variable <code>GT_POSTGRES15_ENDPOINTS</code> is not set.</dd><dt><a class="macro" href="macro.maybe_skip_postgres_integration_test.html" title="macro common_meta::maybe_skip_postgres_integration_test">maybe_<wbr>skip_<wbr>postgres_<wbr>integration_<wbr>test</a></dt><dd>Skip the test if the environment variable <code>GT_POSTGRES_ENDPOINTS</code> is not set.</dd><dt><a class="macro" href="macro.record_rds_sql_execute_elapsed.html" title="macro common_meta::record_rds_sql_execute_elapsed">record_<wbr>rds_<wbr>sql_<wbr>execute_<wbr>elapsed</a></dt></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.DatanodeId.html" title="type common_meta::DatanodeId">Datanode<wbr>Id</a></dt><dt><a class="type" href="type.FlownodeId.html" title="type common_meta::FlownodeId">Flownode<wbr>Id</a></dt><dt><a class="type" href="type.SchemaOptions.html" title="type common_meta::SchemaOptions">Schema<wbr>Options</a></dt><dd>Schema options.</dd></dl><script type="text/json" id="notable-traits-data">{"&'a [u8]":"<h3>Notable traits for <code>&amp;[<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for &amp;[<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</div>","&'a mut [u8]":"<h3>Notable traits for <code>&amp;mut [<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for &amp;mut [<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</div>","&[u8]":"<h3>Notable traits for <code>&amp;[<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for &amp;[<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</div>","&mut [u8]":"<h3>Notable traits for <code>&amp;mut [<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for &amp;mut [<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</div>","<Arc<S> as Service<Request>>::Future":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</div><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</div>","<Arc<W> as MakeWriter<'a>>::Writer":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</div><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</div>","Vec<u8>":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html\" title=\"struct alloc::vec::Vec\">Vec</a>&lt;<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>, A&gt;</code></h3><pre><code><div class=\"where\">impl&lt;A&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html\" title=\"struct alloc::vec::Vec\">Vec</a>&lt;<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>, A&gt;<div class=\"where\">where\n A: <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/alloc/trait.Allocator.html\" title=\"trait core::alloc::Allocator\">Allocator</a>,</div></div>"}</script></section></div></main></body></html>