greptimedb/mito2/compaction/compactor/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 `compactor` mod in crate `mito2`."><title>mito2::compaction::compactor - 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="mito2" 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 compactor</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../mito2/index.html">mito2</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 compactor</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="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In mito2::<wbr>compaction</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">mito2</a>::<wbr><a href="../index.html">compaction</a></div><h1>Module <span>compactor</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/mito2/compaction/compactor.rs.html#15-1446">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.CompactionRegion.html" title="struct mito2::compaction::compactor::CompactionRegion">Compaction<wbr>Region</a></dt><dd>CompactionRegion represents a region that needs to be compacted.
It’s the subset of MitoRegion.</dd><dt><a class="struct" href="struct.CompactionVersion.html" title="struct mito2::compaction::compactor::CompactionVersion">Compaction<wbr>Version</a></dt><dd>Region version for compaction that does not hold memtables.</dd><dt><a class="struct" href="struct.DefaultCompactor.html" title="struct mito2::compaction::compactor::DefaultCompactor">Default<wbr>Compactor</a></dt><dd>DefaultCompactor is the default implementation of Compactor.</dd><dt><a class="struct" href="struct.DefaultSstMerger.html" title="struct mito2::compaction::compactor::DefaultSstMerger">Default<wbr>SstMerger</a></dt><dd>The production <a href="trait.SstMerger.html" title="trait mito2::compaction::compactor::SstMerger"><code>SstMerger</code></a> that reads, merges, and writes SST files.</dd><dt><a class="struct" href="struct.MergeOutput.html" title="struct mito2::compaction::compactor::MergeOutput">Merge<wbr>Output</a></dt><dd><code>[MergeOutput]</code> represents the output of merging SST files.</dd><dt><a class="struct" href="struct.OpenCompactionRegionRequest.html" title="struct mito2::compaction::compactor::OpenCompactionRegionRequest">Open<wbr>Compaction<wbr>Region<wbr>Request</a></dt><dd>OpenCompactionRegionRequest represents the request to open a compaction region.</dd><dt><a class="struct" href="struct.OutputSequenceMetadata.html" title="struct mito2::compaction::compactor::OutputSequenceMetadata">Output<wbr>Sequence<wbr>Metadata</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>File-level sequence metadata is independent of physical row encoding.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.Compactor.html" title="trait mito2::compaction::compactor::Compactor">Compactor</a></dt><dd>Compactor is the trait that defines the compaction logic.</dd><dt><a class="trait" href="trait.SstMerger.html" title="trait mito2::compaction::compactor::SstMerger">SstMerger</a></dt><dd>Trait for merging a single compaction output into SST files.</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.known_max_input_sequence.html" title="fn mito2::compaction::compactor::known_max_input_sequence">known_<wbr>max_<wbr>input_<wbr>sequence</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Computes the maximum target-domain sequence bound of the output of merging
<code>inputs</code>. A bound can be a row maximum or an admission marker; compaction
must preserve both for sequence-based pruning. Unknown bounds must remain
unknown rather than being replaced with a partial maximum.</dd><dt><a class="fn" href="fn.open_compaction_region.html" title="fn mito2::compaction::compactor::open_compaction_region">open_<wbr>compaction_<wbr>region</a></dt><dd>Open a compaction region from a compaction request.
It’s simple version of RegionOpener::open().</dd><dt><a class="fn" href="fn.output_sequence_metadata.html" title="fn mito2::compaction::compactor::output_sequence_metadata">output_<wbr>sequence_<wbr>metadata</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Compaction does not admit new data, so it inherits the input sequence bounds
without allocating a new admission marker. Retaining physical row sequences
does not by itself restore exact-read capability for untrusted inputs.</dd><dt><a class="fn" href="fn.sst_info_from_file_meta.html" title="fn mito2::compaction::compactor::sst_info_from_file_meta">sst_<wbr>info_<wbr>from_<wbr>file_<wbr>meta</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Builds an <a href="../../sst/parquet/struct.SstInfo.html" title="struct mito2::sst::parquet::SstInfo"><code>SstInfo</code></a> for the remote-compaction path by copying the scalar
fields that <a href="../../sst/file/struct.FileMeta.html" title="struct mito2::sst::file::FileMeta"><code>FileMeta</code></a> also carries.</dd></dl></section></div></main></body></html>