Files
greptimedb/query/index.html
T

4 lines
11 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 `query` crate."><title>query - 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="query" 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="../crates.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 crate"><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="#">Crate query</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../query/index.html">query</a><span class="version">1.3.0-alpha.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>query</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/query/lib.rs.html#15-52">Source</a> </span></div><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.DfContextProviderAdapter"><code>pub use crate::datafusion::<a class="struct" href="datafusion/struct.DfContextProviderAdapter.html" title="struct query::datafusion::DfContextProviderAdapter">DfContextProviderAdapter</a>;</code></dt><dt id="reexport.QueryEngine"><code>pub use crate::query_engine::<a class="trait" href="query_engine/trait.QueryEngine.html" title="trait query::query_engine::QueryEngine">QueryEngine</a>;</code></dt><dt id="reexport.QueryEngineContext"><code>pub use crate::query_engine::<a class="struct" href="query_engine/struct.QueryEngineContext.html" title="struct query::query_engine::QueryEngineContext">QueryEngineContext</a>;</code></dt><dt id="reexport.QueryEngineFactory"><code>pub use crate::query_engine::<a class="struct" href="query_engine/struct.QueryEngineFactory.html" title="struct query::query_engine::QueryEngineFactory">QueryEngineFactory</a>;</code></dt><dt id="reexport.QueryEngineRef"><code>pub use crate::query_engine::<a class="type" href="query_engine/type.QueryEngineRef.html" title="type query::query_engine::QueryEngineRef">QueryEngineRef</a>;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="analyze/index.html" title="mod query::analyze">analyze</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Customized <code>ANALYZE</code> plan that aware of <a href="dist_plan/struct.MergeScanExec.html" title="struct query::dist_plan::MergeScanExec">MergeScanExec</a>.</dd><dt><a class="mod" href="datafusion/index.html" title="mod query::datafusion">datafusion</a></dt><dd>Planner, QueryEngine implementations based on DataFusion.</dd><dt><a class="mod" href="dist_plan/index.html" title="mod query::dist_plan">dist_<wbr>plan</a></dt><dt><a class="mod" href="dummy_catalog/index.html" title="mod query::dummy_catalog">dummy_<wbr>catalog</a></dt><dd>Dummy catalog for region server.</dd><dt><a class="mod" href="error/index.html" title="mod query::error">error</a></dt><dt><a class="mod" href="executor/index.html" title="mod query::executor">executor</a></dt><dt><a class="mod" href="log_query/index.html" title="mod query::log_query">log_<wbr>query</a></dt><dt><a class="mod" href="metrics/index.html" title="mod query::metrics">metrics</a></dt><dt><a class="mod" href="optimizer/index.html" title="mod query::optimizer">optimizer</a></dt><dt><a class="mod" href="options/index.html" title="mod query::options">options</a></dt><dt><a class="mod" href="parser/index.html" title="mod query::parser">parser</a></dt><dt><a class="mod" href="part_sort/index.html" title="mod query::part_sort">part_<wbr>sort</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Module for sorting input data within each [<code>PartitionRange</code>].</dd><dt><a class="mod" href="physical_wrapper/index.html" title="mod query::physical_wrapper">physical_<wbr>wrapper</a></dt><dt><a class="mod" href="plan/index.html" title="mod query::plan">plan</a></dt><dt><a class="mod" href="planner/index.html" title="mod query::planner">planner</a></dt><dt><a class="mod" href="promql/index.html" title="mod query::promql">promql</a></dt><dt><a class="mod" href="query_engine/index.html" title="mod query::query_engine">query_<wbr>engine</a></dt><dt><a class="mod" href="range_select/index.html" title="mod query::range_select">range_<wbr>select</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="region_query/index.html" title="mod query::region_query">region_<wbr>query</a></dt><dt><a class="mod" href="sql/index.html" title="mod query::sql">sql</a></dt><dt><a class="mod" href="window_sort/index.html" title="mod query::window_sort">window_<wbr>sort</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A physical plan for window sort(Which is sorting multiple sorted ranges according to input <code>PartitionRange</code>).</dd></dl><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.array_iter_helper.html" title="macro query::array_iter_helper">array_<wbr>iter_<wbr>helper</a></dt><dd>Get an iterator from a primitive array.</dd><dt><a class="macro" href="macro.downcast_ts_array.html" title="macro query::downcast_ts_array">downcast_<wbr>ts_<wbr>array</a></dt><dd>Downcast a temporal array to a specific type</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.analyze_plan_metrics_to_json_value.html" title="fn query::analyze_plan_metrics_to_json_value">analyze_<wbr>plan_<wbr>metrics_<wbr>to_<wbr>json_<wbr>value</a></dt><dd>Returns verbose analyze metrics as JSON values using the same <code>JsonMetrics</code> shape
as <code>EXPLAIN ANALYZE VERBOSE FORMAT JSON</code>.</dd><dt><a class="fn" href="fn.dist_analyze_output_schema.html" title="fn query::dist_analyze_output_schema">dist_<wbr>analyze_<wbr>output_<wbr>schema</a></dt><dd>Fixed output schema of <a href="analyze/struct.DistAnalyzeExec.html" title="struct query::analyze::DistAnalyzeExec"><code>DistAnalyzeExec</code></a>, for <code>Describe</code> handlers:
execution rewrites the plan in <code>optimize_physical_plan</code>, so this schema
differs from the logical <code>Analyze</code> plans.</dd></dl><script type="text/json" id="notable-traits-data">{"<Arc<S> as Service<Request>>::Future":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</div><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</div>","<Arc<W> as MakeWriter<'a>>::Writer":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</div><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</div>"}</script></section></div></main></body></html>