rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-05-23 16:30:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ GreptimeTeam/greptimedb@805536aed1 🚀

Browse Source
This commit is contained in:
github-merge-queue[bot]
2026-03-20 09:07:36 +00:00
commit 6da71d3ed6
21276 changed files with 2468449 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
src/api/error.rs.html Normal file
View File

@@ -0,0 +1,103 @@
<!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="Source of the Rust file `src/api/src/error.rs`."><title>error.rs - source</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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">api/</div>error.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">use </span>std::any::Any;
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>common_error::ext::ErrorExt;
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>common_error::status_code::StatusCode;
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span>common_macro::stack_trace_debug;
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>common_time::timestamp::TimeUnit;
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>datatypes::prelude::ConcreteDataType;
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>snafu::Location;
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>snafu::prelude::<span class="kw-2">*</span>;
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">pub type </span><span class="prelude-ty">Result</span>&lt;T&gt; = std::result::Result&lt;T, Error&gt;;
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a><span class="attr">#[derive(Snafu)]
<a href=#28 id=28 data-nosnippet>28</a>#[snafu(visibility(<span class="kw">pub</span>))]
<a href=#29 id=29 data-nosnippet>29</a>#[stack_trace_debug]
<a href=#30 id=30 data-nosnippet>30</a></span><span class="kw">pub enum </span>Error {
<a href=#31 id=31 data-nosnippet>31</a> <span class="attr">#[snafu(display(<span class="string">"Unknown proto column datatype: {}"</span>, datatype))]
<a href=#32 id=32 data-nosnippet>32</a> </span>UnknownColumnDataType {
<a href=#33 id=33 data-nosnippet>33</a> datatype: i32,
<a href=#34 id=34 data-nosnippet>34</a> <span class="attr">#[snafu(implicit)]
<a href=#35 id=35 data-nosnippet>35</a> </span>location: Location,
<a href=#36 id=36 data-nosnippet>36</a> <span class="attr">#[snafu(source)]
<a href=#37 id=37 data-nosnippet>37</a> </span>error: prost::UnknownEnumValue,
<a href=#38 id=38 data-nosnippet>38</a> },
<a href=#39 id=39 data-nosnippet>39</a>
<a href=#40 id=40 data-nosnippet>40</a> <span class="attr">#[snafu(display(<span class="string">"Failed to create column datatype from {:?}"</span>, from))]
<a href=#41 id=41 data-nosnippet>41</a> </span>IntoColumnDataType {
<a href=#42 id=42 data-nosnippet>42</a> from: ConcreteDataType,
<a href=#43 id=43 data-nosnippet>43</a> <span class="attr">#[snafu(implicit)]
<a href=#44 id=44 data-nosnippet>44</a> </span>location: Location,
<a href=#45 id=45 data-nosnippet>45</a> },
<a href=#46 id=46 data-nosnippet>46</a>
<a href=#47 id=47 data-nosnippet>47</a> <span class="attr">#[snafu(display(<span class="string">"Failed to convert column default constraint, column: {}"</span>, column))]
<a href=#48 id=48 data-nosnippet>48</a> </span>ConvertColumnDefaultConstraint {
<a href=#49 id=49 data-nosnippet>49</a> column: String,
<a href=#50 id=50 data-nosnippet>50</a> <span class="attr">#[snafu(implicit)]
<a href=#51 id=51 data-nosnippet>51</a> </span>location: Location,
<a href=#52 id=52 data-nosnippet>52</a> source: datatypes::error::Error,
<a href=#53 id=53 data-nosnippet>53</a> },
<a href=#54 id=54 data-nosnippet>54</a>
<a href=#55 id=55 data-nosnippet>55</a> <span class="attr">#[snafu(display(<span class="string">"Invalid column default constraint, column: {}"</span>, column))]
<a href=#56 id=56 data-nosnippet>56</a> </span>InvalidColumnDefaultConstraint {
<a href=#57 id=57 data-nosnippet>57</a> column: String,
<a href=#58 id=58 data-nosnippet>58</a> <span class="attr">#[snafu(implicit)]
<a href=#59 id=59 data-nosnippet>59</a> </span>location: Location,
<a href=#60 id=60 data-nosnippet>60</a> source: datatypes::error::Error,
<a href=#61 id=61 data-nosnippet>61</a> },
<a href=#62 id=62 data-nosnippet>62</a>
<a href=#63 id=63 data-nosnippet>63</a> <span class="attr">#[snafu(display(<span class="string">"Failed to serialize JSON"</span>))]
<a href=#64 id=64 data-nosnippet>64</a> </span>SerializeJson {
<a href=#65 id=65 data-nosnippet>65</a> <span class="attr">#[snafu(source)]
<a href=#66 id=66 data-nosnippet>66</a> </span>error: serde_json::Error,
<a href=#67 id=67 data-nosnippet>67</a> <span class="attr">#[snafu(implicit)]
<a href=#68 id=68 data-nosnippet>68</a> </span>location: Location,
<a href=#69 id=69 data-nosnippet>69</a> },
<a href=#70 id=70 data-nosnippet>70</a>
<a href=#71 id=71 data-nosnippet>71</a> <span class="attr">#[snafu(display(<span class="string">"Invalid time unit: {time_unit}"</span>))]
<a href=#72 id=72 data-nosnippet>72</a> </span>InvalidTimeUnit {
<a href=#73 id=73 data-nosnippet>73</a> time_unit: i32,
<a href=#74 id=74 data-nosnippet>74</a> <span class="attr">#[snafu(implicit)]
<a href=#75 id=75 data-nosnippet>75</a> </span>location: Location,
<a href=#76 id=76 data-nosnippet>76</a> },
<a href=#77 id=77 data-nosnippet>77</a>
<a href=#78 id=78 data-nosnippet>78</a> <span class="attr">#[snafu(display(<span class="string">"Inconsistent time unit: {:?}"</span>, units))]
<a href=#79 id=79 data-nosnippet>79</a> </span>InconsistentTimeUnit {
<a href=#80 id=80 data-nosnippet>80</a> units: Vec&lt;TimeUnit&gt;,
<a href=#81 id=81 data-nosnippet>81</a> <span class="attr">#[snafu(implicit)]
<a href=#82 id=82 data-nosnippet>82</a> </span>location: Location,
<a href=#83 id=83 data-nosnippet>83</a> },
<a href=#84 id=84 data-nosnippet>84</a>}
<a href=#85 id=85 data-nosnippet>85</a>
<a href=#86 id=86 data-nosnippet>86</a><span class="kw">impl </span>ErrorExt <span class="kw">for </span>Error {
<a href=#87 id=87 data-nosnippet>87</a> <span class="kw">fn </span>status_code(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; StatusCode {
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">match </span><span class="self">self </span>{
<a href=#89 id=89 data-nosnippet>89</a> Error::UnknownColumnDataType { .. }
<a href=#90 id=90 data-nosnippet>90</a> | Error::InvalidTimeUnit { .. }
<a href=#91 id=91 data-nosnippet>91</a> | Error::InconsistentTimeUnit { .. } =&gt; StatusCode::InvalidArguments,
<a href=#92 id=92 data-nosnippet>92</a> Error::IntoColumnDataType { .. } | Error::SerializeJson { .. } =&gt; {
<a href=#93 id=93 data-nosnippet>93</a> StatusCode::Unexpected
<a href=#94 id=94 data-nosnippet>94</a> }
<a href=#95 id=95 data-nosnippet>95</a> Error::ConvertColumnDefaultConstraint { source, .. }
<a href=#96 id=96 data-nosnippet>96</a> | Error::InvalidColumnDefaultConstraint { source, .. } =&gt; source.status_code(),
<a href=#97 id=97 data-nosnippet>97</a> }
<a href=#98 id=98 data-nosnippet>98</a> }
<a href=#99 id=99 data-nosnippet>99</a>
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">fn </span>as_any(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="kw">dyn </span>Any {
<a href=#101 id=101 data-nosnippet>101</a> <span class="self">self
<a href=#102 id=102 data-nosnippet>102</a> </span>}
<a href=#103 id=103 data-nosnippet>103</a>}</code></pre></div></section></main></body></html>

1996
src/api/helper.rs.html Normal file
View File

File diff suppressed because it is too large Load Diff

28
src/api/lib.rs.html Normal file
View File

@@ -0,0 +1,28 @@
<!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="Source of the Rust file `src/api/src/lib.rs`."><title>lib.rs - source</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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">api/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">pub mod </span>error;
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">pub mod </span>helper;
<a href=#17 id=17 data-nosnippet>17</a>
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">pub mod </span>prom_store {
<a href=#19 id=19 data-nosnippet>19</a> <span class="kw">pub mod </span>remote {
<a href=#20 id=20 data-nosnippet>20</a> <span class="kw">pub use </span>greptime_proto::prometheus::remote::<span class="kw-2">*</span>;
<a href=#21 id=21 data-nosnippet>21</a> }
<a href=#22 id=22 data-nosnippet>22</a>}
<a href=#23 id=23 data-nosnippet>23</a>
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">pub mod </span>region;
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">pub mod </span>v1;
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">pub use </span>greptime_proto;
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">pub use </span>prost::DecodeError;</code></pre></div></section></main></body></html>

54
src/api/region.rs.html Normal file
View File

@@ -0,0 +1,54 @@
<!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="Source of the Rust file `src/api/src/region.rs`."><title>region.rs - source</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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">api/</div>region.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">use </span>std::collections::HashMap;
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>common_base::AffectedRows;
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>greptime_proto::v1::region::RegionResponse <span class="kw">as </span>RegionResponseV1;
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a><span class="doccomment">/// This result struct is derived from [RegionResponseV1]
<a href=#21 id=21 data-nosnippet>21</a></span><span class="attr">#[derive(Debug)]
<a href=#22 id=22 data-nosnippet>22</a></span><span class="kw">pub struct </span>RegionResponse {
<a href=#23 id=23 data-nosnippet>23</a> <span class="kw">pub </span>affected_rows: AffectedRows,
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">pub </span>extensions: HashMap&lt;String, Vec&lt;u8&gt;&gt;,
<a href=#25 id=25 data-nosnippet>25</a> <span class="kw">pub </span>metadata: Vec&lt;u8&gt;,
<a href=#26 id=26 data-nosnippet>26</a>}
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">impl </span>RegionResponse {
<a href=#29 id=29 data-nosnippet>29</a> <span class="kw">pub fn </span>from_region_response(region_response: RegionResponseV1) -&gt; <span class="self">Self </span>{
<a href=#30 id=30 data-nosnippet>30</a> <span class="self">Self </span>{
<a href=#31 id=31 data-nosnippet>31</a> affected_rows: region_response.affected_rows <span class="kw">as _</span>,
<a href=#32 id=32 data-nosnippet>32</a> extensions: region_response.extensions,
<a href=#33 id=33 data-nosnippet>33</a> metadata: region_response.metadata,
<a href=#34 id=34 data-nosnippet>34</a> }
<a href=#35 id=35 data-nosnippet>35</a> }
<a href=#36 id=36 data-nosnippet>36</a>
<a href=#37 id=37 data-nosnippet>37</a> <span class="doccomment">/// Creates one response without extension
<a href=#38 id=38 data-nosnippet>38</a> </span><span class="kw">pub fn </span>new(affected_rows: AffectedRows) -&gt; <span class="self">Self </span>{
<a href=#39 id=39 data-nosnippet>39</a> <span class="self">Self </span>{
<a href=#40 id=40 data-nosnippet>40</a> affected_rows,
<a href=#41 id=41 data-nosnippet>41</a> extensions: Default::default(),
<a href=#42 id=42 data-nosnippet>42</a> metadata: Vec::new(),
<a href=#43 id=43 data-nosnippet>43</a> }
<a href=#44 id=44 data-nosnippet>44</a> }
<a href=#45 id=45 data-nosnippet>45</a>
<a href=#46 id=46 data-nosnippet>46</a> <span class="doccomment">/// Creates one response with metadata.
<a href=#47 id=47 data-nosnippet>47</a> </span><span class="kw">pub fn </span>from_metadata(metadata: Vec&lt;u8&gt;) -&gt; <span class="self">Self </span>{
<a href=#48 id=48 data-nosnippet>48</a> <span class="self">Self </span>{
<a href=#49 id=49 data-nosnippet>49</a> affected_rows: <span class="number">0</span>,
<a href=#50 id=50 data-nosnippet>50</a> extensions: Default::default(),
<a href=#51 id=51 data-nosnippet>51</a> metadata,
<a href=#52 id=52 data-nosnippet>52</a> }
<a href=#53 id=53 data-nosnippet>53</a> }
<a href=#54 id=54 data-nosnippet>54</a>}</code></pre></div></section></main></body></html>

23
src/api/v1.rs.html Normal file
View File

@@ -0,0 +1,23 @@
<!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="Source of the Rust file `src/api/src/v1.rs`."><title>v1.rs - source</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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">api/</div>v1.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">pub mod </span>column_def;
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">pub mod </span>helper;
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">pub mod </span>meta {
<a href=#20 id=20 data-nosnippet>20</a> <span class="kw">pub use </span>greptime_proto::v1::meta::<span class="kw-2">*</span>;
<a href=#21 id=21 data-nosnippet>21</a>}
<a href=#22 id=22 data-nosnippet>22</a>
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">pub use </span>greptime_proto::v1::<span class="kw-2">*</span>;</code></pre></div></section></main></body></html>

415
src/api/v1/column_def.rs.html Normal file
View File

@@ -0,0 +1,415 @@
<!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="Source of the Rust file `src/api/src/v1/column_def.rs`."><title>column_def.rs - source</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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">api/v1/</div>column_def.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">use </span>std::collections::HashMap;
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>arrow_schema::extension::{EXTENSION_TYPE_METADATA_KEY, EXTENSION_TYPE_NAME_KEY};
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>datatypes::schema::{
<a href=#19 id=19 data-nosnippet>19</a> COMMENT_KEY, ColumnDefaultConstraint, ColumnSchema, FULLTEXT_KEY, FulltextAnalyzer,
<a href=#20 id=20 data-nosnippet>20</a> FulltextBackend, FulltextOptions, INVERTED_INDEX_KEY, Metadata, SKIPPING_INDEX_KEY,
<a href=#21 id=21 data-nosnippet>21</a> SkippingIndexOptions, SkippingIndexType, VECTOR_INDEX_KEY,
<a href=#22 id=22 data-nosnippet>22</a>};
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>greptime_proto::v1::{
<a href=#24 id=24 data-nosnippet>24</a> Analyzer, FulltextBackend <span class="kw">as </span>PbFulltextBackend, SkippingIndexType <span class="kw">as </span>PbSkippingIndexType,
<a href=#25 id=25 data-nosnippet>25</a>};
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span>snafu::ResultExt;
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">use </span><span class="kw">crate</span>::error::{<span class="self">self</span>, ConvertColumnDefaultConstraintSnafu, <span class="prelude-ty">Result</span>};
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">use </span><span class="kw">crate</span>::helper::ColumnDataTypeWrapper;
<a href=#30 id=30 data-nosnippet>30</a><span class="kw">use </span><span class="kw">crate</span>::v1::{ColumnDef, ColumnOptions, SemanticType};
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a><span class="doccomment">/// Key used to store fulltext options in gRPC column options.
<a href=#33 id=33 data-nosnippet>33</a></span><span class="kw">const </span>FULLTEXT_GRPC_KEY: <span class="kw-2">&amp;</span>str = <span class="string">"fulltext"</span>;
<a href=#34 id=34 data-nosnippet>34</a><span class="doccomment">/// Key used to store inverted index options in gRPC column options.
<a href=#35 id=35 data-nosnippet>35</a></span><span class="kw">const </span>INVERTED_INDEX_GRPC_KEY: <span class="kw-2">&amp;</span>str = <span class="string">"inverted_index"</span>;
<a href=#36 id=36 data-nosnippet>36</a><span class="doccomment">/// Key used to store skip index options in gRPC column options.
<a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">const </span>SKIPPING_INDEX_GRPC_KEY: <span class="kw-2">&amp;</span>str = <span class="string">"skipping_index"</span>;
<a href=#38 id=38 data-nosnippet>38</a><span class="doccomment">/// Key used to store vector index options in gRPC column options.
<a href=#39 id=39 data-nosnippet>39</a></span><span class="kw">const </span>VECTOR_INDEX_GRPC_KEY: <span class="kw-2">&amp;</span>str = <span class="string">"vector_index"</span>;
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a><span class="kw">const </span>COLUMN_OPTION_MAPPINGS: [(<span class="kw-2">&amp;</span>str, <span class="kw-2">&amp;</span>str); <span class="number">6</span>] = [
<a href=#42 id=42 data-nosnippet>42</a> (FULLTEXT_GRPC_KEY, FULLTEXT_KEY),
<a href=#43 id=43 data-nosnippet>43</a> (INVERTED_INDEX_GRPC_KEY, INVERTED_INDEX_KEY),
<a href=#44 id=44 data-nosnippet>44</a> (SKIPPING_INDEX_GRPC_KEY, SKIPPING_INDEX_KEY),
<a href=#45 id=45 data-nosnippet>45</a> (VECTOR_INDEX_GRPC_KEY, VECTOR_INDEX_KEY),
<a href=#46 id=46 data-nosnippet>46</a> (EXTENSION_TYPE_NAME_KEY, EXTENSION_TYPE_NAME_KEY),
<a href=#47 id=47 data-nosnippet>47</a> (EXTENSION_TYPE_METADATA_KEY, EXTENSION_TYPE_METADATA_KEY),
<a href=#48 id=48 data-nosnippet>48</a>];
<a href=#49 id=49 data-nosnippet>49</a>
<a href=#50 id=50 data-nosnippet>50</a><span class="doccomment">/// Tries to construct a `ColumnSchema` from the given `ColumnDef`.
<a href=#51 id=51 data-nosnippet>51</a></span><span class="kw">pub fn </span>try_as_column_schema(column_def: <span class="kw-2">&amp;</span>ColumnDef) -&gt; <span class="prelude-ty">Result</span>&lt;ColumnSchema&gt; {
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">let </span>data_type = ColumnDataTypeWrapper::try_new(
<a href=#53 id=53 data-nosnippet>53</a> column_def.data_type,
<a href=#54 id=54 data-nosnippet>54</a> column_def.datatype_extension.clone(),
<a href=#55 id=55 data-nosnippet>55</a> )<span class="question-mark">?</span>;
<a href=#56 id=56 data-nosnippet>56</a>
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">let </span>constraint = <span class="kw">if </span>column_def.default_constraint.is_empty() {
<a href=#58 id=58 data-nosnippet>58</a> <span class="prelude-val">None
<a href=#59 id=59 data-nosnippet>59</a> </span>} <span class="kw">else </span>{
<a href=#60 id=60 data-nosnippet>60</a> <span class="prelude-val">Some</span>(
<a href=#61 id=61 data-nosnippet>61</a> ColumnDefaultConstraint::try_from(column_def.default_constraint.as_slice()).context(
<a href=#62 id=62 data-nosnippet>62</a> error::ConvertColumnDefaultConstraintSnafu {
<a href=#63 id=63 data-nosnippet>63</a> column: <span class="kw-2">&amp;</span>column_def.name,
<a href=#64 id=64 data-nosnippet>64</a> },
<a href=#65 id=65 data-nosnippet>65</a> )<span class="question-mark">?</span>,
<a href=#66 id=66 data-nosnippet>66</a> )
<a href=#67 id=67 data-nosnippet>67</a> };
<a href=#68 id=68 data-nosnippet>68</a>
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw">let </span><span class="kw-2">mut </span>metadata = HashMap::new();
<a href=#70 id=70 data-nosnippet>70</a> <span class="kw">if </span>!column_def.comment.is_empty() {
<a href=#71 id=71 data-nosnippet>71</a> metadata.insert(COMMENT_KEY.to_string(), column_def.comment.clone());
<a href=#72 id=72 data-nosnippet>72</a> }
<a href=#73 id=73 data-nosnippet>73</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(options) = column_def.options.as_ref() {
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(fulltext) = options.options.get(FULLTEXT_GRPC_KEY) {
<a href=#75 id=75 data-nosnippet>75</a> metadata.insert(FULLTEXT_KEY.to_string(), fulltext.to_owned());
<a href=#76 id=76 data-nosnippet>76</a> }
<a href=#77 id=77 data-nosnippet>77</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(inverted_index) = options.options.get(INVERTED_INDEX_GRPC_KEY) {
<a href=#78 id=78 data-nosnippet>78</a> metadata.insert(INVERTED_INDEX_KEY.to_string(), inverted_index.to_owned());
<a href=#79 id=79 data-nosnippet>79</a> }
<a href=#80 id=80 data-nosnippet>80</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(skipping_index) = options.options.get(SKIPPING_INDEX_GRPC_KEY) {
<a href=#81 id=81 data-nosnippet>81</a> metadata.insert(SKIPPING_INDEX_KEY.to_string(), skipping_index.to_owned());
<a href=#82 id=82 data-nosnippet>82</a> }
<a href=#83 id=83 data-nosnippet>83</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(vector_index) = options.options.get(VECTOR_INDEX_GRPC_KEY) {
<a href=#84 id=84 data-nosnippet>84</a> metadata.insert(VECTOR_INDEX_KEY.to_string(), vector_index.to_owned());
<a href=#85 id=85 data-nosnippet>85</a> }
<a href=#86 id=86 data-nosnippet>86</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(extension_name) = options.options.get(EXTENSION_TYPE_NAME_KEY) {
<a href=#87 id=87 data-nosnippet>87</a> metadata.insert(EXTENSION_TYPE_NAME_KEY.to_string(), extension_name.clone());
<a href=#88 id=88 data-nosnippet>88</a> }
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(extension_metadata) = options.options.get(EXTENSION_TYPE_METADATA_KEY) {
<a href=#90 id=90 data-nosnippet>90</a> metadata.insert(
<a href=#91 id=91 data-nosnippet>91</a> EXTENSION_TYPE_METADATA_KEY.to_string(),
<a href=#92 id=92 data-nosnippet>92</a> extension_metadata.clone(),
<a href=#93 id=93 data-nosnippet>93</a> );
<a href=#94 id=94 data-nosnippet>94</a> }
<a href=#95 id=95 data-nosnippet>95</a> }
<a href=#96 id=96 data-nosnippet>96</a>
<a href=#97 id=97 data-nosnippet>97</a> ColumnSchema::new(<span class="kw-2">&amp;</span>column_def.name, data_type.into(), column_def.is_nullable)
<a href=#98 id=98 data-nosnippet>98</a> .with_metadata(metadata)
<a href=#99 id=99 data-nosnippet>99</a> .with_time_index(column_def.semantic_type() == SemanticType::Timestamp)
<a href=#100 id=100 data-nosnippet>100</a> .with_default_constraint(constraint)
<a href=#101 id=101 data-nosnippet>101</a> .context(error::InvalidColumnDefaultConstraintSnafu {
<a href=#102 id=102 data-nosnippet>102</a> column: <span class="kw-2">&amp;</span>column_def.name,
<a href=#103 id=103 data-nosnippet>103</a> })
<a href=#104 id=104 data-nosnippet>104</a>}
<a href=#105 id=105 data-nosnippet>105</a>
<a href=#106 id=106 data-nosnippet>106</a><span class="doccomment">/// Tries to construct a `ColumnDef` from the given `ColumnSchema`.
<a href=#107 id=107 data-nosnippet>107</a>///
<a href=#108 id=108 data-nosnippet>108</a>/// TODO(weny): Add tests for this function.
<a href=#109 id=109 data-nosnippet>109</a></span><span class="kw">pub fn </span>try_as_column_def(column_schema: <span class="kw-2">&amp;</span>ColumnSchema, is_primary_key: bool) -&gt; <span class="prelude-ty">Result</span>&lt;ColumnDef&gt; {
<a href=#110 id=110 data-nosnippet>110</a> <span class="kw">let </span>column_datatype =
<a href=#111 id=111 data-nosnippet>111</a> ColumnDataTypeWrapper::try_from(column_schema.data_type.clone()).map(|w| w.to_parts())<span class="question-mark">?</span>;
<a href=#112 id=112 data-nosnippet>112</a>
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw">let </span>semantic_type = <span class="kw">if </span>column_schema.is_time_index() {
<a href=#114 id=114 data-nosnippet>114</a> SemanticType::Timestamp
<a href=#115 id=115 data-nosnippet>115</a> } <span class="kw">else if </span>is_primary_key {
<a href=#116 id=116 data-nosnippet>116</a> SemanticType::Tag
<a href=#117 id=117 data-nosnippet>117</a> } <span class="kw">else </span>{
<a href=#118 id=118 data-nosnippet>118</a> SemanticType::Field
<a href=#119 id=119 data-nosnippet>119</a> } <span class="kw">as </span>i32;
<a href=#120 id=120 data-nosnippet>120</a> <span class="kw">let </span>comment = column_schema
<a href=#121 id=121 data-nosnippet>121</a> .metadata()
<a href=#122 id=122 data-nosnippet>122</a> .get(COMMENT_KEY)
<a href=#123 id=123 data-nosnippet>123</a> .cloned()
<a href=#124 id=124 data-nosnippet>124</a> .unwrap_or_default();
<a href=#125 id=125 data-nosnippet>125</a>
<a href=#126 id=126 data-nosnippet>126</a> <span class="kw">let </span>default_constraint = <span class="kw">match </span>column_schema.default_constraint() {
<a href=#127 id=127 data-nosnippet>127</a> <span class="prelude-val">None </span>=&gt; <span class="macro">vec!</span>[],
<a href=#128 id=128 data-nosnippet>128</a> <span class="prelude-val">Some</span>(v) =&gt; v
<a href=#129 id=129 data-nosnippet>129</a> .clone()
<a href=#130 id=130 data-nosnippet>130</a> .try_into()
<a href=#131 id=131 data-nosnippet>131</a> .context(ConvertColumnDefaultConstraintSnafu {
<a href=#132 id=132 data-nosnippet>132</a> column: <span class="kw-2">&amp;</span>column_schema.name,
<a href=#133 id=133 data-nosnippet>133</a> })<span class="question-mark">?</span>,
<a href=#134 id=134 data-nosnippet>134</a> };
<a href=#135 id=135 data-nosnippet>135</a> <span class="kw">let </span>options = options_from_column_schema(column_schema);
<a href=#136 id=136 data-nosnippet>136</a> <span class="prelude-val">Ok</span>(ColumnDef {
<a href=#137 id=137 data-nosnippet>137</a> name: column_schema.name.clone(),
<a href=#138 id=138 data-nosnippet>138</a> data_type: column_datatype.<span class="number">0 </span><span class="kw">as </span>i32,
<a href=#139 id=139 data-nosnippet>139</a> is_nullable: column_schema.is_nullable(),
<a href=#140 id=140 data-nosnippet>140</a> default_constraint,
<a href=#141 id=141 data-nosnippet>141</a> semantic_type,
<a href=#142 id=142 data-nosnippet>142</a> comment,
<a href=#143 id=143 data-nosnippet>143</a> datatype_extension: column_datatype.<span class="number">1</span>,
<a href=#144 id=144 data-nosnippet>144</a> options,
<a href=#145 id=145 data-nosnippet>145</a> })
<a href=#146 id=146 data-nosnippet>146</a>}
<a href=#147 id=147 data-nosnippet>147</a>
<a href=#148 id=148 data-nosnippet>148</a><span class="doccomment">/// Collect the [ColumnOptions] into the [Metadata] that can be used in, for example, [ColumnSchema].
<a href=#149 id=149 data-nosnippet>149</a></span><span class="kw">pub fn </span>collect_column_options(column_options: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>ColumnOptions&gt;) -&gt; Metadata {
<a href=#150 id=150 data-nosnippet>150</a> <span class="kw">let </span><span class="prelude-val">Some</span>(ColumnOptions { options }) = column_options <span class="kw">else </span>{
<a href=#151 id=151 data-nosnippet>151</a> <span class="kw">return </span>Metadata::default();
<a href=#152 id=152 data-nosnippet>152</a> };
<a href=#153 id=153 data-nosnippet>153</a>
<a href=#154 id=154 data-nosnippet>154</a> <span class="kw">let </span><span class="kw-2">mut </span>metadata = Metadata::with_capacity(options.len());
<a href=#155 id=155 data-nosnippet>155</a> <span class="kw">for </span>(x, y) <span class="kw">in </span>COLUMN_OPTION_MAPPINGS {
<a href=#156 id=156 data-nosnippet>156</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = options.get(x) {
<a href=#157 id=157 data-nosnippet>157</a> metadata.insert(y.to_string(), v.clone());
<a href=#158 id=158 data-nosnippet>158</a> }
<a href=#159 id=159 data-nosnippet>159</a> }
<a href=#160 id=160 data-nosnippet>160</a> metadata
<a href=#161 id=161 data-nosnippet>161</a>}
<a href=#162 id=162 data-nosnippet>162</a>
<a href=#163 id=163 data-nosnippet>163</a><span class="doccomment">/// Constructs a `ColumnOptions` from the given `ColumnSchema`.
<a href=#164 id=164 data-nosnippet>164</a></span><span class="kw">pub fn </span>options_from_column_schema(column_schema: <span class="kw-2">&amp;</span>ColumnSchema) -&gt; <span class="prelude-ty">Option</span>&lt;ColumnOptions&gt; {
<a href=#165 id=165 data-nosnippet>165</a> <span class="kw">let </span><span class="kw-2">mut </span>options = ColumnOptions::default();
<a href=#166 id=166 data-nosnippet>166</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(fulltext) = column_schema.metadata().get(FULLTEXT_KEY) {
<a href=#167 id=167 data-nosnippet>167</a> options
<a href=#168 id=168 data-nosnippet>168</a> .options
<a href=#169 id=169 data-nosnippet>169</a> .insert(FULLTEXT_GRPC_KEY.to_string(), fulltext.to_owned());
<a href=#170 id=170 data-nosnippet>170</a> }
<a href=#171 id=171 data-nosnippet>171</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(inverted_index) = column_schema.metadata().get(INVERTED_INDEX_KEY) {
<a href=#172 id=172 data-nosnippet>172</a> options
<a href=#173 id=173 data-nosnippet>173</a> .options
<a href=#174 id=174 data-nosnippet>174</a> .insert(INVERTED_INDEX_GRPC_KEY.to_string(), inverted_index.clone());
<a href=#175 id=175 data-nosnippet>175</a> }
<a href=#176 id=176 data-nosnippet>176</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(skipping_index) = column_schema.metadata().get(SKIPPING_INDEX_KEY) {
<a href=#177 id=177 data-nosnippet>177</a> options
<a href=#178 id=178 data-nosnippet>178</a> .options
<a href=#179 id=179 data-nosnippet>179</a> .insert(SKIPPING_INDEX_GRPC_KEY.to_string(), skipping_index.clone());
<a href=#180 id=180 data-nosnippet>180</a> }
<a href=#181 id=181 data-nosnippet>181</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(vector_index) = column_schema.metadata().get(VECTOR_INDEX_KEY) {
<a href=#182 id=182 data-nosnippet>182</a> options
<a href=#183 id=183 data-nosnippet>183</a> .options
<a href=#184 id=184 data-nosnippet>184</a> .insert(VECTOR_INDEX_GRPC_KEY.to_string(), vector_index.clone());
<a href=#185 id=185 data-nosnippet>185</a> }
<a href=#186 id=186 data-nosnippet>186</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(extension_name) = column_schema.metadata().get(EXTENSION_TYPE_NAME_KEY) {
<a href=#187 id=187 data-nosnippet>187</a> options
<a href=#188 id=188 data-nosnippet>188</a> .options
<a href=#189 id=189 data-nosnippet>189</a> .insert(EXTENSION_TYPE_NAME_KEY.to_string(), extension_name.clone());
<a href=#190 id=190 data-nosnippet>190</a> }
<a href=#191 id=191 data-nosnippet>191</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(extension_metadata) = column_schema.metadata().get(EXTENSION_TYPE_METADATA_KEY) {
<a href=#192 id=192 data-nosnippet>192</a> options.options.insert(
<a href=#193 id=193 data-nosnippet>193</a> EXTENSION_TYPE_METADATA_KEY.to_string(),
<a href=#194 id=194 data-nosnippet>194</a> extension_metadata.clone(),
<a href=#195 id=195 data-nosnippet>195</a> );
<a href=#196 id=196 data-nosnippet>196</a> }
<a href=#197 id=197 data-nosnippet>197</a>
<a href=#198 id=198 data-nosnippet>198</a> (!options.options.is_empty()).then_some(options)
<a href=#199 id=199 data-nosnippet>199</a>}
<a href=#200 id=200 data-nosnippet>200</a>
<a href=#201 id=201 data-nosnippet>201</a><span class="doccomment">/// Checks if the `ColumnOptions` contains fulltext options.
<a href=#202 id=202 data-nosnippet>202</a></span><span class="kw">pub fn </span>contains_fulltext(options: <span class="kw-2">&amp;</span><span class="prelude-ty">Option</span>&lt;ColumnOptions&gt;) -&gt; bool {
<a href=#203 id=203 data-nosnippet>203</a> options
<a href=#204 id=204 data-nosnippet>204</a> .as_ref()
<a href=#205 id=205 data-nosnippet>205</a> .is_some_and(|o| o.options.contains_key(FULLTEXT_GRPC_KEY))
<a href=#206 id=206 data-nosnippet>206</a>}
<a href=#207 id=207 data-nosnippet>207</a>
<a href=#208 id=208 data-nosnippet>208</a><span class="doccomment">/// Checks if the `ColumnOptions` contains skipping index options.
<a href=#209 id=209 data-nosnippet>209</a></span><span class="kw">pub fn </span>contains_skipping(options: <span class="kw-2">&amp;</span><span class="prelude-ty">Option</span>&lt;ColumnOptions&gt;) -&gt; bool {
<a href=#210 id=210 data-nosnippet>210</a> options
<a href=#211 id=211 data-nosnippet>211</a> .as_ref()
<a href=#212 id=212 data-nosnippet>212</a> .is_some_and(|o| o.options.contains_key(SKIPPING_INDEX_GRPC_KEY))
<a href=#213 id=213 data-nosnippet>213</a>}
<a href=#214 id=214 data-nosnippet>214</a>
<a href=#215 id=215 data-nosnippet>215</a><span class="doccomment">/// Tries to construct a `ColumnOptions` from the given `FulltextOptions`.
<a href=#216 id=216 data-nosnippet>216</a></span><span class="kw">pub fn </span>options_from_fulltext(fulltext: <span class="kw-2">&amp;</span>FulltextOptions) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;ColumnOptions&gt;&gt; {
<a href=#217 id=217 data-nosnippet>217</a> <span class="kw">let </span><span class="kw-2">mut </span>options = ColumnOptions::default();
<a href=#218 id=218 data-nosnippet>218</a>
<a href=#219 id=219 data-nosnippet>219</a> <span class="kw">let </span>v = serde_json::to_string(fulltext).context(error::SerializeJsonSnafu)<span class="question-mark">?</span>;
<a href=#220 id=220 data-nosnippet>220</a> options.options.insert(FULLTEXT_GRPC_KEY.to_string(), v);
<a href=#221 id=221 data-nosnippet>221</a>
<a href=#222 id=222 data-nosnippet>222</a> <span class="prelude-val">Ok</span>((!options.options.is_empty()).then_some(options))
<a href=#223 id=223 data-nosnippet>223</a>}
<a href=#224 id=224 data-nosnippet>224</a>
<a href=#225 id=225 data-nosnippet>225</a><span class="doccomment">/// Tries to construct a `ColumnOptions` from the given `SkippingIndexOptions`.
<a href=#226 id=226 data-nosnippet>226</a></span><span class="kw">pub fn </span>options_from_skipping(skipping: <span class="kw-2">&amp;</span>SkippingIndexOptions) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;ColumnOptions&gt;&gt; {
<a href=#227 id=227 data-nosnippet>227</a> <span class="kw">let </span><span class="kw-2">mut </span>options = ColumnOptions::default();
<a href=#228 id=228 data-nosnippet>228</a>
<a href=#229 id=229 data-nosnippet>229</a> <span class="kw">let </span>v = serde_json::to_string(skipping).context(error::SerializeJsonSnafu)<span class="question-mark">?</span>;
<a href=#230 id=230 data-nosnippet>230</a> options
<a href=#231 id=231 data-nosnippet>231</a> .options
<a href=#232 id=232 data-nosnippet>232</a> .insert(SKIPPING_INDEX_GRPC_KEY.to_string(), v);
<a href=#233 id=233 data-nosnippet>233</a>
<a href=#234 id=234 data-nosnippet>234</a> <span class="prelude-val">Ok</span>((!options.options.is_empty()).then_some(options))
<a href=#235 id=235 data-nosnippet>235</a>}
<a href=#236 id=236 data-nosnippet>236</a>
<a href=#237 id=237 data-nosnippet>237</a><span class="doccomment">/// Tries to construct a `ColumnOptions` for inverted index.
<a href=#238 id=238 data-nosnippet>238</a></span><span class="kw">pub fn </span>options_from_inverted() -&gt; ColumnOptions {
<a href=#239 id=239 data-nosnippet>239</a> <span class="kw">let </span><span class="kw-2">mut </span>options = ColumnOptions::default();
<a href=#240 id=240 data-nosnippet>240</a> options
<a href=#241 id=241 data-nosnippet>241</a> .options
<a href=#242 id=242 data-nosnippet>242</a> .insert(INVERTED_INDEX_GRPC_KEY.to_string(), <span class="string">"true"</span>.to_string());
<a href=#243 id=243 data-nosnippet>243</a> options
<a href=#244 id=244 data-nosnippet>244</a>}
<a href=#245 id=245 data-nosnippet>245</a>
<a href=#246 id=246 data-nosnippet>246</a><span class="doccomment">/// Tries to construct a `FulltextAnalyzer` from the given analyzer.
<a href=#247 id=247 data-nosnippet>247</a></span><span class="kw">pub fn </span>as_fulltext_option_analyzer(analyzer: Analyzer) -&gt; FulltextAnalyzer {
<a href=#248 id=248 data-nosnippet>248</a> <span class="kw">match </span>analyzer {
<a href=#249 id=249 data-nosnippet>249</a> Analyzer::English =&gt; FulltextAnalyzer::English,
<a href=#250 id=250 data-nosnippet>250</a> Analyzer::Chinese =&gt; FulltextAnalyzer::Chinese,
<a href=#251 id=251 data-nosnippet>251</a> }
<a href=#252 id=252 data-nosnippet>252</a>}
<a href=#253 id=253 data-nosnippet>253</a>
<a href=#254 id=254 data-nosnippet>254</a><span class="doccomment">/// Tries to construct a `FulltextBackend` from the given backend.
<a href=#255 id=255 data-nosnippet>255</a></span><span class="kw">pub fn </span>as_fulltext_option_backend(backend: PbFulltextBackend) -&gt; FulltextBackend {
<a href=#256 id=256 data-nosnippet>256</a> <span class="kw">match </span>backend {
<a href=#257 id=257 data-nosnippet>257</a> PbFulltextBackend::Bloom =&gt; FulltextBackend::Bloom,
<a href=#258 id=258 data-nosnippet>258</a> PbFulltextBackend::Tantivy =&gt; FulltextBackend::Tantivy,
<a href=#259 id=259 data-nosnippet>259</a> }
<a href=#260 id=260 data-nosnippet>260</a>}
<a href=#261 id=261 data-nosnippet>261</a>
<a href=#262 id=262 data-nosnippet>262</a><span class="doccomment">/// Tries to construct a `SkippingIndexType` from the given skipping index type.
<a href=#263 id=263 data-nosnippet>263</a></span><span class="kw">pub fn </span>as_skipping_index_type(skipping_index_type: PbSkippingIndexType) -&gt; SkippingIndexType {
<a href=#264 id=264 data-nosnippet>264</a> <span class="kw">match </span>skipping_index_type {
<a href=#265 id=265 data-nosnippet>265</a> PbSkippingIndexType::BloomFilter =&gt; SkippingIndexType::BloomFilter,
<a href=#266 id=266 data-nosnippet>266</a> }
<a href=#267 id=267 data-nosnippet>267</a>}
<a href=#268 id=268 data-nosnippet>268</a>
<a href=#269 id=269 data-nosnippet>269</a><span class="attr">#[cfg(test)]
<a href=#270 id=270 data-nosnippet>270</a></span><span class="kw">mod </span>tests {
<a href=#271 id=271 data-nosnippet>271</a>
<a href=#272 id=272 data-nosnippet>272</a> <span class="kw">use </span>datatypes::data_type::ConcreteDataType;
<a href=#273 id=273 data-nosnippet>273</a> <span class="kw">use </span>datatypes::schema::{
<a href=#274 id=274 data-nosnippet>274</a> FulltextAnalyzer, FulltextBackend, VectorDistanceMetric, VectorIndexOptions,
<a href=#275 id=275 data-nosnippet>275</a> };
<a href=#276 id=276 data-nosnippet>276</a> <span class="kw">use </span>serde_json::json;
<a href=#277 id=277 data-nosnippet>277</a>
<a href=#278 id=278 data-nosnippet>278</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#279 id=279 data-nosnippet>279</a> <span class="kw">use </span><span class="kw">crate</span>::v1::ColumnDataType;
<a href=#280 id=280 data-nosnippet>280</a>
<a href=#281 id=281 data-nosnippet>281</a> <span class="attr">#[test]
<a href=#282 id=282 data-nosnippet>282</a> </span><span class="kw">fn </span>test_try_as_column_schema() {
<a href=#283 id=283 data-nosnippet>283</a> <span class="kw">let </span>column_def = ColumnDef {
<a href=#284 id=284 data-nosnippet>284</a> name: <span class="string">"test"</span>.to_string(),
<a href=#285 id=285 data-nosnippet>285</a> data_type: ColumnDataType::String <span class="kw">as </span>i32,
<a href=#286 id=286 data-nosnippet>286</a> is_nullable: <span class="bool-val">true</span>,
<a href=#287 id=287 data-nosnippet>287</a> default_constraint: ColumnDefaultConstraint::Value(<span class="string">"test_default"</span>.into())
<a href=#288 id=288 data-nosnippet>288</a> .try_into()
<a href=#289 id=289 data-nosnippet>289</a> .unwrap(),
<a href=#290 id=290 data-nosnippet>290</a> semantic_type: SemanticType::Field <span class="kw">as </span>i32,
<a href=#291 id=291 data-nosnippet>291</a> comment: <span class="string">"test_comment"</span>.to_string(),
<a href=#292 id=292 data-nosnippet>292</a> datatype_extension: <span class="prelude-val">None</span>,
<a href=#293 id=293 data-nosnippet>293</a> options: <span class="prelude-val">Some</span>(ColumnOptions {
<a href=#294 id=294 data-nosnippet>294</a> options: HashMap::from([
<a href=#295 id=295 data-nosnippet>295</a> (
<a href=#296 id=296 data-nosnippet>296</a> FULLTEXT_GRPC_KEY.to_string(),
<a href=#297 id=297 data-nosnippet>297</a> <span class="string">"{\"enable\":true}"</span>.to_string(),
<a href=#298 id=298 data-nosnippet>298</a> ),
<a href=#299 id=299 data-nosnippet>299</a> (INVERTED_INDEX_GRPC_KEY.to_string(), <span class="string">"true"</span>.to_string()),
<a href=#300 id=300 data-nosnippet>300</a> (
<a href=#301 id=301 data-nosnippet>301</a> VECTOR_INDEX_GRPC_KEY.to_string(),
<a href=#302 id=302 data-nosnippet>302</a> <span class="string">"{\"engine\":\"usearch\",\"metric\":\"l2sq\",\"connectivity\":16,\"expansion-add\":128,\"expansion-search\":64}"</span>.to_string(),
<a href=#303 id=303 data-nosnippet>303</a> ),
<a href=#304 id=304 data-nosnippet>304</a> ]),
<a href=#305 id=305 data-nosnippet>305</a> }),
<a href=#306 id=306 data-nosnippet>306</a> };
<a href=#307 id=307 data-nosnippet>307</a>
<a href=#308 id=308 data-nosnippet>308</a> <span class="kw">let </span>schema = try_as_column_schema(<span class="kw-2">&amp;</span>column_def).unwrap();
<a href=#309 id=309 data-nosnippet>309</a> <span class="macro">assert_eq!</span>(schema.name, <span class="string">"test"</span>);
<a href=#310 id=310 data-nosnippet>310</a> <span class="macro">assert_eq!</span>(schema.data_type, ConcreteDataType::string_datatype());
<a href=#311 id=311 data-nosnippet>311</a> <span class="macro">assert!</span>(!schema.is_time_index());
<a href=#312 id=312 data-nosnippet>312</a> <span class="macro">assert!</span>(schema.is_nullable());
<a href=#313 id=313 data-nosnippet>313</a> <span class="macro">assert_eq!</span>(
<a href=#314 id=314 data-nosnippet>314</a> schema.default_constraint().unwrap(),
<a href=#315 id=315 data-nosnippet>315</a> <span class="kw-2">&amp;</span>ColumnDefaultConstraint::Value(<span class="string">"test_default"</span>.into())
<a href=#316 id=316 data-nosnippet>316</a> );
<a href=#317 id=317 data-nosnippet>317</a> <span class="macro">assert_eq!</span>(schema.metadata().get(COMMENT_KEY).unwrap(), <span class="string">"test_comment"</span>);
<a href=#318 id=318 data-nosnippet>318</a> <span class="macro">assert_eq!</span>(
<a href=#319 id=319 data-nosnippet>319</a> schema.fulltext_options().unwrap().unwrap(),
<a href=#320 id=320 data-nosnippet>320</a> FulltextOptions {
<a href=#321 id=321 data-nosnippet>321</a> enable: <span class="bool-val">true</span>,
<a href=#322 id=322 data-nosnippet>322</a> ..Default::default()
<a href=#323 id=323 data-nosnippet>323</a> }
<a href=#324 id=324 data-nosnippet>324</a> );
<a href=#325 id=325 data-nosnippet>325</a> <span class="macro">assert!</span>(schema.is_inverted_indexed());
<a href=#326 id=326 data-nosnippet>326</a> <span class="kw">let </span>vector_options = schema.vector_index_options().unwrap().unwrap();
<a href=#327 id=327 data-nosnippet>327</a> <span class="macro">assert_eq!</span>(vector_options.metric, VectorDistanceMetric::L2sq);
<a href=#328 id=328 data-nosnippet>328</a> }
<a href=#329 id=329 data-nosnippet>329</a>
<a href=#330 id=330 data-nosnippet>330</a> <span class="attr">#[test]
<a href=#331 id=331 data-nosnippet>331</a> </span><span class="kw">fn </span>test_options_from_column_schema() {
<a href=#332 id=332 data-nosnippet>332</a> <span class="kw">let </span>schema = ColumnSchema::new(<span class="string">"test"</span>, ConcreteDataType::string_datatype(), <span class="bool-val">true</span>);
<a href=#333 id=333 data-nosnippet>333</a> <span class="kw">let </span>options = options_from_column_schema(<span class="kw-2">&amp;</span>schema);
<a href=#334 id=334 data-nosnippet>334</a> <span class="macro">assert!</span>(options.is_none());
<a href=#335 id=335 data-nosnippet>335</a>
<a href=#336 id=336 data-nosnippet>336</a> <span class="kw">let </span><span class="kw-2">mut </span>schema = ColumnSchema::new(<span class="string">"test"</span>, ConcreteDataType::string_datatype(), <span class="bool-val">true</span>)
<a href=#337 id=337 data-nosnippet>337</a> .with_fulltext_options(FulltextOptions::new_unchecked(
<a href=#338 id=338 data-nosnippet>338</a> <span class="bool-val">true</span>,
<a href=#339 id=339 data-nosnippet>339</a> FulltextAnalyzer::English,
<a href=#340 id=340 data-nosnippet>340</a> <span class="bool-val">false</span>,
<a href=#341 id=341 data-nosnippet>341</a> FulltextBackend::Bloom,
<a href=#342 id=342 data-nosnippet>342</a> <span class="number">10240</span>,
<a href=#343 id=343 data-nosnippet>343</a> <span class="number">0.01</span>,
<a href=#344 id=344 data-nosnippet>344</a> ))
<a href=#345 id=345 data-nosnippet>345</a> .unwrap();
<a href=#346 id=346 data-nosnippet>346</a> schema.set_inverted_index(<span class="bool-val">true</span>);
<a href=#347 id=347 data-nosnippet>347</a> <span class="kw">let </span>options = options_from_column_schema(<span class="kw-2">&amp;</span>schema).unwrap();
<a href=#348 id=348 data-nosnippet>348</a> <span class="macro">assert_eq!</span>(
<a href=#349 id=349 data-nosnippet>349</a> options.options.get(FULLTEXT_GRPC_KEY).unwrap(),
<a href=#350 id=350 data-nosnippet>350</a> <span class="string">"{\"enable\":true,\"analyzer\":\"English\",\"case-sensitive\":false,\"backend\":\"bloom\",\"granularity\":10240,\"false-positive-rate-in-10000\":100}"
<a href=#351 id=351 data-nosnippet>351</a> </span>);
<a href=#352 id=352 data-nosnippet>352</a> <span class="macro">assert_eq!</span>(
<a href=#353 id=353 data-nosnippet>353</a> options.options.get(INVERTED_INDEX_GRPC_KEY).unwrap(),
<a href=#354 id=354 data-nosnippet>354</a> <span class="string">"true"
<a href=#355 id=355 data-nosnippet>355</a> </span>);
<a href=#356 id=356 data-nosnippet>356</a> }
<a href=#357 id=357 data-nosnippet>357</a>
<a href=#358 id=358 data-nosnippet>358</a> <span class="attr">#[test]
<a href=#359 id=359 data-nosnippet>359</a> </span><span class="kw">fn </span>test_vector_index_options_roundtrip() {
<a href=#360 id=360 data-nosnippet>360</a> <span class="kw">let </span>schema = ColumnSchema::new(<span class="string">"test"</span>, ConcreteDataType::vector_datatype(<span class="number">4</span>), <span class="bool-val">true</span>)
<a href=#361 id=361 data-nosnippet>361</a> .with_vector_index_options(<span class="kw-2">&amp;</span>VectorIndexOptions::default())
<a href=#362 id=362 data-nosnippet>362</a> .unwrap();
<a href=#363 id=363 data-nosnippet>363</a> <span class="kw">let </span>column_def = try_as_column_def(<span class="kw-2">&amp;</span>schema, <span class="bool-val">false</span>).unwrap();
<a href=#364 id=364 data-nosnippet>364</a> <span class="kw">let </span>roundtrip = try_as_column_schema(<span class="kw-2">&amp;</span>column_def).unwrap();
<a href=#365 id=365 data-nosnippet>365</a> <span class="kw">let </span>options = roundtrip.vector_index_options().unwrap().unwrap();
<a href=#366 id=366 data-nosnippet>366</a> <span class="macro">assert_eq!</span>(options.metric, VectorDistanceMetric::L2sq);
<a href=#367 id=367 data-nosnippet>367</a>
<a href=#368 id=368 data-nosnippet>368</a> <span class="kw">let </span>options = column_def.options.unwrap();
<a href=#369 id=369 data-nosnippet>369</a> <span class="kw">let </span>raw = options.options.get(VECTOR_INDEX_GRPC_KEY).unwrap();
<a href=#370 id=370 data-nosnippet>370</a> <span class="kw">let </span>json_value: serde_json::Value = serde_json::from_str(raw).unwrap();
<a href=#371 id=371 data-nosnippet>371</a> <span class="kw">let </span>expected = <span class="macro">json!</span>({
<a href=#372 id=372 data-nosnippet>372</a> <span class="string">"engine"</span>: <span class="string">"usearch"</span>,
<a href=#373 id=373 data-nosnippet>373</a> <span class="string">"metric"</span>: <span class="string">"l2sq"</span>,
<a href=#374 id=374 data-nosnippet>374</a> <span class="string">"connectivity"</span>: <span class="number">16</span>,
<a href=#375 id=375 data-nosnippet>375</a> <span class="string">"expansion-add"</span>: <span class="number">128</span>,
<a href=#376 id=376 data-nosnippet>376</a> <span class="string">"expansion-search"</span>: <span class="number">64
<a href=#377 id=377 data-nosnippet>377</a> </span>});
<a href=#378 id=378 data-nosnippet>378</a> <span class="macro">assert_eq!</span>(json_value, expected);
<a href=#379 id=379 data-nosnippet>379</a> }
<a href=#380 id=380 data-nosnippet>380</a>
<a href=#381 id=381 data-nosnippet>381</a> <span class="attr">#[test]
<a href=#382 id=382 data-nosnippet>382</a> </span><span class="kw">fn </span>test_options_with_fulltext() {
<a href=#383 id=383 data-nosnippet>383</a> <span class="kw">let </span>fulltext = FulltextOptions::new_unchecked(
<a href=#384 id=384 data-nosnippet>384</a> <span class="bool-val">true</span>,
<a href=#385 id=385 data-nosnippet>385</a> FulltextAnalyzer::English,
<a href=#386 id=386 data-nosnippet>386</a> <span class="bool-val">false</span>,
<a href=#387 id=387 data-nosnippet>387</a> FulltextBackend::Bloom,
<a href=#388 id=388 data-nosnippet>388</a> <span class="number">10240</span>,
<a href=#389 id=389 data-nosnippet>389</a> <span class="number">0.01</span>,
<a href=#390 id=390 data-nosnippet>390</a> );
<a href=#391 id=391 data-nosnippet>391</a> <span class="kw">let </span>options = options_from_fulltext(<span class="kw-2">&amp;</span>fulltext).unwrap().unwrap();
<a href=#392 id=392 data-nosnippet>392</a> <span class="macro">assert_eq!</span>(
<a href=#393 id=393 data-nosnippet>393</a> options.options.get(FULLTEXT_GRPC_KEY).unwrap(),
<a href=#394 id=394 data-nosnippet>394</a> <span class="string">"{\"enable\":true,\"analyzer\":\"English\",\"case-sensitive\":false,\"backend\":\"bloom\",\"granularity\":10240,\"false-positive-rate-in-10000\":100}"
<a href=#395 id=395 data-nosnippet>395</a> </span>);
<a href=#396 id=396 data-nosnippet>396</a> }
<a href=#397 id=397 data-nosnippet>397</a>
<a href=#398 id=398 data-nosnippet>398</a> <span class="attr">#[test]
<a href=#399 id=399 data-nosnippet>399</a> </span><span class="kw">fn </span>test_contains_fulltext() {
<a href=#400 id=400 data-nosnippet>400</a> <span class="kw">let </span>options = ColumnOptions {
<a href=#401 id=401 data-nosnippet>401</a> options: HashMap::from([(
<a href=#402 id=402 data-nosnippet>402</a> FULLTEXT_GRPC_KEY.to_string(),
<a href=#403 id=403 data-nosnippet>403</a> <span class="string">"{\"enable\":true}"</span>.to_string(),
<a href=#404 id=404 data-nosnippet>404</a> )]),
<a href=#405 id=405 data-nosnippet>405</a> };
<a href=#406 id=406 data-nosnippet>406</a> <span class="macro">assert!</span>(contains_fulltext(<span class="kw-2">&amp;</span><span class="prelude-val">Some</span>(options)));
<a href=#407 id=407 data-nosnippet>407</a>
<a href=#408 id=408 data-nosnippet>408</a> <span class="kw">let </span>options = ColumnOptions {
<a href=#409 id=409 data-nosnippet>409</a> options: HashMap::new(),
<a href=#410 id=410 data-nosnippet>410</a> };
<a href=#411 id=411 data-nosnippet>411</a> <span class="macro">assert!</span>(!contains_fulltext(<span class="kw-2">&amp;</span><span class="prelude-val">Some</span>(options)));
<a href=#412 id=412 data-nosnippet>412</a>
<a href=#413 id=413 data-nosnippet>413</a> <span class="macro">assert!</span>(!contains_fulltext(<span class="kw-2">&amp;</span><span class="prelude-val">None</span>));
<a href=#414 id=414 data-nosnippet>414</a> }
<a href=#415 id=415 data-nosnippet>415</a>}</code></pre></div></section></main></body></html>

65
src/api/v1/helper.rs.html Normal file
View File

@@ -0,0 +1,65 @@
<!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="Source of the Rust file `src/api/src/v1/helper.rs`."><title>helper.rs - source</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="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">api/v1/</div>helper.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">use </span>greptime_proto::v1::value::ValueData;
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">use </span>greptime_proto::v1::{ColumnDataType, ColumnSchema, Row, SemanticType, Value};
<a href=#17 id=17 data-nosnippet>17</a>
<a href=#18 id=18 data-nosnippet>18</a><span class="doccomment">/// Create a time index [ColumnSchema] with column's name and datatype.
<a href=#19 id=19 data-nosnippet>19</a>/// Other fields are left default.
<a href=#20 id=20 data-nosnippet>20</a>/// Useful when you just want to create a simple [ColumnSchema] without providing much struct fields.
<a href=#21 id=21 data-nosnippet>21</a></span><span class="kw">pub fn </span>time_index_column_schema(name: <span class="kw-2">&amp;</span>str, datatype: ColumnDataType) -&gt; ColumnSchema {
<a href=#22 id=22 data-nosnippet>22</a> ColumnSchema {
<a href=#23 id=23 data-nosnippet>23</a> column_name: name.to_string(),
<a href=#24 id=24 data-nosnippet>24</a> datatype: datatype <span class="kw">as </span>i32,
<a href=#25 id=25 data-nosnippet>25</a> semantic_type: SemanticType::Timestamp <span class="kw">as </span>i32,
<a href=#26 id=26 data-nosnippet>26</a> ..Default::default()
<a href=#27 id=27 data-nosnippet>27</a> }
<a href=#28 id=28 data-nosnippet>28</a>}
<a href=#29 id=29 data-nosnippet>29</a>
<a href=#30 id=30 data-nosnippet>30</a><span class="doccomment">/// Create a tag [ColumnSchema] with column's name and datatype.
<a href=#31 id=31 data-nosnippet>31</a>/// Other fields are left default.
<a href=#32 id=32 data-nosnippet>32</a>/// Useful when you just want to create a simple [ColumnSchema] without providing much struct fields.
<a href=#33 id=33 data-nosnippet>33</a></span><span class="kw">pub fn </span>tag_column_schema(name: <span class="kw-2">&amp;</span>str, datatype: ColumnDataType) -&gt; ColumnSchema {
<a href=#34 id=34 data-nosnippet>34</a> ColumnSchema {
<a href=#35 id=35 data-nosnippet>35</a> column_name: name.to_string(),
<a href=#36 id=36 data-nosnippet>36</a> datatype: datatype <span class="kw">as </span>i32,
<a href=#37 id=37 data-nosnippet>37</a> semantic_type: SemanticType::Tag <span class="kw">as </span>i32,
<a href=#38 id=38 data-nosnippet>38</a> ..Default::default()
<a href=#39 id=39 data-nosnippet>39</a> }
<a href=#40 id=40 data-nosnippet>40</a>}
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a><span class="doccomment">/// Create a field [ColumnSchema] with column's name and datatype.
<a href=#43 id=43 data-nosnippet>43</a>/// Other fields are left default.
<a href=#44 id=44 data-nosnippet>44</a>/// Useful when you just want to create a simple [ColumnSchema] without providing much struct fields.
<a href=#45 id=45 data-nosnippet>45</a></span><span class="kw">pub fn </span>field_column_schema(name: <span class="kw-2">&amp;</span>str, datatype: ColumnDataType) -&gt; ColumnSchema {
<a href=#46 id=46 data-nosnippet>46</a> ColumnSchema {
<a href=#47 id=47 data-nosnippet>47</a> column_name: name.to_string(),
<a href=#48 id=48 data-nosnippet>48</a> datatype: datatype <span class="kw">as </span>i32,
<a href=#49 id=49 data-nosnippet>49</a> semantic_type: SemanticType::Field <span class="kw">as </span>i32,
<a href=#50 id=50 data-nosnippet>50</a> ..Default::default()
<a href=#51 id=51 data-nosnippet>51</a> }
<a href=#52 id=52 data-nosnippet>52</a>}
<a href=#53 id=53 data-nosnippet>53</a>
<a href=#54 id=54 data-nosnippet>54</a><span class="doccomment">/// Create a [Row] from [ValueData]s.
<a href=#55 id=55 data-nosnippet>55</a>/// Useful when you don't want to write much verbose codes.
<a href=#56 id=56 data-nosnippet>56</a></span><span class="kw">pub fn </span>row(values: Vec&lt;ValueData&gt;) -&gt; Row {
<a href=#57 id=57 data-nosnippet>57</a> Row {
<a href=#58 id=58 data-nosnippet>58</a> values: values
<a href=#59 id=59 data-nosnippet>59</a> .into_iter()
<a href=#60 id=60 data-nosnippet>60</a> .map(|x| Value {
<a href=#61 id=61 data-nosnippet>61</a> value_data: <span class="prelude-val">Some</span>(x),
<a href=#62 id=62 data-nosnippet>62</a> })
<a href=#63 id=63 data-nosnippet>63</a> .collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;(),
<a href=#64 id=64 data-nosnippet>64</a> }
<a href=#65 id=65 data-nosnippet>65</a>}</code></pre></div></section></main></body></html>