blob: f19a2328e5f0491cecd8861ed4e1fbdbedaf87d3 [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::FileIORegistry 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"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1FileIORegistry.html">FileIORegistry</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classiceberg_1_1FileIORegistry-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::FileIORegistry Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Registry for <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> implementations.
<a href="classiceberg_1_1FileIORegistry.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="file__io__registry_8h_source.html">file_io_registry.h</a>&gt;</code></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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1FileIORegistry_1_1Factory.html">Factory</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structiceberg_1_1FileIORegistry_1_1Factory.html" title="Factory for explicit loading and optional scheme-based routing.">Factory</a> for explicit loading and optional scheme-based routing. <a href="structiceberg_1_1FileIORegistry_1_1Factory.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a26c7a0a91db864955b1883fac8bc8193" id="r_a26c7a0a91db864955b1883fac8bc8193"><td class="memItemLeft" align="right" valign="top"><a id="a26c7a0a91db864955b1883fac8bc8193" name="a26c7a0a91db864955b1883fac8bc8193"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>Properties</b> = std::unordered_map&lt; std::string, std::string &gt;</td></tr>
<tr class="separator:a26c7a0a91db864955b1883fac8bc8193"><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:a4bf67f99304a412e535fcee9d71b1e67" id="r_a4bf67f99304a412e535fcee9d71b1e67"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileIORegistry.html#a4bf67f99304a412e535fcee9d71b1e67">Register</a> (std::string name, <a class="el" href="structiceberg_1_1FileIORegistry_1_1Factory.html">Factory</a> factory)</td></tr>
<tr class="memdesc:a4bf67f99304a412e535fcee9d71b1e67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> factory under the given name. <br /></td></tr>
<tr class="separator:a4bf67f99304a412e535fcee9d71b1e67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e9f6cbd63968094e1ddd8f07be32230" id="r_a6e9f6cbd63968094e1ddd8f07be32230"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileIORegistry.html#a6e9f6cbd63968094e1ddd8f07be32230">Load</a> (std::string_view name, const Properties &amp;properties)</td></tr>
<tr class="memdesc:a6e9f6cbd63968094e1ddd8f07be32230"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load a <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> implementation by name. <br /></td></tr>
<tr class="separator:a6e9f6cbd63968094e1ddd8f07be32230"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd4cd6e91e17fe93650461b112f8be6a" id="r_afd4cd6e91e17fe93650461b112f8be6a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileIORegistry.html#afd4cd6e91e17fe93650461b112f8be6a">Resolve</a> (std::string_view scheme)</td></tr>
<tr class="memdesc:afd4cd6e91e17fe93650461b112f8be6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the last registered factory accepting <code>scheme</code>. <br /></td></tr>
<tr class="separator:afd4cd6e91e17fe93650461b112f8be6a"><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-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:aabbf80821dd83ffea77021d230a07ee1" id="r_aabbf80821dd83ffea77021d230a07ee1"><td class="memItemLeft" align="right" valign="top"><a id="aabbf80821dd83ffea77021d230a07ee1" name="aabbf80821dd83ffea77021d230a07ee1"></a>
static constexpr std::string_view&#160;</td><td class="memItemRight" valign="bottom"><b>kArrowLocalFileIO</b> = &quot;arrow-fs-local&quot;</td></tr>
<tr class="separator:aabbf80821dd83ffea77021d230a07ee1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9f2f52962644015b00fbeea83ed1703" id="r_ab9f2f52962644015b00fbeea83ed1703"><td class="memItemLeft" align="right" valign="top"><a id="ab9f2f52962644015b00fbeea83ed1703" name="ab9f2f52962644015b00fbeea83ed1703"></a>
static constexpr std::string_view&#160;</td><td class="memItemRight" valign="bottom"><b>kArrowS3FileIO</b> = &quot;arrow-fs-s3&quot;</td></tr>
<tr class="separator:ab9f2f52962644015b00fbeea83ed1703"><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>Registry for <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> implementations. </p>
<p>Provides a mechanism to register and load <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> implementations by name. This allows the REST catalog (and others) to resolve <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> implementations at runtime based on configuration properties like "io-impl". Registrations must be completed before registry consumers are created. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6e9f6cbd63968094e1ddd8f07be32230" name="a6e9f6cbd63968094e1ddd8f07be32230"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e9f6cbd63968094e1ddd8f07be32230">&#9670;&#160;</a></span>Load()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &gt; &gt; iceberg::FileIORegistry::Load </td>
<td>(</td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Properties &amp;&#160;</td>
<td class="paramname"><em>properties</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Load a <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> implementation by name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The implementation name to look up. </td></tr>
<tr><td class="paramname">properties</td><td>Configuration properties to pass to the factory. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A unique_ptr to the <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> instance, or an error if not found. </dd></dl>
</div>
</div>
<a id="a4bf67f99304a412e535fcee9d71b1e67" name="a4bf67f99304a412e535fcee9d71b1e67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bf67f99304a412e535fcee9d71b1e67">&#9670;&#160;</a></span>Register()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void iceberg::FileIORegistry::Register </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiceberg_1_1FileIORegistry_1_1Factory.html">Factory</a>&#160;</td>
<td class="paramname"><em>factory</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Register a <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> factory under the given name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The implementation name (e.g., "local", "s3") </td></tr>
<tr><td class="paramname">factory</td><td>The factory function that creates the <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afd4cd6e91e17fe93650461b112f8be6a" name="afd4cd6e91e17fe93650461b112f8be6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd4cd6e91e17fe93650461b112f8be6a">&#9670;&#160;</a></span>Resolve()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::string &gt; iceberg::FileIORegistry::Resolve </td>
<td>(</td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>scheme</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the last registered factory accepting <code>scheme</code>. </p>
<p>Matching is case-insensitive; registration order determines precedence. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/<a class="el" href="file__io__registry_8h_source.html">file_io_registry.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>