blob: ede8a88cff9061d114394bf0f28f660e28f79abf [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/puffin/file_metadata.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&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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_5f8b885c726a45ce475267a26efacb77.html">puffin</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">file_metadata.h</div></div>
</div><!--header-->
<div class="contents">
<a href="file__metadata_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"> * &quot;License&quot;); 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"> * &quot;AS IS&quot; 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 &lt;cstdint&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include &lt;optional&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;string_view&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &lt;unordered_map&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include &quot;iceberg/iceberg_export.h&quot;</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include &quot;iceberg/result.h&quot;</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">namespace </span>iceberg::puffin {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="foldopen" id="foldopen00038" data-start="{" data-end="};">
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="file__metadata_8h.html#a370ebcb6e23ad5d7640b3f2a612b06cc"> 38</a></span><span class="keyword">enum class</span> <a class="code hl_enumeration" href="file__metadata_8h.html#a370ebcb6e23ad5d7640b3f2a612b06cc">PuffinCompressionCodec</a> {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> kNone,</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> kLz4,</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> kZstd,</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>};</div>
</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>ICEBERG_EXPORT std::string_view CodecName(PuffinCompressionCodec codec);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>ICEBERG_EXPORT Result&lt;PuffinCompressionCodec&gt; PuffinCompressionCodecFromName(</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> std::string_view codec_name);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>ICEBERG_EXPORT std::string ToString(PuffinCompressionCodec codec);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="foldopen" id="foldopen00052" data-start="{" data-end="};">
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1StandardBlobTypes.html"> 52</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structiceberg_1_1puffin_1_1StandardBlobTypes.html">StandardBlobTypes</a> {</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1StandardBlobTypes.html#a56ddc41d0b314ceb80ba6f8da65c7d93"> 55</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::string_view <a class="code hl_variable" href="structiceberg_1_1puffin_1_1StandardBlobTypes.html#a56ddc41d0b314ceb80ba6f8da65c7d93">kApacheDatasketchesThetaV1</a> =</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="stringliteral">&quot;apache-datasketches-theta-v1&quot;</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1StandardBlobTypes.html#a6dc6f92f1eafdfa747657dcbd4abd394"> 59</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::string_view <a class="code hl_variable" href="structiceberg_1_1puffin_1_1StandardBlobTypes.html#a6dc6f92f1eafdfa747657dcbd4abd394">kDeletionVectorV1</a> = <span class="stringliteral">&quot;deletion-vector-v1&quot;</span>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>};</div>
</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="foldopen" id="foldopen00063" data-start="{" data-end="};">
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1StandardPuffinProperties.html"> 63</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structiceberg_1_1puffin_1_1StandardPuffinProperties.html">StandardPuffinProperties</a> {</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1StandardPuffinProperties.html#a9a1e50e04e551d463d667b5d3bc0bebf"> 66</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::string_view <a class="code hl_variable" href="structiceberg_1_1puffin_1_1StandardPuffinProperties.html#a9a1e50e04e551d463d667b5d3bc0bebf">kCreatedBy</a> = <span class="stringliteral">&quot;created-by&quot;</span>;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>};</div>
</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="foldopen" id="foldopen00070" data-start="{" data-end="};">
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1Blob.html"> 70</a></span><span class="keyword">struct </span>ICEBERG_EXPORT <a class="code hl_struct" href="structiceberg_1_1puffin_1_1Blob.html">Blob</a> {</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1Blob.html#a4f7ca2a6cc93306a0a67890dadce3cea"> 72</a></span> std::string <a class="code hl_variable" href="structiceberg_1_1puffin_1_1Blob.html#a4f7ca2a6cc93306a0a67890dadce3cea">type</a>;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1Blob.html#a3b5f15d99ca2e7230fbb92d7f861c468"> 74</a></span> std::vector&lt;int32_t&gt; <a class="code hl_variable" href="structiceberg_1_1puffin_1_1Blob.html#a3b5f15d99ca2e7230fbb92d7f861c468">input_fields</a>;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1Blob.html#a2668a95631f8f420d56b0d5145f14096"> 76</a></span> int64_t <a class="code hl_variable" href="structiceberg_1_1puffin_1_1Blob.html#a2668a95631f8f420d56b0d5145f14096">snapshot_id</a>;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1Blob.html#ac79dc1a305b5e235f57ca2031f67a75e"> 78</a></span> int64_t <a class="code hl_variable" href="structiceberg_1_1puffin_1_1Blob.html#ac79dc1a305b5e235f57ca2031f67a75e">sequence_number</a>;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> std::vector&lt;uint8_t&gt; data;</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1Blob.html#ac624cbd7745bef9a4df537f167b9435e"> 81</a></span> std::optional&lt;PuffinCompressionCodec&gt; <a class="code hl_variable" href="structiceberg_1_1puffin_1_1Blob.html#ac624cbd7745bef9a4df537f167b9435e">requested_compression</a>;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> std::unordered_map&lt;std::string, std::string&gt; properties;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">friend</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1puffin_1_1Blob.html">Blob</a>&amp; lhs, <span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1puffin_1_1Blob.html">Blob</a>&amp; rhs) = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span>};</div>
</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span>ICEBERG_EXPORT std::string ToString(<span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1puffin_1_1Blob.html">Blob</a>&amp; blob);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="foldopen" id="foldopen00090" data-start="{" data-end="};">
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1BlobMetadata.html"> 90</a></span><span class="keyword">struct </span>ICEBERG_EXPORT <a class="code hl_struct" href="structiceberg_1_1puffin_1_1BlobMetadata.html">BlobMetadata</a> {</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1BlobMetadata.html#a9ee2847def227ef7d66b4dad77c79abe"> 92</a></span> std::string <a class="code hl_variable" href="structiceberg_1_1puffin_1_1BlobMetadata.html#a9ee2847def227ef7d66b4dad77c79abe">type</a>;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1BlobMetadata.html#acb23b8e1304c1c8f1313b3e502d89d1d"> 94</a></span> std::vector&lt;int32_t&gt; <a class="code hl_variable" href="structiceberg_1_1puffin_1_1BlobMetadata.html#acb23b8e1304c1c8f1313b3e502d89d1d">input_fields</a>;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1BlobMetadata.html#aba7ed7503bc6340693616ae2da1baeca"> 96</a></span> int64_t <a class="code hl_variable" href="structiceberg_1_1puffin_1_1BlobMetadata.html#aba7ed7503bc6340693616ae2da1baeca">snapshot_id</a>;</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1BlobMetadata.html#a2006c5efb416a6d939682999a7a1b29f"> 98</a></span> int64_t <a class="code hl_variable" href="structiceberg_1_1puffin_1_1BlobMetadata.html#a2006c5efb416a6d939682999a7a1b29f">sequence_number</a>;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> int64_t offset;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> int64_t length;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1BlobMetadata.html#aa4c3cfd2e88e11f993a8295ad9f244c0"> 102</a></span> std::string <a class="code hl_variable" href="structiceberg_1_1puffin_1_1BlobMetadata.html#aa4c3cfd2e88e11f993a8295ad9f244c0">compression_codec</a>;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> std::unordered_map&lt;std::string, std::string&gt; properties;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keyword">friend</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1puffin_1_1BlobMetadata.html">BlobMetadata</a>&amp; lhs, <span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1puffin_1_1BlobMetadata.html">BlobMetadata</a>&amp; rhs) = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span>};</div>
</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span>ICEBERG_EXPORT std::string ToString(<span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1puffin_1_1BlobMetadata.html">BlobMetadata</a>&amp; blob_metadata);</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="foldopen" id="foldopen00111" data-start="{" data-end="};">
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="structiceberg_1_1puffin_1_1FileMetadata.html"> 111</a></span><span class="keyword">struct </span>ICEBERG_EXPORT <a class="code hl_struct" href="structiceberg_1_1puffin_1_1FileMetadata.html">FileMetadata</a> {</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> std::vector&lt;BlobMetadata&gt; blobs;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> std::unordered_map&lt;std::string, std::string&gt; properties;</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keyword">friend</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1puffin_1_1FileMetadata.html">FileMetadata</a>&amp; lhs, <span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1puffin_1_1FileMetadata.html">FileMetadata</a>&amp; rhs) = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span>};</div>
</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span>ICEBERG_EXPORT std::string ToString(<span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1puffin_1_1FileMetadata.html">FileMetadata</a>&amp; file_metadata);</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span>} <span class="comment">// namespace iceberg::puffin</span></div>
<div class="ttc" id="afile__metadata_8h_html_a370ebcb6e23ad5d7640b3f2a612b06cc"><div class="ttname"><a href="file__metadata_8h.html#a370ebcb6e23ad5d7640b3f2a612b06cc">iceberg::puffin::PuffinCompressionCodec</a></div><div class="ttdeci">PuffinCompressionCodec</div><div class="ttdoc">Compression codecs supported by Puffin files.</div><div class="ttdef"><b>Definition</b> file_metadata.h:38</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1BlobMetadata_html"><div class="ttname"><a href="structiceberg_1_1puffin_1_1BlobMetadata.html">iceberg::puffin::BlobMetadata</a></div><div class="ttdoc">Metadata about a blob stored in a Puffin file footer.</div><div class="ttdef"><b>Definition</b> file_metadata.h:90</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1BlobMetadata_html_a2006c5efb416a6d939682999a7a1b29f"><div class="ttname"><a href="structiceberg_1_1puffin_1_1BlobMetadata.html#a2006c5efb416a6d939682999a7a1b29f">iceberg::puffin::BlobMetadata::sequence_number</a></div><div class="ttdeci">int64_t sequence_number</div><div class="ttdoc">Sequence number of the Iceberg table's snapshot the blob was computed from.</div><div class="ttdef"><b>Definition</b> file_metadata.h:98</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1BlobMetadata_html_a9ee2847def227ef7d66b4dad77c79abe"><div class="ttname"><a href="structiceberg_1_1puffin_1_1BlobMetadata.html#a9ee2847def227ef7d66b4dad77c79abe">iceberg::puffin::BlobMetadata::type</a></div><div class="ttdeci">std::string type</div><div class="ttdoc">See StandardBlobTypes for known types.</div><div class="ttdef"><b>Definition</b> file_metadata.h:92</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1BlobMetadata_html_aa4c3cfd2e88e11f993a8295ad9f244c0"><div class="ttname"><a href="structiceberg_1_1puffin_1_1BlobMetadata.html#aa4c3cfd2e88e11f993a8295ad9f244c0">iceberg::puffin::BlobMetadata::compression_codec</a></div><div class="ttdeci">std::string compression_codec</div><div class="ttdoc">Codec name (e.g. &quot;lz4&quot;, &quot;zstd&quot;), or empty if not compressed.</div><div class="ttdef"><b>Definition</b> file_metadata.h:102</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1BlobMetadata_html_aba7ed7503bc6340693616ae2da1baeca"><div class="ttname"><a href="structiceberg_1_1puffin_1_1BlobMetadata.html#aba7ed7503bc6340693616ae2da1baeca">iceberg::puffin::BlobMetadata::snapshot_id</a></div><div class="ttdeci">int64_t snapshot_id</div><div class="ttdoc">ID of the Iceberg table's snapshot the blob was computed from.</div><div class="ttdef"><b>Definition</b> file_metadata.h:96</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1BlobMetadata_html_acb23b8e1304c1c8f1313b3e502d89d1d"><div class="ttname"><a href="structiceberg_1_1puffin_1_1BlobMetadata.html#acb23b8e1304c1c8f1313b3e502d89d1d">iceberg::puffin::BlobMetadata::input_fields</a></div><div class="ttdeci">std::vector&lt; int32_t &gt; input_fields</div><div class="ttdoc">Ordered list of field IDs the blob was computed from.</div><div class="ttdef"><b>Definition</b> file_metadata.h:94</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1Blob_html"><div class="ttname"><a href="structiceberg_1_1puffin_1_1Blob.html">iceberg::puffin::Blob</a></div><div class="ttdoc">A blob in a Puffin file.</div><div class="ttdef"><b>Definition</b> file_metadata.h:70</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1Blob_html_a2668a95631f8f420d56b0d5145f14096"><div class="ttname"><a href="structiceberg_1_1puffin_1_1Blob.html#a2668a95631f8f420d56b0d5145f14096">iceberg::puffin::Blob::snapshot_id</a></div><div class="ttdeci">int64_t snapshot_id</div><div class="ttdoc">ID of the Iceberg table's snapshot the blob was computed from.</div><div class="ttdef"><b>Definition</b> file_metadata.h:76</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1Blob_html_a3b5f15d99ca2e7230fbb92d7f861c468"><div class="ttname"><a href="structiceberg_1_1puffin_1_1Blob.html#a3b5f15d99ca2e7230fbb92d7f861c468">iceberg::puffin::Blob::input_fields</a></div><div class="ttdeci">std::vector&lt; int32_t &gt; input_fields</div><div class="ttdoc">Ordered list of field IDs the blob was computed from.</div><div class="ttdef"><b>Definition</b> file_metadata.h:74</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1Blob_html_a4f7ca2a6cc93306a0a67890dadce3cea"><div class="ttname"><a href="structiceberg_1_1puffin_1_1Blob.html#a4f7ca2a6cc93306a0a67890dadce3cea">iceberg::puffin::Blob::type</a></div><div class="ttdeci">std::string type</div><div class="ttdoc">See StandardBlobTypes for known types.</div><div class="ttdef"><b>Definition</b> file_metadata.h:72</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1Blob_html_ac624cbd7745bef9a4df537f167b9435e"><div class="ttname"><a href="structiceberg_1_1puffin_1_1Blob.html#ac624cbd7745bef9a4df537f167b9435e">iceberg::puffin::Blob::requested_compression</a></div><div class="ttdeci">std::optional&lt; PuffinCompressionCodec &gt; requested_compression</div><div class="ttdoc">If not set, the writer's default codec will be used.</div><div class="ttdef"><b>Definition</b> file_metadata.h:81</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1Blob_html_ac79dc1a305b5e235f57ca2031f67a75e"><div class="ttname"><a href="structiceberg_1_1puffin_1_1Blob.html#ac79dc1a305b5e235f57ca2031f67a75e">iceberg::puffin::Blob::sequence_number</a></div><div class="ttdeci">int64_t sequence_number</div><div class="ttdoc">Sequence number of the Iceberg table's snapshot the blob was computed from.</div><div class="ttdef"><b>Definition</b> file_metadata.h:78</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1FileMetadata_html"><div class="ttname"><a href="structiceberg_1_1puffin_1_1FileMetadata.html">iceberg::puffin::FileMetadata</a></div><div class="ttdoc">Metadata about a Puffin file.</div><div class="ttdef"><b>Definition</b> file_metadata.h:111</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1StandardBlobTypes_html"><div class="ttname"><a href="structiceberg_1_1puffin_1_1StandardBlobTypes.html">iceberg::puffin::StandardBlobTypes</a></div><div class="ttdoc">Standard blob types defined by the Iceberg specification.</div><div class="ttdef"><b>Definition</b> file_metadata.h:52</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1StandardBlobTypes_html_a56ddc41d0b314ceb80ba6f8da65c7d93"><div class="ttname"><a href="structiceberg_1_1puffin_1_1StandardBlobTypes.html#a56ddc41d0b314ceb80ba6f8da65c7d93">iceberg::puffin::StandardBlobTypes::kApacheDatasketchesThetaV1</a></div><div class="ttdeci">static constexpr std::string_view kApacheDatasketchesThetaV1</div><div class="ttdef"><b>Definition</b> file_metadata.h:55</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1StandardBlobTypes_html_a6dc6f92f1eafdfa747657dcbd4abd394"><div class="ttname"><a href="structiceberg_1_1puffin_1_1StandardBlobTypes.html#a6dc6f92f1eafdfa747657dcbd4abd394">iceberg::puffin::StandardBlobTypes::kDeletionVectorV1</a></div><div class="ttdeci">static constexpr std::string_view kDeletionVectorV1</div><div class="ttdoc">A serialized deletion vector according to the Iceberg spec.</div><div class="ttdef"><b>Definition</b> file_metadata.h:59</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1StandardPuffinProperties_html"><div class="ttname"><a href="structiceberg_1_1puffin_1_1StandardPuffinProperties.html">iceberg::puffin::StandardPuffinProperties</a></div><div class="ttdoc">Standard file-level properties for Puffin files.</div><div class="ttdef"><b>Definition</b> file_metadata.h:63</div></div>
<div class="ttc" id="astructiceberg_1_1puffin_1_1StandardPuffinProperties_html_a9a1e50e04e551d463d667b5d3bc0bebf"><div class="ttname"><a href="structiceberg_1_1puffin_1_1StandardPuffinProperties.html#a9a1e50e04e551d463d667b5d3bc0bebf">iceberg::puffin::StandardPuffinProperties::kCreatedBy</a></div><div class="ttdeci">static constexpr std::string_view kCreatedBy</div><div class="ttdef"><b>Definition</b> file_metadata.h:66</div></div>
</div><!-- fragment --></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>