| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Paimon-cpp: /home/runner/work/paimon-cpp/paimon-cpp/include/paimon/catalog/catalog.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">Paimon-cpp |
| </div> |
| <div id="projectbrief">A high-performance C++ implementation of Apache Paimon</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d5ce83a91c1ada980bd794a9f3314520.html">paimon</a></li><li class="navelem"><a class="el" href="dir_c303d81fcec65aef767d65e2c1798f68.html">catalog</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">catalog.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="catalog_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * limitations under the License.</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include <chrono></span></div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <map></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <optional></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <variant></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "<a class="code" href="identifier_8h.html">paimon/catalog/identifier.h</a>"</span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">paimon/result.h</a>"</span></div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include "<a class="code" href="snapshot__info_8h.html">paimon/snapshot/snapshot_info.h</a>"</span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include "<a class="code" href="status_8h.html">paimon/status.h</a>"</span></div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include "<a class="code" href="type__fwd_8h.html">paimon/type_fwd.h</a>"</span></div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include "<a class="code" href="visibility_8h.html">paimon/visibility.h</a>"</span></div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">struct </span><a class="code hl_struct" href="struct_arrow_schema.html">ArrowSchema</a>;</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacepaimon.html">paimon</a> {</div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment">// Tag name or snapshot id</span></div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="namespacepaimon.html#a7272315c02a68083734c50f3e747abdf"> 40</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespacepaimon.html#a7272315c02a68083734c50f3e747abdf">Instant</a> = std::variant<std::string, int64_t>;</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keyword">class </span><a class="code hl_class" href="classpaimon_1_1_database.html">Database</a>;</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="keyword">class </span><a class="code hl_class" href="classpaimon_1_1_table.html">Table</a>;</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="keyword">class </span>View;</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="keyword">class </span><a class="code hl_class" href="classpaimon_1_1_schema.html">Schema</a>;</div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="keyword">class </span>Snapshot;</div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="keyword">class </span>PartitionStatistics;</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="keyword">class </span>Tag;</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="keyword">class </span><a class="code hl_class" href="classpaimon_1_1_identifier.html">Identifier</a>;</div> |
| <div class="foldopen" id="foldopen00052" data-start="{" data-end="};"> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html"> 52</a></span><span class="keyword">class </span>PAIMON_EXPORT <a class="code hl_class" href="classpaimon_1_1_catalog.html">Catalog</a> {</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a6761df59f92fa8d361d2224b4ab5a5b8"> 54</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> SYSTEM_DATABASE_NAME[];</div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#ac8e24315525d650976a73480afef08d2"> 55</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> SYSTEM_TABLE_SPLITTER[];</div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a88b6d8397691b01f256b288916786177"> 56</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> DB_SUFFIX[];</div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a35cd0cfd608112dcf536d5b561ec7d8c"> 57</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> DB_LOCATION_PROP[];</div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a40ca2ab99f62612d7cf5a252c3b07328"> 69</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::unique_ptr<Catalog></a>> <a class="code hl_function" href="classpaimon_1_1_catalog.html#a40ca2ab99f62612d7cf5a252c3b07328">Create</a>(</div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">const</span> std::string& root_path, <span class="keyword">const</span> std::map<std::string, std::string>& options,</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">const</span> std::shared_ptr<FileSystem>& file_system = <span class="keyword">nullptr</span>);</div> |
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a70b09552f71b95c6efc299074bd61c9b"> 73</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classpaimon_1_1_catalog.html#a70b09552f71b95c6efc299074bd61c9b">~Catalog</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div> |
| <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a84df9597c6b425ff192f01b66f060cb5"> 82</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_status.html">Status</a> <a class="code hl_function" href="classpaimon_1_1_catalog.html#a84df9597c6b425ff192f01b66f060cb5">CreateDatabase</a>(<span class="keyword">const</span> std::string& name,</div> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">const</span> std::map<std::string, std::string>& options,</div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">bool</span> ignore_if_exists) = 0;</div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div> |
| <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a3897ab46944bc30efb90182dbb68359e"> 98</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_status.html">Status</a> <a class="code hl_function" href="classpaimon_1_1_catalog.html#a3897ab46944bc30efb90182dbb68359e">CreateTable</a>(<span class="keyword">const</span> <a class="code hl_class" href="classpaimon_1_1_identifier.html">Identifier</a>& identifier, <a class="code hl_struct" href="struct_arrow_schema.html">ArrowSchema</a>* c_schema,</div> |
| <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">const</span> std::vector<std::string>& partition_keys,</div> |
| <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keyword">const</span> std::vector<std::string>& primary_keys,</div> |
| <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keyword">const</span> std::map<std::string, std::string>& options,</div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <span class="keywordtype">bool</span> ignore_if_exists) = 0;</div> |
| <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div> |
| <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#ad105a410f62dbbe891272d3c647b7976"> 107</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::vector<std::string></a>> <a class="code hl_function" href="classpaimon_1_1_catalog.html#ad105a410f62dbbe891272d3c647b7976">ListDatabases</a>() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div> |
| <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#ad0bb25fe3c39013b1f981079208e4c4c"> 116</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::vector<std::string></a>> <a class="code hl_function" href="classpaimon_1_1_catalog.html#ad0bb25fe3c39013b1f981079208e4c4c">ListTables</a>(<span class="keyword">const</span> std::string& db_name) <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div> |
| <div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a64d2540b73141b56cf3c0983d91ac4bc"> 125</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_status.html">Status</a> <a class="code hl_function" href="classpaimon_1_1_catalog.html#a64d2540b73141b56cf3c0983d91ac4bc">DropDatabase</a>(<span class="keyword">const</span> std::string& name, <span class="keywordtype">bool</span> ignore_if_not_exists,</div> |
| <div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> <span class="keywordtype">bool</span> cascade) = 0;</div> |
| <div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div> |
| <div class="line"><a id="l00133" name="l00133"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#aefa990be4e6085cd974d10058708ec69"> 133</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_status.html">Status</a> <a class="code hl_function" href="classpaimon_1_1_catalog.html#aefa990be4e6085cd974d10058708ec69">DropTable</a>(<span class="keyword">const</span> <a class="code hl_class" href="classpaimon_1_1_identifier.html">Identifier</a>& identifier, <span class="keywordtype">bool</span> ignore_if_not_exists) = 0;</div> |
| <div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> </div> |
| <div class="line"><a id="l00141" name="l00141"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a40a3e8efa5b2f93f869ad96057ba259c"> 141</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_status.html">Status</a> <a class="code hl_function" href="classpaimon_1_1_catalog.html#a40a3e8efa5b2f93f869ad96057ba259c">RenameTable</a>(<span class="keyword">const</span> <a class="code hl_class" href="classpaimon_1_1_identifier.html">Identifier</a>& from_table, <span class="keyword">const</span> <a class="code hl_class" href="classpaimon_1_1_identifier.html">Identifier</a>& to_table,</div> |
| <div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> <span class="keywordtype">bool</span> ignore_if_not_exists) = 0;</div> |
| <div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> </div> |
| <div class="line"><a id="l00148" name="l00148"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a9f7eca6e83e7dec670067c5ce6e40282"> 148</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::shared_ptr<Table></a>> <a class="code hl_function" href="classpaimon_1_1_catalog.html#a9f7eca6e83e7dec670067c5ce6e40282">GetTable</a>(<span class="keyword">const</span> <a class="code hl_class" href="classpaimon_1_1_identifier.html">Identifier</a>& identifier) <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> </div> |
| <div class="line"><a id="l00155" name="l00155"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#aaf2810f83b1d246cf43912bde9897778"> 155</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<bool></a> <a class="code hl_function" href="classpaimon_1_1_catalog.html#aaf2810f83b1d246cf43912bde9897778">DatabaseExists</a>(<span class="keyword">const</span> std::string& db_name) <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> </div> |
| <div class="line"><a id="l00161" name="l00161"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a932d3d0f433c56ffd60792d391894cfc"> 161</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<bool></a> <a class="code hl_function" href="classpaimon_1_1_catalog.html#a932d3d0f433c56ffd60792d391894cfc">TableExists</a>(<span class="keyword">const</span> <a class="code hl_class" href="classpaimon_1_1_identifier.html">Identifier</a>& identifier) <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> </div> |
| <div class="line"><a id="l00169" name="l00169"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#ad116620f15a45bb7a538b58b68e65c97"> 169</a></span> <span class="keyword">virtual</span> std::string <a class="code hl_function" href="classpaimon_1_1_catalog.html#ad116620f15a45bb7a538b58b68e65c97">GetDatabaseLocation</a>(<span class="keyword">const</span> std::string& db_name) <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> </div> |
| <div class="line"><a id="l00178" name="l00178"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a2000de7ddc9359bb7f7a35effeb6d74d"> 178</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::string></a> <a class="code hl_function" href="classpaimon_1_1_catalog.html#a2000de7ddc9359bb7f7a35effeb6d74d">GetTableLocation</a>(<span class="keyword">const</span> <a class="code hl_class" href="classpaimon_1_1_identifier.html">Identifier</a>& identifier) <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> </div> |
| <div class="line"><a id="l00183" name="l00183"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#abe34a5b283e9f1d7c1dd90e148df3378"> 183</a></span> <span class="keyword">virtual</span> std::string <a class="code hl_function" href="classpaimon_1_1_catalog.html#abe34a5b283e9f1d7c1dd90e148df3378">GetRootPath</a>() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> </div> |
| <div class="line"><a id="l00188" name="l00188"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a2e95dfc17f25b19a541f8453745161d0"> 188</a></span> <span class="keyword">virtual</span> std::shared_ptr<FileSystem> <a class="code hl_function" href="classpaimon_1_1_catalog.html#a2e95dfc17f25b19a541f8453745161d0">GetFileSystem</a>() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> </div> |
| <div class="line"><a id="l00193" name="l00193"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a04a859824bc890669ef980fbe0f8ee92"> 193</a></span> <span class="keyword">virtual</span> <span class="keyword">const</span> std::map<std::string, std::string>& <a class="code hl_function" href="classpaimon_1_1_catalog.html#a04a859824bc890669ef980fbe0f8ee92">GetOptions</a>() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> </div> |
| <div class="line"><a id="l00201" name="l00201"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a76e4d168264fe571fee9e39d356457e8"> 201</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::shared_ptr<Schema></a>> <a class="code hl_function" href="classpaimon_1_1_catalog.html#a76e4d168264fe571fee9e39d356457e8">LoadTableSchema</a>(<span class="keyword">const</span> <a class="code hl_class" href="classpaimon_1_1_identifier.html">Identifier</a>& identifier) <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> </div> |
| <div class="line"><a id="l00209" name="l00209"></a><span class="lineno"><a class="line" href="classpaimon_1_1_catalog.html#a44ba13c2315f71f5ca6f42648209150e"> 209</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::vector<SnapshotInfo></a>> <a class="code hl_function" href="classpaimon_1_1_catalog.html#a44ba13c2315f71f5ca6f42648209150e">ListSnapshots</a>(</div> |
| <div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> <span class="keyword">const</span> <a class="code hl_class" href="classpaimon_1_1_identifier.html">Identifier</a>& identifier, <span class="keyword">const</span> std::string& branch = <span class="stringliteral">""</span>) <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span>};</div> |
| </div> |
| <div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> </div> |
| <div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span>} <span class="comment">// namespace paimon</span></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html"><div class="ttname"><a href="classpaimon_1_1_catalog.html">paimon::Catalog</a></div><div class="ttdoc">This interface is responsible for reading and writing metadata such as database/table from a paimon c...</div><div class="ttdef"><b>Definition</b> catalog.h:52</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_a04a859824bc890669ef980fbe0f8ee92"><div class="ttname"><a href="classpaimon_1_1_catalog.html#a04a859824bc890669ef980fbe0f8ee92">paimon::Catalog::GetOptions</a></div><div class="ttdeci">virtual const std::map< std::string, std::string > & GetOptions() const =0</div><div class="ttdoc">Returns the catalog-level options that were passed during catalog creation.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_a2000de7ddc9359bb7f7a35effeb6d74d"><div class="ttname"><a href="classpaimon_1_1_catalog.html#a2000de7ddc9359bb7f7a35effeb6d74d">paimon::Catalog::GetTableLocation</a></div><div class="ttdeci">virtual Result< std::string > GetTableLocation(const Identifier &identifier) const =0</div><div class="ttdoc">Returns the expected location of a specified table.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_a2e95dfc17f25b19a541f8453745161d0"><div class="ttname"><a href="classpaimon_1_1_catalog.html#a2e95dfc17f25b19a541f8453745161d0">paimon::Catalog::GetFileSystem</a></div><div class="ttdeci">virtual std::shared_ptr< FileSystem > GetFileSystem() const =0</div><div class="ttdoc">Returns the file system used by the catalog.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_a3897ab46944bc30efb90182dbb68359e"><div class="ttname"><a href="classpaimon_1_1_catalog.html#a3897ab46944bc30efb90182dbb68359e">paimon::Catalog::CreateTable</a></div><div class="ttdeci">virtual Status CreateTable(const Identifier &identifier, ArrowSchema *c_schema, const std::vector< std::string > &partition_keys, const std::vector< std::string > &primary_keys, const std::map< std::string, std::string > &options, bool ignore_if_exists)=0</div><div class="ttdoc">Creates a new table in the catalog.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_a40a3e8efa5b2f93f869ad96057ba259c"><div class="ttname"><a href="classpaimon_1_1_catalog.html#a40a3e8efa5b2f93f869ad96057ba259c">paimon::Catalog::RenameTable</a></div><div class="ttdeci">virtual Status RenameTable(const Identifier &from_table, const Identifier &to_table, bool ignore_if_not_exists)=0</div><div class="ttdoc">Renames a table.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_a40ca2ab99f62612d7cf5a252c3b07328"><div class="ttname"><a href="classpaimon_1_1_catalog.html#a40ca2ab99f62612d7cf5a252c3b07328">paimon::Catalog::Create</a></div><div class="ttdeci">static Result< std::unique_ptr< Catalog > > Create(const std::string &root_path, const std::map< std::string, std::string > &options, const std::shared_ptr< FileSystem > &file_system=nullptr)</div><div class="ttdoc">Factory method for creating a Catalog instance.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_a44ba13c2315f71f5ca6f42648209150e"><div class="ttname"><a href="classpaimon_1_1_catalog.html#a44ba13c2315f71f5ca6f42648209150e">paimon::Catalog::ListSnapshots</a></div><div class="ttdeci">virtual Result< std::vector< SnapshotInfo > > ListSnapshots(const Identifier &identifier, const std::string &branch="") const =0</div><div class="ttdoc">Lists all snapshots of the specified table, ordered by snapshot id.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_a64d2540b73141b56cf3c0983d91ac4bc"><div class="ttname"><a href="classpaimon_1_1_catalog.html#a64d2540b73141b56cf3c0983d91ac4bc">paimon::Catalog::DropDatabase</a></div><div class="ttdeci">virtual Status DropDatabase(const std::string &name, bool ignore_if_not_exists, bool cascade)=0</div><div class="ttdoc">Drops a database.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_a70b09552f71b95c6efc299074bd61c9b"><div class="ttname"><a href="classpaimon_1_1_catalog.html#a70b09552f71b95c6efc299074bd61c9b">paimon::Catalog::~Catalog</a></div><div class="ttdeci">virtual ~Catalog()=default</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_a76e4d168264fe571fee9e39d356457e8"><div class="ttname"><a href="classpaimon_1_1_catalog.html#a76e4d168264fe571fee9e39d356457e8">paimon::Catalog::LoadTableSchema</a></div><div class="ttdeci">virtual Result< std::shared_ptr< Schema > > LoadTableSchema(const Identifier &identifier) const =0</div><div class="ttdoc">Loads the latest schema of a specified table.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_a84df9597c6b425ff192f01b66f060cb5"><div class="ttname"><a href="classpaimon_1_1_catalog.html#a84df9597c6b425ff192f01b66f060cb5">paimon::Catalog::CreateDatabase</a></div><div class="ttdeci">virtual Status CreateDatabase(const std::string &name, const std::map< std::string, std::string > &options, bool ignore_if_exists)=0</div><div class="ttdoc">Creates a database with the specified properties.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_a932d3d0f433c56ffd60792d391894cfc"><div class="ttname"><a href="classpaimon_1_1_catalog.html#a932d3d0f433c56ffd60792d391894cfc">paimon::Catalog::TableExists</a></div><div class="ttdeci">virtual Result< bool > TableExists(const Identifier &identifier) const =0</div><div class="ttdoc">Checks whether a table with the specified identifier exists in the catalog.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_a9f7eca6e83e7dec670067c5ce6e40282"><div class="ttname"><a href="classpaimon_1_1_catalog.html#a9f7eca6e83e7dec670067c5ce6e40282">paimon::Catalog::GetTable</a></div><div class="ttdeci">virtual Result< std::shared_ptr< Table > > GetTable(const Identifier &identifier) const =0</div><div class="ttdoc">Gets a table.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_aaf2810f83b1d246cf43912bde9897778"><div class="ttname"><a href="classpaimon_1_1_catalog.html#aaf2810f83b1d246cf43912bde9897778">paimon::Catalog::DatabaseExists</a></div><div class="ttdeci">virtual Result< bool > DatabaseExists(const std::string &db_name) const =0</div><div class="ttdoc">Checks whether a database with the specified name exists in the catalog.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_abe34a5b283e9f1d7c1dd90e148df3378"><div class="ttname"><a href="classpaimon_1_1_catalog.html#abe34a5b283e9f1d7c1dd90e148df3378">paimon::Catalog::GetRootPath</a></div><div class="ttdeci">virtual std::string GetRootPath() const =0</div><div class="ttdoc">Returns the root path of the catalog.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_ad0bb25fe3c39013b1f981079208e4c4c"><div class="ttname"><a href="classpaimon_1_1_catalog.html#ad0bb25fe3c39013b1f981079208e4c4c">paimon::Catalog::ListTables</a></div><div class="ttdeci">virtual Result< std::vector< std::string > > ListTables(const std::string &db_name) const =0</div><div class="ttdoc">Lists all the tables within a specified database.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_ad105a410f62dbbe891272d3c647b7976"><div class="ttname"><a href="classpaimon_1_1_catalog.html#ad105a410f62dbbe891272d3c647b7976">paimon::Catalog::ListDatabases</a></div><div class="ttdeci">virtual Result< std::vector< std::string > > ListDatabases() const =0</div><div class="ttdoc">Lists all the databases available in the catalog.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_ad116620f15a45bb7a538b58b68e65c97"><div class="ttname"><a href="classpaimon_1_1_catalog.html#ad116620f15a45bb7a538b58b68e65c97">paimon::Catalog::GetDatabaseLocation</a></div><div class="ttdeci">virtual std::string GetDatabaseLocation(const std::string &db_name) const =0</div><div class="ttdoc">Returns the expected location of a specified database.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_catalog_html_aefa990be4e6085cd974d10058708ec69"><div class="ttname"><a href="classpaimon_1_1_catalog.html#aefa990be4e6085cd974d10058708ec69">paimon::Catalog::DropTable</a></div><div class="ttdeci">virtual Status DropTable(const Identifier &identifier, bool ignore_if_not_exists)=0</div><div class="ttdoc">Drops a table.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_database_html"><div class="ttname"><a href="classpaimon_1_1_database.html">paimon::Database</a></div><div class="ttdoc">Interface of a database in a catalog.</div><div class="ttdef"><b>Definition</b> database.h:37</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_identifier_html"><div class="ttname"><a href="classpaimon_1_1_identifier.html">paimon::Identifier</a></div><div class="ttdoc">An identifier for a table containing database and table name.</div><div class="ttdef"><b>Definition</b> identifier.h:31</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_result_html"><div class="ttname"><a href="classpaimon_1_1_result.html">paimon::Result</a></div><div class="ttdoc">A Result<T> object holds either a value of type T or a Status object explaining why such a value is n...</div><div class="ttdef"><b>Definition</b> result.h:33</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_schema_html"><div class="ttname"><a href="classpaimon_1_1_schema.html">paimon::Schema</a></div><div class="ttdoc">This interface provides access to TableSchema-related information.</div><div class="ttdef"><b>Definition</b> schema.h:37</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_status_html"><div class="ttname"><a href="classpaimon_1_1_status.html">paimon::Status</a></div><div class="ttdoc">Status outcome object (success or error)</div><div class="ttdef"><b>Definition</b> status.h:92</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_table_html"><div class="ttname"><a href="classpaimon_1_1_table.html">paimon::Table</a></div><div class="ttdoc">A table provides basic abstraction for table type.</div><div class="ttdef"><b>Definition</b> table.h:36</div></div> |
| <div class="ttc" id="aidentifier_8h_html"><div class="ttname"><a href="identifier_8h.html">identifier.h</a></div></div> |
| <div class="ttc" id="anamespacepaimon_html"><div class="ttname"><a href="namespacepaimon.html">paimon</a></div><div class="ttdoc">Top-level namespace for Paimon C++ API.</div><div class="ttdef"><b>Definition</b> api.h:42</div></div> |
| <div class="ttc" id="anamespacepaimon_html_a7272315c02a68083734c50f3e747abdf"><div class="ttname"><a href="namespacepaimon.html#a7272315c02a68083734c50f3e747abdf">paimon::Instant</a></div><div class="ttdeci">std::variant< std::string, int64_t > Instant</div><div class="ttdef"><b>Definition</b> catalog.h:40</div></div> |
| <div class="ttc" id="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></div></div> |
| <div class="ttc" id="asnapshot__info_8h_html"><div class="ttname"><a href="snapshot__info_8h.html">snapshot_info.h</a></div></div> |
| <div class="ttc" id="astatus_8h_html"><div class="ttname"><a href="status_8h.html">status.h</a></div></div> |
| <div class="ttc" id="astruct_arrow_schema_html"><div class="ttname"><a href="struct_arrow_schema.html">ArrowSchema</a></div><div class="ttdef"><b>Definition</b> abi.h:53</div></div> |
| <div class="ttc" id="atype__fwd_8h_html"><div class="ttname"><a href="type__fwd_8h.html">type_fwd.h</a></div></div> |
| <div class="ttc" id="avisibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.h</a></div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
| </small></address> |
| </body> |
| </html> |
