Files
greptimedb/mito2/compaction/index.html
2026-05-15 04:01:35 +00:00

4 lines
8.7 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `compaction` mod in crate `mito2`."><title>mito2::compaction - 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="mito2" 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 compaction</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../mito2/index.html">mito2</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module compaction</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="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate mito2</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></div><h1>Module <span>compaction</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.rs.html#15-2325">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="buckets/index.html" title="mod mito2::compaction::buckets">buckets</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="compactor/index.html" title="mod mito2::compaction::compactor">compactor</a></dt><dt><a class="mod" href="memory_manager/index.html" title="mod mito2::compaction::memory_manager">memory_<wbr>manager</a></dt><dt><a class="mod" href="picker/index.html" title="mod mito2::compaction::picker">picker</a></dt><dt><a class="mod" href="run/index.html" title="mod mito2::compaction::run">run</a></dt><dd>This file contains code to find sorted runs in a set if ranged items and
along with the best way to merge these items to satisfy the desired run count.</dd><dt><a class="mod" href="task/index.html" title="mod mito2::compaction::task">task</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="twcs/index.html" title="mod mito2::compaction::twcs">twcs</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="window/index.html" title="mod mito2::compaction::window">window</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.CompactionOutput.html" title="struct mito2::compaction::CompactionOutput">Compaction<wbr>Output</a></dt><dt><a class="struct" href="struct.CompactionRequest.html" title="struct mito2::compaction::CompactionRequest">Compaction<wbr>Request</a></dt><dd>Region compaction request.</dd><dt><a class="struct" href="struct.CompactionScheduler.html" title="struct mito2::compaction::CompactionScheduler">Compaction<wbr>Scheduler</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Compaction scheduler tracks and manages compaction tasks.</dd><dt><a class="struct" href="struct.CompactionSstReaderBuilder.html" title="struct mito2::compaction::CompactionSstReaderBuilder">Compaction<wbr>SstReader<wbr>Builder</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Builders to create [BoxedRecordBatchStream] for compaction.</dd><dt><a class="struct" href="struct.CompactionStatus.html" title="struct mito2::compaction::CompactionStatus">Compaction<wbr>Status</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Status of running and pending region compaction tasks.</dd><dt><a class="struct" href="struct.LocalCompactionState.html" title="struct mito2::compaction::LocalCompactionState">Local<wbr>Compaction<wbr>State</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.PendingCompaction.html" title="struct mito2::compaction::PendingCompaction">Pending<wbr>Compaction</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Pending compaction request that is supposed to run after current task is finished,
typically used for manual compactions.</dd><dt><a class="struct" href="struct.SerializedCompactionOutput.html" title="struct mito2::compaction::SerializedCompactionOutput">Serialized<wbr>Compaction<wbr>Output</a></dt><dd>SerializedCompactionOutput is a serialized version of <a href="struct.CompactionOutput.html" title="struct mito2::compaction::CompactionOutput">CompactionOutput</a> by replacing <a href="../sst/file/struct.FileHandle.html" title="struct mito2::sst::file::FileHandle">FileHandle</a> with <a href="../sst/file/struct.FileMeta.html" title="struct mito2::sst::file::FileMeta">FileMeta</a>.</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.ActiveCompaction.html" title="enum mito2::compaction::ActiveCompaction">Active<wbr>Compaction</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="enum" href="enum.RequestCancelResult.html" title="enum mito2::compaction::RequestCancelResult">Request<wbr>Cancel<wbr>Result</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.estimate_compaction_bytes.html" title="fn mito2::compaction::estimate_compaction_bytes">estimate_<wbr>compaction_<wbr>bytes</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Estimates compaction memory as the sum of all input files maximum row-group
uncompressed sizes.</dd><dt><a class="fn" href="fn.find_dynamic_options.html" title="fn mito2::compaction::find_dynamic_options">find_<wbr>dynamic_<wbr>options</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Finds compaction options and TTL together with a single metadata fetch to reduce RTT.</dd><dt><a class="fn" href="fn.get_expired_ssts.html" title="fn mito2::compaction::get_expired_ssts">get_<wbr>expired_<wbr>ssts</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Finds all expired SSTs across levels.</dd><dt><a class="fn" href="fn.time_range_to_predicate.html" title="fn mito2::compaction::time_range_to_predicate">time_<wbr>range_<wbr>to_<wbr>predicate</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Converts time range to predicates so that rows outside the range will be filtered.</dd><dt><a class="fn" href="fn.ts_to_lit.html" title="fn mito2::compaction::ts_to_lit">ts_<wbr>to_<wbr>lit</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>