| <!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::FileWriter 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"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1FileWriter.html">FileWriter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classiceberg_1_1FileWriter-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::FileWriter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Base interface for data file writers. |
| <a href="classiceberg_1_1FileWriter.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="writer_8h_source.html">writer.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::FileWriter:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1FileWriter.png" usemap="#iceberg::FileWriter_map" alt=""/> |
| <map id="iceberg::FileWriter_map" name="iceberg::FileWriter_map"> |
| <area href="classiceberg_1_1DataWriter.html" title="Writer for Iceberg data files." alt="iceberg::DataWriter" shape="rect" coords="0,56,175,80"/> |
| <area href="classiceberg_1_1EqualityDeleteWriter.html" title="Writer for Iceberg equality delete files." alt="iceberg::EqualityDeleteWriter" shape="rect" coords="185,56,360,80"/> |
| <area href="classiceberg_1_1PositionDeleteWriter.html" title="Writer for Iceberg position delete files." alt="iceberg::PositionDeleteWriter" shape="rect" coords="370,56,545,80"/> |
| </map> |
| </div></div> |
| <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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1FileWriter_1_1WriteResult.html">WriteResult</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">File metadata for all files produced by this writer. <a href="structiceberg_1_1FileWriter_1_1WriteResult.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="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:ad27902863767dbda5a2d7fcf88eb0e28" id="r_ad27902863767dbda5a2d7fcf88eb0e28"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileWriter.html#ad27902863767dbda5a2d7fcf88eb0e28">Write</a> (<a class="el" href="structArrowArray.html">ArrowArray</a> *data)=0</td></tr> |
| <tr class="memdesc:ad27902863767dbda5a2d7fcf88eb0e28"><td class="mdescLeft"> </td><td class="mdescRight">Write a batch of records. <br /></td></tr> |
| <tr class="separator:ad27902863767dbda5a2d7fcf88eb0e28"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad32f2d3323e2fea39baa59a96eb50197" id="r_ad32f2d3323e2fea39baa59a96eb50197"><td class="memItemLeft" align="right" valign="top">virtual Result< int64_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileWriter.html#ad32f2d3323e2fea39baa59a96eb50197">Length</a> () const =0</td></tr> |
| <tr class="memdesc:ad32f2d3323e2fea39baa59a96eb50197"><td class="mdescLeft"> </td><td class="mdescRight">Get the current number of bytes written. <br /></td></tr> |
| <tr class="separator:ad32f2d3323e2fea39baa59a96eb50197"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6d7f69f445e791c2c864913fc1188370" id="r_a6d7f69f445e791c2c864913fc1188370"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileWriter.html#a6d7f69f445e791c2c864913fc1188370">Close</a> ()=0</td></tr> |
| <tr class="memdesc:a6d7f69f445e791c2c864913fc1188370"><td class="mdescLeft"> </td><td class="mdescRight">Close the writer and finalize the file. <br /></td></tr> |
| <tr class="separator:a6d7f69f445e791c2c864913fc1188370"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7206abe67a08dc3362379f810cf11b96" id="r_a7206abe67a08dc3362379f810cf11b96"><td class="memItemLeft" align="right" valign="top">virtual Result< <a class="el" href="structiceberg_1_1FileWriter_1_1WriteResult.html">WriteResult</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileWriter.html#a7206abe67a08dc3362379f810cf11b96">Metadata</a> ()=0</td></tr> |
| <tr class="memdesc:a7206abe67a08dc3362379f810cf11b96"><td class="mdescLeft"> </td><td class="mdescRight">Get file metadata for all files produced by this writer. <br /></td></tr> |
| <tr class="separator:a7206abe67a08dc3362379f810cf11b96"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Base interface for data file writers. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a6d7f69f445e791c2c864913fc1188370" name="a6d7f69f445e791c2c864913fc1188370"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6d7f69f445e791c2c864913fc1188370">◆ </a></span>Close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual Status iceberg::FileWriter::Close </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>Close the writer and finalize the file. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1DataWriter.html#acfb7b11e0ddbc46bd984dd5d6f47cb54">iceberg::DataWriter</a>, <a class="el" href="classiceberg_1_1EqualityDeleteWriter.html#a03c473f8e3a8aa2fb29638527b2984e6">iceberg::EqualityDeleteWriter</a>, and <a class="el" href="classiceberg_1_1PositionDeleteWriter.html#a098428452001832ed2edb4f77c0a67ef">iceberg::PositionDeleteWriter</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ad32f2d3323e2fea39baa59a96eb50197" name="ad32f2d3323e2fea39baa59a96eb50197"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad32f2d3323e2fea39baa59a96eb50197">◆ </a></span>Length()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual Result< int64_t > iceberg::FileWriter::Length </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>Get the current number of bytes written. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1DataWriter.html#a33f636f51003a122b97a5eb836846c3c">iceberg::DataWriter</a>, <a class="el" href="classiceberg_1_1EqualityDeleteWriter.html#a708a6b9afdc78d7e91d8c805cca2ada0">iceberg::EqualityDeleteWriter</a>, and <a class="el" href="classiceberg_1_1PositionDeleteWriter.html#a3e645c21bd752f06e31c0d95136266f9">iceberg::PositionDeleteWriter</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a7206abe67a08dc3362379f810cf11b96" name="a7206abe67a08dc3362379f810cf11b96"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7206abe67a08dc3362379f810cf11b96">◆ </a></span>Metadata()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual Result< <a class="el" href="structiceberg_1_1FileWriter_1_1WriteResult.html">WriteResult</a> > iceberg::FileWriter::Metadata </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>Get file metadata for all files produced by this writer. </p> |
| <dl class="section note"><dt>Note</dt><dd>This method should be called after <a class="el" href="classiceberg_1_1FileWriter.html#a6d7f69f445e791c2c864913fc1188370" title="Close the writer and finalize the file.">Close()</a>. </dd></dl> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1DataWriter.html#a981674a97afb37f20d6c8d38417d57b8">iceberg::DataWriter</a>, <a class="el" href="classiceberg_1_1EqualityDeleteWriter.html#a4c8da285388678cf6ba5496f3aa23bce">iceberg::EqualityDeleteWriter</a>, and <a class="el" href="classiceberg_1_1PositionDeleteWriter.html#a9d0ab61a93de91c618791270b566ec62">iceberg::PositionDeleteWriter</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ad27902863767dbda5a2d7fcf88eb0e28" name="ad27902863767dbda5a2d7fcf88eb0e28"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad27902863767dbda5a2d7fcf88eb0e28">◆ </a></span>Write()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual Status iceberg::FileWriter::Write </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structArrowArray.html">ArrowArray</a> * </td> |
| <td class="paramname"><em>data</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>Write a batch of records. </p> |
| <dl class="section note"><dt>Note</dt><dd>The ownership of the <a class="el" href="structArrowArray.html">ArrowArray</a> will be transferred to the writer. </dd></dl> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1DataWriter.html#a6a72a9a4f9193b389e0465fe4120656d">iceberg::DataWriter</a>, <a class="el" href="classiceberg_1_1EqualityDeleteWriter.html#afce144d0fe922ad0d4a49dce13ce6a96">iceberg::EqualityDeleteWriter</a>, and <a class="el" href="classiceberg_1_1PositionDeleteWriter.html#a74077dc2bae65c4a33f5d7c8368a8db4">iceberg::PositionDeleteWriter</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/data/<a class="el" href="writer_8h_source.html">writer.h</a></li> |
| <li>iceberg/data/<b>writer.cc</b></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> |
