rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-08-24 23:18:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2d26a04bc6174f455caec1a4972807110a115841
greptimedb/common_query/native_histogram/index.html
T
github-merge-queue[bot] 2d26a04bc6 Deploying to gh-pages from @ GreptimeTeam/greptimedb@b882e393df 🚀
2026-08-18 04:36:17 +00:00

11 lines
20 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="Shared native histogram field contract."><title>common_query::native_histogram - 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="common_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 native_histogram</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../common_query/index.html">common_<wbr>query</a><span class="version">1.3.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module native_<wbr>histogram</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><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 common_<wbr>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">common_query</a></div><h1>Module <span>native_<wbr>histogram</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/common_query/native_histogram.rs.html#15-2309">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Shared native histogram field contract.</p>
<p>Prom remote-write v2 stores these names as children of one Struct field, while
metric-engine uses the same contract to recognize native histogram tables.
<a href="struct.NativeHistogram.html" title="struct common_query::native_histogram::NativeHistogram"><code>NativeHistogram</code></a> is the query-time representation and therefore normalizes
integer and floating-point payloads to absolute <code>f64</code> counts.</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.Bucket.html" title="struct common_query::native_histogram::Bucket">Bucket</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A materialized bucket used by query-time estimators and renderers.</dd><dt><a class="struct" href="struct.NativeHistogram.html" title="struct common_query::native_histogram::NativeHistogram">Native<wbr>Histogram</a></dt><dd>Query-time representation of a Prometheus native histogram.</dd><dt><a class="struct" href="struct.Span.html" title="struct common_query::native_histogram::Span">Span</a></dt><dd>A contiguous run of populated sparse buckets.</dd></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.BoundaryRule.html" title="enum common_query::native_histogram::BoundaryRule">Boundary<wbr>Rule</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Inclusion rules for a materialized bucket’s lower and upper bounds.</dd><dt><a class="enum" href="enum.CounterResetHint.html" title="enum common_query::native_histogram::CounterResetHint">Counter<wbr>Reset<wbr>Hint</a></dt><dd>Information carried by a native histogram about a possible counter reset.</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.COUNTER_RESET_HINT.html" title="constant common_query::native_histogram::COUNTER_RESET_HINT">COUNTER_<wbr>RESET_<wbr>HINT</a></dt><dd>Reset hint indicating the first histogram after a counter reset.</dd><dt><a class="constant" href="constant.COUNT_F64_FIELD.html" title="constant common_query::native_histogram::COUNT_F64_FIELD">COUNT_<wbr>F64_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.COUNT_I64_FIELD.html" title="constant common_query::native_histogram::COUNT_I64_FIELD">COUNT_<wbr>I64_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.CUSTOM_BUCKETS_SCHEMA.html" title="constant common_query::native_histogram::CUSTOM_BUCKETS_SCHEMA">CUSTOM_<wbr>BUCKETS_<wbr>SCHEMA</a></dt><dd>Schema identifier for native histograms with explicit custom bucket bounds.</dd><dt><a class="constant" href="constant.CUSTOM_VALUES_FIELD.html" title="constant common_query::native_histogram::CUSTOM_VALUES_FIELD">CUSTOM_<wbr>VALUES_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.GAUGE_RESET_HINT.html" title="constant common_query::native_histogram::GAUGE_RESET_HINT">GAUGE_<wbr>RESET_<wbr>HINT</a></dt><dd>Reset hint identifying a gauge histogram.</dd><dt><a class="constant" href="constant.MAX_EXPONENTIAL_SCHEMA.html" title="constant common_query::native_histogram::MAX_EXPONENTIAL_SCHEMA">MAX_<wbr>EXPONENTIAL_<wbr>SCHEMA</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.MIN_EXPONENTIAL_SCHEMA.html" title="constant common_query::native_histogram::MIN_EXPONENTIAL_SCHEMA">MIN_<wbr>EXPONENTIAL_<wbr>SCHEMA</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.NATIVE_HISTOGRAM_FIELD.html" title="constant common_query::native_histogram::NATIVE_HISTOGRAM_FIELD">NATIVE_<wbr>HISTOGRAM_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.NATIVE_HISTOGRAM_FIELD_NAMES.html" title="constant common_query::native_histogram::NATIVE_HISTOGRAM_FIELD_NAMES">NATIVE_<wbr>HISTOGRAM_<wbr>FIELD_<wbr>NAMES</a></dt><dt><a class="constant" href="constant.NATIVE_HISTOGRAM_LIST_ELEMENT_OFFSET.html" title="constant common_query::native_histogram::NATIVE_HISTOGRAM_LIST_ELEMENT_OFFSET">NATIVE_<wbr>HISTOGRAM_<wbr>LIST_<wbr>ELEMENT_<wbr>OFFSET</a></dt><dd>Offset of list element ids within a column’s id block.</dd><dt><a class="constant" href="constant.NATIVE_HISTOGRAM_SUBFIELD_ID_BASE.html" title="constant common_query::native_histogram::NATIVE_HISTOGRAM_SUBFIELD_ID_BASE">NATIVE_<wbr>HISTOGRAM_<wbr>SUBFIELD_<wbr>ID_<wbr>BASE</a></dt><dd>Reserved base for native-histogram struct sub-field ids.</dd><dt><a class="constant" href="constant.NATIVE_HISTOGRAM_SUBFIELD_ID_STRIDE.html" title="constant common_query::native_histogram::NATIVE_HISTOGRAM_SUBFIELD_ID_STRIDE">NATIVE_<wbr>HISTOGRAM_<wbr>SUBFIELD_<wbr>ID_<wbr>STRIDE</a></dt><dd>Number of ids reserved per histogram column (18 sub-fields + headroom for
list element ids), so multiple histogram columns get disjoint ids.</dd><dt><a class="constant" href="constant.NEGATIVE_BUCKETS_F64_FIELD.html" title="constant common_query::native_histogram::NEGATIVE_BUCKETS_F64_FIELD">NEGATIVE_<wbr>BUCKETS_<wbr>F64_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.NEGATIVE_BUCKETS_I64_FIELD.html" title="constant common_query::native_histogram::NEGATIVE_BUCKETS_I64_FIELD">NEGATIVE_<wbr>BUCKETS_<wbr>I64_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.NEGATIVE_SPAN_LENGTHS_FIELD.html" title="constant common_query::native_histogram::NEGATIVE_SPAN_LENGTHS_FIELD">NEGATIVE_<wbr>SPAN_<wbr>LENGTHS_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.NEGATIVE_SPAN_OFFSETS_FIELD.html" title="constant common_query::native_histogram::NEGATIVE_SPAN_OFFSETS_FIELD">NEGATIVE_<wbr>SPAN_<wbr>OFFSETS_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.NOT_COUNTER_RESET_HINT.html" title="constant common_query::native_histogram::NOT_COUNTER_RESET_HINT">NOT_<wbr>COUNTER_<wbr>RESET_<wbr>HINT</a></dt><dd>Reset hint indicating that no counter reset occurred.</dd><dt><a class="constant" href="constant.POSITIVE_BUCKETS_F64_FIELD.html" title="constant common_query::native_histogram::POSITIVE_BUCKETS_F64_FIELD">POSITIVE_<wbr>BUCKETS_<wbr>F64_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.POSITIVE_BUCKETS_I64_FIELD.html" title="constant common_query::native_histogram::POSITIVE_BUCKETS_I64_FIELD">POSITIVE_<wbr>BUCKETS_<wbr>I64_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.POSITIVE_SPAN_LENGTHS_FIELD.html" title="constant common_query::native_histogram::POSITIVE_SPAN_LENGTHS_FIELD">POSITIVE_<wbr>SPAN_<wbr>LENGTHS_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.POSITIVE_SPAN_OFFSETS_FIELD.html" title="constant common_query::native_histogram::POSITIVE_SPAN_OFFSETS_FIELD">POSITIVE_<wbr>SPAN_<wbr>OFFSETS_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.RESET_HINT_FIELD.html" title="constant common_query::native_histogram::RESET_HINT_FIELD">RESET_<wbr>HINT_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.SCHEMA_FIELD.html" title="constant common_query::native_histogram::SCHEMA_FIELD">SCHEMA_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.START_TIMESTAMP_FIELD.html" title="constant common_query::native_histogram::START_TIMESTAMP_FIELD">START_<wbr>TIMESTAMP_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.SUM_FIELD.html" title="constant common_query::native_histogram::SUM_FIELD">SUM_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.UNKNOWN_COUNTER_RESET_HINT.html" title="constant common_query::native_histogram::UNKNOWN_COUNTER_RESET_HINT">UNKNOWN_<wbr>COUNTER_<wbr>RESET_<wbr>HINT</a></dt><dd>Reset hint indicating that the payload must be inspected.</dd><dt><a class="constant" href="constant.ZERO_COUNT_F64_FIELD.html" title="constant common_query::native_histogram::ZERO_COUNT_F64_FIELD">ZERO_<wbr>COUNT_<wbr>F64_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.ZERO_COUNT_I64_FIELD.html" title="constant common_query::native_histogram::ZERO_COUNT_I64_FIELD">ZERO_<wbr>COUNT_<wbr>I64_<wbr>FIELD</a></dt><dt><a class="constant" href="constant.ZERO_THRESHOLD_FIELD.html" title="constant common_query::native_histogram::ZERO_THRESHOLD_FIELD">ZERO_<wbr>THRESHOLD_<wbr>FIELD</a></dt></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.NATIVE_HISTOGRAM_VALUE_TYPE.html" title="static common_query::native_histogram::NATIVE_HISTOGRAM_VALUE_TYPE">NATIVE_<wbr>HISTOGRAM_<wbr>VALUE_<wbr>TYPE</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.add_reset_hint.html" title="fn common_query::native_histogram::add_reset_hint">add_<wbr>reset_<wbr>hint</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.build_histogram_array.html" title="fn common_query::native_histogram::build_histogram_array">build_<wbr>histogram_<wbr>array</a></dt><dd>Builds a native histogram Struct array from query-time values.</dd><dt><a class="fn" href="fn.ceil_div.html" title="fn common_query::native_histogram::ceil_div">ceil_<wbr>div</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.check_span_bucket_count.html" title="fn common_query::native_histogram::check_span_bucket_count">check_<wbr>span_<wbr>bucket_<wbr>count</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.compact_side.html" title="fn common_query::native_histogram::compact_side">compact_<wbr>side</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.expand_zero_threshold_side.html" title="fn common_query::native_histogram::expand_zero_threshold_side">expand_<wbr>zero_<wbr>threshold_<wbr>side</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.exponential_overflow_bucket_index.html" title="fn common_query::native_histogram::exponential_overflow_bucket_index">exponential_<wbr>overflow_<wbr>bucket_<wbr>index</a></dt><dd>Returns the index of the exponential bucket containing positive infinity.</dd><dt><a class="fn" href="fn.fold_zero_side.html" title="fn common_query::native_histogram::fold_zero_side">fold_<wbr>zero_<wbr>side</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.format_promql_histogram_float.html" title="fn common_query::native_histogram::format_promql_histogram_float">format_<wbr>promql_<wbr>histogram_<wbr>float</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Formats a histogram component like Prometheus’s default <code>%g</code> formatter.</dd><dt><a class="fn" href="fn.get_bound.html" title="fn common_query::native_histogram::get_bound">get_<wbr>bound</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.is_native_histogram_value_schema.html" title="fn common_query::native_histogram::is_native_histogram_value_schema">is_<wbr>native_<wbr>histogram_<wbr>value_<wbr>schema</a></dt><dd>Returns whether a named column matches the configured native histogram contract.</dd><dt><a class="fn" href="fn.is_native_histogram_value_type.html" title="fn common_query::native_histogram::is_native_histogram_value_type">is_<wbr>native_<wbr>histogram_<wbr>value_<wbr>type</a></dt><dd>Returns whether <code>data_type</code> matches the native histogram value contract.</dd><dt><a class="fn" href="fn.list_child.html" title="fn common_query::native_histogram::list_child">list_<wbr>child</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.list_opt.html" title="fn common_query::native_histogram::list_opt">list_<wbr>opt</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.list_values.html" title="fn common_query::native_histogram::list_values">list_<wbr>values</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.map_custom_side.html" title="fn common_query::native_histogram::map_custom_side">map_<wbr>custom_<wbr>side</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.merge_side.html" title="fn common_query::native_histogram::merge_side">merge_<wbr>side</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.native_histogram_arrow_type.html" title="fn common_query::native_histogram::native_histogram_arrow_type">native_<wbr>histogram_<wbr>arrow_<wbr>type</a></dt><dd>Returns the Arrow type for a complete native histogram value.</dd><dt><a class="fn" href="fn.native_histogram_field_type.html" title="fn common_query::native_histogram::native_histogram_field_type">native_<wbr>histogram_<wbr>field_<wbr>type</a></dt><dd>Returns the exact Greptime type for a persisted native histogram field.</dd><dt><a class="fn" href="fn.native_histogram_list_element_id.html" title="fn common_query::native_histogram::native_histogram_list_element_id">native_<wbr>histogram_<wbr>list_<wbr>element_<wbr>id</a></dt><dd>Returns the stable list <code>element-id</code> for a list-typed native-histogram
sub-field, namespaced by its parent <code>column_id</code>, or <code>None</code> if <code>name</code> is not
a known sub-field or the derived id overflows a positive <code>i32</code>.</dd><dt><a class="fn" href="fn.native_histogram_subfield_id.html" title="fn common_query::native_histogram::native_histogram_subfield_id">native_<wbr>histogram_<wbr>subfield_<wbr>id</a></dt><dd>Returns the stable field id for a native-histogram struct sub-field,
namespaced by its parent <code>column_id</code>, or <code>None</code> if <code>name</code> is not a known
sub-field or the derived id overflows a positive <code>i32</code>.</dd><dt><a class="fn" href="fn.native_histogram_value_type.html" title="fn common_query::native_histogram::native_histogram_value_type">native_<wbr>histogram_<wbr>value_<wbr>type</a></dt><dd>Returns the exact Greptime type for a complete native histogram value.</dd><dt><a class="fn" href="fn.optional_primitive.html" title="fn common_query::native_histogram::optional_primitive">optional_<wbr>primitive</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.primitive_child.html" title="fn common_query::native_histogram::primitive_child">primitive_<wbr>child</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.read_histogram.html" title="fn common_query::native_histogram::read_histogram">read_<wbr>histogram</a></dt><dd>Decodes one native histogram row into the query-time <a href="struct.NativeHistogram.html" title="struct common_query::native_histogram::NativeHistogram"><code>NativeHistogram</code></a> model.</dd><dt><a class="fn" href="fn.read_spans.html" title="fn common_query::native_histogram::read_spans">read_<wbr>spans</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.reconcile_custom.html" title="fn common_query::native_histogram::reconcile_custom">reconcile_<wbr>custom</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.reconcile_exponential.html" title="fn common_query::native_histogram::reconcile_exponential">reconcile_<wbr>exponential</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.reduce_side.html" title="fn common_query::native_histogram::reduce_side">reduce_<wbr>side</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.required_primitive.html" title="fn common_query::native_histogram::required_primitive">required_<wbr>primitive</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.side_bucket_indices.html" title="fn common_query::native_histogram::side_bucket_indices">side_<wbr>bucket_<wbr>indices</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.side_counts.html" title="fn common_query::native_histogram::side_counts">side_<wbr>counts</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.side_layout_equal.html" title="fn common_query::native_histogram::side_layout_equal">side_<wbr>layout_<wbr>equal</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.span_bucket_len.html" title="fn common_query::native_histogram::span_bucket_len">span_<wbr>bucket_<wbr>len</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.spans_from_indices_counts.html" title="fn common_query::native_histogram::spans_from_indices_counts">spans_<wbr>from_<wbr>indices_<wbr>counts</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.struct_child.html" title="fn common_query::native_histogram::struct_child">struct_<wbr>child</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.subfield_index.html" title="fn common_query::native_histogram::subfield_index">subfield_<wbr>index</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink