Files
greptimedb/frontend/instance/index.html
2025-12-22 06:16:12 +00:00

4 lines
8.7 KiB
HTML
Raw Permalink 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 `instance` mod in crate `frontend`."><title>frontend::instance - 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="frontend" 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 mod"><!--[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 instance</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../frontend/index.html">frontend</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module instance</a></h2><h3><a href="#reexports">Module 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="#structs" title="Structs">Structs</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 frontend</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">frontend</a></div><h1>Module <span>instance</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/frontend/instance.rs.html#15-1328">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.StandaloneDatanodeManager"><code>pub use standalone::<a class="struct" href="standalone/struct.StandaloneDatanodeManager.html" title="struct frontend::instance::standalone::StandaloneDatanodeManager">StandaloneDatanodeManager</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="builder/index.html" title="mod frontend::instance::builder">builder</a></dt><dt><a class="mod" href="grpc/index.html" title="mod frontend::instance::grpc">grpc</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="influxdb/index.html" title="mod frontend::instance::influxdb">influxdb</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="jaeger/index.html" title="mod frontend::instance::jaeger">jaeger</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="log_handler/index.html" title="mod frontend::instance::log_handler">log_<wbr>handler</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="logs/index.html" title="mod frontend::instance::logs">logs</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="opentsdb/index.html" title="mod frontend::instance::opentsdb">opentsdb</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="otlp/index.html" title="mod frontend::instance::otlp">otlp</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="prom_store/index.html" title="mod frontend::instance::prom_store">prom_<wbr>store</a></dt><dt><a class="mod" href="promql/index.html" title="mod frontend::instance::promql">promql</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="region_query/index.html" title="mod frontend::instance::region_query">region_<wbr>query</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="standalone/index.html" title="mod frontend::instance::standalone">standalone</a></dt></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.validate_db_permission.html" title="macro frontend::instance::validate_db_permission">validate_<wbr>db_<wbr>permission</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Validate <code>stmt.database</code> permission if its presented.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Instance.html" title="struct frontend::instance::Instance">Instance</a></dt><dd>The frontend instance contains necessary components, and implements many
traits, like <a href="../../servers/query_handler/grpc/trait.GrpcQueryHandler.html" title="trait servers::query_handler::grpc::GrpcQueryHandler"><code>servers::query_handler::grpc::GrpcQueryHandler</code></a>,
<a href="../../servers/query_handler/sql/trait.SqlQueryHandler.html" title="trait servers::query_handler::sql::SqlQueryHandler"><code>servers::query_handler::sql::SqlQueryHandler</code></a>, etc.</dd><dt><a class="struct" href="struct.OTLP_LEGACY_DEFAULT_VALUE.html" title="struct frontend::instance::OTLP_LEGACY_DEFAULT_VALUE">OTLP_<wbr>LEGACY_<wbr>DEFAULT_<wbr>VALUE</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.attach_timeout.html" title="fn frontend::instance::attach_timeout">attach_<wbr>timeout</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.attach_timer.html" title="fn frontend::instance::attach_timer">attach_<wbr>timer</a></dt><dd>Attaches a timer to the output and observes it once the output is exhausted.</dd><dt><a class="fn" href="fn.check_permission.html" title="fn frontend::instance::check_permission">check_<wbr>permission</a></dt><dt><a class="fn" href="fn.derive_timeout.html" title="fn frontend::instance::derive_timeout">derive_<wbr>timeout</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>If the relevant variables are set, the timeout is enforced for all PostgreSQL statements.
For MySQL, it applies only to read-only statements.</dd><dt><a class="fn" href="fn.fast_legacy_check.html" title="fn frontend::instance::fast_legacy_check">fast_<wbr>legacy_<wbr>check</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.parse_stmt.html" title="fn frontend::instance::parse_stmt">parse_<wbr>stmt</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.should_capture_statement.html" title="fn frontend::instance::should_capture_statement">should_<wbr>capture_<wbr>statement</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.validate_database.html" title="fn frontend::instance::validate_database">validate_<wbr>database</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.validate_flow.html" title="fn frontend::instance::validate_flow">validate_<wbr>flow</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.validate_param.html" title="fn frontend::instance::validate_param">validate_<wbr>param</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>