greptimedb/src/object_store/manager.rs.html

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/object-store/src/manager.rs`."><title>manager.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="object_store" 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">object_store/</div>manager.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><span class="kw">use </span>std::sync::Arc;
<a href=#17 id=17 data-nosnippet>17</a>
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span><span class="kw">crate</span>::ObjectStore;
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">pub type </span>ObjectStoreManagerRef = Arc&lt;ObjectStoreManager&gt;;
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a><span class="doccomment">/// Manages multiple object stores so that users can configure a storage for each table.
<a href=#23 id=23 data-nosnippet>23</a>/// This struct certainly have one default object store, and can have zero or more custom object stores.
<a href=#24 id=24 data-nosnippet>24</a></span><span class="attr">#[derive(Debug)]
<a href=#25 id=25 data-nosnippet>25</a></span><span class="kw">pub struct </span>ObjectStoreManager {
<a href=#26 id=26 data-nosnippet>26</a>    stores: HashMap&lt;String, ObjectStore&gt;,
<a href=#27 id=27 data-nosnippet>27</a>    default_object_store: ObjectStore,
<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="kw">impl </span>ObjectStoreManager {
<a href=#31 id=31 data-nosnippet>31</a>    <span class="doccomment">/// Creates a new manager from the object store used as a default one.
<a href=#32 id=32 data-nosnippet>32</a>    </span><span class="kw">pub fn </span>new(name: <span class="kw-2">&amp;</span>str, object_store: ObjectStore) -&gt; <span class="self">Self </span>{
<a href=#33 id=33 data-nosnippet>33</a>        ObjectStoreManager {
<a href=#34 id=34 data-nosnippet>34</a>            stores: [(name.to_lowercase(), object_store.clone())].into(),
<a href=#35 id=35 data-nosnippet>35</a>            default_object_store: object_store,
<a href=#36 id=36 data-nosnippet>36</a>        }
<a href=#37 id=37 data-nosnippet>37</a>    }
<a href=#38 id=38 data-nosnippet>38</a>
<a href=#39 id=39 data-nosnippet>39</a>    <span class="doccomment">/// Adds an object store to the manager.
<a href=#40 id=40 data-nosnippet>40</a>    /// # Safety
<a href=#41 id=41 data-nosnippet>41</a>    ///      Panic when the name already exists
<a href=#42 id=42 data-nosnippet>42</a>    </span><span class="kw">pub fn </span>add(<span class="kw-2">&amp;mut </span><span class="self">self</span>, name: <span class="kw-2">&amp;</span>str, object_store: ObjectStore) {
<a href=#43 id=43 data-nosnippet>43</a>        <span class="kw">let </span>name = name.to_lowercase();
<a href=#44 id=44 data-nosnippet>44</a>        <span class="kw">if </span><span class="self">self</span>.stores.insert(name.clone(), object_store).is_some() {
<a href=#45 id=45 data-nosnippet>45</a>            <span class="macro">panic!</span>(<span class="string">"Object storage provider name conflicts, the `{name}` already exists"</span>);
<a href=#46 id=46 data-nosnippet>46</a>        }
<a href=#47 id=47 data-nosnippet>47</a>    }
<a href=#48 id=48 data-nosnippet>48</a>
<a href=#49 id=49 data-nosnippet>49</a>    <span class="doccomment">/// Finds an object store corresponding to the name.
<a href=#50 id=50 data-nosnippet>50</a>    </span><span class="kw">pub fn </span>find(<span class="kw-2">&amp;</span><span class="self">self</span>, name: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>ObjectStore&gt; {
<a href=#51 id=51 data-nosnippet>51</a>        <span class="self">self</span>.stores.get(<span class="kw-2">&amp;</span>name.to_lowercase())
<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">/// Returns the default object storage
<a href=#55 id=55 data-nosnippet>55</a>    </span><span class="kw">pub fn </span>default_object_store(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>ObjectStore {
<a href=#56 id=56 data-nosnippet>56</a>        <span class="kw-2">&amp;</span><span class="self">self</span>.default_object_store
<a href=#57 id=57 data-nosnippet>57</a>    }
<a href=#58 id=58 data-nosnippet>58</a>}
<a href=#59 id=59 data-nosnippet>59</a>
<a href=#60 id=60 data-nosnippet>60</a><span class="attr">#[cfg(test)]
<a href=#61 id=61 data-nosnippet>61</a></span><span class="kw">mod </span>tests {
<a href=#62 id=62 data-nosnippet>62</a>    <span class="kw">use </span>common_test_util::temp_dir::{TempDir, create_temp_dir};
<a href=#63 id=63 data-nosnippet>63</a>
<a href=#64 id=64 data-nosnippet>64</a>    <span class="kw">use </span><span class="kw">super</span>::ObjectStoreManager;
<a href=#65 id=65 data-nosnippet>65</a>    <span class="kw">use </span><span class="kw">crate</span>::ObjectStore;
<a href=#66 id=66 data-nosnippet>66</a>    <span class="kw">use </span><span class="kw">crate</span>::services::Fs <span class="kw">as </span>Builder;
<a href=#67 id=67 data-nosnippet>67</a>
<a href=#68 id=68 data-nosnippet>68</a>    <span class="kw">fn </span>new_object_store(dir: <span class="kw-2">&amp;</span>TempDir) -&gt; ObjectStore {
<a href=#69 id=69 data-nosnippet>69</a>        <span class="kw">let </span>store_dir = dir.path().to_str().unwrap();
<a href=#70 id=70 data-nosnippet>70</a>        <span class="kw">let </span>builder = Builder::default().root(store_dir);
<a href=#71 id=71 data-nosnippet>71</a>        ObjectStore::new(builder).unwrap().finish()
<a href=#72 id=72 data-nosnippet>72</a>    }
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a>    <span class="attr">#[test]
<a href=#75 id=75 data-nosnippet>75</a>    </span><span class="kw">fn </span>test_manager_behavior() {
<a href=#76 id=76 data-nosnippet>76</a>        <span class="kw">let </span>dir = create_temp_dir(<span class="string">"default"</span>);
<a href=#77 id=77 data-nosnippet>77</a>        <span class="kw">let </span><span class="kw-2">mut </span>manager = ObjectStoreManager::new(<span class="string">"Default"</span>, new_object_store(<span class="kw-2">&amp;</span>dir));
<a href=#78 id=78 data-nosnippet>78</a>
<a href=#79 id=79 data-nosnippet>79</a>        <span class="macro">assert!</span>(manager.find(<span class="string">"default"</span>).is_some());
<a href=#80 id=80 data-nosnippet>80</a>        <span class="macro">assert!</span>(manager.find(<span class="string">"Default"</span>).is_some());
<a href=#81 id=81 data-nosnippet>81</a>        <span class="macro">assert!</span>(manager.find(<span class="string">"Gcs"</span>).is_none());
<a href=#82 id=82 data-nosnippet>82</a>        <span class="macro">assert!</span>(manager.find(<span class="string">"gcs"</span>).is_none());
<a href=#83 id=83 data-nosnippet>83</a>
<a href=#84 id=84 data-nosnippet>84</a>        <span class="kw">let </span>dir = create_temp_dir(<span class="string">"default"</span>);
<a href=#85 id=85 data-nosnippet>85</a>        manager.add(<span class="string">"Gcs"</span>, new_object_store(<span class="kw-2">&amp;</span>dir));
<a href=#86 id=86 data-nosnippet>86</a>
<a href=#87 id=87 data-nosnippet>87</a>        <span class="comment">// Should not overwrite the default object store with the new one.
<a href=#88 id=88 data-nosnippet>88</a>        </span><span class="macro">assert!</span>(manager.find(<span class="string">"default"</span>).is_some());
<a href=#89 id=89 data-nosnippet>89</a>        <span class="macro">assert!</span>(manager.find(<span class="string">"Gcs"</span>).is_some());
<a href=#90 id=90 data-nosnippet>90</a>        <span class="macro">assert!</span>(manager.find(<span class="string">"gcs"</span>).is_some());
<a href=#91 id=91 data-nosnippet>91</a>    }
<a href=#92 id=92 data-nosnippet>92</a>}
</code></pre></div></section></main></body></html>