blob: 2894462f243f28efd1a7e098b2aa209be9c8a50a [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/partition_spec.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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">partition_spec.h</div></div>
</div><!--header-->
<div class="contents">
<a href="partition__spec_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;memory&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;optional&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;span&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;unordered_map&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include &quot;iceberg/iceberg_export.h&quot;</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include &quot;<a class="code" href="partition__field_8h.html">iceberg/partition_field.h</a>&quot;</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#include &quot;iceberg/result.h&quot;</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#include &quot;<a class="code" href="type__fwd_8h.html">iceberg/type_fwd.h</a>&quot;</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="preprocessor">#include &quot;<a class="code" href="formattable_8h.html">iceberg/util/formattable.h</a>&quot;</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#include &quot;<a class="code" href="lazy_8h.html">iceberg/util/lazy.h</a>&quot;</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="keyword">namespace </span>iceberg {</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="foldopen" id="foldopen00047" data-start="{" data-end="};">
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classiceberg_1_1PartitionSpec.html"> 47</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1util_1_1Formattable.html">util::Formattable</a> {</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> int32_t kInitialSpecId = 0;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classiceberg_1_1PartitionSpec.html#ad97896f90ee14db953bd7af46d389b06"> 52</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> int32_t kLegacyPartitionDataIdStart = 1000;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> int32_t kInvalidPartitionFieldId = -1;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">static</span> <span class="keyword">const</span> std::shared_ptr&lt;PartitionSpec&gt;&amp; Unpartitioned();</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"> 59</span> int32_t spec_id() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> std::span&lt;const PartitionField&gt; fields() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> Result&lt;std::unique_ptr&lt;StructType&gt;&gt; PartitionType(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Schema.html">Schema</a>&amp; schema) <span class="keyword">const</span>;</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> Result&lt;std::string&gt; PartitionPath(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1PartitionValues.html">PartitionValues</a>&amp; data) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">bool</span> CompatibleWith(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a>&amp; other) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> std::string ToString() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> int32_t last_assigned_field_id()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> last_assigned_field_id_; }</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">friend</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a>&amp; lhs, <span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a>&amp; rhs) {</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keywordflow">return</span> lhs.Equals(rhs);</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> }</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> Status Validate(<span class="keyword">const</span> Schema&amp; schema, <span class="keywordtype">bool</span> allow_missing_fields) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="comment">// \brief Validates the partition field names are unique within the partition spec and</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="comment">// schema.</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">static</span> Status ValidatePartitionName(<span class="keyword">const</span> Schema&amp; schema, <span class="keyword">const</span> PartitionSpec&amp; spec);</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="classiceberg_1_1PartitionSpec.html#a0337c81bdfc75ae19d371024f09e3af7"> 98</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classiceberg_1_1PartitionSpec.html#a0337c81bdfc75ae19d371024f09e3af7">PartitionFieldRef</a> = std::reference_wrapper&lt;const PartitionField&gt;;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> Result&lt;std::vector&lt;PartitionFieldRef&gt;&gt; GetFieldsBySourceId(int32_t source_id) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">static</span> Result&lt;std::unique_ptr&lt;PartitionSpec&gt;&gt; Make(</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Schema.html">Schema</a>&amp; schema, int32_t spec_id, std::vector&lt;PartitionField&gt; fields,</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="keywordtype">bool</span> allow_missing_fields,</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> std::optional&lt;int32_t&gt; last_assigned_field_id = std::nullopt);</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">static</span> Result&lt;std::unique_ptr&lt;PartitionSpec&gt;&gt; Make(</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> int32_t spec_id, std::vector&lt;PartitionField&gt; fields,</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> std::optional&lt;int32_t&gt; last_assigned_field_id = std::nullopt);</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> HasSequentialFieldIds(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a>&amp; spec);</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> <a class="code hl_class" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a>(int32_t spec_id, std::vector&lt;PartitionField&gt; fields,</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> std::optional&lt;int32_t&gt; last_assigned_field_id = std::nullopt);</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="keywordtype">bool</span> Equals(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a>&amp; other) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> <span class="keyword">static</span> Status ValidateRedundantPartitions(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a>&amp; spec);</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> <span class="keyword">using </span>SourceIdToFieldsMap = std::unordered_map&lt;int32_t, std::vector&lt;PartitionFieldRef&gt;&gt;;</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> <span class="keyword">static</span> Result&lt;SourceIdToFieldsMap&gt; InitSourceIdToFieldsMap(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a>&amp;);</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <span class="keyword">const</span> int32_t spec_id_;</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> std::vector&lt;PartitionField&gt; fields_;</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> int32_t last_assigned_field_id_;</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> <a class="code hl_class" href="classiceberg_1_1Lazy.html">Lazy&lt;InitSourceIdToFieldsMap&gt;</a> source_id_to_fields_;</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span>};</div>
</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span>} <span class="comment">// namespace iceberg</span></div>
<div class="ttc" id="aclassiceberg_1_1Lazy_html"><div class="ttname"><a href="classiceberg_1_1Lazy.html">iceberg::Lazy</a></div><div class="ttdef"><b>Definition</b> lazy.h:35</div></div>
<div class="ttc" id="aclassiceberg_1_1PartitionSpec_html"><div class="ttname"><a href="classiceberg_1_1PartitionSpec.html">iceberg::PartitionSpec</a></div><div class="ttdoc">A partition spec for a Table.</div><div class="ttdef"><b>Definition</b> partition_spec.h:47</div></div>
<div class="ttc" id="aclassiceberg_1_1PartitionSpec_html_a0337c81bdfc75ae19d371024f09e3af7"><div class="ttname"><a href="classiceberg_1_1PartitionSpec.html#a0337c81bdfc75ae19d371024f09e3af7">iceberg::PartitionSpec::PartitionFieldRef</a></div><div class="ttdeci">std::reference_wrapper&lt; const PartitionField &gt; PartitionFieldRef</div><div class="ttdoc">Get the partition fields by source ID.</div><div class="ttdef"><b>Definition</b> partition_spec.h:98</div></div>
<div class="ttc" id="aclassiceberg_1_1PartitionValues_html"><div class="ttname"><a href="classiceberg_1_1PartitionValues.html">iceberg::PartitionValues</a></div><div class="ttdoc">StructLike wrapper for a vector of literals that represent partition values.</div><div class="ttdef"><b>Definition</b> partition_values.h:36</div></div>
<div class="ttc" id="aclassiceberg_1_1Schema_html"><div class="ttname"><a href="classiceberg_1_1Schema.html">iceberg::Schema</a></div><div class="ttdoc">A schema for a Table.</div><div class="ttdef"><b>Definition</b> schema.h:49</div></div>
<div class="ttc" id="aclassiceberg_1_1util_1_1Formattable_html"><div class="ttname"><a href="classiceberg_1_1util_1_1Formattable.html">iceberg::util::Formattable</a></div><div class="ttdoc">Interface for objects that can be formatted via std::format.</div><div class="ttdef"><b>Definition</b> formattable.h:36</div></div>
<div class="ttc" id="aformattable_8h_html"><div class="ttname"><a href="formattable_8h.html">formattable.h</a></div></div>
<div class="ttc" id="alazy_8h_html"><div class="ttname"><a href="lazy_8h.html">lazy.h</a></div></div>
<div class="ttc" id="apartition__field_8h_html"><div class="ttname"><a href="partition__field_8h.html">partition_field.h</a></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&#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>