Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1arrow_1_1ArrowFileSystemFileIO.html
blob: 4959f6133bf4b35dc4829fd32b6409f11420b0d0 [file] [log] [blame]
<!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::ArrowFileSystemFileIO 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"><b>iceberg</b></li><li class="navelem"><b>arrow</b></li><li class="navelem"><a class="el" href="classiceberg_1_1arrow_1_1ArrowFileSystemFileIO.html">ArrowFileSystemFileIO</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classiceberg_1_1arrow_1_1ArrowFileSystemFileIO-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::arrow::ArrowFileSystemFileIO Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A concrete implementation of <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> for Arrow file system.
<a href="classiceberg_1_1arrow_1_1ArrowFileSystemFileIO.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="arrow__fs__file__io__internal_8h_source.html">arrow_fs_file_io_internal.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::arrow::ArrowFileSystemFileIO:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1arrow_1_1ArrowFileSystemFileIO.png" usemap="#iceberg::arrow::ArrowFileSystemFileIO_map" alt=""/>
<map id="iceberg::arrow::ArrowFileSystemFileIO_map" name="iceberg::arrow::ArrowFileSystemFileIO_map">
<area href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files." alt="iceberg::FileIO" shape="rect" coords="0,0,230,24"/>
</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:a1c2bd3b754cfedc803c5005a7bf620e5" id="r_a1c2bd3b754cfedc803c5005a7bf620e5"><td class="memItemLeft" align="right" valign="top"><a id="a1c2bd3b754cfedc803c5005a7bf620e5" name="a1c2bd3b754cfedc803c5005a7bf620e5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ArrowFileSystemFileIO</b> (std::shared_ptr&lt;::arrow::fs::FileSystem &gt; arrow_fs)</td></tr>
<tr class="separator:a1c2bd3b754cfedc803c5005a7bf620e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa023cae7f400db161e6d847c2bf6f2f3" id="r_aa023cae7f400db161e6d847c2bf6f2f3"><td class="memItemLeft" align="right" valign="top">Result&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1arrow_1_1ArrowFileSystemFileIO.html#aa023cae7f400db161e6d847c2bf6f2f3">ReadFile</a> (const std::string &amp;file_location, std::optional&lt; size_t &gt; length) override</td></tr>
<tr class="memdesc:aa023cae7f400db161e6d847c2bf6f2f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the content of the file at the given location. <br /></td></tr>
<tr class="separator:aa023cae7f400db161e6d847c2bf6f2f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a989c72cecf8dc2463cc90f947d36ba50" id="r_a989c72cecf8dc2463cc90f947d36ba50"><td class="memItemLeft" align="right" valign="top">Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1arrow_1_1ArrowFileSystemFileIO.html#a989c72cecf8dc2463cc90f947d36ba50">WriteFile</a> (const std::string &amp;file_location, std::string_view content) override</td></tr>
<tr class="memdesc:a989c72cecf8dc2463cc90f947d36ba50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write the given content to the file at the given location. <br /></td></tr>
<tr class="separator:a989c72cecf8dc2463cc90f947d36ba50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a054c596530ea55f4e66155c46308ab74" id="r_a054c596530ea55f4e66155c46308ab74"><td class="memItemLeft" align="right" valign="top">Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1arrow_1_1ArrowFileSystemFileIO.html#a054c596530ea55f4e66155c46308ab74">DeleteFile</a> (const std::string &amp;file_location) override</td></tr>
<tr class="memdesc:a054c596530ea55f4e66155c46308ab74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a file at the given location. <br /></td></tr>
<tr class="separator:a054c596530ea55f4e66155c46308ab74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1220a089e1da05614613613cbfcf0656" id="r_a1220a089e1da05614613613cbfcf0656"><td class="memItemLeft" align="right" valign="top"><a id="a1220a089e1da05614613613cbfcf0656" name="a1220a089e1da05614613613cbfcf0656"></a>
const std::shared_ptr&lt;::arrow::fs::FileSystem &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>fs</b> () const</td></tr>
<tr class="memdesc:a1220a089e1da05614613613cbfcf0656"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Arrow file system. <br /></td></tr>
<tr class="separator:a1220a089e1da05614613613cbfcf0656"><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:a9f75861e2aeb0c393526e947419d5386" id="r_a9f75861e2aeb0c393526e947419d5386"><td class="memItemLeft" align="right" valign="top"><a id="a9f75861e2aeb0c393526e947419d5386" name="a9f75861e2aeb0c393526e947419d5386"></a>
static std::unique_ptr&lt; <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>MakeMockFileIO</b> ()</td></tr>
<tr class="memdesc:a9f75861e2aeb0c393526e947419d5386"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make an in-memory <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> backed by arrow::fs::internal::MockFileSystem. <br /></td></tr>
<tr class="separator:a9f75861e2aeb0c393526e947419d5386"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88ac7cc4b4c0dd50eef88f3f6b85c7b9" id="r_a88ac7cc4b4c0dd50eef88f3f6b85c7b9"><td class="memItemLeft" align="right" valign="top"><a id="a88ac7cc4b4c0dd50eef88f3f6b85c7b9" name="a88ac7cc4b4c0dd50eef88f3f6b85c7b9"></a>
static std::unique_ptr&lt; <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>MakeLocalFileIO</b> ()</td></tr>
<tr class="memdesc:a88ac7cc4b4c0dd50eef88f3f6b85c7b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make a local <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> backed by arrow::fs::LocalFileSystem. <br /></td></tr>
<tr class="separator:a88ac7cc4b4c0dd50eef88f3f6b85c7b9"><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>A concrete implementation of <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> for Arrow file system. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a054c596530ea55f4e66155c46308ab74" name="a054c596530ea55f4e66155c46308ab74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a054c596530ea55f4e66155c46308ab74">&#9670;&#160;</a></span>DeleteFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Status iceberg::arrow::ArrowFileSystemFileIO::DeleteFile </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>file_location</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete a file at the given location. </p>
<p>Reimplemented from <a class="el" href="classiceberg_1_1FileIO.html#ace7c9ec329017d5a99082739e8578937">iceberg::FileIO</a>.</p>
</div>
</div>
<a id="aa023cae7f400db161e6d847c2bf6f2f3" name="aa023cae7f400db161e6d847c2bf6f2f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa023cae7f400db161e6d847c2bf6f2f3">&#9670;&#160;</a></span>ReadFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Result&lt; std::string &gt; iceberg::arrow::ArrowFileSystemFileIO::ReadFile </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>file_location</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::optional&lt; size_t &gt;&#160;</td>
<td class="paramname"><em>length</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read the content of the file at the given location. </p>
<p>Reimplemented from <a class="el" href="classiceberg_1_1FileIO.html#a714e3babeac9395ed6ef4b2f5c94a5cd">iceberg::FileIO</a>.</p>
</div>
</div>
<a id="a989c72cecf8dc2463cc90f947d36ba50" name="a989c72cecf8dc2463cc90f947d36ba50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a989c72cecf8dc2463cc90f947d36ba50">&#9670;&#160;</a></span>WriteFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Status iceberg::arrow::ArrowFileSystemFileIO::WriteFile </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>file_location</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>content</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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write the given content to the file at the given location. </p>
<p>Reimplemented from <a class="el" href="classiceberg_1_1FileIO.html#a527a78aca1045034250f50a51d8dc0f9">iceberg::FileIO</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/arrow/<a class="el" href="arrow__fs__file__io__internal_8h_source.html">arrow_fs_file_io_internal.h</a></li>
<li>iceberg/arrow/<b>arrow_fs_file_io.cc</b></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>