| <!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/table.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">table.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="table_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 <map></span></div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include "<a class="code" href="identifier_8h.html">paimon/catalog/identifier.h</a>"</span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">paimon/result.h</a>"</span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include "<a class="code" href="schema_8h.html">paimon/schema/schema.h</a>"</span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "<a class="code" href="status_8h.html">paimon/status.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="type__fwd_8h.html">paimon/type_fwd.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="visibility_8h.html">paimon/visibility.h</a>"</span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacepaimon.html">paimon</a> {</div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div> |
| <div class="foldopen" id="foldopen00036" data-start="{" data-end="};"> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classpaimon_1_1_table.html"> 36</a></span><span class="keyword">class </span>PAIMON_EXPORT <a class="code hl_class" href="classpaimon_1_1_table.html">Table</a> {</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classpaimon_1_1_table.html#aa94a49d841dd537c5edd9513b0850aa9"> 44</a></span> <span class="keyword">static</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_table.html#aa94a49d841dd537c5edd9513b0850aa9">Create</a>(<span class="keyword">const</span> std::shared_ptr<FileSystem>& file_system,</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">const</span> std::string& table_path,</div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">const</span> <a class="code hl_class" href="classpaimon_1_1_identifier.html">Identifier</a>& identifier);</div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div> |
| <div class="foldopen" id="foldopen00048" data-start="{" data-end="}"> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classpaimon_1_1_table.html#ad04b846746474aa83957d586fc7a6bbf"> 48</a></span> <a class="code hl_function" href="classpaimon_1_1_table.html#ad04b846746474aa83957d586fc7a6bbf">Table</a>(<span class="keyword">const</span> std::shared_ptr<Schema>& schema, <span class="keyword">const</span> std::string& database,</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">const</span> std::string& table_name)</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> : schema_(schema), database_(database), table_name_(table_name) {}</div> |
| </div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classpaimon_1_1_table.html#a806c80307e17f4c7184d408f1e847f4b"> 52</a></span> <a class="code hl_function" href="classpaimon_1_1_table.html#a806c80307e17f4c7184d408f1e847f4b">~Table</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div> |
| <div class="foldopen" id="foldopen00055" data-start="{" data-end="}"> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classpaimon_1_1_table.html#af2a114a26e3fbd72c00292bd1db39f53"> 55</a></span> std::string <a class="code hl_function" href="classpaimon_1_1_table.html#af2a114a26e3fbd72c00292bd1db39f53">Name</a>()<span class="keyword"> const </span>{</div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordflow">return</span> table_name_;</div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> }</div> |
| </div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classpaimon_1_1_table.html#ac08d18467b0c2179704df36dd4da2c13"> 60</a></span> std::string <a class="code hl_function" href="classpaimon_1_1_table.html#ac08d18467b0c2179704df36dd4da2c13">FullName</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div> |
| <div class="foldopen" id="foldopen00064" data-start="{" data-end="}"> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="classpaimon_1_1_table.html#ac851845d63e3ae9e3ad0dc3a3d6365fc"> 64</a></span> std::string <a class="code hl_function" href="classpaimon_1_1_table.html#ac851845d63e3ae9e3ad0dc3a3d6365fc">Uuid</a>()<span class="keyword"> const </span>{</div> |
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">return</span> FullName();</div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> }</div> |
| </div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div> |
| <div class="foldopen" id="foldopen00069" data-start="{" data-end="}"> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classpaimon_1_1_table.html#aec9deca14991901dcd18434613d1dcaa"> 69</a></span> std::shared_ptr<Schema> <a class="code hl_function" href="classpaimon_1_1_table.html#aec9deca14991901dcd18434613d1dcaa">LatestSchema</a>()<span class="keyword"> const </span>{</div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">return</span> schema_;</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div> |
| </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"> 73</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="classpaimon_1_1_table.html#a63b35e53784264a5dff454ca9336f5c9"> 74</a></span> std::shared_ptr<Schema> <a class="code hl_variable" href="classpaimon_1_1_table.html#a63b35e53784264a5dff454ca9336f5c9">schema_</a>;</div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classpaimon_1_1_table.html#a5e3048b0b4eab034171ee20337e6eee6"> 75</a></span> std::string <a class="code hl_variable" href="classpaimon_1_1_table.html#a5e3048b0b4eab034171ee20337e6eee6">database_</a>;</div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classpaimon_1_1_table.html#a890bed506e34a2f0afb8dc7e3447d74e"> 76</a></span> std::string <a class="code hl_variable" href="classpaimon_1_1_table.html#a890bed506e34a2f0afb8dc7e3447d74e">table_name_</a>;</div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span>};</div> |
| </div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span>} <span class="comment">// namespace paimon</span></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_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="aclasspaimon_1_1_table_html_a5e3048b0b4eab034171ee20337e6eee6"><div class="ttname"><a href="classpaimon_1_1_table.html#a5e3048b0b4eab034171ee20337e6eee6">paimon::Table::database_</a></div><div class="ttdeci">std::string database_</div><div class="ttdef"><b>Definition</b> table.h:75</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_table_html_a63b35e53784264a5dff454ca9336f5c9"><div class="ttname"><a href="classpaimon_1_1_table.html#a63b35e53784264a5dff454ca9336f5c9">paimon::Table::schema_</a></div><div class="ttdeci">std::shared_ptr< Schema > schema_</div><div class="ttdef"><b>Definition</b> table.h:74</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_table_html_a806c80307e17f4c7184d408f1e847f4b"><div class="ttname"><a href="classpaimon_1_1_table.html#a806c80307e17f4c7184d408f1e847f4b">paimon::Table::~Table</a></div><div class="ttdeci">~Table()=default</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_table_html_a890bed506e34a2f0afb8dc7e3447d74e"><div class="ttname"><a href="classpaimon_1_1_table.html#a890bed506e34a2f0afb8dc7e3447d74e">paimon::Table::table_name_</a></div><div class="ttdeci">std::string table_name_</div><div class="ttdef"><b>Definition</b> table.h:76</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_table_html_aa94a49d841dd537c5edd9513b0850aa9"><div class="ttname"><a href="classpaimon_1_1_table.html#aa94a49d841dd537c5edd9513b0850aa9">paimon::Table::Create</a></div><div class="ttdeci">static Result< std::shared_ptr< Table > > Create(const std::shared_ptr< FileSystem > &file_system, const std::string &table_path, const Identifier &identifier)</div><div class="ttdoc">Creates a table by loading the latest schema from the specified table path.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_table_html_ac08d18467b0c2179704df36dd4da2c13"><div class="ttname"><a href="classpaimon_1_1_table.html#ac08d18467b0c2179704df36dd4da2c13">paimon::Table::FullName</a></div><div class="ttdeci">std::string FullName() const</div><div class="ttdoc">Full name of the table, default is database.tableName.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_table_html_ac851845d63e3ae9e3ad0dc3a3d6365fc"><div class="ttname"><a href="classpaimon_1_1_table.html#ac851845d63e3ae9e3ad0dc3a3d6365fc">paimon::Table::Uuid</a></div><div class="ttdeci">std::string Uuid() const</div><div class="ttdoc">UUID of the table, metastore can provide the true UUID of this table, default is the full name.</div><div class="ttdef"><b>Definition</b> table.h:64</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_table_html_ad04b846746474aa83957d586fc7a6bbf"><div class="ttname"><a href="classpaimon_1_1_table.html#ad04b846746474aa83957d586fc7a6bbf">paimon::Table::Table</a></div><div class="ttdeci">Table(const std::shared_ptr< Schema > &schema, const std::string &database, const std::string &table_name)</div><div class="ttdef"><b>Definition</b> table.h:48</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_table_html_aec9deca14991901dcd18434613d1dcaa"><div class="ttname"><a href="classpaimon_1_1_table.html#aec9deca14991901dcd18434613d1dcaa">paimon::Table::LatestSchema</a></div><div class="ttdeci">std::shared_ptr< Schema > LatestSchema() const</div><div class="ttdoc">Loads the latest schema of table.</div><div class="ttdef"><b>Definition</b> table.h:69</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_table_html_af2a114a26e3fbd72c00292bd1db39f53"><div class="ttname"><a href="classpaimon_1_1_table.html#af2a114a26e3fbd72c00292bd1db39f53">paimon::Table::Name</a></div><div class="ttdeci">std::string Name() const</div><div class="ttdoc">A name to identify this table.</div><div class="ttdef"><b>Definition</b> table.h:55</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="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></div></div> |
| <div class="ttc" id="aschema_8h_html"><div class="ttname"><a href="schema_8h.html">schema.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="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> |
