greptimedb/datanode/store/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="object storage utilities"><title>datanode::store - 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="datanode" 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 store</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../datanode/index.html">datanode</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 store</a></h2><h3><a href="#constants">Module Items</a></h3><ul class="block"><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 class="in-crate"><a href="../index.html">In crate datanode</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">datanode</a></div><h1>Module <span>store</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/datanode/store.rs.html#15-303">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>object storage utilities</p>
</div></details><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.PROBE_CLEANUP_TIMEOUT.html" title="constant datanode::store::PROBE_CLEANUP_TIMEOUT">PROBE_<wbr>CLEANUP_<wbr>TIMEOUT</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The budget of the best-effort cleanup after a timed-out probe, kept short so an
unresponsive store cannot block startup a second time.</dd><dt><a class="constant" href="constant.PROBE_CONTENT.html" title="constant datanode::store::PROBE_CONTENT">PROBE_<wbr>CONTENT</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The content written by <a href="fn.probe_object_store.html" title="fn datanode::store::probe_object_store"><code>probe_object_store</code></a>.</dd><dt><a class="constant" href="constant.PROBE_DIR.html" title="constant datanode::store::PROBE_DIR">PROBE_<wbr>DIR</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The directory that holds the objects created by <a href="fn.probe_object_store.html" title="fn datanode::store::probe_object_store"><code>probe_object_store</code></a>.</dd><dt><a class="constant" href="constant.PROBE_STAGGER.html" title="constant datanode::store::PROBE_STAGGER">PROBE_<wbr>STAGGER</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The maximum random delay before a probe starts. It is short enough that startup
waits at most this delay, and it spreads out the probes of providers that share
an object storage.</dd><dt><a class="constant" href="constant.PROBE_SUFFIX.html" title="constant datanode::store::PROBE_SUFFIX">PROBE_<wbr>SUFFIX</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The content appended by <a href="fn.probe_object_store.html" title="fn datanode::store::probe_object_store"><code>probe_object_store</code></a> to exercise read-modify-write.</dd><dt><a class="constant" href="constant.PROBE_TIMEOUT.html" title="constant datanode::store::PROBE_TIMEOUT">PROBE_<wbr>TIMEOUT</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The budget of one <a href="fn.probe_object_store.html" title="fn datanode::store::probe_object_store"><code>probe_object_store</code></a> call, including the retries an object
store makes on top of its 30s request timeout.</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.clean_old_read_cache.html" title="fn datanode::store::clean_old_read_cache">clean_<wbr>old_<wbr>read_<wbr>cache</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Cleans up old LRU read cache directories that were removed.</dd><dt><a class="fn" href="fn.new_object_store.html" title="fn datanode::store::new_object_store">new_<wbr>object_<wbr>store</a></dt><dt><a class="fn" href="fn.probe_key_prefix.html" title="fn datanode::store::probe_key_prefix">probe_<wbr>key_<wbr>prefix</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Returns a unique key prefix for <a href="fn.probe_object_store.html" title="fn datanode::store::probe_object_store"><code>probe_object_store</code></a>, so datanodes sharing
the same bucket and root do not collide.</dd><dt><a class="fn" href="fn.probe_object_key.html" title="fn datanode::store::probe_object_key">probe_<wbr>object_<wbr>key</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Returns the object key <a href="fn.probe_object_store.html" title="fn datanode::store::probe_object_store"><code>probe_object_store</code></a> probes under <code>prefix</code>.</dd><dt><a class="fn" href="fn.probe_object_store.html" title="fn datanode::store::probe_object_store">probe_<wbr>object_<wbr>store</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Checks that <code>store</code> supports the operations the storage engines rely on: write,
read, overwrite, list and delete.</dd><dt><a class="fn" href="fn.probe_start_delay.html" title="fn datanode::store::probe_start_delay">probe_<wbr>start_<wbr>delay</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Returns a random delay in <code>[0, PROBE_STAGGER)</code>.</dd><dt><a class="fn" href="fn.remove_probe_object.html" title="fn datanode::store::remove_probe_object">remove_<wbr>probe_<wbr>object</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Removes the probe object of a probe that did not finish.</dd><dt><a class="fn" href="fn.verify_content.html" title="fn datanode::store::verify_content">verify_<wbr>content</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>