mkdocs/docs/api/arrow__io__util_8h.html - iceberg-cpp - Git at Google

 <!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/arrow/arrow_io_util.h File 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="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_b7cf026d9e3f55cae42b23722c36a1cb.html">arrow</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#namespaces">Namespaces</a> &#124;
 <a href="#func-members">Functions</a>  </div>
   <div class="headertitle"><div class="title">arrow_io_util.h File Reference</div></div>
 </div><!--header-->
 <div class="contents">

 <p>Provide helpers to create Arrow-backed FileIO implementations.
 <a href="#details">More...</a></p>
 <div class="textblock"><code>#include &lt;memory&gt;</code><br />
 <code>#include &lt;string&gt;</code><br />
 <code>#include &lt;unordered_map&gt;</code><br />
 <code>#include &quot;<a class="el" href="file__io_8h_source.html">iceberg/file_io.h</a>&quot;</code><br />
 <code>#include &quot;<a class="el" href="iceberg__bundle__export_8h_source.html">iceberg/iceberg_bundle_export.h</a>&quot;</code><br />
 <code>#include &quot;<a class="el" href="result_8h_source.html">iceberg/result.h</a>&quot;</code><br />
 </div>
 <p><a href="arrow__io__util_8h_source.html">Go to the source code of this file.</a></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
 Namespaces</h2></td></tr>
 <tr class="memitem:namespaceiceberg" id="r_namespaceiceberg"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr>
 <tr class="memdesc:namespaceiceberg"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core Apache Iceberg C++ APIs. <br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:namespaceiceberg_1_1arrow" id="r_namespaceiceberg_1_1arrow"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1arrow.html">iceberg::arrow</a></td></tr>
 <tr class="memdesc:namespaceiceberg_1_1arrow"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arrow-backed IO and data conversion APIs. <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="func-members" name="func-members"></a>
 Functions</h2></td></tr>
 <tr class="memitem:ab7a1e810bcc704fe597945b32a96d894" id="r_ab7a1e810bcc704fe597945b32a96d894"><td class="memItemLeft" align="right" valign="top"><a id="ab7a1e810bcc704fe597945b32a96d894" name="ab7a1e810bcc704fe597945b32a96d894"></a>
 ICEBERG_BUNDLE_EXPORT std::unique_ptr&lt; <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::arrow::MakeMockFileIO</b> ()</td></tr>
 <tr class="separator:ab7a1e810bcc704fe597945b32a96d894"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ab2aa5166871ebfd494a4bda12d751e79" id="r_ab2aa5166871ebfd494a4bda12d751e79"><td class="memItemLeft" align="right" valign="top"><a id="ab2aa5166871ebfd494a4bda12d751e79" name="ab2aa5166871ebfd494a4bda12d751e79"></a>
 ICEBERG_BUNDLE_EXPORT std::unique_ptr&lt; <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::arrow::MakeLocalFileIO</b> ()</td></tr>
 <tr class="separator:ab2aa5166871ebfd494a4bda12d751e79"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aa4c684c9dab81759ea6d8cd322894af3" id="r_aa4c684c9dab81759ea6d8cd322894af3"><td class="memItemLeft" align="right" valign="top">ICEBERG_BUNDLE_EXPORT <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="namespaceiceberg_1_1arrow.html#aa4c684c9dab81759ea6d8cd322894af3">iceberg::arrow::MakeS3FileIO</a> (const std::unordered_map&lt; std::string, std::string &gt; &amp;properties={})</td></tr>
 <tr class="memdesc:aa4c684c9dab81759ea6d8cd322894af3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an S3 <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> backed by Arrow's S3FileSystem.  <br /></td></tr>
 <tr class="separator:aa4c684c9dab81759ea6d8cd322894af3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:afe534529616b1e1b86fb707c29390931" id="r_afe534529616b1e1b86fb707c29390931"><td class="memItemLeft" align="right" valign="top">ICEBERG_BUNDLE_EXPORT Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1arrow.html#afe534529616b1e1b86fb707c29390931">iceberg::arrow::FinalizeS3</a> ()</td></tr>
 <tr class="memdesc:afe534529616b1e1b86fb707c29390931"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finalize (clean up) the Arrow S3 subsystem.  <br /></td></tr>
 <tr class="separator:afe534529616b1e1b86fb707c29390931"><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>Provide helpers to create Arrow-backed FileIO implementations. </p>
 </div></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>
	<!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/arrow/arrow_io_util.h File 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="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_b7cf026d9e3f55cae42b23722c36a1cb.html">arrow</a></li> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#namespaces">Namespaces</a> \|
	<a href="#func-members">Functions</a> </div>
	<div class="headertitle"><div class="title">arrow_io_util.h File Reference</div></div>
	</div><!--header-->
	<div class="contents">

	<p>Provide helpers to create Arrow-backed FileIO implementations.
	<a href="#details">More...</a></p>
	<div class="textblock"><code>#include <memory></code><br />
	<code>#include <string></code><br />
	<code>#include <unordered_map></code><br />
	<code>#include "<a class="el" href="file__io_8h_source.html">iceberg/file_io.h</a>"</code><br />
	<code>#include "<a class="el" href="iceberg__bundle__export_8h_source.html">iceberg/iceberg_bundle_export.h</a>"</code><br />
	<code>#include "<a class="el" href="result_8h_source.html">iceberg/result.h</a>"</code><br />
	</div>
	<p><a href="arrow__io__util_8h_source.html">Go to the source code of this file.</a></p>
	<table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
	Namespaces</h2></td></tr>
	<tr class="memitem:namespaceiceberg" id="r_namespaceiceberg"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr>
	<tr class="memdesc:namespaceiceberg"><td class="mdescLeft"> </td><td class="mdescRight">Core Apache Iceberg C++ APIs. <br /></td></tr>
	<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:namespaceiceberg_1_1arrow" id="r_namespaceiceberg_1_1arrow"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1arrow.html">iceberg::arrow</a></td></tr>
	<tr class="memdesc:namespaceiceberg_1_1arrow"><td class="mdescLeft"> </td><td class="mdescRight">Arrow-backed IO and data conversion APIs. <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:ab7a1e810bcc704fe597945b32a96d894" id="r_ab7a1e810bcc704fe597945b32a96d894"><td class="memItemLeft" align="right" valign="top"><a id="ab7a1e810bcc704fe597945b32a96d894" name="ab7a1e810bcc704fe597945b32a96d894"></a>
	ICEBERG_BUNDLE_EXPORT std::unique_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > </td><td class="memItemRight" valign="bottom"><b>iceberg::arrow::MakeMockFileIO</b> ()</td></tr>
	<tr class="separator:ab7a1e810bcc704fe597945b32a96d894"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:ab2aa5166871ebfd494a4bda12d751e79" id="r_ab2aa5166871ebfd494a4bda12d751e79"><td class="memItemLeft" align="right" valign="top"><a id="ab2aa5166871ebfd494a4bda12d751e79" name="ab2aa5166871ebfd494a4bda12d751e79"></a>
	ICEBERG_BUNDLE_EXPORT std::unique_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > </td><td class="memItemRight" valign="bottom"><b>iceberg::arrow::MakeLocalFileIO</b> ()</td></tr>
	<tr class="separator:ab2aa5166871ebfd494a4bda12d751e79"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:aa4c684c9dab81759ea6d8cd322894af3" id="r_aa4c684c9dab81759ea6d8cd322894af3"><td class="memItemLeft" align="right" valign="top">ICEBERG_BUNDLE_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::unique_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1arrow.html#aa4c684c9dab81759ea6d8cd322894af3">iceberg::arrow::MakeS3FileIO</a> (const std::unordered_map< std::string, std::string > &properties={})</td></tr>
	<tr class="memdesc:aa4c684c9dab81759ea6d8cd322894af3"><td class="mdescLeft"> </td><td class="mdescRight">Create an S3 <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> backed by Arrow's S3FileSystem. <br /></td></tr>
	<tr class="separator:aa4c684c9dab81759ea6d8cd322894af3"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:afe534529616b1e1b86fb707c29390931" id="r_afe534529616b1e1b86fb707c29390931"><td class="memItemLeft" align="right" valign="top">ICEBERG_BUNDLE_EXPORT Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1arrow.html#afe534529616b1e1b86fb707c29390931">iceberg::arrow::FinalizeS3</a> ()</td></tr>
	<tr class="memdesc:afe534529616b1e1b86fb707c29390931"><td class="mdescLeft"> </td><td class="mdescRight">Finalize (clean up) the Arrow S3 subsystem. <br /></td></tr>
	<tr class="separator:afe534529616b1e1b86fb707c29390931"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>Provide helpers to create Arrow-backed FileIO implementations. </p>
	</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>