Files
greptimedb/src/catalog/table_source/dummy_catalog.rs.html
T

165 lines
18 KiB
HTML

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/catalog/src/table_source/dummy_catalog.rs`."><title>dummy_catalog.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="catalog" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.1 (31fca3adb 2026-06-26)" data-channel="1.96.1" data-search-js="search-b5634cc7.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">catalog/table_source/</div>dummy_catalog.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">//! Dummy catalog for region server.
<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::fmt;
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>std::sync::Arc;
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>async_trait::async_trait;
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>common_catalog::format_full_table_name;
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>datafusion::catalog::{CatalogProvider, CatalogProviderList, SchemaProvider};
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>datafusion::datasource::TableProvider;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span>session::context::QueryContextRef;
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span>snafu::OptionExt;
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span>table::table::adapter::DfTableProviderAdapter;
<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>::CatalogManagerRef;
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">use </span><span class="kw">crate</span>::error::TableNotExistSnafu;
<a href=#30 id=30 data-nosnippet>30</a>
<a href=#31 id=31 data-nosnippet>31</a><span class="doccomment">/// Delegate the resolving requests to the `[CatalogManager]` unconditionally.
<a href=#32 id=32 data-nosnippet>32</a></span><span class="attr">#[derive(Clone)]
<a href=#33 id=33 data-nosnippet>33</a></span><span class="kw">pub struct </span>DummyCatalogList {
<a href=#34 id=34 data-nosnippet>34</a> catalog_manager: CatalogManagerRef,
<a href=#35 id=35 data-nosnippet>35</a> query_ctx: <span class="prelude-ty">Option</span>&lt;QueryContextRef&gt;,
<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><span class="kw">impl </span>DummyCatalogList {
<a href=#39 id=39 data-nosnippet>39</a> <span class="doccomment">/// Creates a new catalog list with the given catalog manager (no query context).
<a href=#40 id=40 data-nosnippet>40</a> </span><span class="kw">pub fn </span>new(catalog_manager: CatalogManagerRef) -&gt; <span class="self">Self </span>{
<a href=#41 id=41 data-nosnippet>41</a> <span class="self">Self </span>{
<a href=#42 id=42 data-nosnippet>42</a> catalog_manager,
<a href=#43 id=43 data-nosnippet>43</a> query_ctx: <span class="prelude-val">None</span>,
<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>
<a href=#47 id=47 data-nosnippet>47</a> <span class="doccomment">/// Creates a new catalog list with the given catalog manager and query context.
<a href=#48 id=48 data-nosnippet>48</a> </span><span class="kw">pub fn </span>new_with_query_ctx(
<a href=#49 id=49 data-nosnippet>49</a> catalog_manager: CatalogManagerRef,
<a href=#50 id=50 data-nosnippet>50</a> query_ctx: QueryContextRef,
<a href=#51 id=51 data-nosnippet>51</a> ) -&gt; <span class="self">Self </span>{
<a href=#52 id=52 data-nosnippet>52</a> <span class="self">Self </span>{
<a href=#53 id=53 data-nosnippet>53</a> catalog_manager,
<a href=#54 id=54 data-nosnippet>54</a> query_ctx: <span class="prelude-val">Some</span>(query_ctx),
<a href=#55 id=55 data-nosnippet>55</a> }
<a href=#56 id=56 data-nosnippet>56</a> }
<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><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>DummyCatalogList {
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#61 id=61 data-nosnippet>61</a> f.debug_struct(<span class="string">"DummyCatalogList"</span>).finish()
<a href=#62 id=62 data-nosnippet>62</a> }
<a href=#63 id=63 data-nosnippet>63</a>}
<a href=#64 id=64 data-nosnippet>64</a>
<a href=#65 id=65 data-nosnippet>65</a><span class="kw">impl </span>CatalogProviderList <span class="kw">for </span>DummyCatalogList {
<a href=#66 id=66 data-nosnippet>66</a> <span class="kw">fn </span>register_catalog(
<a href=#67 id=67 data-nosnippet>67</a> <span class="kw-2">&amp;</span><span class="self">self</span>,
<a href=#68 id=68 data-nosnippet>68</a> _name: String,
<a href=#69 id=69 data-nosnippet>69</a> _catalog: Arc&lt;<span class="kw">dyn </span>CatalogProvider&gt;,
<a href=#70 id=70 data-nosnippet>70</a> ) -&gt; <span class="prelude-ty">Option</span>&lt;Arc&lt;<span class="kw">dyn </span>CatalogProvider&gt;&gt; {
<a href=#71 id=71 data-nosnippet>71</a> <span class="prelude-val">None
<a href=#72 id=72 data-nosnippet>72</a> </span>}
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">fn </span>catalog_names(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Vec&lt;String&gt; {
<a href=#75 id=75 data-nosnippet>75</a> <span class="macro">vec!</span>[]
<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="kw">fn </span>catalog(<span class="kw-2">&amp;</span><span class="self">self</span>, catalog_name: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;Arc&lt;<span class="kw">dyn </span>CatalogProvider&gt;&gt; {
<a href=#79 id=79 data-nosnippet>79</a> <span class="prelude-val">Some</span>(Arc::new(DummyCatalogProvider {
<a href=#80 id=80 data-nosnippet>80</a> catalog_name: catalog_name.to_string(),
<a href=#81 id=81 data-nosnippet>81</a> catalog_manager: <span class="self">self</span>.catalog_manager.clone(),
<a href=#82 id=82 data-nosnippet>82</a> query_ctx: <span class="self">self</span>.query_ctx.clone(),
<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>
<a href=#87 id=87 data-nosnippet>87</a><span class="doccomment">/// A dummy catalog provider for [DummyCatalogList].
<a href=#88 id=88 data-nosnippet>88</a></span><span class="attr">#[derive(Clone)]
<a href=#89 id=89 data-nosnippet>89</a></span><span class="kw">struct </span>DummyCatalogProvider {
<a href=#90 id=90 data-nosnippet>90</a> catalog_name: String,
<a href=#91 id=91 data-nosnippet>91</a> catalog_manager: CatalogManagerRef,
<a href=#92 id=92 data-nosnippet>92</a> query_ctx: <span class="prelude-ty">Option</span>&lt;QueryContextRef&gt;,
<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><span class="kw">impl </span>CatalogProvider <span class="kw">for </span>DummyCatalogProvider {
<a href=#96 id=96 data-nosnippet>96</a> <span class="kw">fn </span>schema_names(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Vec&lt;String&gt; {
<a href=#97 id=97 data-nosnippet>97</a> <span class="macro">vec!</span>[]
<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>schema(<span class="kw-2">&amp;</span><span class="self">self</span>, schema_name: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;Arc&lt;<span class="kw">dyn </span>SchemaProvider&gt;&gt; {
<a href=#101 id=101 data-nosnippet>101</a> <span class="prelude-val">Some</span>(Arc::new(DummySchemaProvider {
<a href=#102 id=102 data-nosnippet>102</a> catalog_name: <span class="self">self</span>.catalog_name.clone(),
<a href=#103 id=103 data-nosnippet>103</a> schema_name: schema_name.to_string(),
<a href=#104 id=104 data-nosnippet>104</a> catalog_manager: <span class="self">self</span>.catalog_manager.clone(),
<a href=#105 id=105 data-nosnippet>105</a> query_ctx: <span class="self">self</span>.query_ctx.clone(),
<a href=#106 id=106 data-nosnippet>106</a> }))
<a href=#107 id=107 data-nosnippet>107</a> }
<a href=#108 id=108 data-nosnippet>108</a>}
<a href=#109 id=109 data-nosnippet>109</a>
<a href=#110 id=110 data-nosnippet>110</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>DummyCatalogProvider {
<a href=#111 id=111 data-nosnippet>111</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#112 id=112 data-nosnippet>112</a> f.debug_struct(<span class="string">"DummyCatalogProvider"</span>)
<a href=#113 id=113 data-nosnippet>113</a> .field(<span class="string">"catalog_name"</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.catalog_name)
<a href=#114 id=114 data-nosnippet>114</a> .finish()
<a href=#115 id=115 data-nosnippet>115</a> }
<a href=#116 id=116 data-nosnippet>116</a>}
<a href=#117 id=117 data-nosnippet>117</a>
<a href=#118 id=118 data-nosnippet>118</a><span class="doccomment">/// A dummy schema provider for [DummyCatalogList].
<a href=#119 id=119 data-nosnippet>119</a></span><span class="attr">#[derive(Clone)]
<a href=#120 id=120 data-nosnippet>120</a></span><span class="kw">struct </span>DummySchemaProvider {
<a href=#121 id=121 data-nosnippet>121</a> catalog_name: String,
<a href=#122 id=122 data-nosnippet>122</a> schema_name: String,
<a href=#123 id=123 data-nosnippet>123</a> catalog_manager: CatalogManagerRef,
<a href=#124 id=124 data-nosnippet>124</a> query_ctx: <span class="prelude-ty">Option</span>&lt;QueryContextRef&gt;,
<a href=#125 id=125 data-nosnippet>125</a>}
<a href=#126 id=126 data-nosnippet>126</a>
<a href=#127 id=127 data-nosnippet>127</a><span class="attr">#[async_trait]
<a href=#128 id=128 data-nosnippet>128</a></span><span class="kw">impl </span>SchemaProvider <span class="kw">for </span>DummySchemaProvider {
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw">fn </span>table_names(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Vec&lt;String&gt; {
<a href=#130 id=130 data-nosnippet>130</a> <span class="macro">vec!</span>[]
<a href=#131 id=131 data-nosnippet>131</a> }
<a href=#132 id=132 data-nosnippet>132</a>
<a href=#133 id=133 data-nosnippet>133</a> <span class="kw">async fn </span>table(<span class="kw-2">&amp;</span><span class="self">self</span>, name: <span class="kw-2">&amp;</span>str) -&gt; datafusion::error::Result&lt;<span class="prelude-ty">Option</span>&lt;Arc&lt;<span class="kw">dyn </span>TableProvider&gt;&gt;&gt; {
<a href=#134 id=134 data-nosnippet>134</a> <span class="kw">let </span>table = <span class="self">self
<a href=#135 id=135 data-nosnippet>135</a> </span>.catalog_manager
<a href=#136 id=136 data-nosnippet>136</a> .table(
<a href=#137 id=137 data-nosnippet>137</a> <span class="kw-2">&amp;</span><span class="self">self</span>.catalog_name,
<a href=#138 id=138 data-nosnippet>138</a> <span class="kw-2">&amp;</span><span class="self">self</span>.schema_name,
<a href=#139 id=139 data-nosnippet>139</a> name,
<a href=#140 id=140 data-nosnippet>140</a> <span class="self">self</span>.query_ctx.as_deref(),
<a href=#141 id=141 data-nosnippet>141</a> )
<a href=#142 id=142 data-nosnippet>142</a> .<span class="kw">await</span><span class="question-mark">?
<a href=#143 id=143 data-nosnippet>143</a> </span>.with_context(|| TableNotExistSnafu {
<a href=#144 id=144 data-nosnippet>144</a> table: format_full_table_name(<span class="kw-2">&amp;</span><span class="self">self</span>.catalog_name, <span class="kw-2">&amp;</span><span class="self">self</span>.schema_name, name),
<a href=#145 id=145 data-nosnippet>145</a> })<span class="question-mark">?</span>;
<a href=#146 id=146 data-nosnippet>146</a>
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">let </span>table_provider: Arc&lt;<span class="kw">dyn </span>TableProvider&gt; = Arc::new(DfTableProviderAdapter::new(table));
<a href=#148 id=148 data-nosnippet>148</a>
<a href=#149 id=149 data-nosnippet>149</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(table_provider))
<a href=#150 id=150 data-nosnippet>150</a> }
<a href=#151 id=151 data-nosnippet>151</a>
<a href=#152 id=152 data-nosnippet>152</a> <span class="kw">fn </span>table_exist(<span class="kw-2">&amp;</span><span class="self">self</span>, _name: <span class="kw-2">&amp;</span>str) -&gt; bool {
<a href=#153 id=153 data-nosnippet>153</a> <span class="bool-val">true
<a href=#154 id=154 data-nosnippet>154</a> </span>}
<a href=#155 id=155 data-nosnippet>155</a>}
<a href=#156 id=156 data-nosnippet>156</a>
<a href=#157 id=157 data-nosnippet>157</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>DummySchemaProvider {
<a href=#158 id=158 data-nosnippet>158</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#159 id=159 data-nosnippet>159</a> f.debug_struct(<span class="string">"DummySchemaProvider"</span>)
<a href=#160 id=160 data-nosnippet>160</a> .field(<span class="string">"catalog_name"</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.catalog_name)
<a href=#161 id=161 data-nosnippet>161</a> .field(<span class="string">"schema_name"</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.schema_name)
<a href=#162 id=162 data-nosnippet>162</a> .finish()
<a href=#163 id=163 data-nosnippet>163</a> }
<a href=#164 id=164 data-nosnippet>164</a>}
</code></pre></div></section></main></body></html>