| <!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::DataSchema 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_data_schema.html">DataSchema</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classpaimon_1_1_data_schema-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">paimon::DataSchema Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="classpaimon_1_1_schema.html" title="This interface provides access to TableSchema-related information.">Schema</a> contract for data tables. |
| <a href="classpaimon_1_1_data_schema.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="schema_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/schema/schema.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for paimon::DataSchema:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classpaimon_1_1_data_schema.png" usemap="#paimon::DataSchema_map" alt=""/> |
| <map id="paimon::DataSchema_map" name="paimon::DataSchema_map"> |
| <area href="classpaimon_1_1_schema.html" title="This interface provides access to TableSchema-related information." alt="paimon::Schema" shape="rect" coords="0,0,129,24"/> |
| </map> |
| </div></div> |
| <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:a7169a1e830563f4724af1460cac8bcac" id="r_a7169a1e830563f4724af1460cac8bcac"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_schema.html#a7169a1e830563f4724af1460cac8bcac">~DataSchema</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">override</a>=<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">default</a></td></tr> |
| <tr class="separator:a7169a1e830563f4724af1460cac8bcac"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad7dd005b78700caa79a60f7e7b0fb7ca" id="r_ad7dd005b78700caa79a60f7e7b0fb7ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int64_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_schema.html#ad7dd005b78700caa79a60f7e7b0fb7ca">Id</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr> |
| <tr class="memdesc:ad7dd005b78700caa79a60f7e7b0fb7ca"><td class="mdescLeft"> </td><td class="mdescRight">Get the unique identifier of this table schema. <br /></td></tr> |
| <tr class="separator:ad7dd005b78700caa79a60f7e7b0fb7ca"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a79efe488acb2a9029bdaa4d1c294d70a" id="r_a79efe488acb2a9029bdaa4d1c294d70a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> <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_data_schema.html#a79efe488acb2a9029bdaa4d1c294d70a">PrimaryKeys</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr> |
| <tr class="memdesc:a79efe488acb2a9029bdaa4d1c294d70a"><td class="mdescLeft"> </td><td class="mdescRight">Get the list of primary key field names. <br /></td></tr> |
| <tr class="separator:a79efe488acb2a9029bdaa4d1c294d70a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4b095c1667e9607bcded3414960d2499" id="r_a4b095c1667e9607bcded3414960d2499"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> <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_data_schema.html#a4b095c1667e9607bcded3414960d2499">PartitionKeys</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr> |
| <tr class="memdesc:a4b095c1667e9607bcded3414960d2499"><td class="mdescLeft"> </td><td class="mdescRight">Get the list of partition key field names. <br /></td></tr> |
| <tr class="separator:a4b095c1667e9607bcded3414960d2499"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7e4c6e6f8fcf1e25af7f11ecedb55a25" id="r_a7e4c6e6f8fcf1e25af7f11ecedb55a25"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> <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_data_schema.html#a7e4c6e6f8fcf1e25af7f11ecedb55a25">BucketKeys</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr> |
| <tr class="memdesc:a7e4c6e6f8fcf1e25af7f11ecedb55a25"><td class="mdescLeft"> </td><td class="mdescRight">Get the list of bucket key field names used for bucketing. <br /></td></tr> |
| <tr class="separator:a7e4c6e6f8fcf1e25af7f11ecedb55a25"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae405e904e3fdda5b321c1b79680bfa11" id="r_ae405e904e3fdda5b321c1b79680bfa11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_schema.html#ae405e904e3fdda5b321c1b79680bfa11">NumBuckets</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr> |
| <tr class="memdesc:ae405e904e3fdda5b321c1b79680bfa11"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of buckets configured for this table. <br /></td></tr> |
| <tr class="separator:ae405e904e3fdda5b321c1b79680bfa11"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aecce4efaa7906e9692f1f8726ac21800" id="r_aecce4efaa7906e9692f1f8726ac21800"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_schema.html#aecce4efaa7906e9692f1f8726ac21800">HighestFieldId</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr> |
| <tr class="memdesc:aecce4efaa7906e9692f1f8726ac21800"><td class="mdescLeft"> </td><td class="mdescRight">Get the highest field id assigned in this schema. <br /></td></tr> |
| <tr class="separator:aecce4efaa7906e9692f1f8726ac21800"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab051b5eacb138fe803c0e4d5bea063b0" id="r_ab051b5eacb138fe803c0e4d5bea063b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> <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_data_schema.html#ab051b5eacb138fe803c0e4d5bea063b0">Options</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr> |
| <tr class="memdesc:ab051b5eacb138fe803c0e4d5bea063b0"><td class="mdescLeft"> </td><td class="mdescRight">Get the table-level options associated with this schema. <br /></td></tr> |
| <tr class="separator:ab051b5eacb138fe803c0e4d5bea063b0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classpaimon_1_1_schema"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classpaimon_1_1_schema')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classpaimon_1_1_schema.html">paimon::Schema</a></td></tr> |
| <tr class="memitem:a35d10462804c6538919a9f8fd597e35a inherit pub_methods_classpaimon_1_1_schema" id="r_a35d10462804c6538919a9f8fd597e35a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_schema.html#a35d10462804c6538919a9f8fd597e35a">~Schema</a> ()=<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">default</a></td></tr> |
| <tr class="separator:a35d10462804c6538919a9f8fd597e35a inherit pub_methods_classpaimon_1_1_schema"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adb2b80cff7d763a887df26d35004e61c inherit pub_methods_classpaimon_1_1_schema" id="r_adb2b80cff7d763a887df26d35004e61c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> <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_schema.html#adb2b80cff7d763a887df26d35004e61c">GetArrowSchema</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr> |
| <tr class="memdesc:adb2b80cff7d763a887df26d35004e61c inherit pub_methods_classpaimon_1_1_schema"><td class="mdescLeft"> </td><td class="mdescRight">Get the Arrow C schema representation of this table schema. <br /></td></tr> |
| <tr class="separator:adb2b80cff7d763a887df26d35004e61c inherit pub_methods_classpaimon_1_1_schema"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a77f0ee7822be63eb90369af843a11ee9 inherit pub_methods_classpaimon_1_1_schema" id="r_a77f0ee7822be63eb90369af843a11ee9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_schema.html#a77f0ee7822be63eb90369af843a11ee9">GetJsonSchema</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr> |
| <tr class="memdesc:a77f0ee7822be63eb90369af843a11ee9 inherit pub_methods_classpaimon_1_1_schema"><td class="mdescLeft"> </td><td class="mdescRight">Get the JSON schema representation of this table schema. <br /></td></tr> |
| <tr class="separator:a77f0ee7822be63eb90369af843a11ee9 inherit pub_methods_classpaimon_1_1_schema"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a86ebde8a32316069856601c05c9d1a28 inherit pub_methods_classpaimon_1_1_schema" id="r_a86ebde8a32316069856601c05c9d1a28"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_schema.html#a86ebde8a32316069856601c05c9d1a28">FieldNames</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr> |
| <tr class="memdesc:a86ebde8a32316069856601c05c9d1a28 inherit pub_methods_classpaimon_1_1_schema"><td class="mdescLeft"> </td><td class="mdescRight">Get the names of all fields in the table schema. <br /></td></tr> |
| <tr class="separator:a86ebde8a32316069856601c05c9d1a28 inherit pub_methods_classpaimon_1_1_schema"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8b1eb0e85de19532d17b67839331ee78 inherit pub_methods_classpaimon_1_1_schema" id="r_a8b1eb0e85de19532d17b67839331ee78"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< <a class="el" href="namespacepaimon.html#aa6dc6701f497b96add0b6d7a5d6497f7">FieldType</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_schema.html#a8b1eb0e85de19532d17b67839331ee78">GetFieldType</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string &field_name) <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr> |
| <tr class="memdesc:a8b1eb0e85de19532d17b67839331ee78 inherit pub_methods_classpaimon_1_1_schema"><td class="mdescLeft"> </td><td class="mdescRight">Get the type of specific field. <br /></td></tr> |
| <tr class="separator:a8b1eb0e85de19532d17b67839331ee78 inherit pub_methods_classpaimon_1_1_schema"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6a9fcbaa6b332a4104b2006fe59df200 inherit pub_methods_classpaimon_1_1_schema" id="r_a6a9fcbaa6b332a4104b2006fe59df200"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> std::optional< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_schema.html#a6a9fcbaa6b332a4104b2006fe59df200">Comment</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr> |
| <tr class="memdesc:a6a9fcbaa6b332a4104b2006fe59df200 inherit pub_methods_classpaimon_1_1_schema"><td class="mdescLeft"> </td><td class="mdescRight">Get an optional comment describing the schema object. <br /></td></tr> |
| <tr class="separator:a6a9fcbaa6b332a4104b2006fe59df200 inherit pub_methods_classpaimon_1_1_schema"><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 class="el" href="classpaimon_1_1_schema.html" title="This interface provides access to TableSchema-related information.">Schema</a> contract for data tables. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a7169a1e830563f4724af1460cac8bcac" name="a7169a1e830563f4724af1460cac8bcac"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7169a1e830563f4724af1460cac8bcac">◆ </a></span>~DataSchema()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">paimon::DataSchema::~DataSchema </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ad7dd005b78700caa79a60f7e7b0fb7ca" name="ad7dd005b78700caa79a60f7e7b0fb7ca"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad7dd005b78700caa79a60f7e7b0fb7ca">◆ </a></span>Id()</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">virtual</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int64_t</a> paimon::DataSchema::Id </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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the unique identifier of this table schema. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The schema id </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a79efe488acb2a9029bdaa4d1c294d70a" name="a79efe488acb2a9029bdaa4d1c294d70a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a79efe488acb2a9029bdaa4d1c294d70a">◆ </a></span>PrimaryKeys()</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">virtual</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::vector< std::string > & paimon::DataSchema::PrimaryKeys </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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the list of primary key field names. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A reference to the vector of primary key names; empty if no primary keys are defined. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a4b095c1667e9607bcded3414960d2499" name="a4b095c1667e9607bcded3414960d2499"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4b095c1667e9607bcded3414960d2499">◆ </a></span>PartitionKeys()</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">virtual</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::vector< std::string > & paimon::DataSchema::PartitionKeys </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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the list of partition key field names. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A reference to the vector of partition key names; empty if the table is not partitioned. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a7e4c6e6f8fcf1e25af7f11ecedb55a25" name="a7e4c6e6f8fcf1e25af7f11ecedb55a25"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7e4c6e6f8fcf1e25af7f11ecedb55a25">◆ </a></span>BucketKeys()</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">virtual</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::vector< std::string > & paimon::DataSchema::BucketKeys </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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the list of bucket key field names used for bucketing. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A reference to the vector of bucket key names. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ae405e904e3fdda5b321c1b79680bfa11" name="ae405e904e3fdda5b321c1b79680bfa11"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae405e904e3fdda5b321c1b79680bfa11">◆ </a></span>NumBuckets()</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">virtual</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> paimon::DataSchema::NumBuckets </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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the number of buckets configured for this table. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The number of buckets. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aecce4efaa7906e9692f1f8726ac21800" name="aecce4efaa7906e9692f1f8726ac21800"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aecce4efaa7906e9692f1f8726ac21800">◆ </a></span>HighestFieldId()</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">virtual</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> paimon::DataSchema::HighestFieldId </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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the highest field id assigned in this schema. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The maximum field id. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ab051b5eacb138fe803c0e4d5bea063b0" name="ab051b5eacb138fe803c0e4d5bea063b0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab051b5eacb138fe803c0e4d5bea063b0">◆ </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">virtual</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::map< std::string, std::string > & paimon::DataSchema::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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the table-level options associated with this schema. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A reference to the map of option key-value pairs (e.g., file format, filesystem). </dd></dl> |
| |
| </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/schema/<a class="el" href="schema_8h_source.html">schema.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> |
