Google Git
Sign in
apache/paimon-cpp/refs/heads/gh-pages/./apidoc/html/classpaimon_1_1_database.html
blob: 4fa84449b19fdf2f344a6341802059490db3b07c [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>Paimon-cpp: paimon::Database 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&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"><a class="el" href="namespacepaimon.html">paimon</a></li><li class="navelem"><a class="el" href="classpaimon_1_1_database.html">Database</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classpaimon_1_1_database-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">paimon::Database Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Interface of a database in a catalog.
<a href="classpaimon_1_1_database.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="database_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/catalog/database.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:a804a54b5b41ca7b66ca2c68c5c1b4b6e" id="r_a804a54b5b41ca7b66ca2c68c5c1b4b6e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_database.html#a804a54b5b41ca7b66ca2c68c5c1b4b6e">~Database</a> ()=<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">default</a></td></tr>
<tr class="separator:a804a54b5b41ca7b66ca2c68c5c1b4b6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae666191f13fd5e9d3c89547c9c01933f" id="r_ae666191f13fd5e9d3c89547c9c01933f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_database.html#ae666191f13fd5e9d3c89547c9c01933f">Name</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr>
<tr class="memdesc:ae666191f13fd5e9d3c89547c9c01933f"><td class="mdescLeft">&#160;</td><td class="mdescRight">================== <a class="el" href="classpaimon_1_1_database.html" title="Interface of a database in a catalog.">Database</a> Metadata ===================== <br /></td></tr>
<tr class="separator:ae666191f13fd5e9d3c89547c9c01933f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac55315cb1eb38dfe358243a9431c6e40" id="r_ac55315cb1eb38dfe358243a9431c6e40"><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&lt; std::string, std::string &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_database.html#ac55315cb1eb38dfe358243a9431c6e40">Options</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr>
<tr class="memdesc:ac55315cb1eb38dfe358243a9431c6e40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the database-level options associated with this database. <br /></td></tr>
<tr class="separator:ac55315cb1eb38dfe358243a9431c6e40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f204f0f5e9b0702150beb0ef419dd77" id="r_a3f204f0f5e9b0702150beb0ef419dd77"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> std::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_database.html#a3f204f0f5e9b0702150beb0ef419dd77">Comment</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr>
<tr class="memdesc:a3f204f0f5e9b0702150beb0ef419dd77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get an optional comment describing the database. <br /></td></tr>
<tr class="separator:a3f204f0f5e9b0702150beb0ef419dd77"><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>Interface of a database in a catalog. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a804a54b5b41ca7b66ca2c68c5c1b4b6e" name="a804a54b5b41ca7b66ca2c68c5c1b4b6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a804a54b5b41ca7b66ca2c68c5c1b4b6e">&#9670;&#160;</a></span>~Database()</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> paimon::Database::~Database </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</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="ae666191f13fd5e9d3c89547c9c01933f" name="ae666191f13fd5e9d3c89547c9c01933f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae666191f13fd5e9d3c89547c9c01933f">&#9670;&#160;</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"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> std::string paimon::Database::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>================== <a class="el" href="classpaimon_1_1_database.html" title="Interface of a database in a catalog.">Database</a> Metadata ===================== </p>
<p>A name to identify this database. </p>
</div>
</div>
<a id="ac55315cb1eb38dfe358243a9431c6e40" name="ac55315cb1eb38dfe358243a9431c6e40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac55315cb1eb38dfe358243a9431c6e40">&#9670;&#160;</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&lt; std::string, std::string &gt; &amp; paimon::Database::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 database-level options associated with this database. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structpaimon_1_1_options.html" title="Configuration options and constants for Paimon table operations.">Options</a> </dd></dl>
</div>
</div>
<a id="a3f204f0f5e9b0702150beb0ef419dd77" name="a3f204f0f5e9b0702150beb0ef419dd77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f204f0f5e9b0702150beb0ef419dd77">&#9670;&#160;</a></span>Comment()</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> std::optional&lt; std::string &gt; paimon::Database::Comment </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 an optional comment describing the database. </p>
<dl class="section return"><dt>Returns</dt><dd>The database comment if set, or std::nullopt otherwise. </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/catalog/<a class="el" href="database_8h_source.html">database.h</a></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>