mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-10 15:22:56 +00:00
71 lines
17 KiB
HTML
71 lines
17 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="SqlQueryInterceptor can track life cycle of a sql query and customize or abort its execution at given point."><title>SqlQueryInterceptor in servers::interceptor - 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-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="servers" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.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"><!--[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="#">SqlQueryInterceptor</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../servers/index.html">servers</a><span class="version">1.0.0-beta.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">SqlQuery<wbr>Interceptor</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.post_execute" title="post_execute">post_execute</a></li><li><a href="#method.post_parsing" title="post_parsing">post_parsing</a></li><li><a href="#method.pre_execute" title="pre_execute">pre_execute</a></li><li><a href="#method.pre_parsing" title="pre_parsing">pre_parsing</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-SqlQueryInterceptor-for-Option%3C%26Arc%3Cdyn+SqlQueryInterceptor%3CError+=+E%3E+%2B+Send+%2B+Sync%3E%3E" title="Option<&SqlQueryInterceptorRef<E>>">Option<&SqlQueryInterceptorRef<E>></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In servers::<wbr>interceptor</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">servers</a>::<wbr><a href="index.html">interceptor</a></div><h1>Trait <span class="trait">SqlQuery<wbr>Interceptor</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/servers/interceptor.rs.html#34-77">Source</a> </span></div><pre class="rust item-decl"><code>pub trait SqlQueryInterceptor {
|
|
type <a href="#associatedtype.Error" class="associatedtype">Error</a>: ErrorExt;
|
|
|
|
// Provided methods
|
|
fn <a href="#method.pre_parsing" class="fn">pre_parsing</a><'a>(
|
|
&self,
|
|
query: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'a, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>, Self::<a class="associatedtype" href="trait.SqlQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::SqlQueryInterceptor::Error">Error</a>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.post_parsing" class="fn">post_parsing</a>(
|
|
&self,
|
|
statements: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><Statement>,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><Statement>, Self::<a class="associatedtype" href="trait.SqlQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::SqlQueryInterceptor::Error">Error</a>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.pre_execute" class="fn">pre_execute</a>(
|
|
&self,
|
|
_statement: &Statement,
|
|
_plan: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&LogicalPlan>,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.SqlQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::SqlQueryInterceptor::Error">Error</a>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.post_execute" class="fn">post_execute</a>(
|
|
&self,
|
|
output: Output,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Output, Self::<a class="associatedtype" href="trait.SqlQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::SqlQueryInterceptor::Error">Error</a>> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>SqlQueryInterceptor can track life cycle of a sql query and customize or
|
|
abort its execution at given point.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.Error" class="method"><a class="src rightside" href="../../src/servers/interceptor.rs.html#35">Source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a>: ErrorExt</h4></section></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.pre_parsing" class="method"><a class="src rightside" href="../../src/servers/interceptor.rs.html#39-45">Source</a><h4 class="code-header">fn <a href="#method.pre_parsing" class="fn">pre_parsing</a><'a>(
|
|
&self,
|
|
query: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'a, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>, Self::<a class="associatedtype" href="trait.SqlQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::SqlQueryInterceptor::Error">Error</a>></h4></section></summary><div class="docblock"><p>Called before a query string is parsed into sql statements.
|
|
The implementation is allowed to change the sql string if needed.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.post_parsing" class="method"><a class="src rightside" href="../../src/servers/interceptor.rs.html#50-56">Source</a><h4 class="code-header">fn <a href="#method.post_parsing" class="fn">post_parsing</a>(
|
|
&self,
|
|
statements: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><Statement>,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><Statement>, Self::<a class="associatedtype" href="trait.SqlQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::SqlQueryInterceptor::Error">Error</a>></h4></section></summary><div class="docblock"><p>Called after sql is parsed into statements. This interceptor is called
|
|
on each statement and the implementation can alter the statement or
|
|
abort execution by raising an error.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.pre_execute" class="method"><a class="src rightside" href="../../src/servers/interceptor.rs.html#59-66">Source</a><h4 class="code-header">fn <a href="#method.pre_execute" class="fn">pre_execute</a>(
|
|
&self,
|
|
_statement: &Statement,
|
|
_plan: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&LogicalPlan>,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.SqlQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::SqlQueryInterceptor::Error">Error</a>></h4></section></summary><div class="docblock"><p>Called before sql is actually executed. This hook is not called at the moment.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.post_execute" class="method"><a class="src rightside" href="../../src/servers/interceptor.rs.html#70-76">Source</a><h4 class="code-header">fn <a href="#method.post_execute" class="fn">post_execute</a>(
|
|
&self,
|
|
output: Output,
|
|
_query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Output, Self::<a class="associatedtype" href="trait.SqlQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::SqlQueryInterceptor::Error">Error</a>></h4></section></summary><div class="docblock"><p>Called after execution finished. The implementation can modify the
|
|
output if needed.</p>
|
|
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-SqlQueryInterceptor-for-Option%3C%26Arc%3Cdyn+SqlQueryInterceptor%3CError+=+E%3E+%2B+Send+%2B+Sync%3E%3E" class="impl"><a class="src rightside" href="../../src/servers/interceptor.rs.html#82-136">Source</a><a href="#impl-SqlQueryInterceptor-for-Option%3C%26Arc%3Cdyn+SqlQueryInterceptor%3CError+=+E%3E+%2B+Send+%2B+Sync%3E%3E" class="anchor">§</a><h3 class="code-header">impl<E> <a class="trait" href="trait.SqlQueryInterceptor.html" title="trait servers::interceptor::SqlQueryInterceptor">SqlQueryInterceptor</a> for <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="type" href="type.SqlQueryInterceptorRef.html" title="type servers::interceptor::SqlQueryInterceptorRef">SqlQueryInterceptorRef</a><E>><div class="where">where
|
|
E: ErrorExt,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/servers/interceptor.rs.html#86">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = E</h4></section><section id="method.pre_parsing-1" class="method trait-impl"><a class="src rightside" href="../../src/servers/interceptor.rs.html#88-98">Source</a><a href="#method.pre_parsing-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.pre_parsing" class="fn">pre_parsing</a><'a>(
|
|
&self,
|
|
query: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
|
query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'a, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>, Self::<a class="associatedtype" href="trait.SqlQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::SqlQueryInterceptor::Error">Error</a>></h4></section><section id="method.post_parsing-1" class="method trait-impl"><a class="src rightside" href="../../src/servers/interceptor.rs.html#100-110">Source</a><a href="#method.post_parsing-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.post_parsing" class="fn">post_parsing</a>(
|
|
&self,
|
|
statements: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><Statement>,
|
|
query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><Statement>, Self::<a class="associatedtype" href="trait.SqlQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::SqlQueryInterceptor::Error">Error</a>></h4></section><section id="method.pre_execute-1" class="method trait-impl"><a class="src rightside" href="../../src/servers/interceptor.rs.html#112-123">Source</a><a href="#method.pre_execute-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.pre_execute" class="fn">pre_execute</a>(
|
|
&self,
|
|
statement: &Statement,
|
|
plan: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&LogicalPlan>,
|
|
query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.SqlQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::SqlQueryInterceptor::Error">Error</a>></h4></section><section id="method.post_execute-1" class="method trait-impl"><a class="src rightside" href="../../src/servers/interceptor.rs.html#125-135">Source</a><a href="#method.post_execute-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.post_execute" class="fn">post_execute</a>(
|
|
&self,
|
|
output: Output,
|
|
query_ctx: QueryContextRef,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Output, Self::<a class="associatedtype" href="trait.SqlQueryInterceptor.html#associatedtype.Error" title="type servers::interceptor::SqlQueryInterceptor::Error">Error</a>></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/servers/interceptor/trait.SqlQueryInterceptor.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html> |