| <!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::DayTransform Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">iceberg-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1DayTransform.html">DayTransform</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classiceberg_1_1DayTransform-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::DayTransform Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Day transform that extracts the number of days from timestamp inputs since the epoch. |
| <a href="classiceberg_1_1DayTransform.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="transform__function_8h_source.html">transform_function.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::DayTransform:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1DayTransform.png" usemap="#iceberg::DayTransform_map" alt=""/> |
| <map id="iceberg::DayTransform_map" name="iceberg::DayTransform_map"> |
| <area href="classiceberg_1_1TransformFunction.html" title="A transform function used for partitioning." alt="iceberg::TransformFunction" shape="rect" coords="0,0,167,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:a6d95aec42995a021f6cb8fb76371305c" id="r_a6d95aec42995a021f6cb8fb76371305c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DayTransform.html#a6d95aec42995a021f6cb8fb76371305c">DayTransform</a> (std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > const &<a class="el" href="classiceberg_1_1TransformFunction.html#a2475d34d0e7284cf007e2177a0aaa99a">source_type</a>)</td></tr> |
| <tr class="separator:a6d95aec42995a021f6cb8fb76371305c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9617e7803992d5a1d6ad6200c65cba9b" id="r_a9617e7803992d5a1d6ad6200c65cba9b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< <a class="el" href="classiceberg_1_1Literal.html">Literal</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DayTransform.html#a9617e7803992d5a1d6ad6200c65cba9b">Transform</a> (const <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &literal) override</td></tr> |
| <tr class="memdesc:a9617e7803992d5a1d6ad6200c65cba9b"><td class="mdescLeft"> </td><td class="mdescRight">Extract a date or timestamp day, as days from 1970-01-01. <br /></td></tr> |
| <tr class="separator:a9617e7803992d5a1d6ad6200c65cba9b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2030c2ba2ef6a1a167e1576bbb330c06" id="r_a2030c2ba2ef6a1a167e1576bbb330c06"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DayTransform.html#a2030c2ba2ef6a1a167e1576bbb330c06">ResultType</a> () const override</td></tr> |
| <tr class="memdesc:a2030c2ba2ef6a1a167e1576bbb330c06"><td class="mdescLeft"> </td><td class="mdescRight">Return the result type of a day transform. <br /></td></tr> |
| <tr class="separator:a2030c2ba2ef6a1a167e1576bbb330c06"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classiceberg_1_1TransformFunction"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1TransformFunction')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classiceberg_1_1TransformFunction.html">iceberg::TransformFunction</a></td></tr> |
| <tr class="memitem:a3e97589741424abf0fb1c0c01117bb5e inherit pub_methods_classiceberg_1_1TransformFunction" id="r_a3e97589741424abf0fb1c0c01117bb5e"><td class="memItemLeft" align="right" valign="top"> |
|  </td><td class="memItemRight" valign="bottom"><b>TransformFunction</b> (<a class="el" href="namespaceiceberg.html#a78b299cfdfb0b9631ca6fc520bd1b131">TransformType</a> <a class="el" href="classiceberg_1_1TransformFunction.html#abf4c9031fa1b0de214e6aa7ffc717c56">transform_type</a>, std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > <a class="el" href="classiceberg_1_1TransformFunction.html#a2475d34d0e7284cf007e2177a0aaa99a">source_type</a>)</td></tr> |
| <tr class="separator:a3e97589741424abf0fb1c0c01117bb5e inherit pub_methods_classiceberg_1_1TransformFunction"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abf4c9031fa1b0de214e6aa7ffc717c56 inherit pub_methods_classiceberg_1_1TransformFunction" id="r_abf4c9031fa1b0de214e6aa7ffc717c56"><td class="memItemLeft" align="right" valign="top"> |
| <a class="el" href="namespaceiceberg.html#a78b299cfdfb0b9631ca6fc520bd1b131">TransformType</a> </td><td class="memItemRight" valign="bottom"><b>transform_type</b> () const</td></tr> |
| <tr class="memdesc:abf4c9031fa1b0de214e6aa7ffc717c56 inherit pub_methods_classiceberg_1_1TransformFunction"><td class="mdescLeft"> </td><td class="mdescRight">Get the transform type. <br /></td></tr> |
| <tr class="separator:abf4c9031fa1b0de214e6aa7ffc717c56 inherit pub_methods_classiceberg_1_1TransformFunction"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2475d34d0e7284cf007e2177a0aaa99a inherit pub_methods_classiceberg_1_1TransformFunction" id="r_a2475d34d0e7284cf007e2177a0aaa99a"><td class="memItemLeft" align="right" valign="top"> |
| const std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > & </td><td class="memItemRight" valign="bottom"><b>source_type</b> () const</td></tr> |
| <tr class="memdesc:a2475d34d0e7284cf007e2177a0aaa99a inherit pub_methods_classiceberg_1_1TransformFunction"><td class="mdescLeft"> </td><td class="mdescRight">Get the source type of transform function. <br /></td></tr> |
| <tr class="separator:a2475d34d0e7284cf007e2177a0aaa99a inherit pub_methods_classiceberg_1_1TransformFunction"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a41eb1028ba30a7cd03fb7a902fd5707d" id="r_a41eb1028ba30a7cd03fb7a902fd5707d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::unique_ptr< <a class="el" href="classiceberg_1_1TransformFunction.html">TransformFunction</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DayTransform.html#a41eb1028ba30a7cd03fb7a902fd5707d">Make</a> (std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > const &<a class="el" href="classiceberg_1_1TransformFunction.html#a2475d34d0e7284cf007e2177a0aaa99a">source_type</a>)</td></tr> |
| <tr class="memdesc:a41eb1028ba30a7cd03fb7a902fd5707d"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classiceberg_1_1DayTransform.html" title="Day transform that extracts the number of days from timestamp inputs since the epoch.">DayTransform</a>. <br /></td></tr> |
| <tr class="separator:a41eb1028ba30a7cd03fb7a902fd5707d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pro_methods_classiceberg_1_1TransformFunction"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classiceberg_1_1TransformFunction')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classiceberg_1_1TransformFunction.html">iceberg::TransformFunction</a></td></tr> |
| <tr class="memitem:a61917b6c790b711c1b160355e8593a0b inherit pro_methods_classiceberg_1_1TransformFunction" id="r_a61917b6c790b711c1b160355e8593a0b"><td class="memItemLeft" align="right" valign="top"> |
| virtual bool </td><td class="memItemRight" valign="bottom"><b>Equals</b> (const <a class="el" href="classiceberg_1_1TransformFunction.html">TransformFunction</a> &other) const</td></tr> |
| <tr class="memdesc:a61917b6c790b711c1b160355e8593a0b inherit pro_methods_classiceberg_1_1TransformFunction"><td class="mdescLeft"> </td><td class="mdescRight">Compare the common properties of two transform functions for equality. <br /></td></tr> |
| <tr class="separator:a61917b6c790b711c1b160355e8593a0b inherit pro_methods_classiceberg_1_1TransformFunction"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Day transform that extracts the number of days from timestamp inputs since the epoch. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a6d95aec42995a021f6cb8fb76371305c" name="a6d95aec42995a021f6cb8fb76371305c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6d95aec42995a021f6cb8fb76371305c">◆ </a></span>DayTransform()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">iceberg::DayTransform::DayTransform </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > const & </td> |
| <td class="paramname"><em>source_type</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">source_type</td><td>Must be a timestamp type. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a41eb1028ba30a7cd03fb7a902fd5707d" name="a41eb1028ba30a7cd03fb7a902fd5707d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a41eb1028ba30a7cd03fb7a902fd5707d">◆ </a></span>Make()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::unique_ptr< <a class="el" href="classiceberg_1_1TransformFunction.html">TransformFunction</a> > > iceberg::DayTransform::Make </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > const & </td> |
| <td class="paramname"><em>source_type</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a <a class="el" href="classiceberg_1_1DayTransform.html" title="Day transform that extracts the number of days from timestamp inputs since the epoch.">DayTransform</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">source_type</td><td><a class="el" href="classiceberg_1_1Type.html" title="Interface for a data type for a field.">Type</a> of the input data. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A Result containing the <a class="el" href="classiceberg_1_1DayTransform.html" title="Day transform that extracts the number of days from timestamp inputs since the epoch.">DayTransform</a> or an error. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a2030c2ba2ef6a1a167e1576bbb330c06" name="a2030c2ba2ef6a1a167e1576bbb330c06"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2030c2ba2ef6a1a167e1576bbb330c06">◆ </a></span>ResultType()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > iceberg::DayTransform::ResultType </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>Return the result type of a day transform. </p> |
| <p>Note: The physical representation conforms to the Iceberg spec as <a class="el" href="classiceberg_1_1DateType.html" title="A data type representing a calendar date without reference to a timezone or time.">DateType</a> is internally converted to int. The <a class="el" href="classiceberg_1_1DateType.html" title="A data type representing a calendar date without reference to a timezone or time.">DateType</a> returned here provides a more human-readable way to display the partition field. </p> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1TransformFunction.html#a82841b58ce6380a7467bccf57e18e0d5">iceberg::TransformFunction</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a9617e7803992d5a1d6ad6200c65cba9b" name="a9617e7803992d5a1d6ad6200c65cba9b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9617e7803992d5a1d6ad6200c65cba9b">◆ </a></span>Transform()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< <a class="el" href="classiceberg_1_1Literal.html">Literal</a> > iceberg::DayTransform::Transform </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1Literal.html">Literal</a> & </td> |
| <td class="paramname"><em>literal</em></td><td>)</td> |
| <td></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>Extract a date or timestamp day, as days from 1970-01-01. </p> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1TransformFunction.html#afb1c573d9bd098c76d858f476ef16f3f">iceberg::TransformFunction</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>iceberg/<a class="el" href="transform__function_8h_source.html">transform_function.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
| </small></address> |
| </body> |
| </html> |
