blob: 9b8fdcbec60a774ebb9c5f2a47284645ec90d3fc [file]
<!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>iceberg-cpp: iceberg::TransactionContext 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">iceberg-cpp
</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&amp;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&amp;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"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1TransactionContext.html">TransactionContext</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classiceberg_1_1TransactionContext-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::TransactionContext Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Shared context between <a class="el" href="classiceberg_1_1Transaction.html" title="A transaction for performing multiple updates to a table.">Transaction</a> and <a class="el" href="classiceberg_1_1PendingUpdate.html" title="Base class for all kinds of table metadata updates.">PendingUpdate</a> instances.
<a href="classiceberg_1_1TransactionContext.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="transaction_8h_source.html">transaction.h</a>&gt;</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:a9c5a18adf5db1ef6c703a107a9f04dc4" id="r_a9c5a18adf5db1ef6c703a107a9f04dc4"><td class="memItemLeft" align="right" valign="top"><a id="a9c5a18adf5db1ef6c703a107a9f04dc4" name="a9c5a18adf5db1ef6c703a107a9f04dc4"></a>
const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>base</b> () const</td></tr>
<tr class="separator:a9c5a18adf5db1ef6c703a107a9f04dc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a835e78fad4967d46c87075b604b2e5d6" id="r_a835e78fad4967d46c87075b604b2e5d6"><td class="memItemLeft" align="right" valign="top"><a id="a835e78fad4967d46c87075b604b2e5d6" name="a835e78fad4967d46c87075b604b2e5d6"></a>
const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>current</b> () const</td></tr>
<tr class="separator:a835e78fad4967d46c87075b604b2e5d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e1c0012e9b773030e64fbf6776bb774" id="r_a1e1c0012e9b773030e64fbf6776bb774"><td class="memItemLeft" align="right" valign="top"><a id="a1e1c0012e9b773030e64fbf6776bb774" name="a1e1c0012e9b773030e64fbf6776bb774"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>MetadataFileLocation</b> (std::string_view filename) const</td></tr>
<tr class="separator:a1e1c0012e9b773030e64fbf6776bb774"><td class="memSeparator" colspan="2">&#160;</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:a789845c354422aa9aa56087519906ea7" id="r_a789845c354422aa9aa56087519906ea7"><td class="memItemLeft" align="right" valign="top"><a id="a789845c354422aa9aa56087519906ea7" name="a789845c354422aa9aa56087519906ea7"></a>
static Result&lt; std::shared_ptr&lt; <a class="el" href="classiceberg_1_1TransactionContext.html">TransactionContext</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Make</b> (std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Table.html">Table</a> &gt; table, TransactionKind kind)</td></tr>
<tr class="separator:a789845c354422aa9aa56087519906ea7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a37c32c0b305f948c5b8d613e593aa06d" id="r_a37c32c0b305f948c5b8d613e593aa06d"><td class="memItemLeft" align="right" valign="top"><a id="a37c32c0b305f948c5b8d613e593aa06d" name="a37c32c0b305f948c5b8d613e593aa06d"></a>
std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Table.html">Table</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>table</b></td></tr>
<tr class="separator:a37c32c0b305f948c5b8d613e593aa06d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee47f902cd1ac89116a5503fa7c0d48f" id="r_aee47f902cd1ac89116a5503fa7c0d48f"><td class="memItemLeft" align="right" valign="top"><a id="aee47f902cd1ac89116a5503fa7c0d48f" name="aee47f902cd1ac89116a5503fa7c0d48f"></a>
std::unique_ptr&lt; <a class="el" href="classiceberg_1_1TableMetadataBuilder.html">TableMetadataBuilder</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>metadata_builder</b></td></tr>
<tr class="separator:aee47f902cd1ac89116a5503fa7c0d48f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23cac60d3b83480db8aa29f293aa1552" id="r_a23cac60d3b83480db8aa29f293aa1552"><td class="memItemLeft" align="right" valign="top"><a id="a23cac60d3b83480db8aa29f293aa1552" name="a23cac60d3b83480db8aa29f293aa1552"></a>
TransactionKind&#160;</td><td class="memItemRight" valign="bottom"><b>kind</b></td></tr>
<tr class="separator:a23cac60d3b83480db8aa29f293aa1552"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea075d161b723a50c1c0871bc14d52b8" id="r_aea075d161b723a50c1c0871bc14d52b8"><td class="memItemLeft" align="right" valign="top"><a id="aea075d161b723a50c1c0871bc14d52b8" name="aea075d161b723a50c1c0871bc14d52b8"></a>
std::optional&lt; std::weak_ptr&lt; <a class="el" href="classiceberg_1_1Transaction.html">Transaction</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>transaction</b></td></tr>
<tr class="separator:aea075d161b723a50c1c0871bc14d52b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Shared context between <a class="el" href="classiceberg_1_1Transaction.html" title="A transaction for performing multiple updates to a table.">Transaction</a> and <a class="el" href="classiceberg_1_1PendingUpdate.html" title="Base class for all kinds of table metadata updates.">PendingUpdate</a> instances. </p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/<a class="el" href="transaction_8h_source.html">transaction.h</a></li>
<li>iceberg/<b>transaction.cc</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>