| <!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: paimon::FormatTable Class Reference</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> |
| <!-- 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="namespacepaimon.html">paimon</a></li><li class="navelem"><a class="el" href="classpaimon_1_1_format_table.html">FormatTable</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pri-methods">Private Member Functions</a> | |
| <a href="#pri-attribs">Private Attributes</a> | |
| <a href="classpaimon_1_1_format_table-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">paimon::FormatTable Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A table that is a directory of data files of one format, laid out like a standard Hive table. |
| <a href="classpaimon_1_1_format_table.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="format__table_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/table/format/format_table.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:a5e64a4c7639c078931d23580a73e7aaf" id="r_a5e64a4c7639c078931d23580a73e7aaf"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aaf">Format</a> { <a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aafa7bb7c37684110cabfa71e442f9283f89">PARQUET</a> |
| , <a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aafa6d8e87b2e81c11252ad12520596a0ee1">ORC</a> |
| }</td></tr> |
| <tr class="memdesc:a5e64a4c7639c078931d23580a73e7aaf"><td class="mdescLeft"> </td><td class="mdescRight">Formats a format table's files can be in. <a href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aaf">More...</a><br /></td></tr> |
| <tr class="separator:a5e64a4c7639c078931d23580a73e7aaf"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a4e93af96bccf08809a3bf26ee6ec735e" id="r_a4e93af96bccf08809a3bf26ee6ec735e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a4e93af96bccf08809a3bf26ee6ec735e">~FormatTable</a> ()</td></tr> |
| <tr class="separator:a4e93af96bccf08809a3bf26ee6ec735e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae60a23987d78468025acd002b23af529" id="r_ae60a23987d78468025acd002b23af529"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#ae60a23987d78468025acd002b23af529">Location</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:ae60a23987d78468025acd002b23af529"><td class="mdescLeft"> </td><td class="mdescRight">Directory the data files live in. <br /></td></tr> |
| <tr class="separator:ae60a23987d78468025acd002b23af529"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa0ae5176bdcdb2f82ca89e8e4e31ed96" id="r_aa0ae5176bdcdb2f82ca89e8e4e31ed96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aaf">Format</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#aa0ae5176bdcdb2f82ca89e8e4e31ed96">GetFormat</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:aa0ae5176bdcdb2f82ca89e8e4e31ed96"><td class="mdescLeft"> </td><td class="mdescRight">Format of every data file in the directory. <br /></td></tr> |
| <tr class="separator:aa0ae5176bdcdb2f82ca89e8e4e31ed96"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afe9cdb6cc76c637a67d9379f9957b07a" id="r_afe9cdb6cc76c637a67d9379f9957b07a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::vector< std::string > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#afe9cdb6cc76c637a67d9379f9957b07a">PartitionKeys</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:afe9cdb6cc76c637a67d9379f9957b07a"><td class="mdescLeft"> </td><td class="mdescRight">Fields the table is partitioned by, in the order their directories nest. <br /></td></tr> |
| <tr class="separator:afe9cdb6cc76c637a67d9379f9957b07a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a45b68b4a5956c8845e558253ec31ca03" id="r_a45b68b4a5956c8845e558253ec31ca03"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a45b68b4a5956c8845e558253ec31ca03">FileCompression</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a45b68b4a5956c8845e558253ec31ca03"><td class="mdescLeft"> </td><td class="mdescRight">Compression new data files are written with. <br /></td></tr> |
| <tr class="separator:a45b68b4a5956c8845e558253ec31ca03"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a51b21f1e211e3c01a890b5a314ed5d6a" id="r_a51b21f1e211e3c01a890b5a314ed5d6a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a51b21f1e211e3c01a890b5a314ed5d6a">PartitionDefaultName</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a51b21f1e211e3c01a890b5a314ed5d6a"><td class="mdescLeft"> </td><td class="mdescRight">Directory name standing for a null partition value, from <code>partition.default-name</code>. <br /></td></tr> |
| <tr class="separator:a51b21f1e211e3c01a890b5a314ed5d6a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac9074d698944be78ad983eb21c89eb35" id="r_ac9074d698944be78ad983eb21c89eb35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#ac9074d698944be78ad983eb21c89eb35">PartitionOnlyValueInPath</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:ac9074d698944be78ad983eb21c89eb35"><td class="mdescLeft"> </td><td class="mdescRight">Whether a partition directory is named by its value alone (<code>2025/01/</code>) instead of <code>key=value</code> (<code>year=2025/month=01/</code>), from <code>format-table.partition-path-only-value</code>. <br /></td></tr> |
| <tr class="separator:ac9074d698944be78ad983eb21c89eb35"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a23690cced467fe44dd8a7c3c204bad42" id="r_a23690cced467fe44dd8a7c3c204bad42"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::map< std::string, std::string > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a23690cced467fe44dd8a7c3c204bad42">Options</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a23690cced467fe44dd8a7c3c204bad42"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classpaimon_1_1_table.html" title="A table provides basic abstraction for table type.">Table</a> options: the ones stored in the schema, with any given at the call on top. <br /></td></tr> |
| <tr class="separator:a23690cced467fe44dd8a7c3c204bad42"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a34322b7d9fc4d24717f6ab3bf55d5275" id="r_a34322b7d9fc4d24717f6ab3bf55d5275"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a34322b7d9fc4d24717f6ab3bf55d5275">Name</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a34322b7d9fc4d24717f6ab3bf55d5275"><td class="mdescLeft"> </td><td class="mdescRight">A name to identify this table. <br /></td></tr> |
| <tr class="separator:a34322b7d9fc4d24717f6ab3bf55d5275"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a08904ab2d93117600422a5fe42a30213" id="r_a08904ab2d93117600422a5fe42a30213"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a08904ab2d93117600422a5fe42a30213">FullName</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a08904ab2d93117600422a5fe42a30213"><td class="mdescLeft"> </td><td class="mdescRight">Full name of the table, database.tableName. <br /></td></tr> |
| <tr class="separator:a08904ab2d93117600422a5fe42a30213"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2cfdd066868a99b95720875ad1283319" id="r_a2cfdd066868a99b95720875ad1283319"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classpaimon_1_1_data_schema.html">DataSchema</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a2cfdd066868a99b95720875ad1283319">LatestSchema</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a2cfdd066868a99b95720875ad1283319"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classpaimon_1_1_schema.html" title="This interface provides access to TableSchema-related information.">Schema</a> of the table, including its partition fields. <br /></td></tr> |
| <tr class="separator:a2cfdd066868a99b95720875ad1283319"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afcacc335160bd7d39dcf88ff2706ae2e" id="r_afcacc335160bd7d39dcf88ff2706ae2e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_result.html">Result</a>< std::unique_ptr<<a class="el" href="struct_arrow_schema.html">::ArrowSchema</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#afcacc335160bd7d39dcf88ff2706ae2e">GetArrowSchema</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:afcacc335160bd7d39dcf88ff2706ae2e"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classpaimon_1_1_schema.html" title="This interface provides access to TableSchema-related information.">Schema</a> of the table as an arrow schema, including its partition fields. <br /></td></tr> |
| <tr class="separator:afcacc335160bd7d39dcf88ff2706ae2e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afdf86c63ab744ac68012862b53b2e307" id="r_afdf86c63ab744ac68012862b53b2e307"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classpaimon_1_1_file_system.html">FileSystem</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#afdf86c63ab744ac68012862b53b2e307">GetFileSystem</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:afdf86c63ab744ac68012862b53b2e307"><td class="mdescLeft"> </td><td class="mdescRight">File system holding the table directory. <br /></td></tr> |
| <tr class="separator:afdf86c63ab744ac68012862b53b2e307"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4d2d0158fa89bc0194dcb86c011f6a36" id="r_a4d2d0158fa89bc0194dcb86c011f6a36"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a4d2d0158fa89bc0194dcb86c011f6a36">LocationCarriesPaimonMetadata</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a4d2d0158fa89bc0194dcb86c011f6a36"><td class="mdescLeft"> </td><td class="mdescRight">Whether this table's own metadata lives under its location, as told by whoever loaded it. <br /></td></tr> |
| <tr class="separator:a4d2d0158fa89bc0194dcb86c011f6a36"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:ab8d2302e0255af3e4f0c509be4ad1026" id="r_ab8d2302e0255af3e4f0c509be4ad1026"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< <a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aaf">Format</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#ab8d2302e0255af3e4f0c509be4ad1026">ParseFormat</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">file_format</a>)</td></tr> |
| <tr class="memdesc:ab8d2302e0255af3e4f0c509be4ad1026"><td class="mdescLeft"> </td><td class="mdescRight">Parses the <code>file.format</code> option, case-insensitively. <br /></td></tr> |
| <tr class="separator:ab8d2302e0255af3e4f0c509be4ad1026"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af5f12036973f37684e3d9abc837d5c2c" id="r_af5f12036973f37684e3d9abc837d5c2c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#af5f12036973f37684e3d9abc837d5c2c">FormatToString</a> (<a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aaf">Format</a> format)</td></tr> |
| <tr class="memdesc:af5f12036973f37684e3d9abc837d5c2c"><td class="mdescLeft"> </td><td class="mdescRight">The identifier of a format, as it appears in <code>file.format</code> and as a file extension. <br /></td></tr> |
| <tr class="separator:af5f12036973f37684e3d9abc837d5c2c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae783dc7de67a608a1f6b70eec54526db" id="r_ae783dc7de67a608a1f6b70eec54526db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::shared_ptr< <a class="el" href="classpaimon_1_1_format_table.html">FormatTable</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#ae783dc7de67a608a1f6b70eec54526db">Create</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_file_system.html">FileSystem</a> > &file_system, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">table_path</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_identifier.html">Identifier</a> &identifier, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::map< std::string, std::string > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">dynamic_options</a>)</td></tr> |
| <tr class="memdesc:ae783dc7de67a608a1f6b70eec54526db"><td class="mdescLeft"> </td><td class="mdescRight">Loads a format table from its directory, reading the schema stored under it. <br /></td></tr> |
| <tr class="separator:ae783dc7de67a608a1f6b70eec54526db"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa5adfd5449a02314cc83efb014c19dff" id="r_aa5adfd5449a02314cc83efb014c19dff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::shared_ptr< <a class="el" href="classpaimon_1_1_format_table.html">FormatTable</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#aa5adfd5449a02314cc83efb014c19dff">Create</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_file_system.html">FileSystem</a> > &file_system, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">location</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_identifier.html">Identifier</a> &identifier, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_data_schema.html">DataSchema</a> > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">schema</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">location_carries_paimon_metadata</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::map< std::string, std::string > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">dynamic_options</a>)</td></tr> |
| <tr class="memdesc:aa5adfd5449a02314cc83efb014c19dff"><td class="mdescLeft"> </td><td class="mdescRight">Builds a format table from a schema that is already loaded, for a caller that has one in hand, such as a catalog that just created the table. <br /></td></tr> |
| <tr class="separator:aa5adfd5449a02314cc83efb014c19dff"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa6f7b5a9fab50b042ab296843ff52145" id="r_aa6f7b5a9fab50b042ab296843ff52145"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::shared_ptr< <a class="el" href="classpaimon_1_1_format_table.html">FormatTable</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#aa6f7b5a9fab50b042ab296843ff52145">Copy</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_format_table.html">FormatTable</a> > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">table</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::map< std::string, std::string > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">dynamic_options</a>)</td></tr> |
| <tr class="memdesc:aa6f7b5a9fab50b042ab296843ff52145"><td class="mdescLeft"> </td><td class="mdescRight">Copies <code>table</code> with <code>dynamic_options</code> on top of the options it already carries, which is the precedence every context builder promises for a table it was handed rather than loaded itself. <br /></td></tr> |
| <tr class="separator:aa6f7b5a9fab50b042ab296843ff52145"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a> |
| Private Member Functions</h2></td></tr> |
| <tr class="memitem:a31e8278ef32e81dace14c2fee9170b4f" id="r_a31e8278ef32e81dace14c2fee9170b4f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a31e8278ef32e81dace14c2fee9170b4f">FormatTable</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_file_system.html">FileSystem</a> > &file_system, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">location</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_identifier.html">Identifier</a> &identifier, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_data_schema.html">DataSchema</a> > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">schema</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::map< std::string, std::string > &options, <a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aaf">Format</a> format, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">file_compression</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">partition_default_name</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">partition_only_value_in_path</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">location_carries_paimon_metadata</a>)</td></tr> |
| <tr class="separator:a31e8278ef32e81dace14c2fee9170b4f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a> |
| Private Attributes</h2></td></tr> |
| <tr class="memitem:aca9b647a865a9f94e2ae407753fcf55d" id="r_aca9b647a865a9f94e2ae407753fcf55d"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classpaimon_1_1_file_system.html">FileSystem</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#aca9b647a865a9f94e2ae407753fcf55d">file_system_</a></td></tr> |
| <tr class="separator:aca9b647a865a9f94e2ae407753fcf55d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a11f2fe3d2aa89f00a852ae76800c3b8e" id="r_a11f2fe3d2aa89f00a852ae76800c3b8e"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a11f2fe3d2aa89f00a852ae76800c3b8e">location_</a></td></tr> |
| <tr class="separator:a11f2fe3d2aa89f00a852ae76800c3b8e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a704242beccf0fe4b532921bc7df2d578" id="r_a704242beccf0fe4b532921bc7df2d578"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_identifier.html">Identifier</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a704242beccf0fe4b532921bc7df2d578">identifier_</a></td></tr> |
| <tr class="separator:a704242beccf0fe4b532921bc7df2d578"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aad1a37e05586573d0e491eaab6a312b5" id="r_aad1a37e05586573d0e491eaab6a312b5"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classpaimon_1_1_data_schema.html">DataSchema</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#aad1a37e05586573d0e491eaab6a312b5">schema_</a></td></tr> |
| <tr class="separator:aad1a37e05586573d0e491eaab6a312b5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a28a7735cecde596a287b9d800a0e8617" id="r_a28a7735cecde596a287b9d800a0e8617"><td class="memItemLeft" align="right" valign="top">std::map< std::string, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a28a7735cecde596a287b9d800a0e8617">options_</a></td></tr> |
| <tr class="separator:a28a7735cecde596a287b9d800a0e8617"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1357abb74ab11ca61604ae0dc7ef4545" id="r_a1357abb74ab11ca61604ae0dc7ef4545"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aaf">Format</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a1357abb74ab11ca61604ae0dc7ef4545">format_</a></td></tr> |
| <tr class="separator:a1357abb74ab11ca61604ae0dc7ef4545"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ade6ce3386b31ac0b87a7083679db87e6" id="r_ade6ce3386b31ac0b87a7083679db87e6"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#ade6ce3386b31ac0b87a7083679db87e6">file_compression_</a></td></tr> |
| <tr class="separator:ade6ce3386b31ac0b87a7083679db87e6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a88cb678809b9b6fb0c5a07b3335cbd9b" id="r_a88cb678809b9b6fb0c5a07b3335cbd9b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a88cb678809b9b6fb0c5a07b3335cbd9b">partition_default_name_</a></td></tr> |
| <tr class="separator:a88cb678809b9b6fb0c5a07b3335cbd9b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4425b1a8647eec340a13587e8fa42612" id="r_a4425b1a8647eec340a13587e8fa42612"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#a4425b1a8647eec340a13587e8fa42612">partition_only_value_in_path_</a> = <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">false</a></td></tr> |
| <tr class="separator:a4425b1a8647eec340a13587e8fa42612"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad931287f9703ec8288da1a877b2bf869" id="r_ad931287f9703ec8288da1a877b2bf869"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_format_table.html#ad931287f9703ec8288da1a877b2bf869">location_carries_paimon_metadata_</a> = <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">false</a></td></tr> |
| <tr class="separator:ad931287f9703ec8288da1a877b2bf869"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A table that is a directory of data files of one format, laid out like a standard Hive table. </p> |
| <p>It carries no snapshots and no manifests: the files under its location are the table, and a partitioned table's partitions are the <code>key=value</code> directories below that location, or the bare-value ones under <code>format-table.partition-path-only-value</code>. A table is a format table when its <code>type</code> option is <code>format-table</code>; <code>file.format</code> then names the format of every file in it, defaulting to <code>parquet</code>.</p> |
| <p>Writes only insert - there is nowhere to record an update or a delete - so a read fills <code>_VALUE_KIND</code> with inserts throughout.</p> |
| <p>Reading and writing go through the entry points every other table uses: <code><a class="el" href="classpaimon_1_1_table_scan.html" title="A scanner interface for reading table's meta and create a plan.">TableScan</a></code>, <code><a class="el" href="classpaimon_1_1_table_read.html" title="Given a Split or a list of Split, generate a reader for batch reading.">TableRead</a></code>, <code><a class="el" href="classpaimon_1_1_file_store_write.html" title="Interface for write operations in a file store.">FileStoreWrite</a></code> and <code><a class="el" href="classpaimon_1_1_file_store_commit.html" title="Interface for commit operations in a file store.">FileStoreCommit</a></code>. Each recognises a format table from the schema under the table path, or takes one already loaded through the <code><a class="el" href="classpaimon_1_1_format_table.html" title="A table that is a directory of data files of one format, laid out like a standard Hive table.">FormatTable</a></code> constructor every context builder has, which is how a table whose schema lives in a metastore is reached.</p> |
| <p>See <code>docs/source/user_guide/format_table.rst</code> for what is not supported yet. </p> |
| </div><h2 class="groupheader">Member Enumeration Documentation</h2> |
| <a id="a5e64a4c7639c078931d23580a73e7aaf" name="a5e64a4c7639c078931d23580a73e7aaf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5e64a4c7639c078931d23580a73e7aaf">◆ </a></span>Format</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">enum</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">class</a> <a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aaf">paimon::FormatTable::Format</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">strong</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Formats a format table's files can be in. </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a5e64a4c7639c078931d23580a73e7aafa7bb7c37684110cabfa71e442f9283f89" name="a5e64a4c7639c078931d23580a73e7aafa7bb7c37684110cabfa71e442f9283f89"></a>PARQUET </td><td class="fielddoc"></td></tr> |
| <tr><td class="fieldname"><a id="a5e64a4c7639c078931d23580a73e7aafa6d8e87b2e81c11252ad12520596a0ee1" name="a5e64a4c7639c078931d23580a73e7aafa6d8e87b2e81c11252ad12520596a0ee1"></a>ORC </td><td class="fielddoc"></td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a4e93af96bccf08809a3bf26ee6ec735e" name="a4e93af96bccf08809a3bf26ee6ec735e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4e93af96bccf08809a3bf26ee6ec735e">◆ </a></span>~FormatTable()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">paimon::FormatTable::~FormatTable </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a31e8278ef32e81dace14c2fee9170b4f" name="a31e8278ef32e81dace14c2fee9170b4f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a31e8278ef32e81dace14c2fee9170b4f">◆ </a></span>FormatTable()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">paimon::FormatTable::FormatTable </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_file_system.html">FileSystem</a> > & </td> |
| <td class="paramname"><em>file_system</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & </td> |
| <td class="paramname"><em>location</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_identifier.html">Identifier</a> & </td> |
| <td class="paramname"><em>identifier</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_data_schema.html">DataSchema</a> > & </td> |
| <td class="paramname"><em>schema</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::map< std::string, std::string > & </td> |
| <td class="paramname"><em>options</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aaf">Format</a> </td> |
| <td class="paramname"><em>format</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & </td> |
| <td class="paramname"><em>file_compression</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & </td> |
| <td class="paramname"><em>partition_default_name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> </td> |
| <td class="paramname"><em>partition_only_value_in_path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> </td> |
| <td class="paramname"><em>location_carries_paimon_metadata</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ab8d2302e0255af3e4f0c509be4ad1026" name="ab8d2302e0255af3e4f0c509be4ad1026"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab8d2302e0255af3e4f0c509be4ad1026">◆ </a></span>ParseFormat()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< <a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aaf">Format</a> > paimon::FormatTable::ParseFormat </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & </td> |
| <td class="paramname"><em>file_format</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Parses the <code>file.format</code> option, case-insensitively. </p> |
| <p>A format this library has no reader for is rejected by name, instead of failing later with a missing-format-factory error. </p> |
| |
| </div> |
| </div> |
| <a id="af5f12036973f37684e3d9abc837d5c2c" name="af5f12036973f37684e3d9abc837d5c2c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af5f12036973f37684e3d9abc837d5c2c">◆ </a></span>FormatToString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> std::string paimon::FormatTable::FormatToString </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aaf">Format</a> </td> |
| <td class="paramname"><em>format</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The identifier of a format, as it appears in <code>file.format</code> and as a file extension. </p> |
| |
| </div> |
| </div> |
| <a id="ae783dc7de67a608a1f6b70eec54526db" name="ae783dc7de67a608a1f6b70eec54526db"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae783dc7de67a608a1f6b70eec54526db">◆ </a></span>Create() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::shared_ptr< <a class="el" href="classpaimon_1_1_format_table.html">FormatTable</a> > > paimon::FormatTable::Create </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_file_system.html">FileSystem</a> > & </td> |
| <td class="paramname"><em>file_system</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & </td> |
| <td class="paramname"><em>table_path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_identifier.html">Identifier</a> & </td> |
| <td class="paramname"><em>identifier</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::map< std::string, std::string > & </td> |
| <td class="paramname"><em>dynamic_options</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Loads a format table from its directory, reading the schema stored under it. </p> |
| <p>This needs a schema file under the table directory, which a table created through <code>SchemaManager</code> or a file system catalog has. A table whose schema lives in a metastore has none, and is loaded through <code><a class="el" href="classpaimon_1_1_catalog.html#a82b118dfa0594678a13814e07e02984e" title="Gets a format table: a directory of data files laid out like a standard Hive table.">Catalog::GetFormatTable()</a></code> instead.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">file_system</td><td>File system holding the table directory. </td></tr> |
| <tr><td class="paramname">table_path</td><td>Root path of the table, which is also its data location. </td></tr> |
| <tr><td class="paramname">identifier</td><td>Logical table identifier, used for naming and error messages. </td></tr> |
| <tr><td class="paramname">dynamic_options</td><td><a class="el" href="structpaimon_1_1_options.html" title="Configuration options and constants for Paimon table operations.">Options</a> given at the call, which win over the ones stored in the schema. Empty when the caller has none. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A result containing the format table, or an error status. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa5adfd5449a02314cc83efb014c19dff" name="aa5adfd5449a02314cc83efb014c19dff"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa5adfd5449a02314cc83efb014c19dff">◆ </a></span>Create() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::shared_ptr< <a class="el" href="classpaimon_1_1_format_table.html">FormatTable</a> > > paimon::FormatTable::Create </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_file_system.html">FileSystem</a> > & </td> |
| <td class="paramname"><em>file_system</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & </td> |
| <td class="paramname"><em>location</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_identifier.html">Identifier</a> & </td> |
| <td class="paramname"><em>identifier</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_data_schema.html">DataSchema</a> > & </td> |
| <td class="paramname"><em>schema</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> </td> |
| <td class="paramname"><em>location_carries_paimon_metadata</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::map< std::string, std::string > & </td> |
| <td class="paramname"><em>dynamic_options</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Builds a format table from a schema that is already loaded, for a caller that has one in hand, such as a catalog that just created the table. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">location</td><td>Directory the data files live in. It may not be empty: every path this table reads or writes is checked against it, and an empty one is a prefix of nothing. A trailing separator names the same directory as none. </td></tr> |
| <tr><td class="paramname">location_carries_paimon_metadata</td><td>See <code><a class="el" href="classpaimon_1_1_format_table.html#a4d2d0158fa89bc0194dcb86c011f6a36" title="Whether this table's own metadata lives under its location, as told by whoever loaded it.">LocationCarriesPaimonMetadata()</a></code>. Only the caller knows: a file system catalog puts metadata there, a REST or Hive catalog keeps it in the metastore. </td></tr> |
| <tr><td class="paramname">dynamic_options</td><td><a class="el" href="structpaimon_1_1_options.html" title="Configuration options and constants for Paimon table operations.">Options</a> given at the call, which win over the ones stored in the schema. Empty when the caller has none. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A result containing the format table, or an error status. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa6f7b5a9fab50b042ab296843ff52145" name="aa6f7b5a9fab50b042ab296843ff52145"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa6f7b5a9fab50b042ab296843ff52145">◆ </a></span>Copy()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::shared_ptr< <a class="el" href="classpaimon_1_1_format_table.html">FormatTable</a> > > paimon::FormatTable::Copy </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_format_table.html">FormatTable</a> > & </td> |
| <td class="paramname"><em>table</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::map< std::string, std::string > & </td> |
| <td class="paramname"><em>dynamic_options</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copies <code>table</code> with <code>dynamic_options</code> on top of the options it already carries, which is the precedence every context builder promises for a table it was handed rather than loaded itself. </p> |
| <p><code>table</code> comes back as it is when there is nothing to add.</p> |
| <p><code>type</code> is not overridable: it is structural and is read from the schema alone.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">table</td><td>The table to copy. </td></tr> |
| <tr><td class="paramname">dynamic_options</td><td><a class="el" href="structpaimon_1_1_options.html" title="Configuration options and constants for Paimon table operations.">Options</a> given at the call. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A result containing the copied table, or an error status. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ae60a23987d78468025acd002b23af529" name="ae60a23987d78468025acd002b23af529"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae60a23987d78468025acd002b23af529">◆ </a></span>Location()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & paimon::FormatTable::Location </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Directory the data files live in. </p> |
| |
| </div> |
| </div> |
| <a id="aa0ae5176bdcdb2f82ca89e8e4e31ed96" name="aa0ae5176bdcdb2f82ca89e8e4e31ed96"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa0ae5176bdcdb2f82ca89e8e4e31ed96">◆ </a></span>GetFormat()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aaf">Format</a> paimon::FormatTable::GetFormat </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Format of every data file in the directory. </p> |
| |
| </div> |
| </div> |
| <a id="afe9cdb6cc76c637a67d9379f9957b07a" name="afe9cdb6cc76c637a67d9379f9957b07a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afe9cdb6cc76c637a67d9379f9957b07a">◆ </a></span>PartitionKeys()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::vector< std::string > & paimon::FormatTable::PartitionKeys </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Fields the table is partitioned by, in the order their directories nest. </p> |
| |
| </div> |
| </div> |
| <a id="a45b68b4a5956c8845e558253ec31ca03" name="a45b68b4a5956c8845e558253ec31ca03"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a45b68b4a5956c8845e558253ec31ca03">◆ </a></span>FileCompression()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & paimon::FormatTable::FileCompression </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Compression new data files are written with. </p> |
| <p>It is resolved from <code>file.compression</code>, then <code>format-table.file.compression</code>, then the bare <code>compression</code> key an engine's own writer reads, then what the table's format writes by default. </p> |
| |
| </div> |
| </div> |
| <a id="a51b21f1e211e3c01a890b5a314ed5d6a" name="a51b21f1e211e3c01a890b5a314ed5d6a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a51b21f1e211e3c01a890b5a314ed5d6a">◆ </a></span>PartitionDefaultName()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & paimon::FormatTable::PartitionDefaultName </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Directory name standing for a null partition value, from <code>partition.default-name</code>. </p> |
| |
| </div> |
| </div> |
| <a id="ac9074d698944be78ad983eb21c89eb35" name="ac9074d698944be78ad983eb21c89eb35"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac9074d698944be78ad983eb21c89eb35">◆ </a></span>PartitionOnlyValueInPath()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> paimon::FormatTable::PartitionOnlyValueInPath </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Whether a partition directory is named by its value alone (<code>2025/01/</code>) instead of <code>key=value</code> (<code>year=2025/month=01/</code>), from <code>format-table.partition-path-only-value</code>. </p> |
| <p>The value-only layout carries no field names, so the nesting order of the table's partition keys alone says which key a directory belongs to. </p> |
| |
| </div> |
| </div> |
| <a id="a23690cced467fe44dd8a7c3c204bad42" name="a23690cced467fe44dd8a7c3c204bad42"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a23690cced467fe44dd8a7c3c204bad42">◆ </a></span>Options()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::map< std::string, std::string > & paimon::FormatTable::Options </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><a class="el" href="classpaimon_1_1_table.html" title="A table provides basic abstraction for table type.">Table</a> options: the ones stored in the schema, with any given at the call on top. </p> |
| |
| </div> |
| </div> |
| <a id="a34322b7d9fc4d24717f6ab3bf55d5275" name="a34322b7d9fc4d24717f6ab3bf55d5275"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a34322b7d9fc4d24717f6ab3bf55d5275">◆ </a></span>Name()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string paimon::FormatTable::Name </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>A name to identify this table. </p> |
| |
| </div> |
| </div> |
| <a id="a08904ab2d93117600422a5fe42a30213" name="a08904ab2d93117600422a5fe42a30213"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a08904ab2d93117600422a5fe42a30213">◆ </a></span>FullName()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string paimon::FormatTable::FullName </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Full name of the table, database.tableName. </p> |
| |
| </div> |
| </div> |
| <a id="a2cfdd066868a99b95720875ad1283319" name="a2cfdd066868a99b95720875ad1283319"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2cfdd066868a99b95720875ad1283319">◆ </a></span>LatestSchema()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr< <a class="el" href="classpaimon_1_1_data_schema.html">DataSchema</a> > paimon::FormatTable::LatestSchema </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><a class="el" href="classpaimon_1_1_schema.html" title="This interface provides access to TableSchema-related information.">Schema</a> of the table, including its partition fields. </p> |
| |
| </div> |
| </div> |
| <a id="afcacc335160bd7d39dcf88ff2706ae2e" name="afcacc335160bd7d39dcf88ff2706ae2e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afcacc335160bd7d39dcf88ff2706ae2e">◆ </a></span>GetArrowSchema()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_result.html">Result</a>< std::unique_ptr<<a class="el" href="struct_arrow_schema.html">::ArrowSchema</a> > > paimon::FormatTable::GetArrowSchema </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><a class="el" href="classpaimon_1_1_schema.html" title="This interface provides access to TableSchema-related information.">Schema</a> of the table as an arrow schema, including its partition fields. </p> |
| |
| </div> |
| </div> |
| <a id="afdf86c63ab744ac68012862b53b2e307" name="afdf86c63ab744ac68012862b53b2e307"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afdf86c63ab744ac68012862b53b2e307">◆ </a></span>GetFileSystem()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr< <a class="el" href="classpaimon_1_1_file_system.html">FileSystem</a> > paimon::FormatTable::GetFileSystem </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>File system holding the table directory. </p> |
| |
| </div> |
| </div> |
| <a id="a4d2d0158fa89bc0194dcb86c011f6a36" name="a4d2d0158fa89bc0194dcb86c011f6a36"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4d2d0158fa89bc0194dcb86c011f6a36">◆ </a></span>LocationCarriesPaimonMetadata()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> paimon::FormatTable::LocationCarriesPaimonMetadata </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Whether this table's own metadata lives under its location, as told by whoever loaded it. </p> |
| <p>Only then are the <code>schema</code> and <code>branch</code> directories below the location table metadata rather than table content. For a table whose schema lives in a metastore they are data, and are read and written like any other directory. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="aca9b647a865a9f94e2ae407753fcf55d" name="aca9b647a865a9f94e2ae407753fcf55d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aca9b647a865a9f94e2ae407753fcf55d">◆ </a></span>file_system_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="classpaimon_1_1_file_system.html">FileSystem</a>> paimon::FormatTable::file_system_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a11f2fe3d2aa89f00a852ae76800c3b8e" name="a11f2fe3d2aa89f00a852ae76800c3b8e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a11f2fe3d2aa89f00a852ae76800c3b8e">◆ </a></span>location_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string paimon::FormatTable::location_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a704242beccf0fe4b532921bc7df2d578" name="a704242beccf0fe4b532921bc7df2d578"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a704242beccf0fe4b532921bc7df2d578">◆ </a></span>identifier_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_identifier.html">Identifier</a> paimon::FormatTable::identifier_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="aad1a37e05586573d0e491eaab6a312b5" name="aad1a37e05586573d0e491eaab6a312b5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aad1a37e05586573d0e491eaab6a312b5">◆ </a></span>schema_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="classpaimon_1_1_data_schema.html">DataSchema</a>> paimon::FormatTable::schema_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a28a7735cecde596a287b9d800a0e8617" name="a28a7735cecde596a287b9d800a0e8617"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a28a7735cecde596a287b9d800a0e8617">◆ </a></span>options_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::map<std::string, std::string> paimon::FormatTable::options_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a1357abb74ab11ca61604ae0dc7ef4545" name="a1357abb74ab11ca61604ae0dc7ef4545"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1357abb74ab11ca61604ae0dc7ef4545">◆ </a></span>format_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_format_table.html#a5e64a4c7639c078931d23580a73e7aaf">Format</a> paimon::FormatTable::format_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="ade6ce3386b31ac0b87a7083679db87e6" name="ade6ce3386b31ac0b87a7083679db87e6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ade6ce3386b31ac0b87a7083679db87e6">◆ </a></span>file_compression_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string paimon::FormatTable::file_compression_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a88cb678809b9b6fb0c5a07b3335cbd9b" name="a88cb678809b9b6fb0c5a07b3335cbd9b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a88cb678809b9b6fb0c5a07b3335cbd9b">◆ </a></span>partition_default_name_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string paimon::FormatTable::partition_default_name_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a4425b1a8647eec340a13587e8fa42612" name="a4425b1a8647eec340a13587e8fa42612"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4425b1a8647eec340a13587e8fa42612">◆ </a></span>partition_only_value_in_path_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> paimon::FormatTable::partition_only_value_in_path_ = <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">false</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="ad931287f9703ec8288da1a877b2bf869" name="ad931287f9703ec8288da1a877b2bf869"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad931287f9703ec8288da1a877b2bf869">◆ </a></span>location_carries_paimon_metadata_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> paimon::FormatTable::location_carries_paimon_metadata_ = <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">false</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/table/format/<a class="el" href="format__table_8h_source.html">format_table.h</a></li> |
| </ul> |
| </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> |
