greptimedb/servers/prom_store/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="prometheus protocol supportings handles prometheus remote_write, remote_read logic"><title>servers::prom_store - 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="servers" 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 prom_store</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../servers/index.html">servers</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 prom_<wbr>store</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="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate servers</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></div><h1>Module <span>prom_<wbr>store</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/servers/prom_store.rs.html#15-1784">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>prometheus protocol supportings
handles prometheus remote_write, remote_read logic</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.ChargedBuffer.html" title="struct servers::prom_store::ChargedBuffer">Charged<wbr>Buffer</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Decompressed bytes together with the memory permits charged for them.
The permits are released when the buffer is dropped, so the aggregate
memory accounting covers the whole lifetime of the decompressed data.</dd><dt><a class="struct" href="struct.LabelColumn.html" title="struct servers::prom_store::LabelColumn">Label<wbr>Column</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.LabelValues.html" title="enum servers::prom_store::LabelValues">Label<wbr>Values</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.DATABASE_LABEL.html" title="constant servers::prom_store::DATABASE_LABEL">DATABASE_<wbr>LABEL</a></dt><dd>special label for selecting database name on remote write</dd><dt><a class="constant" href="constant.DATABASE_LABEL_ALT.html" title="constant servers::prom_store::DATABASE_LABEL_ALT">DATABASE_<wbr>LABEL_<wbr>ALT</a></dt><dt><a class="constant" href="constant.DATABASE_LABEL_ALT_BYTES.html" title="constant servers::prom_store::DATABASE_LABEL_ALT_BYTES">DATABASE_<wbr>LABEL_<wbr>ALT_<wbr>BYTES</a></dt><dt><a class="constant" href="constant.DATABASE_LABEL_BYTES.html" title="constant servers::prom_store::DATABASE_LABEL_BYTES">DATABASE_<wbr>LABEL_<wbr>BYTES</a></dt><dt><a class="constant" href="constant.FIELD_NAME_LABEL.html" title="constant servers::prom_store::FIELD_NAME_LABEL">FIELD_<wbr>NAME_<wbr>LABEL</a></dt><dd>The same as <code>FIELD_COLUMN_MATCHER</code> in <code>promql</code> crate</dd><dt><a class="constant" href="constant.MAX_DECOMPRESSED_REQUEST_SIZE.html" title="constant servers::prom_store::MAX_DECOMPRESSED_REQUEST_SIZE">MAX_<wbr>DECOMPRESSED_<wbr>REQUEST_<wbr>SIZE</a></dt><dd>Hard cap on the decompressed size of a handler-decompressed request body
(Prometheus remote read/write, Loki push).</dd><dt><a class="constant" href="constant.METRIC_NAME_LABEL.html" title="constant servers::prom_store::METRIC_NAME_LABEL">METRIC_<wbr>NAME_<wbr>LABEL</a></dt><dt><a class="constant" href="constant.METRIC_NAME_LABEL_BYTES.html" title="constant servers::prom_store::METRIC_NAME_LABEL_BYTES">METRIC_<wbr>NAME_<wbr>LABEL_<wbr>BYTES</a></dt><dt><a class="constant" href="constant.PHYSICAL_TABLE_LABEL.html" title="constant servers::prom_store::PHYSICAL_TABLE_LABEL">PHYSICAL_<wbr>TABLE_<wbr>LABEL</a></dt><dd>special label for selecting physical table name on remote write</dd><dt><a class="constant" href="constant.PHYSICAL_TABLE_LABEL_ALT.html" title="constant servers::prom_store::PHYSICAL_TABLE_LABEL_ALT">PHYSICAL_<wbr>TABLE_<wbr>LABEL_<wbr>ALT</a></dt><dt><a class="constant" href="constant.PHYSICAL_TABLE_LABEL_ALT_BYTES.html" title="constant servers::prom_store::PHYSICAL_TABLE_LABEL_ALT_BYTES">PHYSICAL_<wbr>TABLE_<wbr>LABEL_<wbr>ALT_<wbr>BYTES</a></dt><dt><a class="constant" href="constant.PHYSICAL_TABLE_LABEL_BYTES.html" title="constant servers::prom_store::PHYSICAL_TABLE_LABEL_BYTES">PHYSICAL_<wbr>TABLE_<wbr>LABEL_<wbr>BYTES</a></dt><dt class="deprecated"><a class="constant" href="constant.SCHEMA_LABEL.html" title="constant servers::prom_store::SCHEMA_LABEL">SCHEMA_<wbr>LABEL</a><wbr><span class="stab deprecated" title="">Deprecated</span></dt><dd>deprecated, use DATABASE_LABEL instead</dd><dt class="deprecated"><a class="constant" href="constant.SCHEMA_LABEL_BYTES.html" title="constant servers::prom_store::SCHEMA_LABEL_BYTES">SCHEMA_<wbr>LABEL_<wbr>BYTES</a><wbr><span class="stab deprecated" title="">Deprecated</span></dt><dt><a class="constant" href="constant.ZSTD_DECOMPRESS_CHUNK.html" title="constant servers::prom_store::ZSTD_DECOMPRESS_CHUNK">ZSTD_<wbr>DECOMPRESS_<wbr>CHUNK</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Size of the chunks a zstd body is decompressed and charged in.</dd></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.append_recordbatch_to_timeseries.html" title="fn servers::prom_store::append_recordbatch_to_timeseries">append_<wbr>recordbatch_<wbr>to_<wbr>timeseries</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.compare_timeseries_labels.html" title="fn servers::prom_store::compare_timeseries_labels">compare_<wbr>timeseries_<wbr>labels</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Sort timeseries by labels, matching the former <code>BTreeMap</code> order.</dd><dt><a class="fn" href="fn.extract_schema_from_query.html" title="fn servers::prom_store::extract_schema_from_query">extract_<wbr>schema_<wbr>from_<wbr>query</a></dt><dd>Extract database selector from a remote read query.</dd><dt><a class="fn" href="fn.hash_timeseries.html" title="fn servers::prom_store::hash_timeseries">hash_<wbr>timeseries</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.is_database_selection_label.html" title="fn servers::prom_store::is_database_selection_label">is_<wbr>database_<wbr>selection_<wbr>label</a></dt><dd>Check if given label is a database selection label</dd><dt><a class="fn" href="fn.is_physical_table_selection_label.html" title="fn servers::prom_store::is_physical_table_selection_label">is_<wbr>physical_<wbr>table_<wbr>selection_<wbr>label</a></dt><dd>Check if given label is a physical table selection label</dd><dt><a class="fn" href="fn.is_remote_read_special_label.html" title="fn servers::prom_store::is_remote_read_special_label">is_<wbr>remote_<wbr>read_<wbr>special_<wbr>label</a></dt><dt><a class="fn" href="fn.is_remote_write_special_label.html" title="fn servers::prom_store::is_remote_write_special_label">is_<wbr>remote_<wbr>write_<wbr>special_<wbr>label</a></dt><dd>Check if given label is a special label for remote write</dd><dt><a class="fn" href="fn.label_columns.html" title="fn servers::prom_store::label_columns">label_<wbr>columns</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.lit_timestamp_millisecond.html" title="fn servers::prom_store::lit_timestamp_millisecond">lit_<wbr>timestamp_<wbr>millisecond</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.matches_timeseries.html" title="fn servers::prom_store::matches_timeseries">matches_<wbr>timeseries</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.mock_timeseries.html" title="fn servers::prom_store::mock_timeseries">mock_<wbr>timeseries</a></dt><dd>Mock timeseries for test, it is both used in servers and frontend crate
So we present it here</dd><dt><a class="fn" href="fn.mock_timeseries_new_label.html" title="fn servers::prom_store::mock_timeseries_new_label">mock_<wbr>timeseries_<wbr>new_<wbr>label</a></dt><dd>Add new labels to the mock timeseries.</dd><dt><a class="fn" href="fn.mock_timeseries_special_labels.html" title="fn servers::prom_store::mock_timeseries_special_labels">mock_<wbr>timeseries_<wbr>special_<wbr>labels</a></dt><dd>Add new labels to the mock timeseries.</dd><dt><a class="fn" href="fn.new_label.html" title="fn servers::prom_store::new_label">new_<wbr>label</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.new_timeseries.html" title="fn servers::prom_store::new_timeseries">new_<wbr>timeseries</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.query_to_plan.html" title="fn servers::prom_store::query_to_plan">query_<wbr>to_<wbr>plan</a></dt><dd>Create a DataFrame from a remote Query</dd><dt><a class="fn" href="fn.recordbatches_to_timeseries.html" title="fn servers::prom_store::recordbatches_to_timeseries">recordbatches_<wbr>to_<wbr>timeseries</a></dt><dt><a class="fn" href="fn.row_labels.html" title="fn servers::prom_store::row_labels">row_<wbr>labels</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.snappy_compress.html" title="fn servers::prom_store::snappy_compress">snappy_<wbr>compress</a></dt><dt><a class="fn" href="fn.snappy_decompress.html" title="fn servers::prom_store::snappy_decompress">snappy_<wbr>decompress</a></dt><dd>Decompresses a raw Snappy body with the hard decoded-size cap enforced,
without charging the aggregate request-memory limiter.</dd><dt><a class="fn" href="fn.snappy_decompress_limited.html" title="fn servers::prom_store::snappy_decompress_limited">snappy_<wbr>decompress_<wbr>limited</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Decompresses a raw Snappy body after enforcing a hard cap on the decoded
size and charging the aggregate request-memory limiter.</dd><dt><a class="fn" href="fn.table_name.html" title="fn servers::prom_store::table_name">table_<wbr>name</a></dt><dd>Get table name from remote query</dd><dt><a class="fn" href="fn.to_grpc_row_insert_requests.html" title="fn servers::prom_store::to_grpc_row_insert_requests">to_<wbr>grpc_<wbr>row_<wbr>insert_<wbr>requests</a></dt><dt><a class="fn" href="fn.zstd_decompress_limited.html" title="fn servers::prom_store::zstd_decompress_limited">zstd_<wbr>decompress_<wbr>limited</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Decompresses a zstd body with a hard cap on the decoded size, charging the
aggregate request-memory limiter incrementally while the output is
materialized (zstd streams don’t declare their decoded size up front).</dd></dl></section></div></main></body></html>