rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-01-09 14:52:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
greptimedb/datatypes/schema/index.html
github-merge-queue[bot] b451487ba2 Deploying to gh-pages from @ GreptimeTeam/greptimedb@0c373062c2 🚀
2026-01-09 10:26:55 +00:00

1 line
12 KiB
HTML
Raw Permalink 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 `schema` mod in crate `datatypes`."><title>datatypes::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-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="datatypes" 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 schema</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../datatypes/index.html">datatypes</a><span class="version">1.0.0-beta.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module schema</a></h2><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</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="#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 datatypes</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">datatypes</a></div><h1>Module <span>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/datatypes/schema.rs.html#15-511">Source</a> </span></div><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.ColumnDefaultConstraint"><code>pub use crate::schema::constraint::<a class="enum" href="constraint/enum.ColumnDefaultConstraint.html" title="enum datatypes::schema::constraint::ColumnDefaultConstraint">ColumnDefaultConstraint</a>;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="column_schema/index.html" title="mod datatypes::schema::column_schema">column_<wbr>schema</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="constraint/index.html" title="mod datatypes::schema::constraint">constraint</a></dt><dt><a class="mod" href="raw/index.html" title="mod datatypes::schema::raw">raw</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.ColumnSchema.html" title="struct datatypes::schema::ColumnSchema">Column<wbr>Schema</a></dt><dd>Schema of a column, used as an immutable struct.</dd><dt><a class="struct" href="struct.FieldsAndIndices.html" title="struct datatypes::schema::FieldsAndIndices">Fields<wbr>AndIndices</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.FulltextOptions.html" title="struct datatypes::schema::FulltextOptions">Fulltext<wbr>Options</a></dt><dd>Fulltext options for a column.</dd><dt><a class="struct" href="struct.RawSchema.html" title="struct datatypes::schema::RawSchema">RawSchema</a></dt><dd>Struct used to serialize and deserialize <a href="struct.Schema.html" title="struct datatypes::schema::Schema"><code>Schema</code></a>.</dd><dt><a class="struct" href="struct.Schema.html" title="struct datatypes::schema::Schema">Schema</a></dt><dd>A common schema, should be immutable.</dd><dt><a class="struct" href="struct.SchemaBuilder.html" title="struct datatypes::schema::SchemaBuilder">Schema<wbr>Builder</a></dt><dt><a class="struct" href="struct.SkippingIndexOptions.html" title="struct datatypes::schema::SkippingIndexOptions">Skipping<wbr>Index<wbr>Options</a></dt><dd>Skipping options for a column.</dd><dt><a class="struct" href="struct.VectorIndexOptions.html" title="struct datatypes::schema::VectorIndexOptions">Vector<wbr>Index<wbr>Options</a></dt><dd>Options for vector index (HNSW).</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.ColumnExtType.html" title="enum datatypes::schema::ColumnExtType">Column<wbr>ExtType</a></dt><dd>Column extended type set in column schema’s metadata.</dd><dt><a class="enum" href="enum.FulltextAnalyzer.html" title="enum datatypes::schema::FulltextAnalyzer">Fulltext<wbr>Analyzer</a></dt><dd>Fulltext analyzer.</dd><dt><a class="enum" href="enum.FulltextBackend.html" title="enum datatypes::schema::FulltextBackend">Fulltext<wbr>Backend</a></dt><dd>The backend of the fulltext index.</dd><dt><a class="enum" href="enum.SkippingIndexType.html" title="enum datatypes::schema::SkippingIndexType">Skipping<wbr>Index<wbr>Type</a></dt><dd>Skip index types.</dd><dt><a class="enum" href="enum.VectorDistanceMetric.html" title="enum datatypes::schema::VectorDistanceMetric">Vector<wbr>Distance<wbr>Metric</a></dt><dd>Distance metric for vector similarity search.</dd><dt><a class="enum" href="enum.VectorIndexEngineType.html" title="enum datatypes::schema::VectorIndexEngineType">Vector<wbr>Index<wbr>Engine<wbr>Type</a></dt><dd>Supported vector index engine types.</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.COLUMN_FULLTEXT_CHANGE_OPT_KEY_ENABLE.html" title="constant datatypes::schema::COLUMN_FULLTEXT_CHANGE_OPT_KEY_ENABLE">COLUMN_<wbr>FULLTEXT_<wbr>CHANGE_<wbr>OPT_<wbr>KEY_<wbr>ENABLE</a></dt><dd>Keys used in fulltext options</dd><dt><a class="constant" href="constant.COLUMN_FULLTEXT_OPT_KEY_ANALYZER.html" title="constant datatypes::schema::COLUMN_FULLTEXT_OPT_KEY_ANALYZER">COLUMN_<wbr>FULLTEXT_<wbr>OPT_<wbr>KEY_<wbr>ANALYZER</a></dt><dt><a class="constant" href="constant.COLUMN_FULLTEXT_OPT_KEY_BACKEND.html" title="constant datatypes::schema::COLUMN_FULLTEXT_OPT_KEY_BACKEND">COLUMN_<wbr>FULLTEXT_<wbr>OPT_<wbr>KEY_<wbr>BACKEND</a></dt><dt><a class="constant" href="constant.COLUMN_FULLTEXT_OPT_KEY_CASE_SENSITIVE.html" title="constant datatypes::schema::COLUMN_FULLTEXT_OPT_KEY_CASE_SENSITIVE">COLUMN_<wbr>FULLTEXT_<wbr>OPT_<wbr>KEY_<wbr>CASE_<wbr>SENSITIVE</a></dt><dt><a class="constant" href="constant.COLUMN_FULLTEXT_OPT_KEY_FALSE_POSITIVE_RATE.html" title="constant datatypes::schema::COLUMN_FULLTEXT_OPT_KEY_FALSE_POSITIVE_RATE">COLUMN_<wbr>FULLTEXT_<wbr>OPT_<wbr>KEY_<wbr>FALSE_<wbr>POSITIVE_<wbr>RATE</a></dt><dt><a class="constant" href="constant.COLUMN_FULLTEXT_OPT_KEY_GRANULARITY.html" title="constant datatypes::schema::COLUMN_FULLTEXT_OPT_KEY_GRANULARITY">COLUMN_<wbr>FULLTEXT_<wbr>OPT_<wbr>KEY_<wbr>GRANULARITY</a></dt><dt><a class="constant" href="constant.COLUMN_SKIPPING_INDEX_OPT_KEY_FALSE_POSITIVE_RATE.html" title="constant datatypes::schema::COLUMN_SKIPPING_INDEX_OPT_KEY_FALSE_POSITIVE_RATE">COLUMN_<wbr>SKIPPING_<wbr>INDEX_<wbr>OPT_<wbr>KEY_<wbr>FALSE_<wbr>POSITIVE_<wbr>RATE</a></dt><dt><a class="constant" href="constant.COLUMN_SKIPPING_INDEX_OPT_KEY_GRANULARITY.html" title="constant datatypes::schema::COLUMN_SKIPPING_INDEX_OPT_KEY_GRANULARITY">COLUMN_<wbr>SKIPPING_<wbr>INDEX_<wbr>OPT_<wbr>KEY_<wbr>GRANULARITY</a></dt><dd>Keys used in SKIPPING index options</dd><dt><a class="constant" href="constant.COLUMN_SKIPPING_INDEX_OPT_KEY_TYPE.html" title="constant datatypes::schema::COLUMN_SKIPPING_INDEX_OPT_KEY_TYPE">COLUMN_<wbr>SKIPPING_<wbr>INDEX_<wbr>OPT_<wbr>KEY_<wbr>TYPE</a></dt><dt><a class="constant" href="constant.COMMENT_KEY.html" title="constant datatypes::schema::COMMENT_KEY">COMMENT_<wbr>KEY</a></dt><dt><a class="constant" href="constant.FULLTEXT_KEY.html" title="constant datatypes::schema::FULLTEXT_KEY">FULLTEXT_<wbr>KEY</a></dt><dd>Key used to store fulltext options in arrow field’s metadata.</dd><dt><a class="constant" href="constant.INVERTED_INDEX_KEY.html" title="constant datatypes::schema::INVERTED_INDEX_KEY">INVERTED_<wbr>INDEX_<wbr>KEY</a></dt><dd>Key used to store whether the column has inverted index in arrow field’s metadata.</dd><dt><a class="constant" href="constant.SKIPPING_INDEX_KEY.html" title="constant datatypes::schema::SKIPPING_INDEX_KEY">SKIPPING_<wbr>INDEX_<wbr>KEY</a></dt><dd>Key used to store skip options in arrow field’s metadata.</dd><dt><a class="constant" href="constant.TIME_INDEX_KEY.html" title="constant datatypes::schema::TIME_INDEX_KEY">TIME_<wbr>INDEX_<wbr>KEY</a></dt><dd>Key used to store whether the column is time index in arrow field’s metadata.</dd><dt><a class="constant" href="constant.TYPE_KEY.html" title="constant datatypes::schema::TYPE_KEY">TYPE_<wbr>KEY</a></dt><dd>Key used to store actual column type in field metadata.</dd><dt><a class="constant" href="constant.VECTOR_INDEX_KEY.html" title="constant datatypes::schema::VECTOR_INDEX_KEY">VECTOR_<wbr>INDEX_<wbr>KEY</a></dt><dd>Key used to store vector index options in arrow field’s metadata.</dd><dt><a class="constant" href="constant.VERSION_KEY.html" title="constant datatypes::schema::VERSION_KEY">VERSION_<wbr>KEY</a></dt><dd>Key used to store version number of the schema in metadata.</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.collect_fields.html" title="fn datatypes::schema::collect_fields">collect_<wbr>fields</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.try_parse_version.html" title="fn datatypes::schema::try_parse_version">try_<wbr>parse_<wbr>version</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.validate_timestamp_index.html" title="fn datatypes::schema::validate_timestamp_index">validate_<wbr>timestamp_<wbr>index</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.Metadata.html" title="type datatypes::schema::Metadata">Metadata</a></dt><dt><a class="type" href="type.SchemaRef.html" title="type datatypes::schema::SchemaRef">Schema<wbr>Ref</a></dt></dl></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink