| <!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::sql Namespace 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="namespaceiceberg_1_1sql.html">sql</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"><div class="title">iceberg::sql Namespace Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>SQL catalog APIs. |
| <a href="namespaceiceberg_1_1sql.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1sql_1_1CatalogStore.html">CatalogStore</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Semantic, driver-agnostic storage interface for the SQL catalog. <a href="classiceberg_1_1sql_1_1CatalogStore.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1sql_1_1CatalogStoreOptions.html">CatalogStoreOptions</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Connection parameters used to construct a built-in <code><a class="el" href="classiceberg_1_1sql_1_1CatalogStore.html" title="Semantic, driver-agnostic storage interface for the SQL catalog.">CatalogStore</a></code>. <a href="structiceberg_1_1sql_1_1CatalogStoreOptions.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1sql_1_1NamespaceProperty.html">NamespaceProperty</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A namespace property row. <a href="structiceberg_1_1sql_1_1NamespaceProperty.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1sql_1_1SqlCatalog.html">SqlCatalog</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">SQL-backed Iceberg catalog. <a href="classiceberg_1_1sql_1_1SqlCatalog.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1sql_1_1SqlCatalogConfig.html">SqlCatalogConfig</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Configuration for the SQL catalog. <a href="structiceberg_1_1sql_1_1SqlCatalogConfig.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:adf05d65d0b4ba42b506ec295efa0f43e" id="r_adf05d65d0b4ba42b506ec295efa0f43e"><td class="memItemLeft" align="right" valign="top">ICEBERG_SQL_CATALOG_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::shared_ptr< <a class="el" href="classiceberg_1_1sql_1_1CatalogStore.html">CatalogStore</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1sql.html#adf05d65d0b4ba42b506ec295efa0f43e">MakeSqliteCatalogStore</a> (const <a class="el" href="structiceberg_1_1sql_1_1CatalogStoreOptions.html">CatalogStoreOptions</a> &options)</td></tr> |
| <tr class="memdesc:adf05d65d0b4ba42b506ec295efa0f43e"><td class="mdescLeft"> </td><td class="mdescRight">Build the built-in SQLite catalog store (sqlpp23 + SQLite3). <br /></td></tr> |
| <tr class="separator:adf05d65d0b4ba42b506ec295efa0f43e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af2c675c64474ef7068ab0b5ade651743" id="r_af2c675c64474ef7068ab0b5ade651743"><td class="memItemLeft" align="right" valign="top">ICEBERG_SQL_CATALOG_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::shared_ptr< <a class="el" href="classiceberg_1_1sql_1_1CatalogStore.html">CatalogStore</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1sql.html#af2c675c64474ef7068ab0b5ade651743">MakePostgreSqlCatalogStore</a> (const <a class="el" href="structiceberg_1_1sql_1_1CatalogStoreOptions.html">CatalogStoreOptions</a> &options)</td></tr> |
| <tr class="memdesc:af2c675c64474ef7068ab0b5ade651743"><td class="mdescLeft"> </td><td class="mdescRight">Build the built-in PostgreSQL catalog store (sqlpp23 + libpq). <br /></td></tr> |
| <tr class="separator:af2c675c64474ef7068ab0b5ade651743"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abfc2441c2dbabf47d15ed25df775f7d4" id="r_abfc2441c2dbabf47d15ed25df775f7d4"><td class="memItemLeft" align="right" valign="top">ICEBERG_SQL_CATALOG_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::shared_ptr< <a class="el" href="classiceberg_1_1sql_1_1CatalogStore.html">CatalogStore</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1sql.html#abfc2441c2dbabf47d15ed25df775f7d4">MakeMySqlCatalogStore</a> (const <a class="el" href="structiceberg_1_1sql_1_1CatalogStoreOptions.html">CatalogStoreOptions</a> &options)</td></tr> |
| <tr class="memdesc:abfc2441c2dbabf47d15ed25df775f7d4"><td class="mdescLeft"> </td><td class="mdescRight">Build the built-in MySQL catalog store (sqlpp23 + libmysqlclient). <br /></td></tr> |
| <tr class="separator:abfc2441c2dbabf47d15ed25df775f7d4"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>SQL catalog APIs. </p> |
| </div><h2 class="groupheader">Function Documentation</h2> |
| <a id="abfc2441c2dbabf47d15ed25df775f7d4" name="abfc2441c2dbabf47d15ed25df775f7d4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abfc2441c2dbabf47d15ed25df775f7d4">◆ </a></span>MakeMySqlCatalogStore()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ICEBERG_SQL_CATALOG_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::shared_ptr< <a class="el" href="classiceberg_1_1sql_1_1CatalogStore.html">CatalogStore</a> > > iceberg::sql::MakeMySqlCatalogStore </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structiceberg_1_1sql_1_1CatalogStoreOptions.html">CatalogStoreOptions</a> & </td> |
| <td class="paramname"><em>options</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Build the built-in MySQL catalog store (sqlpp23 + libmysqlclient). </p> |
| <p><code>options.uri</code> is parsed as <code>[scheme://][user[:password]@]host[:port][/database]</code>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">options</td><td>Store connection options. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A catalog store instance, or ErrorKind::kNotSupported if the MySQL connector was not built. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="af2c675c64474ef7068ab0b5ade651743" name="af2c675c64474ef7068ab0b5ade651743"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af2c675c64474ef7068ab0b5ade651743">◆ </a></span>MakePostgreSqlCatalogStore()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ICEBERG_SQL_CATALOG_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::shared_ptr< <a class="el" href="classiceberg_1_1sql_1_1CatalogStore.html">CatalogStore</a> > > iceberg::sql::MakePostgreSqlCatalogStore </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structiceberg_1_1sql_1_1CatalogStoreOptions.html">CatalogStoreOptions</a> & </td> |
| <td class="paramname"><em>options</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Build the built-in PostgreSQL catalog store (sqlpp23 + libpq). </p> |
| <p><code>options.uri</code> is parsed as <code>[scheme://][user[:password]@]host[:port][/database]</code>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">options</td><td>Store connection options. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A catalog store instance, or ErrorKind::kNotSupported if the PostgreSQL connector was not built. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="adf05d65d0b4ba42b506ec295efa0f43e" name="adf05d65d0b4ba42b506ec295efa0f43e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adf05d65d0b4ba42b506ec295efa0f43e">◆ </a></span>MakeSqliteCatalogStore()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ICEBERG_SQL_CATALOG_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::shared_ptr< <a class="el" href="classiceberg_1_1sql_1_1CatalogStore.html">CatalogStore</a> > > iceberg::sql::MakeSqliteCatalogStore </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structiceberg_1_1sql_1_1CatalogStoreOptions.html">CatalogStoreOptions</a> & </td> |
| <td class="paramname"><em>options</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Build the built-in SQLite catalog store (sqlpp23 + SQLite3). </p> |
| <p><code>options.uri</code> is the SQLite database file path, or ":memory:".</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">options</td><td>Store connection options. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A catalog store instance, or ErrorKind::kNotSupported if the SQLite connector was not built. </dd></dl> |
| |
| </div> |
| </div> |
| </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> |
