rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-05-16 13:00:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2c331a8643edcda236a263ab5dd73ec218e2e72f
greptimedb/store_api/metric_engine_consts/index.html
github-merge-queue[bot] 2c331a8643 Deploying to gh-pages from @ GreptimeTeam/greptimedb@0572a680af 🚀
2026-03-13 04:38:03 +00:00

10 lines
11 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="Constants used in metric engine."><title>store_api::metric_engine_consts - 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="store_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 metric_engine_consts</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../store_api/index.html">store_<wbr>api</a><span class="version">1.0.0-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module metric_<wbr>engine_<wbr>consts</a></h2><h3><a href="#constants">Module Items</a></h3><ul class="block"><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 store_<wbr>api</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">store_api</a></div><h1>Module <span>metric_<wbr>engine_<wbr>consts</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/store_api/metric_engine_consts.rs.html#15-149">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Constants used in metric engine.</p>
</div></details><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.ALTER_PHYSICAL_EXTENSION_KEY.html" title="constant store_api::metric_engine_consts::ALTER_PHYSICAL_EXTENSION_KEY">ALTER_<wbr>PHYSICAL_<wbr>EXTENSION_<wbr>KEY</a></dt><dd>HashMap key to be used in the region server’s extension response.
Represent a list of column metadata that are added to physical table.</dd><dt><a class="constant" href="constant.DATA_REGION_SUBDIR.html" title="constant store_api::metric_engine_consts::DATA_REGION_SUBDIR">DATA_<wbr>REGION_<wbr>SUBDIR</a></dt><dt><a class="constant" href="constant.DATA_SCHEMA_TABLE_ID_COLUMN_NAME.html" title="constant store_api::metric_engine_consts::DATA_SCHEMA_TABLE_ID_COLUMN_NAME">DATA_<wbr>SCHEMA_<wbr>TABLE_<wbr>ID_<wbr>COLUMN_<wbr>NAME</a></dt><dd>Column name of internal column <code>__metric</code> that stores the original metric name</dd><dt><a class="constant" href="constant.DATA_SCHEMA_TSID_COLUMN_NAME.html" title="constant store_api::metric_engine_consts::DATA_SCHEMA_TSID_COLUMN_NAME">DATA_<wbr>SCHEMA_<wbr>TSID_<wbr>COLUMN_<wbr>NAME</a></dt><dt><a class="constant" href="constant.FILE_ENGINE_NAME.html" title="constant store_api::metric_engine_consts::FILE_ENGINE_NAME">FILE_<wbr>ENGINE_<wbr>NAME</a></dt><dt><a class="constant" href="constant.LOGICAL_TABLE_METADATA_KEY.html" title="constant store_api::metric_engine_consts::LOGICAL_TABLE_METADATA_KEY">LOGICAL_<wbr>TABLE_<wbr>METADATA_<wbr>KEY</a></dt><dd>Metadata key present in the <code>CREATE TABLE ... WITH ()</code> clause. This key is
used to identify a logical table and associate it with a corresponding physical
table . E.g.:</dd><dt><a class="constant" href="constant.MANIFEST_INFO_EXTENSION_KEY.html" title="constant store_api::metric_engine_consts::MANIFEST_INFO_EXTENSION_KEY">MANIFEST_<wbr>INFO_<wbr>EXTENSION_<wbr>KEY</a></dt><dd>HashMap key to be used in the region server’s extension response.
Represent the manifest info of a region.</dd><dt><a class="constant" href="constant.MEMTABLE_PARTITION_TREE_PRIMARY_KEY_ENCODING.html" title="constant store_api::metric_engine_consts::MEMTABLE_PARTITION_TREE_PRIMARY_KEY_ENCODING">MEMTABLE_<wbr>PARTITION_<wbr>TREE_<wbr>PRIMARY_<wbr>KEY_<wbr>ENCODING</a></dt><dd>Option key for memtable partition tree primary key encoding.</dd><dt><a class="constant" href="constant.METADATA_REGION_SUBDIR.html" title="constant store_api::metric_engine_consts::METADATA_REGION_SUBDIR">METADATA_<wbr>REGION_<wbr>SUBDIR</a></dt><dt><a class="constant" href="constant.METADATA_SCHEMA_KEY_COLUMN_INDEX.html" title="constant store_api::metric_engine_consts::METADATA_SCHEMA_KEY_COLUMN_INDEX">METADATA_<wbr>SCHEMA_<wbr>KEY_<wbr>COLUMN_<wbr>INDEX</a></dt><dt><a class="constant" href="constant.METADATA_SCHEMA_KEY_COLUMN_NAME.html" title="constant store_api::metric_engine_consts::METADATA_SCHEMA_KEY_COLUMN_NAME">METADATA_<wbr>SCHEMA_<wbr>KEY_<wbr>COLUMN_<wbr>NAME</a></dt><dt><a class="constant" href="constant.METADATA_SCHEMA_TIMESTAMP_COLUMN_INDEX.html" title="constant store_api::metric_engine_consts::METADATA_SCHEMA_TIMESTAMP_COLUMN_INDEX">METADATA_<wbr>SCHEMA_<wbr>TIMESTAMP_<wbr>COLUMN_<wbr>INDEX</a></dt><dt><a class="constant" href="constant.METADATA_SCHEMA_TIMESTAMP_COLUMN_NAME.html" title="constant store_api::metric_engine_consts::METADATA_SCHEMA_TIMESTAMP_COLUMN_NAME">METADATA_<wbr>SCHEMA_<wbr>TIMESTAMP_<wbr>COLUMN_<wbr>NAME</a></dt><dt><a class="constant" href="constant.METADATA_SCHEMA_VALUE_COLUMN_INDEX.html" title="constant store_api::metric_engine_consts::METADATA_SCHEMA_VALUE_COLUMN_INDEX">METADATA_<wbr>SCHEMA_<wbr>VALUE_<wbr>COLUMN_<wbr>INDEX</a></dt><dt><a class="constant" href="constant.METADATA_SCHEMA_VALUE_COLUMN_NAME.html" title="constant store_api::metric_engine_consts::METADATA_SCHEMA_VALUE_COLUMN_NAME">METADATA_<wbr>SCHEMA_<wbr>VALUE_<wbr>COLUMN_<wbr>NAME</a></dt><dt><a class="constant" href="constant.METRIC_DATA_REGION_GROUP.html" title="constant store_api::metric_engine_consts::METRIC_DATA_REGION_GROUP">METRIC_<wbr>DATA_<wbr>REGION_<wbr>GROUP</a></dt><dd>region group value for data region inside a metric region</dd><dt><a class="constant" href="constant.METRIC_ENGINE_INDEX_SKIPPING_INDEX_FALSE_POSITIVE_RATE_OPTION.html" title="constant store_api::metric_engine_consts::METRIC_ENGINE_INDEX_SKIPPING_INDEX_FALSE_POSITIVE_RATE_OPTION">METRIC_<wbr>ENGINE_<wbr>INDEX_<wbr>SKIPPING_<wbr>INDEX_<wbr>FALSE_<wbr>POSITIVE_<wbr>RATE_<wbr>OPTION</a></dt><dt><a class="constant" href="constant.METRIC_ENGINE_INDEX_SKIPPING_INDEX_FALSE_POSITIVE_RATE_OPTION_DEFAULT.html" title="constant store_api::metric_engine_consts::METRIC_ENGINE_INDEX_SKIPPING_INDEX_FALSE_POSITIVE_RATE_OPTION_DEFAULT">METRIC_<wbr>ENGINE_<wbr>INDEX_<wbr>SKIPPING_<wbr>INDEX_<wbr>FALSE_<wbr>POSITIVE_<wbr>RATE_<wbr>OPTION_<wbr>DEFAULT</a></dt><dd>Default false positive rate for the skipping index in the metric engine.</dd><dt><a class="constant" href="constant.METRIC_ENGINE_INDEX_SKIPPING_INDEX_GRANULARITY_OPTION.html" title="constant store_api::metric_engine_consts::METRIC_ENGINE_INDEX_SKIPPING_INDEX_GRANULARITY_OPTION">METRIC_<wbr>ENGINE_<wbr>INDEX_<wbr>SKIPPING_<wbr>INDEX_<wbr>GRANULARITY_<wbr>OPTION</a></dt><dd>Option key for the granularity of the skipping index in the metric engine.
This key is used to specify the granularity of the primary key index (skipping index) in the metric engine.</dd><dt><a class="constant" href="constant.METRIC_ENGINE_INDEX_SKIPPING_INDEX_GRANULARITY_OPTION_DEFAULT.html" title="constant store_api::metric_engine_consts::METRIC_ENGINE_INDEX_SKIPPING_INDEX_GRANULARITY_OPTION_DEFAULT">METRIC_<wbr>ENGINE_<wbr>INDEX_<wbr>SKIPPING_<wbr>INDEX_<wbr>GRANULARITY_<wbr>OPTION_<wbr>DEFAULT</a></dt><dd>Default granularity for the skipping index in the metric engine.</dd><dt><a class="constant" href="constant.METRIC_ENGINE_INDEX_TYPE_OPTION.html" title="constant store_api::metric_engine_consts::METRIC_ENGINE_INDEX_TYPE_OPTION">METRIC_<wbr>ENGINE_<wbr>INDEX_<wbr>TYPE_<wbr>OPTION</a></dt><dd>Option key for metric engine index type.
Used to identify the primary key index type of the metric engine.</dd><dt><a class="constant" href="constant.METRIC_ENGINE_NAME.html" title="constant store_api::metric_engine_consts::METRIC_ENGINE_NAME">METRIC_<wbr>ENGINE_<wbr>NAME</a></dt><dt><a class="constant" href="constant.METRIC_METADATA_REGION_GROUP.html" title="constant store_api::metric_engine_consts::METRIC_METADATA_REGION_GROUP">METRIC_<wbr>METADATA_<wbr>REGION_<wbr>GROUP</a></dt><dd>region group value for metadata region inside a metric region</dd><dt><a class="constant" href="constant.PHYSICAL_TABLE_METADATA_KEY.html" title="constant store_api::metric_engine_consts::PHYSICAL_TABLE_METADATA_KEY">PHYSICAL_<wbr>TABLE_<wbr>METADATA_<wbr>KEY</a></dt><dd>Metadata key present in the <code>CREATE TABLE ... WITH ()</code> clause. This key is
used to identify the table is a physical metric table. E.g.:</dd><dt><a class="constant" href="constant.TABLE_COLUMN_METADATA_EXTENSION_KEY.html" title="constant store_api::metric_engine_consts::TABLE_COLUMN_METADATA_EXTENSION_KEY">TABLE_<wbr>COLUMN_<wbr>METADATA_<wbr>EXTENSION_<wbr>KEY</a></dt><dd>HashMap key to be used in the region server’s extension response.
Represent the column metadata of a table.</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.is_metric_engine.html" title="fn store_api::metric_engine_consts::is_metric_engine">is_<wbr>metric_<wbr>engine</a></dt><dd>Returns true if it’s metric engine</dd><dt><a class="fn" href="fn.is_metric_engine_internal_column.html" title="fn store_api::metric_engine_consts::is_metric_engine_internal_column">is_<wbr>metric_<wbr>engine_<wbr>internal_<wbr>column</a></dt><dd>Returns true if it’s a internal column of the metric engine.</dd><dt><a class="fn" href="fn.is_metric_engine_option_key.html" title="fn store_api::metric_engine_consts::is_metric_engine_option_key">is_<wbr>metric_<wbr>engine_<wbr>option_<wbr>key</a></dt><dd>Returns true if the <code>key</code> is a valid option key for the metric engine.</dd></dl></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink