mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-10-12 15:02:32 +00:00
47 lines
11 KiB
HTML
47 lines
11 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="API documentation for the Rust `BatchingExecution` trait in crate `flow`."><title>BatchingExecution in flow - 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="flow" 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="#">BatchingExecution</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../flow/index.html">flow</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="#">Batching<wbr>Execution</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.execute_once" title="execute_once">execute_once</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.rewrite_plan" title="rewrite_plan">rewrite_plan</a></li><li><a href="#method.stop" title="stop">stop</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate flow</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">flow</a></div><h1>Trait <span class="trait">Batching<wbr>Execution</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/flow/batching_mode/batching_execution.rs.html#28-49">Source</a> </span></div><pre class="rust item-decl"><code>pub trait BatchingExecution:
|
|
<a class="trait" href="https://doc.rust-lang.org/1.98.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>
|
|
+ <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>
|
|
+ 'static {
|
|
// Required method
|
|
fn <a href="#tymethod.execute_once" class="fn">execute_once</a><'life0, 'life1, 'life2, 'async_trait>(
|
|
self: <a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>,
|
|
guard: <a class="struct" href="struct.BatchingExecutionGuard.html" title="struct flow::BatchingExecutionGuard">BatchingExecutionGuard</a>,
|
|
task: &'life0 <a class="struct" href="struct.BatchingTask.html" title="struct flow::BatchingTask">BatchingTask</a>,
|
|
engine: &'life1 <a class="type" href="../query/query_engine/type.QueryEngineRef.html" title="type query::query_engine::QueryEngineRef">QueryEngineRef</a>,
|
|
frontend: &'life2 <a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="enum" href="enum.FrontendClient.html" title="enum flow::FrontendClient">FrontendClient</a>>,
|
|
max_window_cnt: <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.usize.html">usize</a>>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/1.98.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="struct" href="struct.ExecuteOnceOutcome.html" title="struct flow::ExecuteOnceOutcome">ExecuteOnceOutcome</a>> + <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
|
<span class="where">where Self: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait,
|
|
'life2: 'async_trait</span>;
|
|
|
|
// Provided methods
|
|
fn <a href="#method.rewrite_plan" class="fn">rewrite_plan</a>(
|
|
&self,
|
|
_task: &<a class="struct" href="struct.BatchingTask.html" title="struct flow::BatchingTask">BatchingTask</a>,
|
|
plan: LogicalPlan,
|
|
) -> <a class="type" href="error/type.Result.html" title="type flow::error::Result">Result</a><LogicalPlan> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.stop" class="fn">stop</a>(&self) { ... }
|
|
}</code></pre><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.execute_once" class="method"><a class="src rightside" href="../src/flow/batching_mode/batching_execution.rs.html#32-39">Source</a><h4 class="code-header">fn <a href="#tymethod.execute_once" class="fn">execute_once</a><'life0, 'life1, 'life2, 'async_trait>(
|
|
self: <a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>,
|
|
guard: <a class="struct" href="struct.BatchingExecutionGuard.html" title="struct flow::BatchingExecutionGuard">BatchingExecutionGuard</a>,
|
|
task: &'life0 <a class="struct" href="struct.BatchingTask.html" title="struct flow::BatchingTask">BatchingTask</a>,
|
|
engine: &'life1 <a class="type" href="../query/query_engine/type.QueryEngineRef.html" title="type query::query_engine::QueryEngineRef">QueryEngineRef</a>,
|
|
frontend: &'life2 <a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="enum" href="enum.FrontendClient.html" title="enum flow::FrontendClient">FrontendClient</a>>,
|
|
max_window_cnt: <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.usize.html">usize</a>>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/1.98.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="struct" href="struct.ExecuteOnceOutcome.html" title="struct flow::ExecuteOnceOutcome">ExecuteOnceOutcome</a>> + <a class="trait" href="https://doc.rust-lang.org/1.98.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
|
Self: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait,
|
|
'life2: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Execute one round while retaining the guard through all task-state updates.
|
|
An implementation that continues after caller cancellation must retain the
|
|
guard with that work and make it stoppable through <a href="trait.BatchingExecution.html#method.stop" title="method flow::BatchingExecution::stop"><code>Self::stop</code></a>.</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.rewrite_plan" class="method"><a class="src rightside" href="../src/flow/batching_mode/batching_execution.rs.html#42-44">Source</a><h4 class="code-header">fn <a href="#method.rewrite_plan" class="fn">rewrite_plan</a>(
|
|
&self,
|
|
_task: &<a class="struct" href="struct.BatchingTask.html" title="struct flow::BatchingTask">BatchingTask</a>,
|
|
plan: LogicalPlan,
|
|
) -> <a class="type" href="error/type.Result.html" title="type flow::error::Result">Result</a><LogicalPlan></h4></section></summary><div class="docblock"><p>Rewrite the completed query plan after incremental merging and before execution.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.stop" class="method"><a class="src rightside" href="../src/flow/batching_mode/batching_execution.rs.html#48">Source</a><h4 class="code-header">fn <a href="#method.stop" class="fn">stop</a>(&self)</h4></section></summary><div class="docblock"><p>Retire this execution instance, rejecting new work and requesting that any
|
|
retained local work stop. This is not an acknowledgement of remote quiescence.</p>
|
|
</div></details></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><script src="../trait.impl/flow/batching_mode/batching_execution/trait.BatchingExecution.js" async></script></section></div></main></body></html> |