mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-15 12:30:38 +00:00
4 lines
10 KiB
HTML
4 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="Common structs and utilities for reading data."><title>mito2::read - 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 read</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 read</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="#constants" title="Constants">Constants</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</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>read</span> <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/read.rs.html#15-1945">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Common structs and utilities for reading data.</p>
|
|
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="batch_adapter/index.html" title="mod mito2::read::batch_adapter">batch_<wbr>adapter</a></dt><dd>Adapter to convert <a href="../memtable/type.BoxedBatchIterator.html" title="type mito2::memtable::BoxedBatchIterator"><code>BoxedBatchIterator</code></a> (primary key format) into an iterator
|
|
of flat-format Arrow [<code>RecordBatch</code>]es, allowing memtable iterators that only
|
|
produce <a href="struct.Batch.html" title="struct mito2::read::Batch"><code>Batch</code></a> to feed into the flat read pipeline.</dd><dt><a class="mod" href="compat/index.html" title="mod mito2::read::compat">compat</a></dt><dd>Utilities to adapt readers with different schema.</dd><dt><a class="mod" href="dedup/index.html" title="mod mito2::read::dedup">dedup</a></dt><dd>Utilities to remove duplicate rows from a sorted batch.</dd><dt><a class="mod" href="flat_dedup/index.html" title="mod mito2::read::flat_dedup">flat_<wbr>dedup</a></dt><dd>Dedup implementation for flat format.</dd><dt><a class="mod" href="flat_merge/index.html" title="mod mito2::read::flat_merge">flat_<wbr>merge</a></dt><dt><a class="mod" href="flat_projection/index.html" title="mod mito2::read::flat_projection">flat_<wbr>projection</a></dt><dd>Utilities for projection on flat format.</dd><dt><a class="mod" href="last_row/index.html" title="mod mito2::read::last_row">last_<wbr>row</a></dt><dd>Utilities to read the last row of each time series.</dd><dt><a class="mod" href="projection/index.html" title="mod mito2::read::projection">projection</a></dt><dd>Projection helpers shared by flat projection code.</dd><dt><a class="mod" href="prune/index.html" title="mod mito2::read::prune">prune</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="pruner/index.html" title="mod mito2::read::pruner">pruner</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Pruner for parallel file pruning across scanner partitions.</dd><dt><a class="mod" href="range/index.html" title="mod mito2::read::range">range</a></dt><dd>Structs for partition ranges.</dd><dt><a class="mod" href="range_cache/index.html" title="mod mito2::read::range_cache">range_<wbr>cache</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Utilities for the partition range scan result cache.</dd><dt><a class="mod" href="read_columns/index.html" title="mod mito2::read::read_columns">read_<wbr>columns</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="scan_region/index.html" title="mod mito2::read::scan_region">scan_<wbr>region</a></dt><dd>Scans a region according to the scan request.</dd><dt><a class="mod" href="scan_util/index.html" title="mod mito2::read::scan_util">scan_<wbr>util</a></dt><dd>Utilities for scanners.</dd><dt><a class="mod" href="seq_scan/index.html" title="mod mito2::read::seq_scan">seq_<wbr>scan</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Sequential scan.</dd><dt><a class="mod" href="series_scan/index.html" title="mod mito2::read::series_scan">series_<wbr>scan</a></dt><dd>Per-series scan implementation.</dd><dt><a class="mod" href="stream/index.html" title="mod mito2::read::stream">stream</a></dt><dt><a class="mod" href="unordered_scan/index.html" title="mod mito2::read::unordered_scan">unordered_<wbr>scan</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Unordered scanner.</dd></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.Batch.html" title="struct mito2::read::Batch">Batch</a></dt><dd>Storage internal representation of a batch of rows for a primary key (time series).</dd><dt><a class="struct" href="struct.BatchBuilder.html" title="struct mito2::read::BatchBuilder">Batch<wbr>Builder</a></dt><dd>Builder to build <a href="struct.Batch.html" title="struct mito2::read::Batch">Batch</a>.</dd><dt><a class="struct" href="struct.BatchChecker.html" title="struct mito2::read::BatchChecker">Batch<wbr>Checker</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>A struct to check the batch is monotonic.</dd><dt><a class="struct" href="struct.BatchColumn.html" title="struct mito2::read::BatchColumn">Batch<wbr>Column</a></dt><dd>A column in a <a href="struct.Batch.html" title="struct mito2::read::Batch">Batch</a>.</dd><dt><a class="struct" href="struct.FlatSource.html" title="struct mito2::read::FlatSource">Flat<wbr>Source</a></dt><dd>Async [RecordBatch] reader and iterator wrapper for flat format.</dd><dt><a class="struct" href="struct.ScannerMetrics.html" title="struct mito2::read::ScannerMetrics">Scanner<wbr>Metrics</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Local metrics for scanners.</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.FlatSourceInner.html" title="enum mito2::read::FlatSourceInner">Flat<wbr>Source<wbr>Inner</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="enum" href="enum.Source.html" title="enum mito2::read::Source">Source</a></dt><dd>Async <a href="struct.Batch.html" title="struct mito2::read::Batch">Batch</a> reader and iterator wrapper.</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.TIMESTAMP_KEY_LEN.html" title="constant mito2::read::TIMESTAMP_KEY_LEN">TIMESTAMP_<wbr>KEY_<wbr>LEN</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Len of timestamp in arrow row format.</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.BatchReader.html" title="trait mito2::read::BatchReader">Batch<wbr>Reader</a></dt><dd>Async batch reader.</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.concat_arrays.html" title="fn mito2::read::concat_arrays">concat_<wbr>arrays</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Helper function to concat arrays from <code>iter</code>.</dd></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.BoxedBatchReader.html" title="type mito2::read::BoxedBatchReader">Boxed<wbr>Batch<wbr>Reader</a></dt><dd>Pointer to <a href="trait.BatchReader.html" title="trait mito2::read::BatchReader">BatchReader</a>.</dd><dt><a class="type" href="type.BoxedBatchStream.html" title="type mito2::read::BoxedBatchStream">Boxed<wbr>Batch<wbr>Stream</a></dt><dd>Pointer to a stream that yields <a href="struct.Batch.html" title="struct mito2::read::Batch">Batch</a>.</dd><dt><a class="type" href="type.BoxedRecordBatchStream.html" title="type mito2::read::BoxedRecordBatchStream">Boxed<wbr>Record<wbr>Batch<wbr>Stream</a></dt><dd>Pointer to a stream that yields [RecordBatch].</dd></dl></section></div></main></body></html> |