mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-07-04 13:00:38 +00:00
13 lines
4.4 KiB
HTML
13 lines
4.4 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="Handler to stream partial `EXPLAIN ANALYZE VERBOSE` metrics as SSE."><title>sql_analyze_stream in servers::http::handler - 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="servers" 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="sidebar-items.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 fn"><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="#">sql_analyze_stream</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../servers/index.html">servers</a><span class="version">1.2.0</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In servers::<wbr>http::<wbr>handler</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">servers</a>::<wbr><a href="../index.html">http</a>::<wbr><a href="index.html">handler</a></div><h1>Function <span class="fn">sql_<wbr>analyze_<wbr>stream</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/http/handler.rs.html#205-208">Source</a> </span></div><pre class="rust item-decl"><code>pub async fn sql_analyze_stream(
|
||
__arg0: State<<a class="struct" href="../struct.ApiState.html" title="struct servers::http::ApiState">ApiState</a>>,
|
||
__arg1: Query<<a class="struct" href="struct.SqlQuery.html" title="struct servers::http::handler::SqlQuery">SqlQuery</a>>,
|
||
__arg2: Extension<QueryContext>,
|
||
form_params: <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Form<<a class="struct" href="struct.SqlQuery.html" title="struct servers::http::handler::SqlQuery">SqlQuery</a>>, FormRejection>,
|
||
) -> Response</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Handler to stream partial <code>EXPLAIN ANALYZE VERBOSE</code> metrics as SSE.</p>
|
||
<p>This experimental endpoint is POST-only SSE, so browser <code>EventSource</code> does
|
||
not apply. Each <code>metrics</code> event carries a complete snapshot (not a delta);
|
||
large snapshots are throttled but never truncated. <code>final</code>, <code>canceled</code>, and
|
||
<code>error</code> are terminal events. If the client disconnects it won’t receive a
|
||
<code>canceled</code> event, but the production frontend stream is dropped and
|
||
best-effort cancels the underlying query.</p>
|
||
</div></details></section></div></main></body></html> |