rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-01-10 07:12:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
be34bef8e71143cdb3ca3e4f366143e2b68a26cb
greptimedb/store_api/metadata/index.html
github-merge-queue[bot] be34bef8e7 Deploying to gh-pages from @ GreptimeTeam/greptimedb@4f290111db 🚀
2025-12-25 19:26:42 +00:00

3 lines
12 KiB
HTML
Raw Blame History

<!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="Metadata of region and column."><title>store_api::metadata - 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 metadata</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-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module metadata</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="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</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>metadata</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/metadata.rs.html#15-2059">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Metadata of region and column.</p>
<p>This mod has its own error type <a href="enum.MetadataError.html" title="enum store_api::metadata::MetadataError">MetadataError</a> for validation and codec exceptions.</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.CastDefaultValueSnafu.html" title="struct store_api::metadata::CastDefaultValueSnafu">Cast<wbr>Default<wbr>Value<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::CastDefaultValue</code> variant</dd><dt><a class="struct" href="struct.ChangeColumnNotFoundSnafu.html" title="struct store_api::metadata::ChangeColumnNotFoundSnafu">Change<wbr>Column<wbr>NotFound<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::ChangeColumnNotFound</code> variant</dd><dt><a class="struct" href="struct.ColumnMetadata.html" title="struct store_api::metadata::ColumnMetadata">Column<wbr>Metadata</a></dt><dd>Metadata of a column.</dd><dt><a class="struct" href="struct.ConvertColumnSchemaSnafu.html" title="struct store_api::metadata::ConvertColumnSchemaSnafu">Convert<wbr>Column<wbr>Schema<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::ConvertColumnSchema</code> variant</dd><dt><a class="struct" href="struct.ConvertTimeRangesSnafu.html" title="struct store_api::metadata::ConvertTimeRangesSnafu">Convert<wbr>Time<wbr>Ranges<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::ConvertTimeRanges</code> variant</dd><dt><a class="struct" href="struct.DecodeArrowIpcSnafu.html" title="struct store_api::metadata::DecodeArrowIpcSnafu">Decode<wbr>Arrow<wbr>IpcSnafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::DecodeArrowIpc</code> variant</dd><dt><a class="struct" href="struct.DecodeProtoSnafu.html" title="struct store_api::metadata::DecodeProtoSnafu">Decode<wbr>Proto<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::DecodeProto</code> variant</dd><dt><a class="struct" href="struct.FlightCodecSnafu.html" title="struct store_api::metadata::FlightCodecSnafu">Flight<wbr>Codec<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::FlightCodec</code> variant</dd><dt><a class="struct" href="struct.GetFulltextOptionsSnafu.html" title="struct store_api::metadata::GetFulltextOptionsSnafu">GetFulltext<wbr>Options<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::GetFulltextOptions</code> variant</dd><dt><a class="struct" href="struct.InvalidColumnOptionSnafu.html" title="struct store_api::metadata::InvalidColumnOptionSnafu">Invalid<wbr>Column<wbr>Option<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::InvalidColumnOption</code> variant</dd><dt><a class="struct" href="struct.InvalidIndexOptionSnafu.html" title="struct store_api::metadata::InvalidIndexOptionSnafu">Invalid<wbr>Index<wbr>Option<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::InvalidIndexOption</code> variant</dd><dt><a class="struct" href="struct.InvalidMetaSnafu.html" title="struct store_api::metadata::InvalidMetaSnafu">Invalid<wbr>Meta<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::InvalidMeta</code> variant</dd><dt><a class="struct" href="struct.InvalidRawRegionRequestSnafu.html" title="struct store_api::metadata::InvalidRawRegionRequestSnafu">Invalid<wbr>RawRegion<wbr>Request<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::InvalidRawRegionRequest</code> variant</dd><dt><a class="struct" href="struct.InvalidRegionRequestSnafu.html" title="struct store_api::metadata::InvalidRegionRequestSnafu">Invalid<wbr>Region<wbr>Request<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::InvalidRegionRequest</code> variant</dd><dt><a class="struct" href="struct.InvalidSchemaSnafu.html" title="struct store_api::metadata::InvalidSchemaSnafu">Invalid<wbr>Schema<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::InvalidSchema</code> variant</dd><dt><a class="struct" href="struct.InvalidSetRegionOptionRequestSnafu.html" title="struct store_api::metadata::InvalidSetRegionOptionRequestSnafu">Invalid<wbr>SetRegion<wbr>Option<wbr>Request<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::InvalidSetRegionOptionRequest</code> variant</dd><dt><a class="struct" href="struct.InvalidUnsetRegionOptionRequestSnafu.html" title="struct store_api::metadata::InvalidUnsetRegionOptionRequestSnafu">Invalid<wbr>Unset<wbr>Region<wbr>Option<wbr>Request<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::InvalidUnsetRegionOptionRequest</code> variant</dd><dt><a class="struct" href="struct.RegionMetadata.html" title="struct store_api::metadata::RegionMetadata">Region<wbr>Metadata</a></dt><dd>General static metadata of a region.</dd><dt><a class="struct" href="struct.RegionMetadataBuilder.html" title="struct store_api::metadata::RegionMetadataBuilder">Region<wbr>Metadata<wbr>Builder</a></dt><dd>Builder to build <a href="struct.RegionMetadata.html" title="struct store_api::metadata::RegionMetadata">RegionMetadata</a>.</dd><dt><a class="struct" href="struct.SchemaProjectSnafu.html" title="struct store_api::metadata::SchemaProjectSnafu">Schema<wbr>Project<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::SchemaProject</code> variant</dd><dt><a class="struct" href="struct.SerdeJsonSnafu.html" title="struct store_api::metadata::SerdeJsonSnafu">Serde<wbr>Json<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::SerdeJson</code> variant</dd><dt><a class="struct" href="struct.SetFulltextOptionsSnafu.html" title="struct store_api::metadata::SetFulltextOptionsSnafu">SetFulltext<wbr>Options<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::SetFulltextOptions</code> variant</dd><dt><a class="struct" href="struct.SetSkippingIndexOptionsSnafu.html" title="struct store_api::metadata::SetSkippingIndexOptionsSnafu">SetSkipping<wbr>Index<wbr>Options<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::SetSkippingIndexOptions</code> variant</dd><dt><a class="struct" href="struct.SkippedFields.html" title="struct store_api::metadata::SkippedFields">Skipped<wbr>Fields</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Fields skipped in serialization.</dd><dt><a class="struct" href="struct.SqlCommonSnafu.html" title="struct store_api::metadata::SqlCommonSnafu">SqlCommon<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::SqlCommon</code> variant</dd><dt><a class="struct" href="struct.TimeIndexNotFoundSnafu.html" title="struct store_api::metadata::TimeIndexNotFoundSnafu">Time<wbr>Index<wbr>NotFound<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::TimeIndexNotFound</code> variant</dd><dt><a class="struct" href="struct.UnexpectedSnafu.html" title="struct store_api::metadata::UnexpectedSnafu">Unexpected<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::Unexpected</code> variant</dd><dt><a class="struct" href="struct.UnsetSkippingIndexOptionsSnafu.html" title="struct store_api::metadata::UnsetSkippingIndexOptionsSnafu">Unset<wbr>Skipping<wbr>Index<wbr>Options<wbr>Snafu</a></dt><dd>SNAFU context selector for the <code>MetadataError::UnsetSkippingIndexOptions</code> variant</dd></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.MetadataError.html" title="enum store_api::metadata::MetadataError">Metadata<wbr>Error</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.set_column_fulltext_options.html" title="fn store_api::metadata::set_column_fulltext_options">set_<wbr>column_<wbr>fulltext_<wbr>options</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Set column fulltext options if it passed the validation.</dd><dt><a class="fn" href="fn.unset_column_fulltext_options.html" title="fn store_api::metadata::unset_column_fulltext_options">unset_<wbr>column_<wbr>fulltext_<wbr>options</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.RegionMetadataRef.html" title="type store_api::metadata::RegionMetadataRef">Region<wbr>Metadata<wbr>Ref</a></dt><dt><a class="type" href="type.Result.html" title="type store_api::metadata::Result">Result</a></dt></dl></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink