mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-10-20 02:42:29 +00:00
6 lines
14 KiB
HTML
6 lines
14 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 `prom_store` mod in crate `servers`."><title>servers::http::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="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In servers::<wbr>http</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></div><h1>Module <span>prom_<wbr>store</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/prom_store.rs.html#15-1192">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.PromStoreState.html" title="struct servers::http::prom_store::PromStoreState">Prom<wbr>Store<wbr>State</a></dt><dt><a class="struct" href="struct.PromWriteError.html" title="struct servers::http::prom_store::PromWriteError">Prom<wbr>Write<wbr>Error</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="struct" href="struct.PromWriteOutcome.html" title="struct servers::http::prom_store::PromWriteOutcome">Prom<wbr>Write<wbr>Outcome</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="struct" href="struct.PromWriteV2Error.html" title="struct servers::http::prom_store::PromWriteV2Error">Prom<wbr>Write<wbr>V2Error</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="struct" href="struct.PromWriteV2Outcome.html" title="struct servers::http::prom_store::PromWriteV2Outcome">Prom<wbr>Write<wbr>V2Outcome</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="struct" href="struct.RemoteWriteQuery.html" title="struct servers::http::prom_store::RemoteWriteQuery">Remote<wbr>Write<wbr>Query</a></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.RemoteWriteProto.html" title="enum servers::http::prom_store::RemoteWriteProto">Remote<wbr>Write<wbr>Proto</a><span title="Restricted Visibility"> 🔒</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.CONTENT_TYPE_PROTO_PARAM.html" title="constant servers::http::prom_store::CONTENT_TYPE_PROTO_PARAM">CONTENT_<wbr>TYPE_<wbr>PROTO_<wbr>PARAM</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.DEFAULT_ENCODING.html" title="constant servers::http::prom_store::DEFAULT_ENCODING">DEFAULT_<wbr>ENCODING</a></dt><dt><a class="constant" href="constant.PHYSICAL_TABLE_PARAM.html" title="constant servers::http::prom_store::PHYSICAL_TABLE_PARAM">PHYSICAL_<wbr>TABLE_<wbr>PARAM</a></dt><dt><a class="constant" href="constant.REMOTE_WRITE_V1_PROTO.html" title="constant servers::http::prom_store::REMOTE_WRITE_V1_PROTO">REMOTE_<wbr>WRITE_<wbr>V1_<wbr>PROTO</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.REMOTE_WRITE_V2_EXEMPLARS_WRITTEN_HEADER.html" title="constant servers::http::prom_store::REMOTE_WRITE_V2_EXEMPLARS_WRITTEN_HEADER">REMOTE_<wbr>WRITE_<wbr>V2_<wbr>EXEMPLARS_<wbr>WRITTEN_<wbr>HEADER</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.REMOTE_WRITE_V2_HISTOGRAMS_WRITTEN_HEADER.html" title="constant servers::http::prom_store::REMOTE_WRITE_V2_HISTOGRAMS_WRITTEN_HEADER">REMOTE_<wbr>WRITE_<wbr>V2_<wbr>HISTOGRAMS_<wbr>WRITTEN_<wbr>HEADER</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.REMOTE_WRITE_V2_PROTO.html" title="constant servers::http::prom_store::REMOTE_WRITE_V2_PROTO">REMOTE_<wbr>WRITE_<wbr>V2_<wbr>PROTO</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.REMOTE_WRITE_V2_SAMPLES_WRITTEN_HEADER.html" title="constant servers::http::prom_store::REMOTE_WRITE_V2_SAMPLES_WRITTEN_HEADER">REMOTE_<wbr>WRITE_<wbr>V2_<wbr>SAMPLES_<wbr>WRITTEN_<wbr>HEADER</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.VM_ENCODING.html" title="constant servers::http::prom_store::VM_ENCODING">VM_<wbr>ENCODING</a></dt><dt><a class="constant" href="constant.VM_PROTO_VERSION.html" title="constant servers::http::prom_store::VM_PROTO_VERSION">VM_<wbr>PROTO_<wbr>VERSION</a></dt></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.PromWriteBatcher.html" title="trait servers::http::prom_store::PromWriteBatcher">Prom<wbr>Write<wbr>Batcher</a><span title="Restricted Visibility"> 🔒</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.append_remote_write_v2_written_headers.html" title="fn servers::http::prom_store::append_remote_write_v2_written_headers">append_<wbr>remote_<wbr>write_<wbr>v2_<wbr>written_<wbr>headers</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.decode_remote_read_request.html" title="fn servers::http::prom_store::decode_remote_read_request">decode_<wbr>remote_<wbr>read_<wbr>request</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.incomplete_prom_write_error.html" title="fn servers::http::prom_store::incomplete_prom_write_error">incomplete_<wbr>prom_<wbr>write_<wbr>error</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.into_prom_write_batches.html" title="fn servers::http::prom_store::into_prom_write_batches">into_<wbr>prom_<wbr>write_<wbr>batches</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.preflight_prometheus_rows.html" title="fn servers::http::prom_store::preflight_prometheus_rows">preflight_<wbr>prometheus_<wbr>rows</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.prepare_remote_write_context.html" title="fn servers::http::prom_store::prepare_remote_write_context">prepare_<wbr>remote_<wbr>write_<wbr>context</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Returns the context still un-shared so the caller can attach
|
|
request-derived extensions (the v2 per-table metadata index) before
|
|
wrapping it in an <code>Arc</code>.</dd><dt><a class="fn" href="fn.prom_write_row_count.html" title="fn servers::http::prom_store::prom_write_row_count">prom_<wbr>write_<wbr>row_<wbr>count</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.record_remote_write_histograms.html" title="fn servers::http::prom_store::record_remote_write_histograms">record_<wbr>remote_<wbr>write_<wbr>histograms</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.record_remote_write_samples.html" title="fn servers::http::prom_store::record_remote_write_samples">record_<wbr>remote_<wbr>write_<wbr>samples</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.remote_read.html" title="fn servers::http::prom_store::remote_read">remote_<wbr>read</a></dt><dt><a class="fn" href="fn.remote_write.html" title="fn servers::http::prom_store::remote_write">remote_<wbr>write</a></dt><dt><a class="fn" href="fn.remote_write_proto.html" title="fn servers::http::prom_store::remote_write_proto">remote_<wbr>write_<wbr>proto</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.remote_write_v1.html" title="fn servers::http::prom_store::remote_write_v1">remote_<wbr>write_<wbr>v1</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.remote_write_v2.html" title="fn servers::http::prom_store::remote_write_v2">remote_<wbr>write_<wbr>v2</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.remote_write_v2_error_response.html" title="fn servers::http::prom_store::remote_write_v2_error_response">remote_<wbr>write_<wbr>v2_<wbr>error_<wbr>response</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.unsupported_remote_write_v2_encoding_response.html" title="fn servers::http::prom_store::unsupported_remote_write_v2_encoding_response">unsupported_<wbr>remote_<wbr>write_<wbr>v2_<wbr>encoding_<wbr>response</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.vm_proto_version_response.html" title="fn servers::http::prom_store::vm_proto_version_response">vm_<wbr>proto_<wbr>version_<wbr>response</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.write_batched_prometheus_v2_rows_with_progress.html" title="fn servers::http::prom_store::write_batched_prometheus_v2_rows_with_progress">write_<wbr>batched_<wbr>prometheus_<wbr>v2_<wbr>rows_<wbr>with_<wbr>progress</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.write_prepared_prometheus_rows_with_progress.html" title="fn servers::http::prom_store::write_prepared_prometheus_rows_with_progress">write_<wbr>prepared_<wbr>prometheus_<wbr>rows_<wbr>with_<wbr>progress</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Writes already-preflighted batches through the ordinary (prepared) write
|
|
path; the pre_write hooks and admission have already run.</dd><dt><a class="fn" href="fn.write_prepared_prometheus_v2_rows_with_progress.html" title="fn servers::http::prom_store::write_prepared_prometheus_v2_rows_with_progress">write_<wbr>prepared_<wbr>prometheus_<wbr>v2_<wbr>rows_<wbr>with_<wbr>progress</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Writes already-preflighted batches through the ordinary (prepared) write
|
|
path with v2 partial-progress accounting; the pre_write hooks and
|
|
admission have already run.</dd><dt><a class="fn" href="fn.write_prometheus_rows_with_progress.html" title="fn servers::http::prom_store::write_prometheus_rows_with_progress">write_<wbr>prometheus_<wbr>rows_<wbr>with_<wbr>progress</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Writes preflighted PRW batches and keeps the number of persisted rows on error.</dd><dt><a class="fn" href="fn.write_prometheus_v2_rows_with_progress.html" title="fn servers::http::prom_store::write_prometheus_v2_rows_with_progress">write_<wbr>prometheus_<wbr>v2_<wbr>rows_<wbr>with_<wbr>progress</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.PromWriteBatch.html" title="type servers::http::prom_store::PromWriteBatch">Prom<wbr>Write<wbr>Batch</a><span title="Restricted Visibility"> 🔒</span> </dt></dl></section></div></main></body></html> |