Files
greptimedb/catalog/system_schema/information_schema/index.html
2026-06-23 06:43:14 +00:00

5 lines
18 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="API documentation for the Rust `information_schema` mod in crate `catalog`."><title>catalog::system_schema::information_schema - 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="catalog" 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 information_schema</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../catalog/index.html">catalog</a><span class="version">1.2.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module information_<wbr>schema</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="#macros" title="Macros">Macros</a></li><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 catalog::<wbr>system_<wbr>schema</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">catalog</a>::<wbr><a href="../index.html">system_schema</a></div><h1>Module <span>information_<wbr>schema</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/catalog/system_schema/information_schema.rs.html#15-568">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="cluster_info/index.html" title="mod catalog::system_schema::information_schema::cluster_info">cluster_<wbr>info</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="columns/index.html" title="mod catalog::system_schema::information_schema::columns">columns</a></dt><dt><a class="mod" href="flows/index.html" title="mod catalog::system_schema::information_schema::flows">flows</a></dt><dt><a class="mod" href="information_memory_table/index.html" title="mod catalog::system_schema::information_schema::information_memory_table">information_<wbr>memory_<wbr>table</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="key_column_usage/index.html" title="mod catalog::system_schema::information_schema::key_column_usage">key_<wbr>column_<wbr>usage</a></dt><dt><a class="mod" href="partitions/index.html" title="mod catalog::system_schema::information_schema::partitions">partitions</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="procedure_info/index.html" title="mod catalog::system_schema::information_schema::procedure_info">procedure_<wbr>info</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="process_list/index.html" title="mod catalog::system_schema::information_schema::process_list">process_<wbr>list</a></dt><dt><a class="mod" href="region_info/index.html" title="mod catalog::system_schema::information_schema::region_info">region_<wbr>info</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="region_peers/index.html" title="mod catalog::system_schema::information_schema::region_peers">region_<wbr>peers</a></dt><dt><a class="mod" href="region_statistics/index.html" title="mod catalog::system_schema::information_schema::region_statistics">region_<wbr>statistics</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="schemata/index.html" title="mod catalog::system_schema::information_schema::schemata">schemata</a></dt><dt><a class="mod" href="ssts/index.html" title="mod catalog::system_schema::information_schema::ssts">ssts</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="statistics/index.html" title="mod catalog::system_schema::information_schema::statistics">statistics</a></dt><dt><a class="mod" href="table_constraints/index.html" title="mod catalog::system_schema::information_schema::table_constraints">table_<wbr>constraints</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="table_names/index.html" title="mod catalog::system_schema::information_schema::table_names">table_<wbr>names</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>All table names in <code>information_schema</code>.</dd><dt><a class="mod" href="table_semantics/index.html" title="mod catalog::system_schema::information_schema::table_semantics">table_<wbr>semantics</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd><code>information_schema.table_semantics</code>: the queryable view over the table
semantic layer. One row per table that carries at least one
<code>greptime.semantic.*</code> option, so a consumer can discover the observability
concept a table stands for with a single SQL query instead of parsing every
tables <code>create_options</code>.</dd><dt><a class="mod" href="tables/index.html" title="mod catalog::system_schema::information_schema::tables">tables</a></dt><dt><a class="mod" href="views/index.html" title="mod catalog::system_schema::information_schema::views">views</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.setup_memory_table.html" title="macro catalog::system_schema::information_schema::setup_memory_table">setup_<wbr>memory_<wbr>table</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></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.DatanodeInspectRequest.html" title="struct catalog::system_schema::information_schema::DatanodeInspectRequest">Datanode<wbr>Inspect<wbr>Request</a></dt><dd>The request to inspect the datanode.</dd><dt><a class="struct" href="struct.InformationSchemaProvider.html" title="struct catalog::system_schema::information_schema::InformationSchemaProvider">Information<wbr>Schema<wbr>Provider</a></dt><dd>The <code>information_schema</code> tables info provider.</dd><dt><a class="struct" href="struct.MEMORY_TABLES.html" title="struct catalog::system_schema::information_schema::MEMORY_TABLES">MEMORY_<wbr>TABLES</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.MakeInformationTableRequest.html" title="struct catalog::system_schema::information_schema::MakeInformationTableRequest">Make<wbr>Information<wbr>Table<wbr>Request</a></dt><dt><a class="struct" href="struct.NoopInformationExtension.html" title="struct catalog::system_schema::information_schema::NoopInformationExtension">Noop<wbr>Information<wbr>Extension</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.DatanodeInspectKind.html" title="enum catalog::system_schema::information_schema::DatanodeInspectKind">Datanode<wbr>Inspect<wbr>Kind</a></dt><dd>The kind of the datanode inspect request.</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.BUILD_INFO.html" title="constant catalog::system_schema::information_schema::BUILD_INFO">BUILD_<wbr>INFO</a></dt><dt><a class="constant" href="constant.CHARACTER_SETS.html" title="constant catalog::system_schema::information_schema::CHARACTER_SETS">CHARACTER_<wbr>SETS</a></dt><dt><a class="constant" href="constant.CHECK_CONSTRAINTS.html" title="constant catalog::system_schema::information_schema::CHECK_CONSTRAINTS">CHECK_<wbr>CONSTRAINTS</a></dt><dt><a class="constant" href="constant.CLUSTER_INFO.html" title="constant catalog::system_schema::information_schema::CLUSTER_INFO">CLUSTER_<wbr>INFO</a></dt><dt><a class="constant" href="constant.COLLATIONS.html" title="constant catalog::system_schema::information_schema::COLLATIONS">COLLATIONS</a></dt><dt><a class="constant" href="constant.COLLATION_CHARACTER_SET_APPLICABILITY.html" title="constant catalog::system_schema::information_schema::COLLATION_CHARACTER_SET_APPLICABILITY">COLLATION_<wbr>CHARACTER_<wbr>SET_<wbr>APPLICABILITY</a></dt><dt><a class="constant" href="constant.COLUMNS.html" title="constant catalog::system_schema::information_schema::COLUMNS">COLUMNS</a></dt><dt><a class="constant" href="constant.COLUMN_PRIVILEGES.html" title="constant catalog::system_schema::information_schema::COLUMN_PRIVILEGES">COLUMN_<wbr>PRIVILEGES</a></dt><dt><a class="constant" href="constant.COLUMN_STATISTICS.html" title="constant catalog::system_schema::information_schema::COLUMN_STATISTICS">COLUMN_<wbr>STATISTICS</a></dt><dt><a class="constant" href="constant.DENSE_PRIMARY_KEY_ENCODING.html" title="constant catalog::system_schema::information_schema::DENSE_PRIMARY_KEY_ENCODING">DENSE_<wbr>PRIMARY_<wbr>KEY_<wbr>ENCODING</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.ENGINES.html" title="constant catalog::system_schema::information_schema::ENGINES">ENGINES</a></dt><dt><a class="constant" href="constant.EVENTS.html" title="constant catalog::system_schema::information_schema::EVENTS">EVENTS</a></dt><dt><a class="constant" href="constant.FILES.html" title="constant catalog::system_schema::information_schema::FILES">FILES</a></dt><dt><a class="constant" href="constant.FLOWS.html" title="constant catalog::system_schema::information_schema::FLOWS">FLOWS</a></dt><dt><a class="constant" href="constant.GLOBAL_STATUS.html" title="constant catalog::system_schema::information_schema::GLOBAL_STATUS">GLOBAL_<wbr>STATUS</a></dt><dt><a class="constant" href="constant.KEY_COLUMN_USAGE.html" title="constant catalog::system_schema::information_schema::KEY_COLUMN_USAGE">KEY_<wbr>COLUMN_<wbr>USAGE</a></dt><dt><a class="constant" href="constant.OPTIMIZER_TRACE.html" title="constant catalog::system_schema::information_schema::OPTIMIZER_TRACE">OPTIMIZER_<wbr>TRACE</a></dt><dt><a class="constant" href="constant.PARAMETERS.html" title="constant catalog::system_schema::information_schema::PARAMETERS">PARAMETERS</a></dt><dt><a class="constant" href="constant.PARTITIONS.html" title="constant catalog::system_schema::information_schema::PARTITIONS">PARTITIONS</a></dt><dt><a class="constant" href="constant.PROCEDURE_INFO.html" title="constant catalog::system_schema::information_schema::PROCEDURE_INFO">PROCEDURE_<wbr>INFO</a></dt><dt><a class="constant" href="constant.PROCESS_LIST.html" title="constant catalog::system_schema::information_schema::PROCESS_LIST">PROCESS_<wbr>LIST</a></dt><dt><a class="constant" href="constant.PROFILING.html" title="constant catalog::system_schema::information_schema::PROFILING">PROFILING</a></dt><dt><a class="constant" href="constant.REFERENTIAL_CONSTRAINTS.html" title="constant catalog::system_schema::information_schema::REFERENTIAL_CONSTRAINTS">REFERENTIAL_<wbr>CONSTRAINTS</a></dt><dt><a class="constant" href="constant.REGION_INFO.html" title="constant catalog::system_schema::information_schema::REGION_INFO">REGION_<wbr>INFO</a></dt><dt><a class="constant" href="constant.REGION_PEERS.html" title="constant catalog::system_schema::information_schema::REGION_PEERS">REGION_<wbr>PEERS</a></dt><dt><a class="constant" href="constant.REGION_STATISTICS.html" title="constant catalog::system_schema::information_schema::REGION_STATISTICS">REGION_<wbr>STATISTICS</a></dt><dt><a class="constant" href="constant.ROUTINES.html" title="constant catalog::system_schema::information_schema::ROUTINES">ROUTINES</a></dt><dt><a class="constant" href="constant.SCHEMATA.html" title="constant catalog::system_schema::information_schema::SCHEMATA">SCHEMATA</a></dt><dt><a class="constant" href="constant.SCHEMA_PRIVILEGES.html" title="constant catalog::system_schema::information_schema::SCHEMA_PRIVILEGES">SCHEMA_<wbr>PRIVILEGES</a></dt><dt><a class="constant" href="constant.SESSION_STATUS.html" title="constant catalog::system_schema::information_schema::SESSION_STATUS">SESSION_<wbr>STATUS</a></dt><dt><a class="constant" href="constant.SPARSE_PRIMARY_KEY_ENCODING.html" title="constant catalog::system_schema::information_schema::SPARSE_PRIMARY_KEY_ENCODING">SPARSE_<wbr>PRIMARY_<wbr>KEY_<wbr>ENCODING</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.SSTS_INDEX_META.html" title="constant catalog::system_schema::information_schema::SSTS_INDEX_META">SSTS_<wbr>INDEX_<wbr>META</a></dt><dt><a class="constant" href="constant.SSTS_MANIFEST.html" title="constant catalog::system_schema::information_schema::SSTS_MANIFEST">SSTS_<wbr>MANIFEST</a></dt><dt><a class="constant" href="constant.SSTS_STORAGE.html" title="constant catalog::system_schema::information_schema::SSTS_STORAGE">SSTS_<wbr>STORAGE</a></dt><dt><a class="constant" href="constant.STATISTICS.html" title="constant catalog::system_schema::information_schema::STATISTICS">STATISTICS</a></dt><dt><a class="constant" href="constant.TABLES.html" title="constant catalog::system_schema::information_schema::TABLES">TABLES</a></dt><dt><a class="constant" href="constant.TABLE_CONSTRAINTS.html" title="constant catalog::system_schema::information_schema::TABLE_CONSTRAINTS">TABLE_<wbr>CONSTRAINTS</a></dt><dt><a class="constant" href="constant.TABLE_PRIVILEGES.html" title="constant catalog::system_schema::information_schema::TABLE_PRIVILEGES">TABLE_<wbr>PRIVILEGES</a></dt><dt><a class="constant" href="constant.TABLE_SEMANTICS.html" title="constant catalog::system_schema::information_schema::TABLE_SEMANTICS">TABLE_<wbr>SEMANTICS</a></dt><dt><a class="constant" href="constant.TRIGGERS.html" title="constant catalog::system_schema::information_schema::TRIGGERS">TRIGGERS</a></dt><dt><a class="constant" href="constant.VIEWS.html" title="constant catalog::system_schema::information_schema::VIEWS">VIEWS</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.InformationExtension.html" title="trait catalog::system_schema::information_schema::InformationExtension">Information<wbr>Extension</a></dt><dd>The <code>InformationExtension</code> trait provides the extension methods for the <code>information_schema</code> tables.</dd><dt><a class="trait" href="trait.InformationSchemaTableFactory.html" title="trait catalog::system_schema::information_schema::InformationSchemaTableFactory">Information<wbr>Schema<wbr>Table<wbr>Factory</a></dt><dd>A factory trait for making information schema tables.</dd><dt><a class="trait" href="trait.InformationTable.html" title="trait catalog::system_schema::information_schema::InformationTable">Information<wbr>Table</a></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.primary_key_encoding_index_type.html" title="fn catalog::system_schema::information_schema::primary_key_encoding_index_type">primary_<wbr>key_<wbr>encoding_<wbr>index_<wbr>type</a><span title="Restricted Visibility">&nbsp;🔒</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.InformationExtensionRef.html" title="type catalog::system_schema::information_schema::InformationExtensionRef">Information<wbr>Extension<wbr>Ref</a></dt><dt><a class="type" href="type.InformationSchemaTableFactoryRef.html" title="type catalog::system_schema::information_schema::InformationSchemaTableFactoryRef">Information<wbr>Schema<wbr>Table<wbr>Factory<wbr>Ref</a></dt></dl></section></div></main></body></html>