Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1PartitionField.html
blob: d3c7163b2831b76a347a01078a5f6ef1791b843e [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::PartitionField Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1PartitionField.html">PartitionField</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classiceberg_1_1PartitionField-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::PartitionField Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>a field with its transform.
<a href="classiceberg_1_1PartitionField.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="partition__field_8h_source.html">partition_field.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::PartitionField:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1PartitionField.png" usemap="#iceberg::PartitionField_map" alt=""/>
<map id="iceberg::PartitionField_map" name="iceberg::PartitionField_map">
<area href="classiceberg_1_1util_1_1Formattable.html" title="Interface for objects that can be formatted via std::format." alt="iceberg::util::Formattable" shape="rect" coords="0,0,149,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a88472e5c2d1f209efccc89c8d54e57fd" id="r_a88472e5c2d1f209efccc89c8d54e57fd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PartitionField.html#a88472e5c2d1f209efccc89c8d54e57fd">PartitionField</a> (int32_t <a class="el" href="classiceberg_1_1PartitionField.html#a04d426b19a55956bf3ac9a8fda16c732">source_id</a>, int32_t <a class="el" href="classiceberg_1_1PartitionField.html#acfbcfaa917a381e19fe341b419d629c5">field_id</a>, std::string <a class="el" href="classiceberg_1_1PartitionField.html#a04982b064f865668c33c8ce6ddc46313">name</a>, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Transform.html">Transform</a> &gt; <a class="el" href="classiceberg_1_1PartitionField.html#a2b12d501b31fcbc06d17fb37e975ea23">transform</a>)</td></tr>
<tr class="memdesc:a88472e5c2d1f209efccc89c8d54e57fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a field. <br /></td></tr>
<tr class="separator:a88472e5c2d1f209efccc89c8d54e57fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04d426b19a55956bf3ac9a8fda16c732" id="r_a04d426b19a55956bf3ac9a8fda16c732"><td class="memItemLeft" align="right" valign="top"><a id="a04d426b19a55956bf3ac9a8fda16c732" name="a04d426b19a55956bf3ac9a8fda16c732"></a>
int32_t&#160;</td><td class="memItemRight" valign="bottom"><b>source_id</b> () const</td></tr>
<tr class="memdesc:a04d426b19a55956bf3ac9a8fda16c732"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the source field ID. <br /></td></tr>
<tr class="separator:a04d426b19a55956bf3ac9a8fda16c732"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfbcfaa917a381e19fe341b419d629c5" id="r_acfbcfaa917a381e19fe341b419d629c5"><td class="memItemLeft" align="right" valign="top"><a id="acfbcfaa917a381e19fe341b419d629c5" name="acfbcfaa917a381e19fe341b419d629c5"></a>
int32_t&#160;</td><td class="memItemRight" valign="bottom"><b>field_id</b> () const</td></tr>
<tr class="memdesc:acfbcfaa917a381e19fe341b419d629c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the partition field ID. <br /></td></tr>
<tr class="separator:acfbcfaa917a381e19fe341b419d629c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04982b064f865668c33c8ce6ddc46313" id="r_a04982b064f865668c33c8ce6ddc46313"><td class="memItemLeft" align="right" valign="top"><a id="a04982b064f865668c33c8ce6ddc46313" name="a04982b064f865668c33c8ce6ddc46313"></a>
std::string_view&#160;</td><td class="memItemRight" valign="bottom"><b>name</b> () const</td></tr>
<tr class="memdesc:a04982b064f865668c33c8ce6ddc46313"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the partition field name. <br /></td></tr>
<tr class="separator:a04982b064f865668c33c8ce6ddc46313"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b12d501b31fcbc06d17fb37e975ea23" id="r_a2b12d501b31fcbc06d17fb37e975ea23"><td class="memItemLeft" align="right" valign="top"><a id="a2b12d501b31fcbc06d17fb37e975ea23" name="a2b12d501b31fcbc06d17fb37e975ea23"></a>
std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Transform.html">Transform</a> &gt; const &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>transform</b> () const</td></tr>
<tr class="memdesc:a2b12d501b31fcbc06d17fb37e975ea23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the transform type. <br /></td></tr>
<tr class="separator:a2b12d501b31fcbc06d17fb37e975ea23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a283571a060eed62337d28d805bd5a09b" id="r_a283571a060eed62337d28d805bd5a09b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1PartitionField.html#a283571a060eed62337d28d805bd5a09b">ToString</a> () const override</td></tr>
<tr class="memdesc:a283571a060eed62337d28d805bd5a09b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a user-readable string representation. <br /></td></tr>
<tr class="separator:a283571a060eed62337d28d805bd5a09b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:aa14688fdeed1bd45e7c9f250998cbbfe" id="r_aa14688fdeed1bd45e7c9f250998cbbfe"><td class="memItemLeft" align="right" valign="top"><a id="aa14688fdeed1bd45e7c9f250998cbbfe" name="aa14688fdeed1bd45e7c9f250998cbbfe"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classiceberg_1_1PartitionField.html">PartitionField</a> &amp;lhs, const <a class="el" href="classiceberg_1_1PartitionField.html">PartitionField</a> &amp;rhs)</td></tr>
<tr class="separator:aa14688fdeed1bd45e7c9f250998cbbfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>a field with its transform. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a88472e5c2d1f209efccc89c8d54e57fd" name="a88472e5c2d1f209efccc89c8d54e57fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88472e5c2d1f209efccc89c8d54e57fd">&#9670;&#160;</a></span>PartitionField()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">iceberg::PartitionField::PartitionField </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>source_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>field_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Transform.html">Transform</a> &gt;&#160;</td>
<td class="paramname"><em>transform</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">source_id</td><td>The source field ID. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">field_id</td><td>The partition field ID. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The partition field name. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">transform</td><td>The transform function. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a283571a060eed62337d28d805bd5a09b" name="a283571a060eed62337d28d805bd5a09b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a283571a060eed62337d28d805bd5a09b">&#9670;&#160;</a></span>ToString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string iceberg::PartitionField::ToString </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a user-readable string representation. </p>
<p>Implements <a class="el" href="classiceberg_1_1util_1_1Formattable.html#a79618aca5b3bf63610d9c87ac5ae0386">iceberg::util::Formattable</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/<a class="el" href="partition__field_8h_source.html">partition_field.h</a></li>
<li>iceberg/<b>partition_field.cc</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>