| <!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/file_writer.h Source File</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> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">file_writer.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="file__writer_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <functional></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <optional></span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "<a class="code" href="arrow__c__data_8h.html">iceberg/arrow_c_data.h</a>"</span></div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include "<a class="code" href="file__format_8h.html">iceberg/file_format.h</a>"</span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include "<a class="code" href="metrics_8h.html">iceberg/metrics.h</a>"</span></div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include "<a class="code" href="metrics__config_8h.html">iceberg/metrics_config.h</a>"</span></div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">iceberg/result.h</a>"</span></div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#include "<a class="code" href="type__fwd_8h.html">iceberg/type_fwd.h</a>"</span></div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#include "<a class="code" href="config_8h.html">iceberg/util/config.h</a>"</span></div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg.html">iceberg</a> {</div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div> |
| <div class="foldopen" id="foldopen00040" data-start="{" data-end="};"> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classiceberg_1_1WriterProperties.html"> 40</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1WriterProperties.html">WriterProperties</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1ConfigBase.html">ConfigBase</a><WriterProperties> {</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">using </span>Entry = <span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1ConfigBase_1_1Entry.html">ConfigBase<WriterProperties>::Entry</a><T>;</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classiceberg_1_1WriterProperties.html#a900e8c7df68c72a277f5bffe9fa57774"> 46</a></span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<std::string> kAvroSchemaName{<span class="stringliteral">"write.avro.schema-name"</span>, <span class="stringliteral">""</span>};</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classiceberg_1_1WriterProperties.html#abaa574296d16477f53547d4ff6f5f8b3"> 48</a></span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<int64_t> kAvroBufferSize{<span class="stringliteral">"write.avro.buffer-size"</span>, 1024 * 1024};</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classiceberg_1_1WriterProperties.html#ad0d51e747dee91694c6b83bc0dca212b"> 50</a></span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<int64_t> kAvroSyncInterval{<span class="stringliteral">"write.avro.sync-interval"</span>, 16 * 1024};</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="classiceberg_1_1WriterProperties.html#a60e3675ed3ceaaa8bcb47750f7a098ad"> 53</a></span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<bool> kAvroSkipDatum{<span class="stringliteral">"write.avro.skip-datum"</span>, <span class="keyword">true</span>};</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<std::string> kAvroCompression{<span class="stringliteral">"write.avro.compression-codec"</span>,</div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="stringliteral">"gzip"</span>};</div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<std::string> kAvroCompressionLevel{<span class="stringliteral">"write.avro.compression-level"</span>,</div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="stringliteral">""</span>};</div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<std::string> kParquetCompression{<span class="stringliteral">"write.parquet.compression-codec"</span>,</div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="stringliteral">"zstd"</span>};</div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<std::string> kParquetCompressionLevel{</div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="stringliteral">"write.parquet.compression-level"</span>, <span class="stringliteral">""</span>};</div> |
| <div class="foldopen" id="foldopen00064" data-start="{" data-end="};"> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="classiceberg_1_1WriterProperties.html#ab3f4ff0fe21f34ec809d0eb432114769"> 64</a></span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<int64_t> kParquetMaxRowGroupRows{<span class="stringliteral">"write.parquet.max-row-group-rows"</span>,</div> |
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> 1024 * 1024};</div> |
| </div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classiceberg_1_1WriterProperties.html#a3760ae142a0a8cfd407121e6ed6d379c"> 70</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classiceberg_1_1WriterProperties.html">WriterProperties</a> <a class="code hl_function" href="classiceberg_1_1WriterProperties.html#a3760ae142a0a8cfd407121e6ed6d379c">FromMap</a>(</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">const</span> std::unordered_map<std::string, std::string>& properties);</div> |
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span>};</div> |
| </div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div> |
| <div class="foldopen" id="foldopen00075" data-start="{" data-end="};"> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriterOptions.html"> 75</a></span><span class="keyword">struct </span>ICEBERG_EXPORT <a class="code hl_struct" href="structiceberg_1_1WriterOptions.html">WriterOptions</a> {</div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriterOptions.html#a64566361f2b34747e98bf8f9ead4e94c"> 77</a></span> std::string <a class="code hl_variable" href="structiceberg_1_1WriterOptions.html#a64566361f2b34747e98bf8f9ead4e94c">path</a>;</div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriterOptions.html#a6977a4706f0c09def323640aa11f1ac4"> 79</a></span> std::shared_ptr<Schema> <a class="code hl_variable" href="structiceberg_1_1WriterOptions.html#a6977a4706f0c09def323640aa11f1ac4">schema</a>;</div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriterOptions.html#a9efc91419caced6e3ef1ab41a30fd01e"> 81</a></span> std::shared_ptr<class FileIO> <a class="code hl_variable" href="structiceberg_1_1WriterOptions.html#a9efc91419caced6e3ef1ab41a30fd01e">io</a>;</div> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriterOptions.html#a738a2f1a969d4bbf19b2ce27ba7d071f"> 83</a></span> std::unordered_map<std::string, std::string> <a class="code hl_variable" href="structiceberg_1_1WriterOptions.html#a738a2f1a969d4bbf19b2ce27ba7d071f">metadata</a>;</div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriterOptions.html#a4ab5f415cf81da59643401d56c41a12b"> 85</a></span> std::shared_ptr<MetricsConfig> metrics_config = MetricsConfig::Default();</div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriterOptions.html#a3db3b2d7fc42f10243afedf29a1f8e05"> 87</a></span> <a class="code hl_class" href="classiceberg_1_1WriterProperties.html">WriterProperties</a> <a class="code hl_variable" href="structiceberg_1_1WriterOptions.html#a3db3b2d7fc42f10243afedf29a1f8e05">properties</a>;</div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>};</div> |
| </div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div> |
| <div class="foldopen" id="foldopen00091" data-start="{" data-end="};"> |
| <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="classiceberg_1_1Writer.html"> 91</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1Writer.html">Writer</a> {</div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classiceberg_1_1Writer.html">~Writer</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <a class="code hl_class" href="classiceberg_1_1Writer.html">Writer</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <a class="code hl_class" href="classiceberg_1_1Writer.html">Writer</a>(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Writer.html">Writer</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <a class="code hl_class" href="classiceberg_1_1Writer.html">Writer</a>& operator=(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Writer.html">Writer</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div> |
| <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="classiceberg_1_1Writer.html#a3088b433357b7589be2aa294fa311346"> 99</a></span> <span class="keyword">virtual</span> Status <a class="code hl_function" href="classiceberg_1_1Writer.html#a3088b433357b7589be2aa294fa311346">Open</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1WriterOptions.html">WriterOptions</a>& options) = 0;</div> |
| <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="classiceberg_1_1Writer.html#ad919074c1cb99c517b3e7e09214cd43c"> 102</a></span> <span class="keyword">virtual</span> Status <a class="code hl_function" href="classiceberg_1_1Writer.html#ad919074c1cb99c517b3e7e09214cd43c">Close</a>() = 0;</div> |
| <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div> |
| <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="classiceberg_1_1Writer.html#ab9fd192deac4e2a73bbd5c8e8ee71529"> 108</a></span> <span class="keyword">virtual</span> Status <a class="code hl_function" href="classiceberg_1_1Writer.html#ab9fd192deac4e2a73bbd5c8e8ee71529">Write</a>(<a class="code hl_struct" href="structArrowArray.html">ArrowArray</a>* data) = 0;</div> |
| <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div> |
| <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="classiceberg_1_1Writer.html#a36090c8c8e11cd6d5746b3c57e90983d"> 112</a></span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<Metrics></a> <a class="code hl_function" href="classiceberg_1_1Writer.html#a36090c8c8e11cd6d5746b3c57e90983d">metrics</a>() = 0;</div> |
| <div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div> |
| <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="classiceberg_1_1Writer.html#a5de3531e7c60570692a4a2b0d8449a81"> 116</a></span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<int64_t></a> <a class="code hl_function" href="classiceberg_1_1Writer.html#a5de3531e7c60570692a4a2b0d8449a81">length</a>() = 0;</div> |
| <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div> |
| <div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="classiceberg_1_1Writer.html#a9630828a5052ec475c653ed492f70124"> 122</a></span> <span class="keyword">virtual</span> std::vector<int64_t> <a class="code hl_function" href="classiceberg_1_1Writer.html#a9630828a5052ec475c653ed492f70124">split_offsets</a>() = 0;</div> |
| <div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span>};</div> |
| </div> |
| <div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div> |
| <div class="line"><a id="l00126" name="l00126"></a><span class="lineno"><a class="line" href="namespaceiceberg.html#accf6d69cf4d7c52851e9dc92d95d3215"> 126</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceiceberg.html#accf6d69cf4d7c52851e9dc92d95d3215">WriterFactory</a> = std::function<Result<std::unique_ptr<Writer>>()>;</div> |
| <div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div> |
| <div class="foldopen" id="foldopen00129" data-start="{" data-end="};"> |
| <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriterFactoryRegistry.html"> 129</a></span><span class="keyword">struct </span>ICEBERG_EXPORT <a class="code hl_struct" href="structiceberg_1_1WriterFactoryRegistry.html">WriterFactoryRegistry</a> {</div> |
| <div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriterFactoryRegistry.html#a39ed0f872bcc9fa7c49dc190b476ba61"> 131</a></span> <a class="code hl_function" href="structiceberg_1_1WriterFactoryRegistry.html#a39ed0f872bcc9fa7c49dc190b476ba61">WriterFactoryRegistry</a>(FileFormatType format_type, <a class="code hl_typedef" href="namespaceiceberg.html#accf6d69cf4d7c52851e9dc92d95d3215">WriterFactory</a> factory);</div> |
| <div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div> |
| <div class="line"><a id="l00134" name="l00134"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriterFactoryRegistry.html#a2ad5a771a2dc4a1c3489fdbb44748c0a"> 134</a></span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#accf6d69cf4d7c52851e9dc92d95d3215">WriterFactory</a>& <a class="code hl_function" href="structiceberg_1_1WriterFactoryRegistry.html#a2ad5a771a2dc4a1c3489fdbb44748c0a">GetFactory</a>(FileFormatType format_type);</div> |
| <div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div> |
| <div class="line"><a id="l00137" name="l00137"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriterFactoryRegistry.html#ae8211b291b25cc5b562d8cce205bc143"> 137</a></span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::unique_ptr<Writer></a>> <a class="code hl_function" href="structiceberg_1_1WriterFactoryRegistry.html#ae8211b291b25cc5b562d8cce205bc143">Open</a>(FileFormatType format_type,</div> |
| <div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1WriterOptions.html">WriterOptions</a>& options);</div> |
| <div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span>};</div> |
| </div> |
| <div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> </div> |
| <div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="aarrow__c__data_8h_html"><div class="ttname"><a href="arrow__c__data_8h.html">arrow_c_data.h</a></div></div> |
| <div class="ttc" id="aclassiceberg_1_1ConfigBase_1_1Entry_html"><div class="ttname"><a href="classiceberg_1_1ConfigBase_1_1Entry.html">iceberg::ConfigBase::Entry</a></div><div class="ttdef"><b>Definition</b> config.h:73</div></div> |
| <div class="ttc" id="aclassiceberg_1_1ConfigBase_html"><div class="ttname"><a href="classiceberg_1_1ConfigBase.html">iceberg::ConfigBase</a></div><div class="ttdef"><b>Definition</b> config.h:70</div></div> |
| <div class="ttc" id="aclassiceberg_1_1WriterProperties_html"><div class="ttname"><a href="classiceberg_1_1WriterProperties.html">iceberg::WriterProperties</a></div><div class="ttdef"><b>Definition</b> file_writer.h:40</div></div> |
| <div class="ttc" id="aclassiceberg_1_1WriterProperties_html_a3760ae142a0a8cfd407121e6ed6d379c"><div class="ttname"><a href="classiceberg_1_1WriterProperties.html#a3760ae142a0a8cfd407121e6ed6d379c">iceberg::WriterProperties::FromMap</a></div><div class="ttdeci">static WriterProperties FromMap(const std::unordered_map< std::string, std::string > &properties)</div><div class="ttdoc">TODO(gangwu): add table properties with write.avro|parquet|orc.*.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Writer_html"><div class="ttname"><a href="classiceberg_1_1Writer.html">iceberg::Writer</a></div><div class="ttdoc">Base writer class to write data from different file formats.</div><div class="ttdef"><b>Definition</b> file_writer.h:91</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Writer_html_a3088b433357b7589be2aa294fa311346"><div class="ttname"><a href="classiceberg_1_1Writer.html#a3088b433357b7589be2aa294fa311346">iceberg::Writer::Open</a></div><div class="ttdeci">virtual Status Open(const WriterOptions &options)=0</div><div class="ttdoc">Open the writer.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Writer_html_a36090c8c8e11cd6d5746b3c57e90983d"><div class="ttname"><a href="classiceberg_1_1Writer.html#a36090c8c8e11cd6d5746b3c57e90983d">iceberg::Writer::metrics</a></div><div class="ttdeci">virtual Result< Metrics > metrics()=0</div><div class="ttdoc">Get the file statistics. Only valid after the file is closed.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Writer_html_a5de3531e7c60570692a4a2b0d8449a81"><div class="ttname"><a href="classiceberg_1_1Writer.html#a5de3531e7c60570692a4a2b0d8449a81">iceberg::Writer::length</a></div><div class="ttdeci">virtual Result< int64_t > length()=0</div><div class="ttdoc">Get the file length. This can be called while the writer is still open or after the file is closed.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Writer_html_a9630828a5052ec475c653ed492f70124"><div class="ttname"><a href="classiceberg_1_1Writer.html#a9630828a5052ec475c653ed492f70124">iceberg::Writer::split_offsets</a></div><div class="ttdeci">virtual std::vector< int64_t > split_offsets()=0</div><div class="ttdoc">Returns a list of recommended split locations, if applicable, empty otherwise. When available,...</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Writer_html_ab9fd192deac4e2a73bbd5c8e8ee71529"><div class="ttname"><a href="classiceberg_1_1Writer.html#ab9fd192deac4e2a73bbd5c8e8ee71529">iceberg::Writer::Write</a></div><div class="ttdeci">virtual Status Write(ArrowArray *data)=0</div><div class="ttdoc">Write arrow data to the file.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Writer_html_ad919074c1cb99c517b3e7e09214cd43c"><div class="ttname"><a href="classiceberg_1_1Writer.html#ad919074c1cb99c517b3e7e09214cd43c">iceberg::Writer::Close</a></div><div class="ttdeci">virtual Status Close()=0</div><div class="ttdoc">Close the writer.</div></div> |
| <div class="ttc" id="aconfig_8h_html"><div class="ttname"><a href="config_8h.html">config.h</a></div><div class="ttdoc">Provide typed configuration helpers.</div></div> |
| <div class="ttc" id="afile__format_8h_html"><div class="ttname"><a href="file__format_8h.html">file_format.h</a></div></div> |
| <div class="ttc" id="ametrics_8h_html"><div class="ttname"><a href="metrics_8h.html">metrics.h</a></div></div> |
| <div class="ttc" id="ametrics__config_8h_html"><div class="ttname"><a href="metrics__config_8h.html">metrics_config.h</a></div><div class="ttdoc">Metrics configuration for Iceberg tables.</div></div> |
| <div class="ttc" id="anamespaceiceberg_html"><div class="ttname"><a href="namespaceiceberg.html">iceberg</a></div><div class="ttdoc">Core Apache Iceberg C++ APIs.</div><div class="ttdef"><b>Definition</b> arrow_io_util.h:33</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a9d5594e371beb516b0120e07e69d3af6"><div class="ttname"><a href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">iceberg::Result</a></div><div class="ttdeci">std::expected< T, E > Result</div><div class="ttdoc">Result alias.</div><div class="ttdef"><b>Definition</b> result.h:88</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_accf6d69cf4d7c52851e9dc92d95d3215"><div class="ttname"><a href="namespaceiceberg.html#accf6d69cf4d7c52851e9dc92d95d3215">iceberg::WriterFactory</a></div><div class="ttdeci">std::function< Result< std::unique_ptr< Writer > >()> WriterFactory</div><div class="ttdoc">Factory function to create a writer of a specific file format.</div><div class="ttdef"><b>Definition</b> file_writer.h:126</div></div> |
| <div class="ttc" id="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></div><div class="ttdoc">Define Result, Status, and error helpers.</div></div> |
| <div class="ttc" id="astructArrowArray_html"><div class="ttname"><a href="structArrowArray.html">ArrowArray</a></div><div class="ttdef"><b>Definition</b> arrow_c_data.h:57</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriterFactoryRegistry_html"><div class="ttname"><a href="structiceberg_1_1WriterFactoryRegistry.html">iceberg::WriterFactoryRegistry</a></div><div class="ttdoc">Registry of writer factories for different file formats.</div><div class="ttdef"><b>Definition</b> file_writer.h:129</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriterFactoryRegistry_html_a2ad5a771a2dc4a1c3489fdbb44748c0a"><div class="ttname"><a href="structiceberg_1_1WriterFactoryRegistry.html#a2ad5a771a2dc4a1c3489fdbb44748c0a">iceberg::WriterFactoryRegistry::GetFactory</a></div><div class="ttdeci">static WriterFactory & GetFactory(FileFormatType format_type)</div><div class="ttdoc">Get the factory function for a specific file format.</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriterFactoryRegistry_html_a39ed0f872bcc9fa7c49dc190b476ba61"><div class="ttname"><a href="structiceberg_1_1WriterFactoryRegistry.html#a39ed0f872bcc9fa7c49dc190b476ba61">iceberg::WriterFactoryRegistry::WriterFactoryRegistry</a></div><div class="ttdeci">WriterFactoryRegistry(FileFormatType format_type, WriterFactory factory)</div><div class="ttdoc">Register a factory function for a specific file format.</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriterFactoryRegistry_html_ae8211b291b25cc5b562d8cce205bc143"><div class="ttname"><a href="structiceberg_1_1WriterFactoryRegistry.html#ae8211b291b25cc5b562d8cce205bc143">iceberg::WriterFactoryRegistry::Open</a></div><div class="ttdeci">static Result< std::unique_ptr< Writer > > Open(FileFormatType format_type, const WriterOptions &options)</div><div class="ttdoc">Open a writer for a specific file format.</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriterOptions_html"><div class="ttname"><a href="structiceberg_1_1WriterOptions.html">iceberg::WriterOptions</a></div><div class="ttdoc">Options for creating a writer.</div><div class="ttdef"><b>Definition</b> file_writer.h:75</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriterOptions_html_a3db3b2d7fc42f10243afedf29a1f8e05"><div class="ttname"><a href="structiceberg_1_1WriterOptions.html#a3db3b2d7fc42f10243afedf29a1f8e05">iceberg::WriterOptions::properties</a></div><div class="ttdeci">WriterProperties properties</div><div class="ttdoc">Format-specific or implementation-specific properties.</div><div class="ttdef"><b>Definition</b> file_writer.h:87</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriterOptions_html_a64566361f2b34747e98bf8f9ead4e94c"><div class="ttname"><a href="structiceberg_1_1WriterOptions.html#a64566361f2b34747e98bf8f9ead4e94c">iceberg::WriterOptions::path</a></div><div class="ttdeci">std::string path</div><div class="ttdoc">The path to the file to write.</div><div class="ttdef"><b>Definition</b> file_writer.h:77</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriterOptions_html_a6977a4706f0c09def323640aa11f1ac4"><div class="ttname"><a href="structiceberg_1_1WriterOptions.html#a6977a4706f0c09def323640aa11f1ac4">iceberg::WriterOptions::schema</a></div><div class="ttdeci">std::shared_ptr< Schema > schema</div><div class="ttdoc">The schema of the data to write.</div><div class="ttdef"><b>Definition</b> file_writer.h:79</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriterOptions_html_a738a2f1a969d4bbf19b2ce27ba7d071f"><div class="ttname"><a href="structiceberg_1_1WriterOptions.html#a738a2f1a969d4bbf19b2ce27ba7d071f">iceberg::WriterOptions::metadata</a></div><div class="ttdeci">std::unordered_map< std::string, std::string > metadata</div><div class="ttdoc">Metadata to write to the file.</div><div class="ttdef"><b>Definition</b> file_writer.h:83</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriterOptions_html_a9efc91419caced6e3ef1ab41a30fd01e"><div class="ttname"><a href="structiceberg_1_1WriterOptions.html#a9efc91419caced6e3ef1ab41a30fd01e">iceberg::WriterOptions::io</a></div><div class="ttdeci">std::shared_ptr< class FileIO > io</div><div class="ttdoc">FileIO instance to create the file.</div><div class="ttdef"><b>Definition</b> file_writer.h:81</div></div> |
| <div class="ttc" id="atype__fwd_8h_html"><div class="ttname"><a href="type__fwd_8h.html">type_fwd.h</a></div></div> |
| </div><!-- fragment --></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> |
