greptimedb/query/analyze/index.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="Customized `ANALYZE` plan that aware of MergeScanExec."><title>query::analyze - 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="query" 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 analyze</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../query/index.html">query</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 analyze</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="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate query</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">query</a></div><h1>Module <span>analyze</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/analyze.rs.html#15-562">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Customized <code>ANALYZE</code> plan that aware of <a href="../dist_plan/struct.MergeScanExec.html" title="struct query::dist_plan::MergeScanExec">MergeScanExec</a>.</p>
<p>The code skeleton is taken from <code>datafusion/physical-plan/src/analyze.rs</code></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.AnalyzeOutputBuilder.html" title="struct query::analyze::AnalyzeOutputBuilder">Analyze<wbr>Output<wbr>Builder</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Build the result [<code>DfRecordBatch</code>] of <code>ANALYZE</code></dd><dt><a class="struct" href="struct.DistAnalyzeExec.html" title="struct query::analyze::DistAnalyzeExec">Dist<wbr>Analyze<wbr>Exec</a></dt><dt><a class="struct" href="struct.JsonMetrics.html" title="struct query::analyze::JsonMetrics">Json<wbr>Metrics</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></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.NODE.html" title="constant query::analyze::NODE">NODE</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.PLAN.html" title="constant query::analyze::PLAN">PLAN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.STAGE.html" title="constant query::analyze::STAGE">STAGE</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></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::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.create_output_batch.html" title="fn query::analyze::create_output_batch">create_<wbr>output_<wbr>batch</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Creates the output of AnalyzeExec as a RecordBatch</dd><dt><a class="fn" href="fn.dist_analyze_output_schema.html" title="fn query::analyze::dist_analyze_output_schema">dist_<wbr>analyze_<wbr>output_<wbr>schema</a></dt><dd>Fixed output schema of <a href="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> plan’s.</dd><dt><a class="fn" href="fn.metrics_to_string.html" title="fn query::analyze::metrics_to_string">metrics_<wbr>to_<wbr>string</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>