Files
greptimedb/api/prom_store/remote/index.html
2025-12-17 08:55:29 +00:00

5 lines
6.8 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 `remote` mod in crate `api`."><title>api::prom_store::remote - 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="api" 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 remote</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../api/index.html">api</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 remote</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In api::<wbr>prom_<wbr>store</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">api</a>::<wbr><a href="../index.html">prom_store</a></div><h1>Module <span>remote</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/api/lib.rs.html#19">Source</a> </span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="chunk/index.html" title="mod api::prom_store::remote::chunk">chunk</a></dt><dd>Nested message and enum types in <code>Chunk</code>.</dd><dt><a class="mod" href="label_matcher/index.html" title="mod api::prom_store::remote::label_matcher">label_<wbr>matcher</a></dt><dd>Nested message and enum types in <code>LabelMatcher</code>.</dd><dt><a class="mod" href="metric_metadata/index.html" title="mod api::prom_store::remote::metric_metadata">metric_<wbr>metadata</a></dt><dd>Nested message and enum types in <code>MetricMetadata</code>.</dd><dt><a class="mod" href="read_request/index.html" title="mod api::prom_store::remote::read_request">read_<wbr>request</a></dt><dd>Nested message and enum types in <code>ReadRequest</code>.</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.Chunk.html" title="struct api::prom_store::remote::Chunk">Chunk</a></dt><dd>Chunk represents a TSDB chunk.
Time range [min, max] is inclusive.</dd><dt><a class="struct" href="struct.ChunkedReadResponse.html" title="struct api::prom_store::remote::ChunkedReadResponse">Chunked<wbr>Read<wbr>Response</a></dt><dd>ChunkedReadResponse is a response when response_type equals STREAMED_XOR_CHUNKS.
We strictly stream full series after series, optionally split by time. This means that a single frame can contain
partition of the single series, but once a new series is started to be streamed it means that no more chunks will
be sent for previous one. Series are returned sorted in the same way TSDB block are internally.</dd><dt><a class="struct" href="struct.ChunkedSeries.html" title="struct api::prom_store::remote::ChunkedSeries">Chunked<wbr>Series</a></dt><dd>ChunkedSeries represents single, encoded time series.</dd><dt><a class="struct" href="struct.Exemplar.html" title="struct api::prom_store::remote::Exemplar">Exemplar</a></dt><dt><a class="struct" href="struct.Label.html" title="struct api::prom_store::remote::Label">Label</a></dt><dt><a class="struct" href="struct.LabelMatcher.html" title="struct api::prom_store::remote::LabelMatcher">Label<wbr>Matcher</a></dt><dd>Matcher specifies a rule, which can match or set of labels or not.</dd><dt><a class="struct" href="struct.Labels.html" title="struct api::prom_store::remote::Labels">Labels</a></dt><dt><a class="struct" href="struct.MetricMetadata.html" title="struct api::prom_store::remote::MetricMetadata">Metric<wbr>Metadata</a></dt><dt><a class="struct" href="struct.Query.html" title="struct api::prom_store::remote::Query">Query</a></dt><dt><a class="struct" href="struct.QueryResult.html" title="struct api::prom_store::remote::QueryResult">Query<wbr>Result</a></dt><dt><a class="struct" href="struct.ReadHints.html" title="struct api::prom_store::remote::ReadHints">Read<wbr>Hints</a></dt><dt><a class="struct" href="struct.ReadRequest.html" title="struct api::prom_store::remote::ReadRequest">Read<wbr>Request</a></dt><dd>ReadRequest represents a remote read request.</dd><dt><a class="struct" href="struct.ReadResponse.html" title="struct api::prom_store::remote::ReadResponse">Read<wbr>Response</a></dt><dd>ReadResponse is a response when response_type equals SAMPLES.</dd><dt><a class="struct" href="struct.Sample.html" title="struct api::prom_store::remote::Sample">Sample</a></dt><dt><a class="struct" href="struct.TimeSeries.html" title="struct api::prom_store::remote::TimeSeries">Time<wbr>Series</a></dt><dd>TimeSeries represents samples and labels for a single time series.</dd><dt><a class="struct" href="struct.WriteRequest.html" title="struct api::prom_store::remote::WriteRequest">Write<wbr>Request</a></dt></dl></section></div></main></body></html>