| <!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::SessionCatalog 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&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="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1SessionCatalog.html">SessionCatalog</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classiceberg_1_1SessionCatalog-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::SessionCatalog Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Factory interface for creating context-bound catalog views. |
| <a href="classiceberg_1_1SessionCatalog.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="session__catalog_8h_source.html">session_catalog.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::SessionCatalog:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1SessionCatalog.png" usemap="#iceberg::SessionCatalog_map" alt=""/> |
| <map id="iceberg::SessionCatalog_map" name="iceberg::SessionCatalog_map"> |
| <area href="classiceberg_1_1rest_1_1RestCatalog.html" title="Session-aware REST catalog root." alt="iceberg::rest::RestCatalog" shape="rect" coords="0,56,155,80"/> |
| </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:a11d686ff03b545d6e4c7247c0c986ea7" id="r_a11d686ff03b545d6e4c7247c0c986ea7"><td class="memItemLeft" align="right" valign="top">virtual std::string_view </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SessionCatalog.html#a11d686ff03b545d6e4c7247c0c986ea7">name</a> () const =0</td></tr> |
| <tr class="memdesc:a11d686ff03b545d6e4c7247c0c986ea7"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classiceberg_1_1Catalog.html" title="A Catalog API for table create, drop, and load operations.">Catalog</a> name. <br /></td></tr> |
| <tr class="separator:a11d686ff03b545d6e4c7247c0c986ea7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9ea90d84eedc5c556eed4f9510f301eb" id="r_a9ea90d84eedc5c556eed4f9510f301eb"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::shared_ptr< <a class="el" href="classiceberg_1_1Catalog.html">Catalog</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SessionCatalog.html#a9ea90d84eedc5c556eed4f9510f301eb">AsCatalog</a> ()=0</td></tr> |
| <tr class="memdesc:a9ea90d84eedc5c556eed4f9510f301eb"><td class="mdescLeft"> </td><td class="mdescRight">Return a <code><a class="el" href="classiceberg_1_1Catalog.html" title="A Catalog API for table create, drop, and load operations.">Catalog</a></code> view bound to the catalog's default session. <br /></td></tr> |
| <tr class="separator:a9ea90d84eedc5c556eed4f9510f301eb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad9f9e4fdd90656239a2d850346d2e8c0" id="r_ad9f9e4fdd90656239a2d850346d2e8c0"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::shared_ptr< <a class="el" href="classiceberg_1_1Catalog.html">Catalog</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SessionCatalog.html#ad9f9e4fdd90656239a2d850346d2e8c0">WithContext</a> (<a class="el" href="structiceberg_1_1SessionContext.html">SessionContext</a> context)=0</td></tr> |
| <tr class="memdesc:ad9f9e4fdd90656239a2d850346d2e8c0"><td class="mdescLeft"> </td><td class="mdescRight">Return a <code><a class="el" href="classiceberg_1_1Catalog.html" title="A Catalog API for table create, drop, and load operations.">Catalog</a></code> view bound to the supplied session context. <br /></td></tr> |
| <tr class="separator:ad9f9e4fdd90656239a2d850346d2e8c0"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Factory interface for creating context-bound catalog views. </p> |
| <p><code><a class="el" href="classiceberg_1_1SessionCatalog.html" title="Factory interface for creating context-bound catalog views.">SessionCatalog</a></code> is not a replacement for <code><a class="el" href="classiceberg_1_1Catalog.html" title="A Catalog API for table create, drop, and load operations.">Catalog</a></code> and does not duplicate table or namespace operations. It is a small root interface for catalogs that can bind the standard <code><a class="el" href="classiceberg_1_1Catalog.html" title="A Catalog API for table create, drop, and load operations.">Catalog</a></code> API to a <code><a class="el" href="structiceberg_1_1SessionContext.html" title="Session state used to bind catalog operations to a caller context.">SessionContext</a></code>.</p> |
| <p>Call <code><a class="el" href="classiceberg_1_1SessionCatalog.html#a9ea90d84eedc5c556eed4f9510f301eb" title="Return a Catalog view bound to the catalog's default session.">AsCatalog()</a></code> for the catalog's default session, or <code><a class="el" href="classiceberg_1_1SessionCatalog.html#ad9f9e4fdd90656239a2d850346d2e8c0" title="Return a Catalog view bound to the supplied session context.">WithContext()</a></code> when the caller has an explicit session identity, properties, or credentials. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a9ea90d84eedc5c556eed4f9510f301eb" name="a9ea90d84eedc5c556eed4f9510f301eb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9ea90d84eedc5c556eed4f9510f301eb">◆ </a></span>AsCatalog()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::shared_ptr< <a class="el" href="classiceberg_1_1Catalog.html">Catalog</a> > > iceberg::SessionCatalog::AsCatalog </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></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>Return a <code><a class="el" href="classiceberg_1_1Catalog.html" title="A Catalog API for table create, drop, and load operations.">Catalog</a></code> view bound to the catalog's default session. </p> |
| <p>Implementations may cache and return the same default catalog view on repeated calls. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1rest_1_1RestCatalog.html#aa98124c18e4e91a6a6cf14f63235c69a">iceberg::rest::RestCatalog</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a11d686ff03b545d6e4c7247c0c986ea7" name="a11d686ff03b545d6e4c7247c0c986ea7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a11d686ff03b545d6e4c7247c0c986ea7">◆ </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">virtual std::string_view iceberg::SessionCatalog::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="classiceberg_1_1Catalog.html" title="A Catalog API for table create, drop, and load operations.">Catalog</a> name. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1rest_1_1RestCatalog.html#aa3a42d4824766f9b5b1269894997463b">iceberg::rest::RestCatalog</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ad9f9e4fdd90656239a2d850346d2e8c0" name="ad9f9e4fdd90656239a2d850346d2e8c0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad9f9e4fdd90656239a2d850346d2e8c0">◆ </a></span>WithContext()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::shared_ptr< <a class="el" href="classiceberg_1_1Catalog.html">Catalog</a> > > iceberg::SessionCatalog::WithContext </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structiceberg_1_1SessionContext.html">SessionContext</a> </td> |
| <td class="paramname"><em>context</em></td><td>)</td> |
| <td></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>Return a <code><a class="el" href="classiceberg_1_1Catalog.html" title="A Catalog API for table create, drop, and load operations.">Catalog</a></code> view bound to the supplied session context. </p> |
| <p>Implementations should reject invalid contexts, such as an empty <code><a class="el" href="structiceberg_1_1SessionContext.html#a2142195dbea1438bbccec17d8c0927c4" title="Unique session identifier. Explicit contexts must provide a non-empty ID.">SessionContext::session_id</a></code>. Returned catalog views use the normal <code><a class="el" href="classiceberg_1_1Catalog.html" title="A Catalog API for table create, drop, and load operations.">Catalog</a></code> interface for all table and namespace operations. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1rest_1_1RestCatalog.html#a973e796ea1c56de85c678ac53da83a99">iceberg::rest::RestCatalog</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>iceberg/catalog/<a class="el" href="session__catalog_8h_source.html">session_catalog.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> |
