rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-05-26 01:40:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b9cdf26903eb5223bf730cc5d5bd6eb51b05ee56
greptimedb/src/mito2/config.rs.html
github-merge-queue[bot] b9cdf26903 Deploying to gh-pages from @ GreptimeTeam/greptimedb@d9736407f2 🚀
2026-04-02 04:05:08 +00:00

736 lines
77 KiB
HTML
Raw Blame History

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/mito2/src/config.rs`."><title>config.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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mito2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">mito2/</div>config.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="doccomment">//! Configurations.
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a></span><span class="kw">use </span>std::cmp;
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>std::path::Path;
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span>std::time::Duration;
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>common_base::memory_limit::MemoryLimit;
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>common_base::readable_size::ReadableSize;
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>common_memory_manager::OnExhaustedPolicy;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span>common_stat::{get_total_cpu_cores, get_total_memory_readable};
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span>common_telemetry::warn;
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span>serde::{Deserialize, Serialize};
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">use </span>serde_with::serde_as;
<a href=#28 id=28 data-nosnippet>28</a>
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">use </span><span class="kw">crate</span>::cache::file_cache::DEFAULT_INDEX_CACHE_PERCENT;
<a href=#30 id=30 data-nosnippet>30</a><span class="kw">use </span><span class="kw">crate</span>::error::Result;
<a href=#31 id=31 data-nosnippet>31</a><span class="kw">use </span><span class="kw">crate</span>::gc::GcConfig;
<a href=#32 id=32 data-nosnippet>32</a><span class="kw">use </span><span class="kw">crate</span>::memtable::MemtableConfig;
<a href=#33 id=33 data-nosnippet>33</a><span class="kw">use </span><span class="kw">crate</span>::sst::DEFAULT_WRITE_BUFFER_SIZE;
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a><span class="kw">const </span>MULTIPART_UPLOAD_MINIMUM_SIZE: ReadableSize = ReadableSize::mb(<span class="number">5</span>);
<a href=#36 id=36 data-nosnippet>36</a><span class="doccomment">/// Default channel size for parallel scan task.
<a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>DEFAULT_SCAN_CHANNEL_SIZE: usize = <span class="number">32</span>;
<a href=#38 id=38 data-nosnippet>38</a><span class="doccomment">/// Default maximum number of SST files to scan concurrently.
<a href=#39 id=39 data-nosnippet>39</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>DEFAULT_MAX_CONCURRENT_SCAN_FILES: usize = <span class="number">384</span>;
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a><span class="comment">// Use `1/GLOBAL_WRITE_BUFFER_SIZE_FACTOR` of OS memory as global write buffer size in default mode
<a href=#42 id=42 data-nosnippet>42</a></span><span class="kw">const </span>GLOBAL_WRITE_BUFFER_SIZE_FACTOR: u64 = <span class="number">8</span>;
<a href=#43 id=43 data-nosnippet>43</a><span class="doccomment">/// Use `1/SST_META_CACHE_SIZE_FACTOR` of OS memory size as SST meta cache size in default mode
<a href=#44 id=44 data-nosnippet>44</a></span><span class="kw">const </span>SST_META_CACHE_SIZE_FACTOR: u64 = <span class="number">32</span>;
<a href=#45 id=45 data-nosnippet>45</a><span class="doccomment">/// Use `1/MEM_CACHE_SIZE_FACTOR` of OS memory size as mem cache size in default mode
<a href=#46 id=46 data-nosnippet>46</a></span><span class="kw">const </span>MEM_CACHE_SIZE_FACTOR: u64 = <span class="number">16</span>;
<a href=#47 id=47 data-nosnippet>47</a><span class="doccomment">/// Use `1/PAGE_CACHE_SIZE_FACTOR` of OS memory size as page cache size in default mode
<a href=#48 id=48 data-nosnippet>48</a></span><span class="kw">const </span>PAGE_CACHE_SIZE_FACTOR: u64 = <span class="number">8</span>;
<a href=#49 id=49 data-nosnippet>49</a><span class="doccomment">/// Use `1/INDEX_CREATE_MEM_THRESHOLD_FACTOR` of OS memory size as mem threshold for creating index
<a href=#50 id=50 data-nosnippet>50</a></span><span class="kw">const </span>INDEX_CREATE_MEM_THRESHOLD_FACTOR: u64 = <span class="number">16</span>;
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a><span class="doccomment">/// Fetch option timeout
<a href=#53 id=53 data-nosnippet>53</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>FETCH_OPTION_TIMEOUT: Duration = Duration::from_secs(<span class="number">3</span>);
<a href=#54 id=54 data-nosnippet>54</a>
<a href=#55 id=55 data-nosnippet>55</a><span class="doccomment">/// Configuration for [MitoEngine](crate::engine::MitoEngine).
<a href=#56 id=56 data-nosnippet>56</a>/// Before using the config, make sure to call `MitoConfig::validate()` to check if the config is valid.
<a href=#57 id=57 data-nosnippet>57</a></span><span class="attr">#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
<a href=#58 id=58 data-nosnippet>58</a>#[serde(default)]
<a href=#59 id=59 data-nosnippet>59</a></span><span class="kw">pub struct </span>MitoConfig {
<a href=#60 id=60 data-nosnippet>60</a> <span class="comment">// Worker configs:
<a href=#61 id=61 data-nosnippet>61</a> </span><span class="doccomment">/// Number of region workers (default: 1/2 of cpu cores).
<a href=#62 id=62 data-nosnippet>62</a> /// Sets to 0 to use the default value.
<a href=#63 id=63 data-nosnippet>63</a> </span><span class="kw">pub </span>num_workers: usize,
<a href=#64 id=64 data-nosnippet>64</a> <span class="doccomment">/// Request channel size of each worker (default 128).
<a href=#65 id=65 data-nosnippet>65</a> </span><span class="kw">pub </span>worker_channel_size: usize,
<a href=#66 id=66 data-nosnippet>66</a> <span class="doccomment">/// Max batch size for a worker to handle requests (default 64).
<a href=#67 id=67 data-nosnippet>67</a> </span><span class="kw">pub </span>worker_request_batch_size: usize,
<a href=#68 id=68 data-nosnippet>68</a>
<a href=#69 id=69 data-nosnippet>69</a> <span class="comment">// Manifest configs:
<a href=#70 id=70 data-nosnippet>70</a> </span><span class="doccomment">/// Number of meta action updated to trigger a new checkpoint
<a href=#71 id=71 data-nosnippet>71</a> /// for the manifest (default 10).
<a href=#72 id=72 data-nosnippet>72</a> </span><span class="kw">pub </span>manifest_checkpoint_distance: u64,
<a href=#73 id=73 data-nosnippet>73</a> <span class="doccomment">/// Number of removed files to keep in manifest's `removed_files` field before also
<a href=#74 id=74 data-nosnippet>74</a> /// remove them from `removed_files`. Mostly for debugging purpose.
<a href=#75 id=75 data-nosnippet>75</a> /// If set to 0, it will only use `keep_removed_file_ttl` to decide when to remove files
<a href=#76 id=76 data-nosnippet>76</a> /// from `removed_files` field.
<a href=#77 id=77 data-nosnippet>77</a> </span><span class="kw">pub </span>experimental_manifest_keep_removed_file_count: usize,
<a href=#78 id=78 data-nosnippet>78</a> <span class="doccomment">/// How long to keep removed files in the `removed_files` field of manifest
<a href=#79 id=79 data-nosnippet>79</a> /// after they are removed from manifest.
<a href=#80 id=80 data-nosnippet>80</a> /// files will only be removed from `removed_files` field
<a href=#81 id=81 data-nosnippet>81</a> /// if both `keep_removed_file_count` and `keep_removed_file_ttl` is reached.
<a href=#82 id=82 data-nosnippet>82</a> </span><span class="attr">#[serde(with = <span class="string">"humantime_serde"</span>)]
<a href=#83 id=83 data-nosnippet>83</a> </span><span class="kw">pub </span>experimental_manifest_keep_removed_file_ttl: Duration,
<a href=#84 id=84 data-nosnippet>84</a> <span class="doccomment">/// Whether to compress manifest and checkpoint file by gzip (default false).
<a href=#85 id=85 data-nosnippet>85</a> </span><span class="kw">pub </span>compress_manifest: bool,
<a href=#86 id=86 data-nosnippet>86</a>
<a href=#87 id=87 data-nosnippet>87</a> <span class="comment">// Background job configs:
<a href=#88 id=88 data-nosnippet>88</a> </span><span class="doccomment">/// Max number of running background index build jobs (default: 1/8 of cpu cores).
<a href=#89 id=89 data-nosnippet>89</a> </span><span class="kw">pub </span>max_background_index_builds: usize,
<a href=#90 id=90 data-nosnippet>90</a> <span class="doccomment">/// Max number of running background flush jobs (default: 1/2 of cpu cores).
<a href=#91 id=91 data-nosnippet>91</a> </span><span class="kw">pub </span>max_background_flushes: usize,
<a href=#92 id=92 data-nosnippet>92</a> <span class="doccomment">/// Max number of running background compaction jobs (default: 1/4 of cpu cores).
<a href=#93 id=93 data-nosnippet>93</a> </span><span class="kw">pub </span>max_background_compactions: usize,
<a href=#94 id=94 data-nosnippet>94</a> <span class="doccomment">/// Max number of running background purge jobs (default: number of cpu cores).
<a href=#95 id=95 data-nosnippet>95</a> </span><span class="kw">pub </span>max_background_purges: usize,
<a href=#96 id=96 data-nosnippet>96</a> <span class="doccomment">/// Memory budget for compaction tasks. Setting it to 0 or "unlimited" disables the limit.
<a href=#97 id=97 data-nosnippet>97</a> </span><span class="kw">pub </span>experimental_compaction_memory_limit: MemoryLimit,
<a href=#98 id=98 data-nosnippet>98</a> <span class="doccomment">/// Behavior when compaction cannot acquire memory from the budget.
<a href=#99 id=99 data-nosnippet>99</a> </span><span class="kw">pub </span>experimental_compaction_on_exhausted: OnExhaustedPolicy,
<a href=#100 id=100 data-nosnippet>100</a>
<a href=#101 id=101 data-nosnippet>101</a> <span class="comment">// Flush configs:
<a href=#102 id=102 data-nosnippet>102</a> </span><span class="doccomment">/// Interval to auto flush a region if it has not flushed yet (default 30 min).
<a href=#103 id=103 data-nosnippet>103</a> </span><span class="attr">#[serde(with = <span class="string">"humantime_serde"</span>)]
<a href=#104 id=104 data-nosnippet>104</a> </span><span class="kw">pub </span>auto_flush_interval: Duration,
<a href=#105 id=105 data-nosnippet>105</a> <span class="doccomment">/// Global write buffer size threshold to trigger flush.
<a href=#106 id=106 data-nosnippet>106</a> </span><span class="kw">pub </span>global_write_buffer_size: ReadableSize,
<a href=#107 id=107 data-nosnippet>107</a> <span class="doccomment">/// Global write buffer size threshold to reject write requests.
<a href=#108 id=108 data-nosnippet>108</a> </span><span class="kw">pub </span>global_write_buffer_reject_size: ReadableSize,
<a href=#109 id=109 data-nosnippet>109</a>
<a href=#110 id=110 data-nosnippet>110</a> <span class="comment">// Cache configs:
<a href=#111 id=111 data-nosnippet>111</a> </span><span class="doccomment">/// Cache size for SST metadata. Setting it to 0 to disable the cache.
<a href=#112 id=112 data-nosnippet>112</a> </span><span class="kw">pub </span>sst_meta_cache_size: ReadableSize,
<a href=#113 id=113 data-nosnippet>113</a> <span class="doccomment">/// Cache size for vectors and arrow arrays. Setting it to 0 to disable the cache.
<a href=#114 id=114 data-nosnippet>114</a> </span><span class="kw">pub </span>vector_cache_size: ReadableSize,
<a href=#115 id=115 data-nosnippet>115</a> <span class="doccomment">/// Cache size for pages of SST row groups. Setting it to 0 to disable the cache.
<a href=#116 id=116 data-nosnippet>116</a> </span><span class="kw">pub </span>page_cache_size: ReadableSize,
<a href=#117 id=117 data-nosnippet>117</a> <span class="doccomment">/// Cache size for time series selector (e.g. `last_value()`). Setting it to 0 to disable the cache.
<a href=#118 id=118 data-nosnippet>118</a> </span><span class="kw">pub </span>selector_result_cache_size: ReadableSize,
<a href=#119 id=119 data-nosnippet>119</a> <span class="doccomment">/// Cache size for flat range scan results. Setting it to 0 to disable the cache.
<a href=#120 id=120 data-nosnippet>120</a> </span><span class="kw">pub </span>range_result_cache_size: ReadableSize,
<a href=#121 id=121 data-nosnippet>121</a> <span class="doccomment">/// Whether to enable the write cache.
<a href=#122 id=122 data-nosnippet>122</a> </span><span class="kw">pub </span>enable_write_cache: bool,
<a href=#123 id=123 data-nosnippet>123</a> <span class="doccomment">/// File system path for write cache dir's root, defaults to `{data_home}`.
<a href=#124 id=124 data-nosnippet>124</a> </span><span class="kw">pub </span>write_cache_path: String,
<a href=#125 id=125 data-nosnippet>125</a> <span class="doccomment">/// Capacity for write cache.
<a href=#126 id=126 data-nosnippet>126</a> </span><span class="kw">pub </span>write_cache_size: ReadableSize,
<a href=#127 id=127 data-nosnippet>127</a> <span class="doccomment">/// TTL for write cache.
<a href=#128 id=128 data-nosnippet>128</a> </span><span class="attr">#[serde(with = <span class="string">"humantime_serde"</span>)]
<a href=#129 id=129 data-nosnippet>129</a> </span><span class="kw">pub </span>write_cache_ttl: <span class="prelude-ty">Option</span>&lt;Duration&gt;,
<a href=#130 id=130 data-nosnippet>130</a> <span class="doccomment">/// Preload index (puffin) files into cache on region open (default: true).
<a href=#131 id=131 data-nosnippet>131</a> </span><span class="kw">pub </span>preload_index_cache: bool,
<a href=#132 id=132 data-nosnippet>132</a> <span class="doccomment">/// Percentage of write cache capacity allocated for index (puffin) files (default: 20).
<a href=#133 id=133 data-nosnippet>133</a> /// The remaining capacity is used for data (parquet) files.
<a href=#134 id=134 data-nosnippet>134</a> /// Must be between 0 and 100 (exclusive).
<a href=#135 id=135 data-nosnippet>135</a> </span><span class="kw">pub </span>index_cache_percent: u8,
<a href=#136 id=136 data-nosnippet>136</a> <span class="doccomment">/// Enable background downloading of files to the local cache when accessed during queries (default: true).
<a href=#137 id=137 data-nosnippet>137</a> /// When enabled, files will be asynchronously downloaded to improve performance for subsequent reads.
<a href=#138 id=138 data-nosnippet>138</a> </span><span class="kw">pub </span>enable_refill_cache_on_read: bool,
<a href=#139 id=139 data-nosnippet>139</a> <span class="doccomment">/// Capacity for manifest cache (default: 256MB).
<a href=#140 id=140 data-nosnippet>140</a> </span><span class="kw">pub </span>manifest_cache_size: ReadableSize,
<a href=#141 id=141 data-nosnippet>141</a>
<a href=#142 id=142 data-nosnippet>142</a> <span class="comment">// Other configs:
<a href=#143 id=143 data-nosnippet>143</a> </span><span class="doccomment">/// Buffer size for SST writing.
<a href=#144 id=144 data-nosnippet>144</a> </span><span class="kw">pub </span>sst_write_buffer_size: ReadableSize,
<a href=#145 id=145 data-nosnippet>145</a> <span class="doccomment">/// Capacity of the channel to send data from parallel scan tasks to the main task (default 32).
<a href=#146 id=146 data-nosnippet>146</a> </span><span class="kw">pub </span>parallel_scan_channel_size: usize,
<a href=#147 id=147 data-nosnippet>147</a> <span class="doccomment">/// Maximum number of SST files to scan concurrently (default 384).
<a href=#148 id=148 data-nosnippet>148</a> </span><span class="kw">pub </span>max_concurrent_scan_files: usize,
<a href=#149 id=149 data-nosnippet>149</a> <span class="doccomment">/// Whether to allow stale entries read during replay.
<a href=#150 id=150 data-nosnippet>150</a> </span><span class="kw">pub </span>allow_stale_entries: bool,
<a href=#151 id=151 data-nosnippet>151</a> <span class="doccomment">/// Memory limit for table scans across all queries. Setting it to 0 disables the limit.
<a href=#152 id=152 data-nosnippet>152</a> /// Supports absolute size (e.g., "2GB") or percentage (e.g., "50%").
<a href=#153 id=153 data-nosnippet>153</a> </span><span class="kw">pub </span>scan_memory_limit: MemoryLimit,
<a href=#154 id=154 data-nosnippet>154</a> <span class="doccomment">/// Behavior when scan memory tracking cannot acquire memory from the budget.
<a href=#155 id=155 data-nosnippet>155</a> /// `wait` means `wait(10s)`, not unlimited waiting.
<a href=#156 id=156 data-nosnippet>156</a> /// Defaults to [`OnExhaustedPolicy::Fail`], which intentionally differs from
<a href=#157 id=157 data-nosnippet>157</a> /// [`OnExhaustedPolicy::default()`].
<a href=#158 id=158 data-nosnippet>158</a> </span><span class="kw">pub </span>scan_memory_on_exhausted: OnExhaustedPolicy,
<a href=#159 id=159 data-nosnippet>159</a>
<a href=#160 id=160 data-nosnippet>160</a> <span class="doccomment">/// Index configs.
<a href=#161 id=161 data-nosnippet>161</a> </span><span class="kw">pub </span>index: IndexConfig,
<a href=#162 id=162 data-nosnippet>162</a> <span class="doccomment">/// Inverted index configs.
<a href=#163 id=163 data-nosnippet>163</a> </span><span class="kw">pub </span>inverted_index: InvertedIndexConfig,
<a href=#164 id=164 data-nosnippet>164</a> <span class="doccomment">/// Full-text index configs.
<a href=#165 id=165 data-nosnippet>165</a> </span><span class="kw">pub </span>fulltext_index: FulltextIndexConfig,
<a href=#166 id=166 data-nosnippet>166</a> <span class="doccomment">/// Bloom filter index configs.
<a href=#167 id=167 data-nosnippet>167</a> </span><span class="kw">pub </span>bloom_filter_index: BloomFilterConfig,
<a href=#168 id=168 data-nosnippet>168</a> <span class="doccomment">/// Vector index configs (HNSW).
<a href=#169 id=169 data-nosnippet>169</a> </span><span class="attr">#[cfg(feature = <span class="string">"vector_index"</span>)]
<a href=#170 id=170 data-nosnippet>170</a> </span><span class="kw">pub </span>vector_index: VectorIndexConfig,
<a href=#171 id=171 data-nosnippet>171</a>
<a href=#172 id=172 data-nosnippet>172</a> <span class="doccomment">/// Memtable config
<a href=#173 id=173 data-nosnippet>173</a> </span><span class="kw">pub </span>memtable: MemtableConfig,
<a href=#174 id=174 data-nosnippet>174</a>
<a href=#175 id=175 data-nosnippet>175</a> <span class="doccomment">/// Minimum time interval between two compactions.
<a href=#176 id=176 data-nosnippet>176</a> /// To align with the old behavior, the default value is 0 (no restrictions).
<a href=#177 id=177 data-nosnippet>177</a> </span><span class="attr">#[serde(with = <span class="string">"humantime_serde"</span>)]
<a href=#178 id=178 data-nosnippet>178</a> </span><span class="kw">pub </span>min_compaction_interval: Duration,
<a href=#179 id=179 data-nosnippet>179</a>
<a href=#180 id=180 data-nosnippet>180</a> <span class="doccomment">/// Whether to enable experimental flat format as the default format.
<a href=#181 id=181 data-nosnippet>181</a> /// When enabled, forces using BulkMemtable and BulkMemtableBuilder.
<a href=#182 id=182 data-nosnippet>182</a> </span><span class="kw">pub </span>default_experimental_flat_format: bool,
<a href=#183 id=183 data-nosnippet>183</a>
<a href=#184 id=184 data-nosnippet>184</a> <span class="kw">pub </span>gc: GcConfig,
<a href=#185 id=185 data-nosnippet>185</a>}
<a href=#186 id=186 data-nosnippet>186</a>
<a href=#187 id=187 data-nosnippet>187</a><span class="kw">impl </span>Default <span class="kw">for </span>MitoConfig {
<a href=#188 id=188 data-nosnippet>188</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#189 id=189 data-nosnippet>189</a> <span class="kw">let </span><span class="kw-2">mut </span>mito_config = MitoConfig {
<a href=#190 id=190 data-nosnippet>190</a> num_workers: divide_num_cpus(<span class="number">2</span>),
<a href=#191 id=191 data-nosnippet>191</a> worker_channel_size: <span class="number">128</span>,
<a href=#192 id=192 data-nosnippet>192</a> worker_request_batch_size: <span class="number">64</span>,
<a href=#193 id=193 data-nosnippet>193</a> manifest_checkpoint_distance: <span class="number">10</span>,
<a href=#194 id=194 data-nosnippet>194</a> experimental_manifest_keep_removed_file_count: <span class="number">256</span>,
<a href=#195 id=195 data-nosnippet>195</a> experimental_manifest_keep_removed_file_ttl: Duration::from_secs(<span class="number">60 </span>* <span class="number">60</span>),
<a href=#196 id=196 data-nosnippet>196</a> compress_manifest: <span class="bool-val">false</span>,
<a href=#197 id=197 data-nosnippet>197</a> max_background_index_builds: divide_num_cpus(<span class="number">8</span>),
<a href=#198 id=198 data-nosnippet>198</a> max_background_flushes: divide_num_cpus(<span class="number">2</span>),
<a href=#199 id=199 data-nosnippet>199</a> max_background_compactions: divide_num_cpus(<span class="number">4</span>),
<a href=#200 id=200 data-nosnippet>200</a> max_background_purges: get_total_cpu_cores(),
<a href=#201 id=201 data-nosnippet>201</a> experimental_compaction_memory_limit: MemoryLimit::Unlimited,
<a href=#202 id=202 data-nosnippet>202</a> experimental_compaction_on_exhausted: OnExhaustedPolicy::default(),
<a href=#203 id=203 data-nosnippet>203</a> auto_flush_interval: Duration::from_secs(<span class="number">30 </span>* <span class="number">60</span>),
<a href=#204 id=204 data-nosnippet>204</a> global_write_buffer_size: ReadableSize::gb(<span class="number">1</span>),
<a href=#205 id=205 data-nosnippet>205</a> global_write_buffer_reject_size: ReadableSize::gb(<span class="number">2</span>),
<a href=#206 id=206 data-nosnippet>206</a> sst_meta_cache_size: ReadableSize::mb(<span class="number">128</span>),
<a href=#207 id=207 data-nosnippet>207</a> vector_cache_size: ReadableSize::mb(<span class="number">512</span>),
<a href=#208 id=208 data-nosnippet>208</a> page_cache_size: ReadableSize::mb(<span class="number">512</span>),
<a href=#209 id=209 data-nosnippet>209</a> selector_result_cache_size: ReadableSize::mb(<span class="number">512</span>),
<a href=#210 id=210 data-nosnippet>210</a> range_result_cache_size: ReadableSize::mb(<span class="number">512</span>),
<a href=#211 id=211 data-nosnippet>211</a> enable_write_cache: <span class="bool-val">false</span>,
<a href=#212 id=212 data-nosnippet>212</a> write_cache_path: String::new(),
<a href=#213 id=213 data-nosnippet>213</a> write_cache_size: ReadableSize::gb(<span class="number">5</span>),
<a href=#214 id=214 data-nosnippet>214</a> write_cache_ttl: <span class="prelude-val">None</span>,
<a href=#215 id=215 data-nosnippet>215</a> preload_index_cache: <span class="bool-val">true</span>,
<a href=#216 id=216 data-nosnippet>216</a> index_cache_percent: DEFAULT_INDEX_CACHE_PERCENT,
<a href=#217 id=217 data-nosnippet>217</a> enable_refill_cache_on_read: <span class="bool-val">true</span>,
<a href=#218 id=218 data-nosnippet>218</a> manifest_cache_size: ReadableSize::mb(<span class="number">256</span>),
<a href=#219 id=219 data-nosnippet>219</a> sst_write_buffer_size: DEFAULT_WRITE_BUFFER_SIZE,
<a href=#220 id=220 data-nosnippet>220</a> parallel_scan_channel_size: DEFAULT_SCAN_CHANNEL_SIZE,
<a href=#221 id=221 data-nosnippet>221</a> max_concurrent_scan_files: DEFAULT_MAX_CONCURRENT_SCAN_FILES,
<a href=#222 id=222 data-nosnippet>222</a> allow_stale_entries: <span class="bool-val">false</span>,
<a href=#223 id=223 data-nosnippet>223</a> scan_memory_limit: MemoryLimit::default(),
<a href=#224 id=224 data-nosnippet>224</a> scan_memory_on_exhausted: OnExhaustedPolicy::Fail,
<a href=#225 id=225 data-nosnippet>225</a> index: IndexConfig::default(),
<a href=#226 id=226 data-nosnippet>226</a> inverted_index: InvertedIndexConfig::default(),
<a href=#227 id=227 data-nosnippet>227</a> fulltext_index: FulltextIndexConfig::default(),
<a href=#228 id=228 data-nosnippet>228</a> bloom_filter_index: BloomFilterConfig::default(),
<a href=#229 id=229 data-nosnippet>229</a> <span class="attr">#[cfg(feature = <span class="string">"vector_index"</span>)]
<a href=#230 id=230 data-nosnippet>230</a> </span>vector_index: VectorIndexConfig::default(),
<a href=#231 id=231 data-nosnippet>231</a> memtable: MemtableConfig::default(),
<a href=#232 id=232 data-nosnippet>232</a> min_compaction_interval: Duration::from_secs(<span class="number">0</span>),
<a href=#233 id=233 data-nosnippet>233</a> default_experimental_flat_format: <span class="bool-val">false</span>,
<a href=#234 id=234 data-nosnippet>234</a> gc: GcConfig::default(),
<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="comment">// Adjust buffer and cache size according to system memory if we can.
<a href=#238 id=238 data-nosnippet>238</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(sys_memory) = get_total_memory_readable() {
<a href=#239 id=239 data-nosnippet>239</a> mito_config.adjust_buffer_and_cache_size(sys_memory);
<a href=#240 id=240 data-nosnippet>240</a> }
<a href=#241 id=241 data-nosnippet>241</a>
<a href=#242 id=242 data-nosnippet>242</a> mito_config
<a href=#243 id=243 data-nosnippet>243</a> }
<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="kw">impl </span>MitoConfig {
<a href=#247 id=247 data-nosnippet>247</a> <span class="doccomment">/// Sanitize incorrect configurations.
<a href=#248 id=248 data-nosnippet>248</a> ///
<a href=#249 id=249 data-nosnippet>249</a> /// Returns an error if there is a configuration that unable to sanitize.
<a href=#250 id=250 data-nosnippet>250</a> </span><span class="kw">pub fn </span>sanitize(<span class="kw-2">&amp;mut </span><span class="self">self</span>, data_home: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#251 id=251 data-nosnippet>251</a> <span class="comment">// Use default value if `num_workers` is 0.
<a href=#252 id=252 data-nosnippet>252</a> </span><span class="kw">if </span><span class="self">self</span>.num_workers == <span class="number">0 </span>{
<a href=#253 id=253 data-nosnippet>253</a> <span class="self">self</span>.num_workers = divide_num_cpus(<span class="number">2</span>);
<a href=#254 id=254 data-nosnippet>254</a> }
<a href=#255 id=255 data-nosnippet>255</a>
<a href=#256 id=256 data-nosnippet>256</a> <span class="comment">// Sanitize channel size.
<a href=#257 id=257 data-nosnippet>257</a> </span><span class="kw">if </span><span class="self">self</span>.worker_channel_size == <span class="number">0 </span>{
<a href=#258 id=258 data-nosnippet>258</a> <span class="macro">warn!</span>(<span class="string">"Sanitize channel size 0 to 1"</span>);
<a href=#259 id=259 data-nosnippet>259</a> <span class="self">self</span>.worker_channel_size = <span class="number">1</span>;
<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="kw">if </span><span class="self">self</span>.max_background_flushes == <span class="number">0 </span>{
<a href=#263 id=263 data-nosnippet>263</a> <span class="macro">warn!</span>(
<a href=#264 id=264 data-nosnippet>264</a> <span class="string">"Sanitize max background flushes 0 to {}"</span>,
<a href=#265 id=265 data-nosnippet>265</a> divide_num_cpus(<span class="number">2</span>)
<a href=#266 id=266 data-nosnippet>266</a> );
<a href=#267 id=267 data-nosnippet>267</a> <span class="self">self</span>.max_background_flushes = divide_num_cpus(<span class="number">2</span>);
<a href=#268 id=268 data-nosnippet>268</a> }
<a href=#269 id=269 data-nosnippet>269</a> <span class="kw">if </span><span class="self">self</span>.max_background_compactions == <span class="number">0 </span>{
<a href=#270 id=270 data-nosnippet>270</a> <span class="macro">warn!</span>(
<a href=#271 id=271 data-nosnippet>271</a> <span class="string">"Sanitize max background compactions 0 to {}"</span>,
<a href=#272 id=272 data-nosnippet>272</a> divide_num_cpus(<span class="number">4</span>)
<a href=#273 id=273 data-nosnippet>273</a> );
<a href=#274 id=274 data-nosnippet>274</a> <span class="self">self</span>.max_background_compactions = divide_num_cpus(<span class="number">4</span>);
<a href=#275 id=275 data-nosnippet>275</a> }
<a href=#276 id=276 data-nosnippet>276</a> <span class="kw">if </span><span class="self">self</span>.max_background_purges == <span class="number">0 </span>{
<a href=#277 id=277 data-nosnippet>277</a> <span class="kw">let </span>cpu_cores = get_total_cpu_cores();
<a href=#278 id=278 data-nosnippet>278</a> <span class="macro">warn!</span>(<span class="string">"Sanitize max background purges 0 to {}"</span>, cpu_cores);
<a href=#279 id=279 data-nosnippet>279</a> <span class="self">self</span>.max_background_purges = cpu_cores;
<a href=#280 id=280 data-nosnippet>280</a> }
<a href=#281 id=281 data-nosnippet>281</a>
<a href=#282 id=282 data-nosnippet>282</a> <span class="kw">if </span><span class="self">self</span>.global_write_buffer_reject_size &lt;= <span class="self">self</span>.global_write_buffer_size {
<a href=#283 id=283 data-nosnippet>283</a> <span class="self">self</span>.global_write_buffer_reject_size = <span class="self">self</span>.global_write_buffer_size * <span class="number">2</span>;
<a href=#284 id=284 data-nosnippet>284</a> <span class="macro">warn!</span>(
<a href=#285 id=285 data-nosnippet>285</a> <span class="string">"Sanitize global write buffer reject size to {}"</span>,
<a href=#286 id=286 data-nosnippet>286</a> <span class="self">self</span>.global_write_buffer_reject_size
<a href=#287 id=287 data-nosnippet>287</a> );
<a href=#288 id=288 data-nosnippet>288</a> }
<a href=#289 id=289 data-nosnippet>289</a>
<a href=#290 id=290 data-nosnippet>290</a> <span class="kw">if </span><span class="self">self</span>.sst_write_buffer_size &lt; MULTIPART_UPLOAD_MINIMUM_SIZE {
<a href=#291 id=291 data-nosnippet>291</a> <span class="self">self</span>.sst_write_buffer_size = MULTIPART_UPLOAD_MINIMUM_SIZE;
<a href=#292 id=292 data-nosnippet>292</a> <span class="macro">warn!</span>(
<a href=#293 id=293 data-nosnippet>293</a> <span class="string">"Sanitize sst write buffer size to {}"</span>,
<a href=#294 id=294 data-nosnippet>294</a> <span class="self">self</span>.sst_write_buffer_size
<a href=#295 id=295 data-nosnippet>295</a> );
<a href=#296 id=296 data-nosnippet>296</a> }
<a href=#297 id=297 data-nosnippet>297</a>
<a href=#298 id=298 data-nosnippet>298</a> <span class="kw">if </span><span class="self">self</span>.parallel_scan_channel_size &lt; <span class="number">1 </span>{
<a href=#299 id=299 data-nosnippet>299</a> <span class="self">self</span>.parallel_scan_channel_size = DEFAULT_SCAN_CHANNEL_SIZE;
<a href=#300 id=300 data-nosnippet>300</a> <span class="macro">warn!</span>(
<a href=#301 id=301 data-nosnippet>301</a> <span class="string">"Sanitize scan channel size to {}"</span>,
<a href=#302 id=302 data-nosnippet>302</a> <span class="self">self</span>.parallel_scan_channel_size
<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> <span class="comment">// Sets write cache path if it is empty.
<a href=#307 id=307 data-nosnippet>307</a> </span><span class="kw">if </span><span class="self">self</span>.write_cache_path.trim().is_empty() {
<a href=#308 id=308 data-nosnippet>308</a> <span class="self">self</span>.write_cache_path = data_home.to_string();
<a href=#309 id=309 data-nosnippet>309</a> }
<a href=#310 id=310 data-nosnippet>310</a>
<a href=#311 id=311 data-nosnippet>311</a> <span class="comment">// Validate index_cache_percent is within valid range (0, 100)
<a href=#312 id=312 data-nosnippet>312</a> </span><span class="kw">if </span><span class="self">self</span>.index_cache_percent == <span class="number">0 </span>|| <span class="self">self</span>.index_cache_percent &gt;= <span class="number">100 </span>{
<a href=#313 id=313 data-nosnippet>313</a> <span class="macro">warn!</span>(
<a href=#314 id=314 data-nosnippet>314</a> <span class="string">"Invalid index_cache_percent {}, resetting to default {}"</span>,
<a href=#315 id=315 data-nosnippet>315</a> <span class="self">self</span>.index_cache_percent, DEFAULT_INDEX_CACHE_PERCENT
<a href=#316 id=316 data-nosnippet>316</a> );
<a href=#317 id=317 data-nosnippet>317</a> <span class="self">self</span>.index_cache_percent = DEFAULT_INDEX_CACHE_PERCENT;
<a href=#318 id=318 data-nosnippet>318</a> }
<a href=#319 id=319 data-nosnippet>319</a>
<a href=#320 id=320 data-nosnippet>320</a> <span class="self">self</span>.index.sanitize(data_home, <span class="kw-2">&amp;</span><span class="self">self</span>.inverted_index)<span class="question-mark">?</span>;
<a href=#321 id=321 data-nosnippet>321</a>
<a href=#322 id=322 data-nosnippet>322</a> <span class="prelude-val">Ok</span>(())
<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="kw">fn </span>adjust_buffer_and_cache_size(<span class="kw-2">&amp;mut </span><span class="self">self</span>, sys_memory: ReadableSize) {
<a href=#326 id=326 data-nosnippet>326</a> <span class="comment">// shouldn't be greater than 1G in default mode.
<a href=#327 id=327 data-nosnippet>327</a> </span><span class="kw">let </span>global_write_buffer_size = cmp::min(
<a href=#328 id=328 data-nosnippet>328</a> sys_memory / GLOBAL_WRITE_BUFFER_SIZE_FACTOR,
<a href=#329 id=329 data-nosnippet>329</a> ReadableSize::gb(<span class="number">1</span>),
<a href=#330 id=330 data-nosnippet>330</a> );
<a href=#331 id=331 data-nosnippet>331</a> <span class="comment">// Use 2x of global write buffer size as global write buffer reject size.
<a href=#332 id=332 data-nosnippet>332</a> </span><span class="kw">let </span>global_write_buffer_reject_size = global_write_buffer_size * <span class="number">2</span>;
<a href=#333 id=333 data-nosnippet>333</a> <span class="comment">// shouldn't be greater than 128MB in default mode.
<a href=#334 id=334 data-nosnippet>334</a> </span><span class="kw">let </span>sst_meta_cache_size = cmp::min(
<a href=#335 id=335 data-nosnippet>335</a> sys_memory / SST_META_CACHE_SIZE_FACTOR,
<a href=#336 id=336 data-nosnippet>336</a> ReadableSize::mb(<span class="number">128</span>),
<a href=#337 id=337 data-nosnippet>337</a> );
<a href=#338 id=338 data-nosnippet>338</a> <span class="comment">// shouldn't be greater than 512MB in default mode.
<a href=#339 id=339 data-nosnippet>339</a> </span><span class="kw">let </span>mem_cache_size = cmp::min(sys_memory / MEM_CACHE_SIZE_FACTOR, ReadableSize::mb(<span class="number">512</span>));
<a href=#340 id=340 data-nosnippet>340</a> <span class="kw">let </span>page_cache_size = sys_memory / PAGE_CACHE_SIZE_FACTOR;
<a href=#341 id=341 data-nosnippet>341</a>
<a href=#342 id=342 data-nosnippet>342</a> <span class="self">self</span>.global_write_buffer_size = global_write_buffer_size;
<a href=#343 id=343 data-nosnippet>343</a> <span class="self">self</span>.global_write_buffer_reject_size = global_write_buffer_reject_size;
<a href=#344 id=344 data-nosnippet>344</a> <span class="self">self</span>.sst_meta_cache_size = sst_meta_cache_size;
<a href=#345 id=345 data-nosnippet>345</a> <span class="self">self</span>.vector_cache_size = mem_cache_size;
<a href=#346 id=346 data-nosnippet>346</a> <span class="self">self</span>.page_cache_size = page_cache_size;
<a href=#347 id=347 data-nosnippet>347</a> <span class="self">self</span>.selector_result_cache_size = mem_cache_size;
<a href=#348 id=348 data-nosnippet>348</a> <span class="self">self</span>.range_result_cache_size = mem_cache_size;
<a href=#349 id=349 data-nosnippet>349</a>
<a href=#350 id=350 data-nosnippet>350</a> <span class="self">self</span>.index.adjust_buffer_and_cache_size(sys_memory);
<a href=#351 id=351 data-nosnippet>351</a> }
<a href=#352 id=352 data-nosnippet>352</a>
<a href=#353 id=353 data-nosnippet>353</a> <span class="doccomment">/// Enable write cache.
<a href=#354 id=354 data-nosnippet>354</a> </span><span class="attr">#[cfg(test)]
<a href=#355 id=355 data-nosnippet>355</a> </span><span class="kw">pub fn </span>enable_write_cache(
<a href=#356 id=356 data-nosnippet>356</a> <span class="kw-2">mut </span><span class="self">self</span>,
<a href=#357 id=357 data-nosnippet>357</a> path: String,
<a href=#358 id=358 data-nosnippet>358</a> size: ReadableSize,
<a href=#359 id=359 data-nosnippet>359</a> ttl: <span class="prelude-ty">Option</span>&lt;Duration&gt;,
<a href=#360 id=360 data-nosnippet>360</a> ) -&gt; <span class="self">Self </span>{
<a href=#361 id=361 data-nosnippet>361</a> <span class="self">self</span>.enable_write_cache = <span class="bool-val">true</span>;
<a href=#362 id=362 data-nosnippet>362</a> <span class="self">self</span>.write_cache_path = path;
<a href=#363 id=363 data-nosnippet>363</a> <span class="self">self</span>.write_cache_size = size;
<a href=#364 id=364 data-nosnippet>364</a> <span class="self">self</span>.write_cache_ttl = ttl;
<a href=#365 id=365 data-nosnippet>365</a> <span class="self">self
<a href=#366 id=366 data-nosnippet>366</a> </span>}
<a href=#367 id=367 data-nosnippet>367</a>}
<a href=#368 id=368 data-nosnippet>368</a>
<a href=#369 id=369 data-nosnippet>369</a><span class="doccomment">/// Index build mode.
<a href=#370 id=370 data-nosnippet>370</a></span><span class="attr">#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq, Default)]
<a href=#371 id=371 data-nosnippet>371</a>#[serde(rename_all = <span class="string">"snake_case"</span>)]
<a href=#372 id=372 data-nosnippet>372</a></span><span class="kw">pub enum </span>IndexBuildMode {
<a href=#373 id=373 data-nosnippet>373</a> <span class="doccomment">/// Build index synchronously.
<a href=#374 id=374 data-nosnippet>374</a> </span><span class="attr">#[default]
<a href=#375 id=375 data-nosnippet>375</a> </span>Sync,
<a href=#376 id=376 data-nosnippet>376</a> <span class="doccomment">/// Build index asynchronously.
<a href=#377 id=377 data-nosnippet>377</a> </span>Async,
<a href=#378 id=378 data-nosnippet>378</a>}
<a href=#379 id=379 data-nosnippet>379</a>
<a href=#380 id=380 data-nosnippet>380</a><span class="attr">#[serde_as]
<a href=#381 id=381 data-nosnippet>381</a>#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
<a href=#382 id=382 data-nosnippet>382</a>#[serde(default)]
<a href=#383 id=383 data-nosnippet>383</a></span><span class="kw">pub struct </span>IndexConfig {
<a href=#384 id=384 data-nosnippet>384</a> <span class="doccomment">/// Auxiliary directory path for the index in filesystem, used to
<a href=#385 id=385 data-nosnippet>385</a> /// store intermediate files for creating the index and staging files
<a href=#386 id=386 data-nosnippet>386</a> /// for searching the index, defaults to `{data_home}/index_intermediate`.
<a href=#387 id=387 data-nosnippet>387</a> ///
<a href=#388 id=388 data-nosnippet>388</a> /// This path contains two subdirectories:
<a href=#389 id=389 data-nosnippet>389</a> /// - `__intm`: for storing intermediate files used during creating index.
<a href=#390 id=390 data-nosnippet>390</a> /// - `staging`: for storing staging files used during searching index.
<a href=#391 id=391 data-nosnippet>391</a> ///
<a href=#392 id=392 data-nosnippet>392</a> /// The default name for this directory is `index_intermediate` for backward compatibility.
<a href=#393 id=393 data-nosnippet>393</a> </span><span class="kw">pub </span>aux_path: String,
<a href=#394 id=394 data-nosnippet>394</a>
<a href=#395 id=395 data-nosnippet>395</a> <span class="doccomment">/// The max capacity of the staging directory.
<a href=#396 id=396 data-nosnippet>396</a> </span><span class="kw">pub </span>staging_size: ReadableSize,
<a href=#397 id=397 data-nosnippet>397</a> <span class="doccomment">/// The TTL of the staging directory.
<a href=#398 id=398 data-nosnippet>398</a> /// Defaults to 7 days.
<a href=#399 id=399 data-nosnippet>399</a> /// Setting it to "0s" to disable TTL.
<a href=#400 id=400 data-nosnippet>400</a> </span><span class="attr">#[serde(with = <span class="string">"humantime_serde"</span>)]
<a href=#401 id=401 data-nosnippet>401</a> </span><span class="kw">pub </span>staging_ttl: <span class="prelude-ty">Option</span>&lt;Duration&gt;,
<a href=#402 id=402 data-nosnippet>402</a>
<a href=#403 id=403 data-nosnippet>403</a> <span class="doccomment">/// Index Build Mode
<a href=#404 id=404 data-nosnippet>404</a> </span><span class="kw">pub </span>build_mode: IndexBuildMode,
<a href=#405 id=405 data-nosnippet>405</a>
<a href=#406 id=406 data-nosnippet>406</a> <span class="doccomment">/// Write buffer size for creating the index.
<a href=#407 id=407 data-nosnippet>407</a> </span><span class="kw">pub </span>write_buffer_size: ReadableSize,
<a href=#408 id=408 data-nosnippet>408</a>
<a href=#409 id=409 data-nosnippet>409</a> <span class="doccomment">/// Cache size for metadata of puffin files. Setting it to 0 to disable the cache.
<a href=#410 id=410 data-nosnippet>410</a> </span><span class="kw">pub </span>metadata_cache_size: ReadableSize,
<a href=#411 id=411 data-nosnippet>411</a> <span class="doccomment">/// Cache size for inverted index content. Setting it to 0 to disable the cache.
<a href=#412 id=412 data-nosnippet>412</a> </span><span class="kw">pub </span>content_cache_size: ReadableSize,
<a href=#413 id=413 data-nosnippet>413</a> <span class="doccomment">/// Page size for inverted index content.
<a href=#414 id=414 data-nosnippet>414</a> </span><span class="kw">pub </span>content_cache_page_size: ReadableSize,
<a href=#415 id=415 data-nosnippet>415</a> <span class="doccomment">/// Cache size for index result. Setting it to 0 to disable the cache.
<a href=#416 id=416 data-nosnippet>416</a> </span><span class="kw">pub </span>result_cache_size: ReadableSize,
<a href=#417 id=417 data-nosnippet>417</a>}
<a href=#418 id=418 data-nosnippet>418</a>
<a href=#419 id=419 data-nosnippet>419</a><span class="kw">impl </span>Default <span class="kw">for </span>IndexConfig {
<a href=#420 id=420 data-nosnippet>420</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#421 id=421 data-nosnippet>421</a> <span class="self">Self </span>{
<a href=#422 id=422 data-nosnippet>422</a> aux_path: String::new(),
<a href=#423 id=423 data-nosnippet>423</a> staging_size: ReadableSize::gb(<span class="number">2</span>),
<a href=#424 id=424 data-nosnippet>424</a> staging_ttl: <span class="prelude-val">Some</span>(Duration::from_secs(<span class="number">7 </span>* <span class="number">24 </span>* <span class="number">60 </span>* <span class="number">60</span>)),
<a href=#425 id=425 data-nosnippet>425</a> build_mode: IndexBuildMode::default(),
<a href=#426 id=426 data-nosnippet>426</a> write_buffer_size: ReadableSize::mb(<span class="number">8</span>),
<a href=#427 id=427 data-nosnippet>427</a> metadata_cache_size: ReadableSize::mb(<span class="number">64</span>),
<a href=#428 id=428 data-nosnippet>428</a> content_cache_size: ReadableSize::mb(<span class="number">128</span>),
<a href=#429 id=429 data-nosnippet>429</a> content_cache_page_size: ReadableSize::kb(<span class="number">64</span>),
<a href=#430 id=430 data-nosnippet>430</a> result_cache_size: ReadableSize::mb(<span class="number">128</span>),
<a href=#431 id=431 data-nosnippet>431</a> }
<a href=#432 id=432 data-nosnippet>432</a> }
<a href=#433 id=433 data-nosnippet>433</a>}
<a href=#434 id=434 data-nosnippet>434</a>
<a href=#435 id=435 data-nosnippet>435</a><span class="kw">impl </span>IndexConfig {
<a href=#436 id=436 data-nosnippet>436</a> <span class="kw">pub fn </span>sanitize(
<a href=#437 id=437 data-nosnippet>437</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#438 id=438 data-nosnippet>438</a> data_home: <span class="kw-2">&amp;</span>str,
<a href=#439 id=439 data-nosnippet>439</a> inverted_index: <span class="kw-2">&amp;</span>InvertedIndexConfig,
<a href=#440 id=440 data-nosnippet>440</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#441 id=441 data-nosnippet>441</a> <span class="attr">#[allow(deprecated)]
<a href=#442 id=442 data-nosnippet>442</a> </span><span class="kw">if </span><span class="self">self</span>.aux_path.is_empty() &amp;&amp; !inverted_index.intermediate_path.is_empty() {
<a href=#443 id=443 data-nosnippet>443</a> <span class="self">self</span>.aux_path.clone_from(<span class="kw-2">&amp;</span>inverted_index.intermediate_path);
<a href=#444 id=444 data-nosnippet>444</a> <span class="macro">warn!</span>(
<a href=#445 id=445 data-nosnippet>445</a> <span class="string">"`inverted_index.intermediate_path` is deprecated, use
<a href=#446 id=446 data-nosnippet>446</a> `index.aux_path` instead. Set `index.aux_path` to {}"</span>,
<a href=#447 id=447 data-nosnippet>447</a> <span class="kw-2">&amp;</span>inverted_index.intermediate_path
<a href=#448 id=448 data-nosnippet>448</a> )
<a href=#449 id=449 data-nosnippet>449</a> }
<a href=#450 id=450 data-nosnippet>450</a> <span class="kw">if </span><span class="self">self</span>.aux_path.is_empty() {
<a href=#451 id=451 data-nosnippet>451</a> <span class="kw">let </span>path = Path::new(data_home).join(<span class="string">"index_intermediate"</span>);
<a href=#452 id=452 data-nosnippet>452</a> <span class="self">self</span>.aux_path = path.as_os_str().to_string_lossy().to_string();
<a href=#453 id=453 data-nosnippet>453</a> }
<a href=#454 id=454 data-nosnippet>454</a>
<a href=#455 id=455 data-nosnippet>455</a> <span class="kw">if </span><span class="self">self</span>.write_buffer_size &lt; MULTIPART_UPLOAD_MINIMUM_SIZE {
<a href=#456 id=456 data-nosnippet>456</a> <span class="self">self</span>.write_buffer_size = MULTIPART_UPLOAD_MINIMUM_SIZE;
<a href=#457 id=457 data-nosnippet>457</a> <span class="macro">warn!</span>(
<a href=#458 id=458 data-nosnippet>458</a> <span class="string">"Sanitize index write buffer size to {}"</span>,
<a href=#459 id=459 data-nosnippet>459</a> <span class="self">self</span>.write_buffer_size
<a href=#460 id=460 data-nosnippet>460</a> );
<a href=#461 id=461 data-nosnippet>461</a> }
<a href=#462 id=462 data-nosnippet>462</a>
<a href=#463 id=463 data-nosnippet>463</a> <span class="kw">if </span><span class="self">self</span>.staging_ttl.map(|ttl| ttl.is_zero()).unwrap_or(<span class="bool-val">false</span>) {
<a href=#464 id=464 data-nosnippet>464</a> <span class="self">self</span>.staging_ttl = <span class="prelude-val">None</span>;
<a href=#465 id=465 data-nosnippet>465</a> }
<a href=#466 id=466 data-nosnippet>466</a>
<a href=#467 id=467 data-nosnippet>467</a> <span class="prelude-val">Ok</span>(())
<a href=#468 id=468 data-nosnippet>468</a> }
<a href=#469 id=469 data-nosnippet>469</a>
<a href=#470 id=470 data-nosnippet>470</a> <span class="kw">pub fn </span>adjust_buffer_and_cache_size(<span class="kw-2">&amp;mut </span><span class="self">self</span>, sys_memory: ReadableSize) {
<a href=#471 id=471 data-nosnippet>471</a> <span class="kw">let </span>cache_size = cmp::min(sys_memory / MEM_CACHE_SIZE_FACTOR, ReadableSize::mb(<span class="number">128</span>));
<a href=#472 id=472 data-nosnippet>472</a> <span class="self">self</span>.result_cache_size = cmp::min(<span class="self">self</span>.result_cache_size, cache_size);
<a href=#473 id=473 data-nosnippet>473</a> <span class="self">self</span>.content_cache_size = cmp::min(<span class="self">self</span>.content_cache_size, cache_size);
<a href=#474 id=474 data-nosnippet>474</a>
<a href=#475 id=475 data-nosnippet>475</a> <span class="kw">let </span>metadata_cache_size = cmp::min(
<a href=#476 id=476 data-nosnippet>476</a> sys_memory / SST_META_CACHE_SIZE_FACTOR,
<a href=#477 id=477 data-nosnippet>477</a> ReadableSize::mb(<span class="number">64</span>),
<a href=#478 id=478 data-nosnippet>478</a> );
<a href=#479 id=479 data-nosnippet>479</a> <span class="self">self</span>.metadata_cache_size = cmp::min(<span class="self">self</span>.metadata_cache_size, metadata_cache_size);
<a href=#480 id=480 data-nosnippet>480</a> }
<a href=#481 id=481 data-nosnippet>481</a>}
<a href=#482 id=482 data-nosnippet>482</a>
<a href=#483 id=483 data-nosnippet>483</a><span class="doccomment">/// Operational mode for certain actions.
<a href=#484 id=484 data-nosnippet>484</a></span><span class="attr">#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq, Default)]
<a href=#485 id=485 data-nosnippet>485</a>#[serde(rename_all = <span class="string">"snake_case"</span>)]
<a href=#486 id=486 data-nosnippet>486</a></span><span class="kw">pub enum </span>Mode {
<a href=#487 id=487 data-nosnippet>487</a> <span class="doccomment">/// The action is performed automatically based on internal criteria.
<a href=#488 id=488 data-nosnippet>488</a> </span><span class="attr">#[default]
<a href=#489 id=489 data-nosnippet>489</a> </span>Auto,
<a href=#490 id=490 data-nosnippet>490</a> <span class="doccomment">/// The action is explicitly disabled.
<a href=#491 id=491 data-nosnippet>491</a> </span>Disable,
<a href=#492 id=492 data-nosnippet>492</a>}
<a href=#493 id=493 data-nosnippet>493</a>
<a href=#494 id=494 data-nosnippet>494</a><span class="kw">impl </span>Mode {
<a href=#495 id=495 data-nosnippet>495</a> <span class="doccomment">/// Whether the action is disabled.
<a href=#496 id=496 data-nosnippet>496</a> </span><span class="kw">pub fn </span>disabled(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<a href=#497 id=497 data-nosnippet>497</a> <span class="macro">matches!</span>(<span class="self">self</span>, Mode::Disable)
<a href=#498 id=498 data-nosnippet>498</a> }
<a href=#499 id=499 data-nosnippet>499</a>
<a href=#500 id=500 data-nosnippet>500</a> <span class="doccomment">/// Whether the action is automatic.
<a href=#501 id=501 data-nosnippet>501</a> </span><span class="kw">pub fn </span>auto(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<a href=#502 id=502 data-nosnippet>502</a> <span class="macro">matches!</span>(<span class="self">self</span>, Mode::Auto)
<a href=#503 id=503 data-nosnippet>503</a> }
<a href=#504 id=504 data-nosnippet>504</a>}
<a href=#505 id=505 data-nosnippet>505</a>
<a href=#506 id=506 data-nosnippet>506</a><span class="doccomment">/// Memory threshold for performing certain actions.
<a href=#507 id=507 data-nosnippet>507</a></span><span class="attr">#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
<a href=#508 id=508 data-nosnippet>508</a>#[serde(rename_all = <span class="string">"snake_case"</span>)]
<a href=#509 id=509 data-nosnippet>509</a></span><span class="kw">pub enum </span>MemoryThreshold {
<a href=#510 id=510 data-nosnippet>510</a> <span class="doccomment">/// Automatically determine the threshold based on internal criteria.
<a href=#511 id=511 data-nosnippet>511</a> </span><span class="attr">#[default]
<a href=#512 id=512 data-nosnippet>512</a> </span>Auto,
<a href=#513 id=513 data-nosnippet>513</a> <span class="doccomment">/// Unlimited memory.
<a href=#514 id=514 data-nosnippet>514</a> </span>Unlimited,
<a href=#515 id=515 data-nosnippet>515</a> <span class="doccomment">/// Fixed memory threshold.
<a href=#516 id=516 data-nosnippet>516</a> </span><span class="attr">#[serde(untagged)]
<a href=#517 id=517 data-nosnippet>517</a> </span>Size(ReadableSize),
<a href=#518 id=518 data-nosnippet>518</a>}
<a href=#519 id=519 data-nosnippet>519</a>
<a href=#520 id=520 data-nosnippet>520</a><span class="doccomment">/// Configuration options for the inverted index.
<a href=#521 id=521 data-nosnippet>521</a></span><span class="attr">#[serde_as]
<a href=#522 id=522 data-nosnippet>522</a>#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
<a href=#523 id=523 data-nosnippet>523</a>#[serde(default)]
<a href=#524 id=524 data-nosnippet>524</a></span><span class="kw">pub struct </span>InvertedIndexConfig {
<a href=#525 id=525 data-nosnippet>525</a> <span class="doccomment">/// Whether to create the index on flush: automatically or never.
<a href=#526 id=526 data-nosnippet>526</a> </span><span class="kw">pub </span>create_on_flush: Mode,
<a href=#527 id=527 data-nosnippet>527</a> <span class="doccomment">/// Whether to create the index on compaction: automatically or never.
<a href=#528 id=528 data-nosnippet>528</a> </span><span class="kw">pub </span>create_on_compaction: Mode,
<a href=#529 id=529 data-nosnippet>529</a> <span class="doccomment">/// Whether to apply the index on query: automatically or never.
<a href=#530 id=530 data-nosnippet>530</a> </span><span class="kw">pub </span>apply_on_query: Mode,
<a href=#531 id=531 data-nosnippet>531</a>
<a href=#532 id=532 data-nosnippet>532</a> <span class="doccomment">/// Memory threshold for performing an external sort during index creation.
<a href=#533 id=533 data-nosnippet>533</a> </span><span class="kw">pub </span>mem_threshold_on_create: MemoryThreshold,
<a href=#534 id=534 data-nosnippet>534</a>
<a href=#535 id=535 data-nosnippet>535</a> <span class="attr">#[deprecated = <span class="string">"use [IndexConfig::aux_path] instead"</span>]
<a href=#536 id=536 data-nosnippet>536</a> #[serde(skip_serializing)]
<a href=#537 id=537 data-nosnippet>537</a> </span><span class="kw">pub </span>intermediate_path: String,
<a href=#538 id=538 data-nosnippet>538</a>
<a href=#539 id=539 data-nosnippet>539</a> <span class="attr">#[deprecated = <span class="string">"use [IndexConfig::write_buffer_size] instead"</span>]
<a href=#540 id=540 data-nosnippet>540</a> #[serde(skip_serializing)]
<a href=#541 id=541 data-nosnippet>541</a> </span><span class="kw">pub </span>write_buffer_size: ReadableSize,
<a href=#542 id=542 data-nosnippet>542</a>}
<a href=#543 id=543 data-nosnippet>543</a>
<a href=#544 id=544 data-nosnippet>544</a><span class="kw">impl </span>Default <span class="kw">for </span>InvertedIndexConfig {
<a href=#545 id=545 data-nosnippet>545</a> <span class="attr">#[allow(deprecated)]
<a href=#546 id=546 data-nosnippet>546</a> </span><span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#547 id=547 data-nosnippet>547</a> <span class="self">Self </span>{
<a href=#548 id=548 data-nosnippet>548</a> create_on_flush: Mode::Auto,
<a href=#549 id=549 data-nosnippet>549</a> create_on_compaction: Mode::Auto,
<a href=#550 id=550 data-nosnippet>550</a> apply_on_query: Mode::Auto,
<a href=#551 id=551 data-nosnippet>551</a> mem_threshold_on_create: MemoryThreshold::Auto,
<a href=#552 id=552 data-nosnippet>552</a> write_buffer_size: ReadableSize::mb(<span class="number">8</span>),
<a href=#553 id=553 data-nosnippet>553</a> intermediate_path: String::new(),
<a href=#554 id=554 data-nosnippet>554</a> }
<a href=#555 id=555 data-nosnippet>555</a> }
<a href=#556 id=556 data-nosnippet>556</a>}
<a href=#557 id=557 data-nosnippet>557</a>
<a href=#558 id=558 data-nosnippet>558</a><span class="kw">impl </span>InvertedIndexConfig {
<a href=#559 id=559 data-nosnippet>559</a> <span class="kw">pub fn </span>mem_threshold_on_create(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
<a href=#560 id=560 data-nosnippet>560</a> <span class="kw">match </span><span class="self">self</span>.mem_threshold_on_create {
<a href=#561 id=561 data-nosnippet>561</a> MemoryThreshold::Auto =&gt; {
<a href=#562 id=562 data-nosnippet>562</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(sys_memory) = get_total_memory_readable() {
<a href=#563 id=563 data-nosnippet>563</a> <span class="prelude-val">Some</span>((sys_memory / INDEX_CREATE_MEM_THRESHOLD_FACTOR).as_bytes() <span class="kw">as </span>usize)
<a href=#564 id=564 data-nosnippet>564</a> } <span class="kw">else </span>{
<a href=#565 id=565 data-nosnippet>565</a> <span class="prelude-val">Some</span>(ReadableSize::mb(<span class="number">64</span>).as_bytes() <span class="kw">as </span>usize)
<a href=#566 id=566 data-nosnippet>566</a> }
<a href=#567 id=567 data-nosnippet>567</a> }
<a href=#568 id=568 data-nosnippet>568</a> MemoryThreshold::Unlimited =&gt; <span class="prelude-val">None</span>,
<a href=#569 id=569 data-nosnippet>569</a> MemoryThreshold::Size(size) =&gt; <span class="prelude-val">Some</span>(size.as_bytes() <span class="kw">as </span>usize),
<a href=#570 id=570 data-nosnippet>570</a> }
<a href=#571 id=571 data-nosnippet>571</a> }
<a href=#572 id=572 data-nosnippet>572</a>}
<a href=#573 id=573 data-nosnippet>573</a>
<a href=#574 id=574 data-nosnippet>574</a><span class="doccomment">/// Configuration options for the full-text index.
<a href=#575 id=575 data-nosnippet>575</a></span><span class="attr">#[serde_as]
<a href=#576 id=576 data-nosnippet>576</a>#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
<a href=#577 id=577 data-nosnippet>577</a>#[serde(default)]
<a href=#578 id=578 data-nosnippet>578</a></span><span class="kw">pub struct </span>FulltextIndexConfig {
<a href=#579 id=579 data-nosnippet>579</a> <span class="doccomment">/// Whether to create the index on flush: automatically or never.
<a href=#580 id=580 data-nosnippet>580</a> </span><span class="kw">pub </span>create_on_flush: Mode,
<a href=#581 id=581 data-nosnippet>581</a> <span class="doccomment">/// Whether to create the index on compaction: automatically or never.
<a href=#582 id=582 data-nosnippet>582</a> </span><span class="kw">pub </span>create_on_compaction: Mode,
<a href=#583 id=583 data-nosnippet>583</a> <span class="doccomment">/// Whether to apply the index on query: automatically or never.
<a href=#584 id=584 data-nosnippet>584</a> </span><span class="kw">pub </span>apply_on_query: Mode,
<a href=#585 id=585 data-nosnippet>585</a> <span class="doccomment">/// Memory threshold for creating the index.
<a href=#586 id=586 data-nosnippet>586</a> </span><span class="kw">pub </span>mem_threshold_on_create: MemoryThreshold,
<a href=#587 id=587 data-nosnippet>587</a> <span class="doccomment">/// Whether to compress the index data.
<a href=#588 id=588 data-nosnippet>588</a> </span><span class="kw">pub </span>compress: bool,
<a href=#589 id=589 data-nosnippet>589</a>}
<a href=#590 id=590 data-nosnippet>590</a>
<a href=#591 id=591 data-nosnippet>591</a><span class="kw">impl </span>Default <span class="kw">for </span>FulltextIndexConfig {
<a href=#592 id=592 data-nosnippet>592</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#593 id=593 data-nosnippet>593</a> <span class="self">Self </span>{
<a href=#594 id=594 data-nosnippet>594</a> create_on_flush: Mode::Auto,
<a href=#595 id=595 data-nosnippet>595</a> create_on_compaction: Mode::Auto,
<a href=#596 id=596 data-nosnippet>596</a> apply_on_query: Mode::Auto,
<a href=#597 id=597 data-nosnippet>597</a> mem_threshold_on_create: MemoryThreshold::Auto,
<a href=#598 id=598 data-nosnippet>598</a> compress: <span class="bool-val">true</span>,
<a href=#599 id=599 data-nosnippet>599</a> }
<a href=#600 id=600 data-nosnippet>600</a> }
<a href=#601 id=601 data-nosnippet>601</a>}
<a href=#602 id=602 data-nosnippet>602</a>
<a href=#603 id=603 data-nosnippet>603</a><span class="kw">impl </span>FulltextIndexConfig {
<a href=#604 id=604 data-nosnippet>604</a> <span class="kw">pub fn </span>mem_threshold_on_create(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#605 id=605 data-nosnippet>605</a> <span class="kw">match </span><span class="self">self</span>.mem_threshold_on_create {
<a href=#606 id=606 data-nosnippet>606</a> MemoryThreshold::Auto =&gt; {
<a href=#607 id=607 data-nosnippet>607</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(sys_memory) = get_total_memory_readable() {
<a href=#608 id=608 data-nosnippet>608</a> (sys_memory / INDEX_CREATE_MEM_THRESHOLD_FACTOR).as_bytes() <span class="kw">as _
<a href=#609 id=609 data-nosnippet>609</a> </span>} <span class="kw">else </span>{
<a href=#610 id=610 data-nosnippet>610</a> ReadableSize::mb(<span class="number">64</span>).as_bytes() <span class="kw">as _
<a href=#611 id=611 data-nosnippet>611</a> </span>}
<a href=#612 id=612 data-nosnippet>612</a> }
<a href=#613 id=613 data-nosnippet>613</a> MemoryThreshold::Unlimited =&gt; usize::MAX,
<a href=#614 id=614 data-nosnippet>614</a> MemoryThreshold::Size(size) =&gt; size.as_bytes() <span class="kw">as _</span>,
<a href=#615 id=615 data-nosnippet>615</a> }
<a href=#616 id=616 data-nosnippet>616</a> }
<a href=#617 id=617 data-nosnippet>617</a>}
<a href=#618 id=618 data-nosnippet>618</a>
<a href=#619 id=619 data-nosnippet>619</a><span class="doccomment">/// Configuration options for the bloom filter.
<a href=#620 id=620 data-nosnippet>620</a></span><span class="attr">#[serde_as]
<a href=#621 id=621 data-nosnippet>621</a>#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
<a href=#622 id=622 data-nosnippet>622</a>#[serde(default)]
<a href=#623 id=623 data-nosnippet>623</a></span><span class="kw">pub struct </span>BloomFilterConfig {
<a href=#624 id=624 data-nosnippet>624</a> <span class="doccomment">/// Whether to create the index on flush: automatically or never.
<a href=#625 id=625 data-nosnippet>625</a> </span><span class="kw">pub </span>create_on_flush: Mode,
<a href=#626 id=626 data-nosnippet>626</a> <span class="doccomment">/// Whether to create the index on compaction: automatically or never.
<a href=#627 id=627 data-nosnippet>627</a> </span><span class="kw">pub </span>create_on_compaction: Mode,
<a href=#628 id=628 data-nosnippet>628</a> <span class="doccomment">/// Whether to apply the index on query: automatically or never.
<a href=#629 id=629 data-nosnippet>629</a> </span><span class="kw">pub </span>apply_on_query: Mode,
<a href=#630 id=630 data-nosnippet>630</a> <span class="doccomment">/// Memory threshold for creating the index.
<a href=#631 id=631 data-nosnippet>631</a> </span><span class="kw">pub </span>mem_threshold_on_create: MemoryThreshold,
<a href=#632 id=632 data-nosnippet>632</a>}
<a href=#633 id=633 data-nosnippet>633</a>
<a href=#634 id=634 data-nosnippet>634</a><span class="kw">impl </span>Default <span class="kw">for </span>BloomFilterConfig {
<a href=#635 id=635 data-nosnippet>635</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#636 id=636 data-nosnippet>636</a> <span class="self">Self </span>{
<a href=#637 id=637 data-nosnippet>637</a> create_on_flush: Mode::Auto,
<a href=#638 id=638 data-nosnippet>638</a> create_on_compaction: Mode::Auto,
<a href=#639 id=639 data-nosnippet>639</a> apply_on_query: Mode::Auto,
<a href=#640 id=640 data-nosnippet>640</a> mem_threshold_on_create: MemoryThreshold::Auto,
<a href=#641 id=641 data-nosnippet>641</a> }
<a href=#642 id=642 data-nosnippet>642</a> }
<a href=#643 id=643 data-nosnippet>643</a>}
<a href=#644 id=644 data-nosnippet>644</a>
<a href=#645 id=645 data-nosnippet>645</a><span class="kw">impl </span>BloomFilterConfig {
<a href=#646 id=646 data-nosnippet>646</a> <span class="kw">pub fn </span>mem_threshold_on_create(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
<a href=#647 id=647 data-nosnippet>647</a> <span class="kw">match </span><span class="self">self</span>.mem_threshold_on_create {
<a href=#648 id=648 data-nosnippet>648</a> MemoryThreshold::Auto =&gt; {
<a href=#649 id=649 data-nosnippet>649</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(sys_memory) = get_total_memory_readable() {
<a href=#650 id=650 data-nosnippet>650</a> <span class="prelude-val">Some</span>((sys_memory / INDEX_CREATE_MEM_THRESHOLD_FACTOR).as_bytes() <span class="kw">as </span>usize)
<a href=#651 id=651 data-nosnippet>651</a> } <span class="kw">else </span>{
<a href=#652 id=652 data-nosnippet>652</a> <span class="prelude-val">Some</span>(ReadableSize::mb(<span class="number">64</span>).as_bytes() <span class="kw">as </span>usize)
<a href=#653 id=653 data-nosnippet>653</a> }
<a href=#654 id=654 data-nosnippet>654</a> }
<a href=#655 id=655 data-nosnippet>655</a> MemoryThreshold::Unlimited =&gt; <span class="prelude-val">None</span>,
<a href=#656 id=656 data-nosnippet>656</a> MemoryThreshold::Size(size) =&gt; <span class="prelude-val">Some</span>(size.as_bytes() <span class="kw">as </span>usize),
<a href=#657 id=657 data-nosnippet>657</a> }
<a href=#658 id=658 data-nosnippet>658</a> }
<a href=#659 id=659 data-nosnippet>659</a>}
<a href=#660 id=660 data-nosnippet>660</a>
<a href=#661 id=661 data-nosnippet>661</a><span class="doccomment">/// Configuration options for the vector index (HNSW).
<a href=#662 id=662 data-nosnippet>662</a></span><span class="attr">#[cfg(feature = <span class="string">"vector_index"</span>)]
<a href=#663 id=663 data-nosnippet>663</a>#[serde_as]
<a href=#664 id=664 data-nosnippet>664</a>#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
<a href=#665 id=665 data-nosnippet>665</a>#[serde(default)]
<a href=#666 id=666 data-nosnippet>666</a></span><span class="kw">pub struct </span>VectorIndexConfig {
<a href=#667 id=667 data-nosnippet>667</a> <span class="doccomment">/// Whether to create the index on flush: automatically or never.
<a href=#668 id=668 data-nosnippet>668</a> </span><span class="kw">pub </span>create_on_flush: Mode,
<a href=#669 id=669 data-nosnippet>669</a> <span class="doccomment">/// Whether to create the index on compaction: automatically or never.
<a href=#670 id=670 data-nosnippet>670</a> </span><span class="kw">pub </span>create_on_compaction: Mode,
<a href=#671 id=671 data-nosnippet>671</a> <span class="doccomment">/// Whether to apply the index on query: automatically or never.
<a href=#672 id=672 data-nosnippet>672</a> </span><span class="kw">pub </span>apply_on_query: Mode,
<a href=#673 id=673 data-nosnippet>673</a> <span class="doccomment">/// Memory threshold for creating the index.
<a href=#674 id=674 data-nosnippet>674</a> </span><span class="kw">pub </span>mem_threshold_on_create: MemoryThreshold,
<a href=#675 id=675 data-nosnippet>675</a>}
<a href=#676 id=676 data-nosnippet>676</a>
<a href=#677 id=677 data-nosnippet>677</a><span class="attr">#[cfg(feature = <span class="string">"vector_index"</span>)]
<a href=#678 id=678 data-nosnippet>678</a></span><span class="kw">impl </span>Default <span class="kw">for </span>VectorIndexConfig {
<a href=#679 id=679 data-nosnippet>679</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#680 id=680 data-nosnippet>680</a> <span class="self">Self </span>{
<a href=#681 id=681 data-nosnippet>681</a> create_on_flush: Mode::Auto,
<a href=#682 id=682 data-nosnippet>682</a> create_on_compaction: Mode::Auto,
<a href=#683 id=683 data-nosnippet>683</a> apply_on_query: Mode::Auto,
<a href=#684 id=684 data-nosnippet>684</a> mem_threshold_on_create: MemoryThreshold::Auto,
<a href=#685 id=685 data-nosnippet>685</a> }
<a href=#686 id=686 data-nosnippet>686</a> }
<a href=#687 id=687 data-nosnippet>687</a>}
<a href=#688 id=688 data-nosnippet>688</a>
<a href=#689 id=689 data-nosnippet>689</a><span class="attr">#[cfg(feature = <span class="string">"vector_index"</span>)]
<a href=#690 id=690 data-nosnippet>690</a></span><span class="kw">impl </span>VectorIndexConfig {
<a href=#691 id=691 data-nosnippet>691</a> <span class="kw">pub fn </span>mem_threshold_on_create(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
<a href=#692 id=692 data-nosnippet>692</a> <span class="kw">match </span><span class="self">self</span>.mem_threshold_on_create {
<a href=#693 id=693 data-nosnippet>693</a> MemoryThreshold::Auto =&gt; {
<a href=#694 id=694 data-nosnippet>694</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(sys_memory) = get_total_memory_readable() {
<a href=#695 id=695 data-nosnippet>695</a> <span class="prelude-val">Some</span>((sys_memory / INDEX_CREATE_MEM_THRESHOLD_FACTOR).as_bytes() <span class="kw">as </span>usize)
<a href=#696 id=696 data-nosnippet>696</a> } <span class="kw">else </span>{
<a href=#697 id=697 data-nosnippet>697</a> <span class="prelude-val">Some</span>(ReadableSize::mb(<span class="number">64</span>).as_bytes() <span class="kw">as </span>usize)
<a href=#698 id=698 data-nosnippet>698</a> }
<a href=#699 id=699 data-nosnippet>699</a> }
<a href=#700 id=700 data-nosnippet>700</a> MemoryThreshold::Unlimited =&gt; <span class="prelude-val">None</span>,
<a href=#701 id=701 data-nosnippet>701</a> MemoryThreshold::Size(size) =&gt; <span class="prelude-val">Some</span>(size.as_bytes() <span class="kw">as </span>usize),
<a href=#702 id=702 data-nosnippet>702</a> }
<a href=#703 id=703 data-nosnippet>703</a> }
<a href=#704 id=704 data-nosnippet>704</a>}
<a href=#705 id=705 data-nosnippet>705</a>
<a href=#706 id=706 data-nosnippet>706</a><span class="doccomment">/// Divide cpu num by a non-zero `divisor` and returns at least 1.
<a href=#707 id=707 data-nosnippet>707</a></span><span class="kw">fn </span>divide_num_cpus(divisor: usize) -&gt; usize {
<a href=#708 id=708 data-nosnippet>708</a> <span class="macro">debug_assert!</span>(divisor &gt; <span class="number">0</span>);
<a href=#709 id=709 data-nosnippet>709</a> <span class="kw">let </span>cores = get_total_cpu_cores();
<a href=#710 id=710 data-nosnippet>710</a> <span class="macro">debug_assert!</span>(cores &gt; <span class="number">0</span>);
<a href=#711 id=711 data-nosnippet>711</a>
<a href=#712 id=712 data-nosnippet>712</a> cores.div_ceil(divisor)
<a href=#713 id=713 data-nosnippet>713</a>}
<a href=#714 id=714 data-nosnippet>714</a>
<a href=#715 id=715 data-nosnippet>715</a><span class="attr">#[cfg(test)]
<a href=#716 id=716 data-nosnippet>716</a></span><span class="kw">mod </span>tests {
<a href=#717 id=717 data-nosnippet>717</a> <span class="kw">use </span>super::<span class="kw-2">*</span>;
<a href=#718 id=718 data-nosnippet>718</a>
<a href=#719 id=719 data-nosnippet>719</a> <span class="attr">#[test]
<a href=#720 id=720 data-nosnippet>720</a> </span><span class="kw">fn </span>test_deserialize_config() {
<a href=#721 id=721 data-nosnippet>721</a> <span class="kw">let </span>s = <span class="string">r#"
<a href=#722 id=722 data-nosnippet>722</a>[memtable]
<a href=#723 id=723 data-nosnippet>723</a>type = "partition_tree"
<a href=#724 id=724 data-nosnippet>724</a>index_max_keys_per_shard = 8192
<a href=#725 id=725 data-nosnippet>725</a>data_freeze_threshold = 1024
<a href=#726 id=726 data-nosnippet>726</a>dedup = true
<a href=#727 id=727 data-nosnippet>727</a>fork_dictionary_bytes = "512MiB"
<a href=#728 id=728 data-nosnippet>728</a>"#</span>;
<a href=#729 id=729 data-nosnippet>729</a> <span class="kw">let </span>config: MitoConfig = toml::from_str(s).unwrap();
<a href=#730 id=730 data-nosnippet>730</a> <span class="kw">let </span>MemtableConfig::PartitionTree(config) = <span class="kw-2">&amp;</span>config.memtable <span class="kw">else </span>{
<a href=#731 id=731 data-nosnippet>731</a> <span class="macro">unreachable!</span>()
<a href=#732 id=732 data-nosnippet>732</a> };
<a href=#733 id=733 data-nosnippet>733</a> <span class="macro">assert_eq!</span>(<span class="number">1024</span>, config.data_freeze_threshold);
<a href=#734 id=734 data-nosnippet>734</a> }
<a href=#735 id=735 data-nosnippet>735</a>}
</code></pre></div></section></main></body></html>
Reference in New Issue View Git Blame Copy Permalink