Deploying to gh-pages from @ GreptimeTeam/greptimedb@af396e60a3 🚀

This commit is contained in:
github-merge-queue[bot]
2026-10-15 05:28:07 +00:00
commit e5ae072cb2
25952 changed files with 3013221 additions and 0 deletions
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+3
View File
@@ -0,0 +1,3 @@
<!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="Region Engine’s definition"><title>store_api::region_engine - 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="store_api" 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 region_engine</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../store_api/index.html">store_<wbr>api</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 region_<wbr>engine</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="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</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 store_<wbr>api</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">store_api</a></div><h1>Module <span>region_<wbr>engine</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/store_api/region_engine.rs.html#15-1162">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Region Engine’s definition</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.GrantedRegion.html" title="struct store_api::region_engine::GrantedRegion">Granted<wbr>Region</a></dt><dt><a class="struct" href="struct.MitoCopyRegionFromRequest.html" title="struct store_api::region_engine::MitoCopyRegionFromRequest">Mito<wbr>Copy<wbr>Region<wbr>From<wbr>Request</a></dt><dd>Request to copy files from a source region to a target region.</dd><dt><a class="struct" href="struct.MitoCopyRegionFromResponse.html" title="struct store_api::region_engine::MitoCopyRegionFromResponse">Mito<wbr>Copy<wbr>Region<wbr>From<wbr>Response</a></dt><dt><a class="struct" href="struct.PartitionRange.html" title="struct store_api::region_engine::PartitionRange">Partition<wbr>Range</a></dt><dd>Represents one data range within a partition</dd><dt><a class="struct" href="struct.PrepareRequest.html" title="struct store_api::region_engine::PrepareRequest">Prepare<wbr>Request</a></dt><dd>Request to override the scanner properties.</dd><dt><a class="struct" href="struct.QueryScanContext.html" title="struct store_api::region_engine::QueryScanContext">Query<wbr>Scan<wbr>Context</a></dt><dd>Necessary context of the query for the scanner.</dd><dt><a class="struct" href="struct.RegionStatistic.html" title="struct store_api::region_engine::RegionStatistic">Region<wbr>Statistic</a></dt><dd>Represents the statistics of a region.</dd><dt><a class="struct" href="struct.RemapManifestsRequest.html" title="struct store_api::region_engine::RemapManifestsRequest">Remap<wbr>Manifests<wbr>Request</a></dt><dd>Request to remap manifests from old regions to new regions.</dd><dt><a class="struct" href="struct.RemapManifestsResponse.html" title="struct store_api::region_engine::RemapManifestsResponse">Remap<wbr>Manifests<wbr>Response</a></dt><dd>Response to remap manifests from old regions to new regions.</dd><dt><a class="struct" href="struct.ScannerProperties.html" title="struct store_api::region_engine::ScannerProperties">Scanner<wbr>Properties</a></dt><dd>Properties of the <a href="trait.RegionScanner.html" title="trait store_api::region_engine::RegionScanner">RegionScanner</a>.</dd><dt><a class="struct" href="struct.SetRegionRoleStateRequest.html" title="struct store_api::region_engine::SetRegionRoleStateRequest">SetRegion<wbr>Role<wbr>State<wbr>Request</a></dt><dd>The request to set region role state.</dd><dt><a class="struct" href="struct.SinglePartitionScanner.html" title="struct store_api::region_engine::SinglePartitionScanner">Single<wbr>Partition<wbr>Scanner</a></dt><dd>A <a href="trait.RegionScanner.html" title="trait store_api::region_engine::RegionScanner">RegionScanner</a> that only scans a single partition.</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.RegionManifestInfo.html" title="enum store_api::region_engine::RegionManifestInfo">Region<wbr>Manifest<wbr>Info</a></dt><dd>The manifest info of a region.</dd><dt><a class="enum" href="enum.RegionRole.html" title="enum store_api::region_engine::RegionRole">Region<wbr>Role</a></dt><dd>The role of the region.
TODO(weny): rename it to <code>RegionRoleState</code></dd><dt><a class="enum" href="enum.ScannerPartitioning.html" title="enum store_api::region_engine::ScannerPartitioning">Scanner<wbr>Partitioning</a></dt><dd>Output partition properties of the <a href="trait.RegionScanner.html" title="trait store_api::region_engine::RegionScanner">RegionScanner</a>.</dd><dt><a class="enum" href="enum.SetRegionRoleStateResponse.html" title="enum store_api::region_engine::SetRegionRoleStateResponse">SetRegion<wbr>Role<wbr>State<wbr>Response</a></dt><dd>The response of setting region role state.</dd><dt><a class="enum" href="enum.SetRegionRoleStateSuccess.html" title="enum store_api::region_engine::SetRegionRoleStateSuccess">SetRegion<wbr>Role<wbr>State<wbr>Success</a></dt><dd>The success response of setting region role state.</dd><dt><a class="enum" href="enum.SettableRegionRoleState.html" title="enum store_api::region_engine::SettableRegionRoleState">Settable<wbr>Region<wbr>Role<wbr>State</a></dt><dd>The settable region role state.</dd><dt><a class="enum" href="enum.SyncRegionFromRequest.html" title="enum store_api::region_engine::SyncRegionFromRequest">Sync<wbr>Region<wbr>From<wbr>Request</a></dt><dd>Request to sync the region from a manifest or a region.</dd><dt><a class="enum" href="enum.SyncRegionFromResponse.html" title="enum store_api::region_engine::SyncRegionFromResponse">Sync<wbr>Region<wbr>From<wbr>Response</a></dt><dd>The response of syncing the region.</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.RegionEngine.html" title="trait store_api::region_engine::RegionEngine">Region<wbr>Engine</a></dt><dt><a class="trait" href="trait.RegionScanner.html" title="trait store_api::region_engine::RegionScanner">Region<wbr>Scanner</a></dt><dd>A scanner that provides a way to scan the region concurrently.</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.BatchResponses.html" title="type store_api::region_engine::BatchResponses">Batch<wbr>Responses</a></dt><dt><a class="type" href="type.RegionEngineRef.html" title="type store_api::region_engine::RegionEngineRef">Region<wbr>Engine<wbr>Ref</a></dt><dt><a class="type" href="type.RegionScannerRef.html" title="type store_api::region_engine::RegionScannerRef">Region<wbr>Scanner<wbr>Ref</a></dt></dl></section></div></main></body></html>
+1
View File
@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"enum":["RegionManifestInfo","RegionRole","ScannerPartitioning","SetRegionRoleStateResponse","SetRegionRoleStateSuccess","SettableRegionRoleState","SyncRegionFromRequest","SyncRegionFromResponse"],"struct":["GrantedRegion","MitoCopyRegionFromRequest","MitoCopyRegionFromResponse","PartitionRange","PrepareRequest","QueryScanContext","RegionStatistic","RemapManifestsRequest","RemapManifestsResponse","ScannerProperties","SetRegionRoleStateRequest","SinglePartitionScanner"],"trait":["RegionEngine","RegionScanner"],"type":["BatchResponses","RegionEngineRef","RegionScannerRef"]};
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,59 @@
<!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="A scanner that provides a way to scan the region concurrently."><title>RegionScanner in store_api::region_engine - 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="store_api" 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 trait"><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="#">RegionScanner</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../store_api/index.html">store_<wbr>api</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="#">Region<wbr>Scanner</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.add_dyn_filter_to_predicate" title="add_dyn_filter_to_predicate">add_dyn_filter_to_predicate</a></li><li><a href="#tymethod.has_predicate_without_region" title="has_predicate_without_region">has_predicate_without_region</a></li><li><a href="#tymethod.metadata" title="metadata">metadata</a></li><li><a href="#tymethod.name" title="name">name</a></li><li><a href="#tymethod.prepare" title="prepare">prepare</a></li><li><a href="#tymethod.properties" title="properties">properties</a></li><li><a href="#tymethod.scan_partition" title="scan_partition">scan_partition</a></li><li><a href="#tymethod.schema" title="schema">schema</a></li><li><a href="#tymethod.set_logical_region" title="set_logical_region">set_logical_region</a></li><li><a href="#tymethod.set_query_load_region_id" title="set_query_load_region_id">set_query_load_region_id</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.reset_state" title="reset_state">reset_state</a></li><li><a href="#method.snapshot_sequence" title="snapshot_sequence">snapshot_sequence</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In store_<wbr>api::<wbr>region_<wbr>engine</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">store_api</a>::<wbr><a href="index.html">region_engine</a></div><h1>Trait <span class="trait">Region<wbr>Scanner</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/store_api/region_engine.rs.html#474-531">Source</a> </span></div><pre class="rust item-decl"><code>pub trait RegionScanner:
<a class="trait" href="https://doc.rust-lang.org/1.98.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>
+ DisplayAs
+ <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> {
// Required methods
fn <a href="#tymethod.name" class="fn">name</a>(&amp;self) -&gt; &amp;<a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.str.html">str</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.properties" class="fn">properties</a>(&amp;self) -&gt; &amp;<a class="struct" href="struct.ScannerProperties.html" title="struct store_api::region_engine::ScannerProperties">ScannerProperties</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.schema" class="fn">schema</a>(&amp;self) -&gt; <a class="type" href="../storage/type.SchemaRef.html" title="type store_api::storage::SchemaRef">SchemaRef</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.metadata" class="fn">metadata</a>(&amp;self) -&gt; <a class="type" href="../metadata/type.RegionMetadataRef.html" title="type store_api::metadata::RegionMetadataRef">RegionMetadataRef</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.prepare" class="fn">prepare</a>(&amp;mut self, request: <a class="struct" href="struct.PrepareRequest.html" title="struct store_api::region_engine::PrepareRequest">PrepareRequest</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.unit.html">()</a>, BoxedError&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.scan_partition" class="fn">scan_partition</a>(
&amp;self,
ctx: &amp;<a class="struct" href="struct.QueryScanContext.html" title="struct store_api::region_engine::QueryScanContext">QueryScanContext</a>,
metrics_set: &amp;ExecutionPlanMetricsSet,
partition: <a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.usize.html">usize</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;SendableRecordBatchStream, BoxedError&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.has_predicate_without_region" class="fn">has_predicate_without_region</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.bool.html">bool</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.add_dyn_filter_to_predicate" class="fn">add_dyn_filter_to_predicate</a>(
&amp;mut self,
filter_exprs: <a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;dyn PhysicalExpr&gt;&gt;,
) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.bool.html">bool</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.set_logical_region" class="fn">set_logical_region</a>(&amp;mut self, logical_region: <a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.bool.html">bool</a>);
<span class="item-spacer"></span> fn <a href="#tymethod.set_query_load_region_id" class="fn">set_query_load_region_id</a>(&amp;mut self, region_id: <a class="struct" href="../storage/struct.RegionId.html" title="struct store_api::storage::RegionId">RegionId</a>);
// Provided methods
fn <a href="#method.reset_state" class="fn">reset_state</a>(&amp;mut self) { ... }
<span class="item-spacer"></span> fn <a href="#method.snapshot_sequence" class="fn">snapshot_sequence</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../storage/type.SequenceNumber.html" title="type store_api::storage::SequenceNumber">SequenceNumber</a>&gt; { ... }
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A scanner that provides a way to scan the region concurrently.</p>
<p>The scanner splits the region into partitions so that each partition can be scanned concurrently.
You can use this trait to implement an <a href="datafusion_physical_plan::ExecutionPlan"><code>ExecutionPlan</code></a>.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.name" class="method"><a class="src rightside" href="../../src/store_api/region_engine.rs.html#475">Source</a><h4 class="code-header">fn <a href="#tymethod.name" class="fn">name</a>(&amp;self) -&gt; &amp;<a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.str.html">str</a></h4></section><details class="toggle method-toggle" open><summary><section id="tymethod.properties" class="method"><a class="src rightside" href="../../src/store_api/region_engine.rs.html#478">Source</a><h4 class="code-header">fn <a href="#tymethod.properties" class="fn">properties</a>(&amp;self) -&gt; &amp;<a class="struct" href="struct.ScannerProperties.html" title="struct store_api::region_engine::ScannerProperties">ScannerProperties</a></h4></section></summary><div class="docblock"><p>Returns the properties of the scanner.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.schema" class="method"><a class="src rightside" href="../../src/store_api/region_engine.rs.html#481">Source</a><h4 class="code-header">fn <a href="#tymethod.schema" class="fn">schema</a>(&amp;self) -&gt; <a class="type" href="../storage/type.SchemaRef.html" title="type store_api::storage::SchemaRef">SchemaRef</a></h4></section></summary><div class="docblock"><p>Returns the schema of the record batches.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.metadata" class="method"><a class="src rightside" href="../../src/store_api/region_engine.rs.html#484">Source</a><h4 class="code-header">fn <a href="#tymethod.metadata" class="fn">metadata</a>(&amp;self) -&gt; <a class="type" href="../metadata/type.RegionMetadataRef.html" title="type store_api::metadata::RegionMetadataRef">RegionMetadataRef</a></h4></section></summary><div class="docblock"><p>Returns the metadata of the region.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.prepare" class="method"><a class="src rightside" href="../../src/store_api/region_engine.rs.html#489">Source</a><h4 class="code-header">fn <a href="#tymethod.prepare" class="fn">prepare</a>(&amp;mut self, request: <a class="struct" href="struct.PrepareRequest.html" title="struct store_api::region_engine::PrepareRequest">PrepareRequest</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.unit.html">()</a>, BoxedError&gt;</h4></section></summary><div class="docblock"><p>Prepares the scanner with the given partition ranges.</p>
<p>This method is for the planner to adjust the scanner’s behavior based on the partition ranges.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.scan_partition" class="method"><a class="src rightside" href="../../src/store_api/region_engine.rs.html#495-500">Source</a><h4 class="code-header">fn <a href="#tymethod.scan_partition" class="fn">scan_partition</a>(
&amp;self,
ctx: &amp;<a class="struct" href="struct.QueryScanContext.html" title="struct store_api::region_engine::QueryScanContext">QueryScanContext</a>,
metrics_set: &amp;ExecutionPlanMetricsSet,
partition: <a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.usize.html">usize</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;SendableRecordBatchStream, BoxedError&gt;</h4></section></summary><div class="docblock"><p>Scans the partition and returns a stream of record batches.</p>
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
<p>Panics if the <code>partition</code> is out of bound.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.has_predicate_without_region" class="method"><a class="src rightside" href="../../src/store_api/region_engine.rs.html#503">Source</a><h4 class="code-header">fn <a href="#tymethod.has_predicate_without_region" class="fn">has_predicate_without_region</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Check if there is any predicate exclude region partition exprs that may be executed in this scanner.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.add_dyn_filter_to_predicate" class="method"><a class="src rightside" href="../../src/store_api/region_engine.rs.html#509-512">Source</a><h4 class="code-header">fn <a href="#tymethod.add_dyn_filter_to_predicate" class="fn">add_dyn_filter_to_predicate</a>(
&amp;mut self,
filter_exprs: <a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;dyn PhysicalExpr&gt;&gt;,
) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.bool.html">bool</a>&gt;</h4></section></summary><div class="docblock"><p>Add the given dynamic filter expressions to the predicate of the scanner.
Returns a vector of booleans indicating which filter expressions were applied.
true indicates the filter expression was applied(will be use by scanner to prune by stat for row group),
false otherwise.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.set_logical_region" class="method"><a class="src rightside" href="../../src/store_api/region_engine.rs.html#523">Source</a><h4 class="code-header">fn <a href="#tymethod.set_logical_region" class="fn">set_logical_region</a>(&amp;mut self, logical_region: <a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.bool.html">bool</a>)</h4></section></summary><div class="docblock"><p>Sets whether the scanner is reading a logical region.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.set_query_load_region_id" class="method"><a class="src rightside" href="../../src/store_api/region_engine.rs.html#526">Source</a><h4 class="code-header">fn <a href="#tymethod.set_query_load_region_id" class="fn">set_query_load_region_id</a>(&amp;mut self, region_id: <a class="struct" href="../storage/struct.RegionId.html" title="struct store_api::storage::RegionId">RegionId</a>)</h4></section></summary><div class="docblock"><p>Sets the region id that should receive query-load metrics.</p>
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.reset_state" class="method"><a class="src rightside" href="../../src/store_api/region_engine.rs.html#520">Source</a><h4 class="code-header">fn <a href="#method.reset_state" class="fn">reset_state</a>(&amp;mut self)</h4></section></summary><div class="docblock"><p>Resets execution state after streams from the previous execution have been dropped.</p>
<p>Callers must not concurrently execute, reset, or install filters through scanner aliases.
Implementations retaining dynamic predicates must discard them and derived pruning state,
while preserving static predicates, the source snapshot, and prepared properties.
The default is a no-op and does not make inherently one-shot sources replayable.</p>
</div></details><section id="method.snapshot_sequence" class="method"><a class="src rightside" href="../../src/store_api/region_engine.rs.html#528-530">Source</a><h4 class="code-header">fn <a href="#method.snapshot_sequence" class="fn">snapshot_sequence</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../storage/type.SequenceNumber.html" title="type store_api::storage::SequenceNumber">SequenceNumber</a>&gt;</h4></section></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait <b>is</b> <a href="https://doc.rust-lang.org/1.98.1/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety".</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><div class="negative-marker"></div><section id="impl-RegionScanner-for-SinglePartitionScanner" class="impl"><a class="src rightside" href="../../src/store_api/region_engine.rs.html#1099-1156">Source</a><a href="#impl-RegionScanner-for-SinglePartitionScanner" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RegionScanner.html" title="trait store_api::region_engine::RegionScanner">RegionScanner</a> for <a class="struct" href="struct.SinglePartitionScanner.html" title="struct store_api::region_engine::SinglePartitionScanner">SinglePartitionScanner</a></h3></section></div><script src="../../trait.impl/store_api/region_engine/trait.RegionScanner.js" async></script></section></div></main></body></html>
@@ -0,0 +1 @@
<!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 `BatchResponses` type in crate `store_api`."><title>BatchResponses in store_api::region_engine - 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="store_api" 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 type"><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="#">BatchResponses</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../store_api/index.html">store_<wbr>api</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="#">Batch<wbr>Responses</a></h2><h3><a href="#aliased-type">Aliased Type</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In store_<wbr>api::<wbr>region_<wbr>engine</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">store_api</a>::<wbr><a href="index.html">region_engine</a></div><h1>Type Alias <span class="type">Batch<wbr>Responses</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/store_api/region_engine.rs.html#535">Source</a> </span></div><pre class="rust item-decl"><code>pub type BatchResponses = <a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;(<a class="struct" href="../storage/struct.RegionId.html" title="struct store_api::storage::RegionId">RegionId</a>, <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;RegionResponse, BoxedError&gt;)&gt;;</code></pre><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>pub struct BatchResponses { <span class="comment">/* private fields */</span> }</code></pre><script src="../../type.impl/alloc/vec/struct.Vec.js" data-self-path="store_api::region_engine::BatchResponses" async></script></section></div></main></body></html>
@@ -0,0 +1 @@
<!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 `RegionEngineRef` type in crate `store_api`."><title>RegionEngineRef in store_api::region_engine - 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="store_api" 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 type"><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="#">RegionEngineRef</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../store_api/index.html">store_<wbr>api</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="#">Region<wbr>Engine<wbr>Ref</a></h2><h3><a href="#aliased-type">Aliased Type</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In store_<wbr>api::<wbr>region_<wbr>engine</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">store_api</a>::<wbr><a href="index.html">region_engine</a></div><h1>Type Alias <span class="type">Region<wbr>Engine<wbr>Ref</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/store_api/region_engine.rs.html#1063">Source</a> </span></div><pre class="rust item-decl"><code>pub type RegionEngineRef = <a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;dyn <a class="trait" href="trait.RegionEngine.html" title="trait store_api::region_engine::RegionEngine">RegionEngine</a>&gt;;</code></pre><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>pub struct RegionEngineRef { <span class="comment">/* private fields */</span> }</code></pre><script src="../../type.impl/alloc/sync/struct.Arc.js" data-self-path="store_api::region_engine::RegionEngineRef" async></script></section></div></main></body></html>
@@ -0,0 +1 @@
<!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 `RegionScannerRef` type in crate `store_api`."><title>RegionScannerRef in store_api::region_engine - 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="store_api" 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 type"><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="#">RegionScannerRef</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../store_api/index.html">store_<wbr>api</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="#">Region<wbr>Scanner<wbr>Ref</a></h2><h3><a href="#aliased-type">Aliased Type</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In store_<wbr>api::<wbr>region_<wbr>engine</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">store_api</a>::<wbr><a href="index.html">region_engine</a></div><h1>Type Alias <span class="type">Region<wbr>Scanner<wbr>Ref</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/store_api/region_engine.rs.html#533">Source</a> </span></div><pre class="rust item-decl"><code>pub type RegionScannerRef = <a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="trait.RegionScanner.html" title="trait store_api::region_engine::RegionScanner">RegionScanner</a>&gt;;</code></pre><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>pub struct RegionScannerRef(<span class="comment">/* private fields */</span>);</code></pre><script src="../../type.impl/alloc/boxed/struct.Box.js" data-self-path="store_api::region_engine::RegionScannerRef" async></script></section></div></main></body></html>