mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-10 15:22:56 +00:00
1 line
6.8 KiB
HTML
1 line
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 `column_def` mod in crate `api`."><title>api::v1::column_def - 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 column_def</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 column_<wbr>def</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><a href="../index.html">In api::v1</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">v1</a></div><h1>Module <span>column_<wbr>def</span> <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/v1/column_def.rs.html#15-349">Source</a> </span></div><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.FULLTEXT_GRPC_KEY.html" title="constant api::v1::column_def::FULLTEXT_GRPC_KEY">FULLTEXT_<wbr>GRPC_<wbr>KEY</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Key used to store fulltext options in gRPC column options.</dd><dt><a class="constant" href="constant.INVERTED_INDEX_GRPC_KEY.html" title="constant api::v1::column_def::INVERTED_INDEX_GRPC_KEY">INVERTED_<wbr>INDEX_<wbr>GRPC_<wbr>KEY</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Key used to store inverted index options in gRPC column options.</dd><dt><a class="constant" href="constant.SKIPPING_INDEX_GRPC_KEY.html" title="constant api::v1::column_def::SKIPPING_INDEX_GRPC_KEY">SKIPPING_<wbr>INDEX_<wbr>GRPC_<wbr>KEY</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Key used to store skip index options in gRPC column options.</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.as_fulltext_option_analyzer.html" title="fn api::v1::column_def::as_fulltext_option_analyzer">as_<wbr>fulltext_<wbr>option_<wbr>analyzer</a></dt><dd>Tries to construct a <code>FulltextAnalyzer</code> from the given analyzer.</dd><dt><a class="fn" href="fn.as_fulltext_option_backend.html" title="fn api::v1::column_def::as_fulltext_option_backend">as_<wbr>fulltext_<wbr>option_<wbr>backend</a></dt><dd>Tries to construct a <code>FulltextBackend</code> from the given backend.</dd><dt><a class="fn" href="fn.as_skipping_index_type.html" title="fn api::v1::column_def::as_skipping_index_type">as_<wbr>skipping_<wbr>index_<wbr>type</a></dt><dd>Tries to construct a <code>SkippingIndexType</code> from the given skipping index type.</dd><dt><a class="fn" href="fn.contains_fulltext.html" title="fn api::v1::column_def::contains_fulltext">contains_<wbr>fulltext</a></dt><dd>Checks if the <code>ColumnOptions</code> contains fulltext options.</dd><dt><a class="fn" href="fn.contains_skipping.html" title="fn api::v1::column_def::contains_skipping">contains_<wbr>skipping</a></dt><dd>Checks if the <code>ColumnOptions</code> contains skipping index options.</dd><dt><a class="fn" href="fn.options_from_column_schema.html" title="fn api::v1::column_def::options_from_column_schema">options_<wbr>from_<wbr>column_<wbr>schema</a></dt><dd>Constructs a <code>ColumnOptions</code> from the given <code>ColumnSchema</code>.</dd><dt><a class="fn" href="fn.options_from_fulltext.html" title="fn api::v1::column_def::options_from_fulltext">options_<wbr>from_<wbr>fulltext</a></dt><dd>Tries to construct a <code>ColumnOptions</code> from the given <code>FulltextOptions</code>.</dd><dt><a class="fn" href="fn.options_from_inverted.html" title="fn api::v1::column_def::options_from_inverted">options_<wbr>from_<wbr>inverted</a></dt><dd>Tries to construct a <code>ColumnOptions</code> for inverted index.</dd><dt><a class="fn" href="fn.options_from_skipping.html" title="fn api::v1::column_def::options_from_skipping">options_<wbr>from_<wbr>skipping</a></dt><dd>Tries to construct a <code>ColumnOptions</code> from the given <code>SkippingIndexOptions</code>.</dd><dt><a class="fn" href="fn.try_as_column_def.html" title="fn api::v1::column_def::try_as_column_def">try_<wbr>as_<wbr>column_<wbr>def</a></dt><dd>Tries to construct a <code>ColumnDef</code> from the given <code>ColumnSchema</code>.</dd><dt><a class="fn" href="fn.try_as_column_schema.html" title="fn api::v1::column_def::try_as_column_schema">try_<wbr>as_<wbr>column_<wbr>schema</a></dt><dd>Tries to construct a <code>ColumnSchema</code> from the given <code>ColumnDef</code>.</dd></dl></section></div></main></body></html> |