| <!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::CommitContextBuilder 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_commit_context_builder.html">CommitContextBuilder</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pri-attribs">Private Attributes</a> | |
| <a href="classpaimon_1_1_commit_context_builder-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">paimon::CommitContextBuilder Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code><a class="el" href="classpaimon_1_1_commit_context_builder.html" title="CommitContextBuilder used to build a CommitContext, has input validation.">CommitContextBuilder</a></code> used to build a <code><a class="el" href="classpaimon_1_1_commit_context.html" title="CommitContext is some configuration for commit operations.">CommitContext</a></code>, has input validation. |
| <a href="classpaimon_1_1_commit_context_builder.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="commit__context_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/commit_context.h</a>></code></p> |
| <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:ad11f5f4ebcc18251e3090c08d4f24261" id="r_ad11f5f4ebcc18251e3090c08d4f24261"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_context_builder.html#ad11f5f4ebcc18251e3090c08d4f24261">CommitContextBuilder</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">root_path</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string &commit_user)</td></tr> |
| <tr class="memdesc:ad11f5f4ebcc18251e3090c08d4f24261"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <code><a class="el" href="classpaimon_1_1_commit_context_builder.html" title="CommitContextBuilder used to build a CommitContext, has input validation.">CommitContextBuilder</a></code> with required parameters. <br /></td></tr> |
| <tr class="separator:ad11f5f4ebcc18251e3090c08d4f24261"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abab143e3062bc63aafada827545df899" id="r_abab143e3062bc63aafada827545df899"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_context_builder.html#abab143e3062bc63aafada827545df899">~CommitContextBuilder</a> ()</td></tr> |
| <tr class="separator:abab143e3062bc63aafada827545df899"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a62f56fb4e3c4362ba54c2a7ce3f74547" id="r_a62f56fb4e3c4362ba54c2a7ce3f74547"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_context_builder.html#a62f56fb4e3c4362ba54c2a7ce3f74547">SetOptions</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::map< std::string, std::string > &options)</td></tr> |
| <tr class="memdesc:a62f56fb4e3c4362ba54c2a7ce3f74547"><td class="mdescLeft"> </td><td class="mdescRight">Set a configuration options map to set some option entries which are not defined in the table schema or whose values you want to overwrite. <br /></td></tr> |
| <tr class="separator:a62f56fb4e3c4362ba54c2a7ce3f74547"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5bafddcf4b5bc55286542595576089ce" id="r_a5bafddcf4b5bc55286542595576089ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_context_builder.html#a5bafddcf4b5bc55286542595576089ce">AddOption</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">key</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string &value)</td></tr> |
| <tr class="memdesc:a5bafddcf4b5bc55286542595576089ce"><td class="mdescLeft"> </td><td class="mdescRight">Add a single configuration option which is not defined in the table schema or whose value you want to overwrite. <br /></td></tr> |
| <tr class="separator:a5bafddcf4b5bc55286542595576089ce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3af910fbc87d8990d7175951d4c91a1b" id="r_a3af910fbc87d8990d7175951d4c91a1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_context_builder.html#a3af910fbc87d8990d7175951d4c91a1b">IgnoreEmptyCommit</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">ignore_empty_commit</a>)</td></tr> |
| <tr class="memdesc:a3af910fbc87d8990d7175951d4c91a1b"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether to ignore empty commits (default is true). <br /></td></tr> |
| <tr class="separator:a3af910fbc87d8990d7175951d4c91a1b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae9b915cd4fd9a12757ca11239ec2fbc6" id="r_ae9b915cd4fd9a12757ca11239ec2fbc6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_context_builder.html#ae9b915cd4fd9a12757ca11239ec2fbc6">UseRESTCatalogCommit</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">use_rest_catalog_commit</a>)</td></tr> |
| <tr class="memdesc:ae9b915cd4fd9a12757ca11239ec2fbc6"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether to use REST catalog commit (default is false). <br /></td></tr> |
| <tr class="separator:ae9b915cd4fd9a12757ca11239ec2fbc6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afb03e59547889d68a13390d74ba08a36" id="r_afb03e59547889d68a13390d74ba08a36"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_context_builder.html#afb03e59547889d68a13390d74ba08a36">WithMemoryPool</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">memory_pool</a>)</td></tr> |
| <tr class="memdesc:afb03e59547889d68a13390d74ba08a36"><td class="mdescLeft"> </td><td class="mdescRight">Sets the memory pool to be used for memory allocation during commit operations. <br /></td></tr> |
| <tr class="separator:afb03e59547889d68a13390d74ba08a36"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a771dcadc571d4c4bfd8808850f324480" id="r_a771dcadc571d4c4bfd8808850f324480"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_context_builder.html#a771dcadc571d4c4bfd8808850f324480">WithExecutor</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_executor.html">Executor</a> > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">executor</a>)</td></tr> |
| <tr class="memdesc:a771dcadc571d4c4bfd8808850f324480"><td class="mdescLeft"> </td><td class="mdescRight">Sets the executor to be used for asynchronous operations during commit. <br /></td></tr> |
| <tr class="separator:a771dcadc571d4c4bfd8808850f324480"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab99028a7e7fcfaa4e7c2253c1a027fa0" id="r_ab99028a7e7fcfaa4e7c2253c1a027fa0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_context_builder.html#ab99028a7e7fcfaa4e7c2253c1a027fa0">WithFileSystem</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> > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">file_system</a>)</td></tr> |
| <tr class="memdesc:ab99028a7e7fcfaa4e7c2253c1a027fa0"><td class="mdescLeft"> </td><td class="mdescRight">Sets a custom file system instance to be used for all file operations in this commit context. <br /></td></tr> |
| <tr class="separator:ab99028a7e7fcfaa4e7c2253c1a027fa0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9dbc721d50c637585fc12e9dc141b72f" id="r_a9dbc721d50c637585fc12e9dc141b72f"><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="classpaimon_1_1_commit_context.html">CommitContext</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_context_builder.html#a9dbc721d50c637585fc12e9dc141b72f">Finish</a> ()</td></tr> |
| <tr class="memdesc:a9dbc721d50c637585fc12e9dc141b72f"><td class="mdescLeft"> </td><td class="mdescRight">Build and return a <code><a class="el" href="classpaimon_1_1_commit_context.html" title="CommitContext is some configuration for commit operations.">CommitContext</a></code> instance with input validation. <br /></td></tr> |
| <tr class="separator:a9dbc721d50c637585fc12e9dc141b72f"><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:ac0e88921ffe20853386496c696ebd860" id="r_ac0e88921ffe20853386496c696ebd860"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">Impl</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_context_builder.html#ac0e88921ffe20853386496c696ebd860">impl_</a></td></tr> |
| <tr class="separator:ac0e88921ffe20853386496c696ebd860"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><code><a class="el" href="classpaimon_1_1_commit_context_builder.html" title="CommitContextBuilder used to build a CommitContext, has input validation.">CommitContextBuilder</a></code> used to build a <code><a class="el" href="classpaimon_1_1_commit_context.html" title="CommitContext is some configuration for commit operations.">CommitContext</a></code>, has input validation. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="ad11f5f4ebcc18251e3090c08d4f24261" name="ad11f5f4ebcc18251e3090c08d4f24261"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad11f5f4ebcc18251e3090c08d4f24261">◆ </a></span>CommitContextBuilder()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">paimon::CommitContextBuilder::CommitContextBuilder </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & </td> |
| <td class="paramname"><em>root_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> std::string & </td> |
| <td class="paramname"><em>commit_user</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs a <code><a class="el" href="classpaimon_1_1_commit_context_builder.html" title="CommitContextBuilder used to build a CommitContext, has input validation.">CommitContextBuilder</a></code> with required parameters. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">root_path</td><td>The root path of the Paimon table. </td></tr> |
| <tr><td class="paramname">commit_user</td><td>The user identifier for the commit operation. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="abab143e3062bc63aafada827545df899" name="abab143e3062bc63aafada827545df899"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abab143e3062bc63aafada827545df899">◆ </a></span>~CommitContextBuilder()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">paimon::CommitContextBuilder::~CommitContextBuilder </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a62f56fb4e3c4362ba54c2a7ce3f74547" name="a62f56fb4e3c4362ba54c2a7ce3f74547"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a62f56fb4e3c4362ba54c2a7ce3f74547">◆ </a></span>SetOptions()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & paimon::CommitContextBuilder::SetOptions </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><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set a configuration options map to set some option entries which are not defined in the table schema or whose values you want to overwrite. </p> |
| <dl class="section note"><dt>Note</dt><dd>The options map will clear the options added by <code><a class="el" href="classpaimon_1_1_commit_context_builder.html#a5bafddcf4b5bc55286542595576089ce" title="Add a single configuration option which is not defined in the table schema or whose value you want to...">AddOption()</a></code> before. </dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">options</td><td>The configuration options map. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Reference to this builder for method chaining. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a5bafddcf4b5bc55286542595576089ce" name="a5bafddcf4b5bc55286542595576089ce"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5bafddcf4b5bc55286542595576089ce">◆ </a></span>AddOption()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & paimon::CommitContextBuilder::AddOption </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::string & </td> |
| <td class="paramname"><em>key</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>value</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add a single configuration option which is not defined in the table schema or whose value you want to overwrite. </p> |
| <p>If you want to add multiple options, call <code><a class="el" href="classpaimon_1_1_commit_context_builder.html#a5bafddcf4b5bc55286542595576089ce" title="Add a single configuration option which is not defined in the table schema or whose value you want to...">AddOption()</a></code> multiple times or use <code><a class="el" href="classpaimon_1_1_commit_context_builder.html#a62f56fb4e3c4362ba54c2a7ce3f74547" title="Set a configuration options map to set some option entries which are not defined in the table schema ...">SetOptions()</a></code> instead. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">key</td><td>The option key. </td></tr> |
| <tr><td class="paramname">value</td><td>The option value. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Reference to this builder for method chaining. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a3af910fbc87d8990d7175951d4c91a1b" name="a3af910fbc87d8990d7175951d4c91a1b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3af910fbc87d8990d7175951d4c91a1b">◆ </a></span>IgnoreEmptyCommit()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & paimon::CommitContextBuilder::IgnoreEmptyCommit </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> </td> |
| <td class="paramname"><em>ignore_empty_commit</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets whether to ignore empty commits (default is true). </p> |
| <p>When set to true, commits that don't contain any actual data changes will be ignored. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ignore_empty_commit</td><td>True to ignore empty commits, false otherwise. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Reference to this builder for method chaining. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ae9b915cd4fd9a12757ca11239ec2fbc6" name="ae9b915cd4fd9a12757ca11239ec2fbc6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae9b915cd4fd9a12757ca11239ec2fbc6">◆ </a></span>UseRESTCatalogCommit()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & paimon::CommitContextBuilder::UseRESTCatalogCommit </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> </td> |
| <td class="paramname"><em>use_rest_catalog_commit</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets whether to use REST catalog commit (default is false). </p> |
| <dl class="section note"><dt>Note</dt><dd>Temporary interface, will be removed in the future. </dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">use_rest_catalog_commit</td><td>True to use REST catalog commit, false otherwise. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Reference to this builder for method chaining. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="afb03e59547889d68a13390d74ba08a36" name="afb03e59547889d68a13390d74ba08a36"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afb03e59547889d68a13390d74ba08a36">◆ </a></span>WithMemoryPool()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & paimon::CommitContextBuilder::WithMemoryPool </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_memory_pool.html">MemoryPool</a> > & </td> |
| <td class="paramname"><em>memory_pool</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the memory pool to be used for memory allocation during commit operations. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">memory_pool</td><td>Shared pointer to the memory pool instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Reference to this builder for method chaining. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a771dcadc571d4c4bfd8808850f324480" name="a771dcadc571d4c4bfd8808850f324480"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a771dcadc571d4c4bfd8808850f324480">◆ </a></span>WithExecutor()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & paimon::CommitContextBuilder::WithExecutor </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_executor.html">Executor</a> > & </td> |
| <td class="paramname"><em>executor</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the executor to be used for asynchronous operations during commit. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">executor</td><td>Shared pointer to the executor instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Reference to this builder for method chaining. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ab99028a7e7fcfaa4e7c2253c1a027fa0" name="ab99028a7e7fcfaa4e7c2253c1a027fa0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab99028a7e7fcfaa4e7c2253c1a027fa0">◆ </a></span>WithFileSystem()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_commit_context_builder.html">CommitContextBuilder</a> & paimon::CommitContextBuilder::WithFileSystem </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><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets a custom file system instance to be used for all file operations in this commit context. </p> |
| <p>This bypasses the global file system registry and uses the provided implementation directly.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">file_system</td><td>The file system to use. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Reference to this builder for method chaining. </dd></dl> |
| <dl class="section note"><dt>Note</dt><dd>If not set, use default file system (configured in <code><a class="el" href="structpaimon_1_1_options.html#a91cdf2a3a8110ea53a0d9197d38cfae3" title=""file-system" - Specify the file system.">Options::FILE_SYSTEM</a></code>) </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a9dbc721d50c637585fc12e9dc141b72f" name="a9dbc721d50c637585fc12e9dc141b72f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9dbc721d50c637585fc12e9dc141b72f">◆ </a></span>Finish()</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="classpaimon_1_1_commit_context.html">CommitContext</a> > > paimon::CommitContextBuilder::Finish </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Build and return a <code><a class="el" href="classpaimon_1_1_commit_context.html" title="CommitContext is some configuration for commit operations.">CommitContext</a></code> instance with input validation. </p> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classpaimon_1_1_result.html" title="A Result<T> object holds either a value of type T or a Status object explaining why such a value is n...">Result</a> containing the constructed <code><a class="el" href="classpaimon_1_1_commit_context.html" title="CommitContext is some configuration for commit operations.">CommitContext</a></code> or an error status. </dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="ac0e88921ffe20853386496c696ebd860" name="ac0e88921ffe20853386496c696ebd860"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac0e88921ffe20853386496c696ebd860">◆ </a></span>impl_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::unique_ptr<<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">Impl</a>> paimon::CommitContextBuilder::impl_</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/<a class="el" href="commit__context_8h_source.html">commit_context.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> |
