Files
greptimedb/query/promql/planner/index.html
2026-05-15 04:01:35 +00:00

3 lines
8.3 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="API documentation for the Rust `planner` mod in crate `query`."><title>query::promql::planner - 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="../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 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 planner</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../query/index.html">query</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module planner</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="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#statics" title="Statics">Statics</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In query::<wbr>promql</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>::<wbr><a href="../index.html">promql</a></div><h1>Module <span>planner</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/promql/planner.rs.html#15-6951">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.FunctionArgs.html" title="struct query::promql::planner::FunctionArgs">Function<wbr>Args</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.PromPlanner.html" title="struct query::promql::planner::PromPlanner">Prom<wbr>Planner</a></dt><dt><a class="struct" href="struct.PromPlannerContext.html" title="struct query::promql::planner::PromPlannerContext">Prom<wbr>Planner<wbr>Context</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.ScalarFunc.html" title="enum query::promql::planner::ScalarFunc">Scalar<wbr>Func</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Represents different types of scalar functions supported in PromQL expressions.
Each variant defines how the function should be processed and what arguments it expects.</dd></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.DB_COLUMN_MATCHER.html" title="constant query::promql::planner::DB_COLUMN_MATCHER">DB_<wbr>COLUMN_<wbr>MATCHER</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.DEFAULT_FIELD_COLUMN.html" title="constant query::promql::planner::DEFAULT_FIELD_COLUMN">DEFAULT_<wbr>FIELD_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>default value column name for empty metric</dd><dt><a class="constant" href="constant.DEFAULT_TIME_INDEX_COLUMN.html" title="constant query::promql::planner::DEFAULT_TIME_INDEX_COLUMN">DEFAULT_<wbr>TIME_<wbr>INDEX_<wbr>COLUMN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.FIELD_COLUMN_MATCHER.html" title="constant query::promql::planner::FIELD_COLUMN_MATCHER">FIELD_<wbr>COLUMN_<wbr>MATCHER</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Special modifier to project field columns under multi-field mode</dd><dt><a class="constant" href="constant.INTERVAL_1H.html" title="constant query::promql::planner::INTERVAL_1H">INTERVAL_<wbr>1H</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Interval 1 hour in millisecond</dd><dt><a class="constant" href="constant.LE_COLUMN_NAME.html" title="constant query::promql::planner::LE_COLUMN_NAME">LE_<wbr>COLUMN_<wbr>NAME</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd><code>le</code> column for conventional histogram.</dd><dt><a class="constant" href="constant.MAX_SCATTER_POINTS.html" title="constant query::promql::planner::MAX_SCATTER_POINTS">MAX_<wbr>SCATTER_<wbr>POINTS</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Threshold for scatter scan mode</dd><dt><a class="constant" href="constant.SCALAR_FUNCTION.html" title="constant query::promql::planner::SCALAR_FUNCTION">SCALAR_<wbr>FUNCTION</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd><code>scalar()</code> function in PromQL.</dd><dt><a class="constant" href="constant.SCHEMA_COLUMN_MATCHER.html" title="constant query::promql::planner::SCHEMA_COLUMN_MATCHER">SCHEMA_<wbr>COLUMN_<wbr>MATCHER</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Special modifier for cross schema query</dd><dt><a class="constant" href="constant.SPECIAL_ABSENT_FUNCTION.html" title="constant query::promql::planner::SPECIAL_ABSENT_FUNCTION">SPECIAL_<wbr>ABSENT_<wbr>FUNCTION</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd><code>absent()</code> function in PromQL</dd><dt><a class="constant" href="constant.SPECIAL_HISTOGRAM_QUANTILE.html" title="constant query::promql::planner::SPECIAL_HISTOGRAM_QUANTILE">SPECIAL_<wbr>HISTOGRAM_<wbr>QUANTILE</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd><code>histogram_quantile</code> function in PromQL</dd><dt><a class="constant" href="constant.SPECIAL_TIME_FUNCTION.html" title="constant query::promql::planner::SPECIAL_TIME_FUNCTION">SPECIAL_<wbr>TIME_<wbr>FUNCTION</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd><code>time()</code> function in PromQL.</dd><dt><a class="constant" href="constant.SPECIAL_VECTOR_FUNCTION.html" title="constant query::promql::planner::SPECIAL_VECTOR_FUNCTION">SPECIAL_<wbr>VECTOR_<wbr>FUNCTION</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd><code>vector</code> function in PromQL</dd></dl><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><dl class="item-table"><dt><a class="static" href="static.LABEL_NAME_REGEX.html" title="static query::promql::planner::LABEL_NAME_REGEX">LABEL_<wbr>NAME_<wbr>REGEX</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Static regex for validating label names according to Prometheus specification.
Label names must match the regex: [a-zA-Z_][a-zA-Z0-9_]*</dd></dl></section></div></main></body></html>