| <!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/transform.h File 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="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#enum-members">Enumerations</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"><div class="title">transform.h File Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="textblock"><code>#include <cstdint></code><br /> |
| <code>#include <memory></code><br /> |
| <code>#include <string_view></code><br /> |
| <code>#include <utility></code><br /> |
| <code>#include <variant></code><br /> |
| <code>#include "iceberg/expression/literal.h"</code><br /> |
| <code>#include "iceberg/iceberg_export.h"</code><br /> |
| <code>#include "iceberg/result.h"</code><br /> |
| <code>#include "<a class="el" href="type__fwd_8h_source.html">iceberg/type_fwd.h</a>"</code><br /> |
| <code>#include "<a class="el" href="formattable_8h_source.html">iceberg/util/formattable.h</a>"</code><br /> |
| </div> |
| <p><a href="transform_8h_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html">iceberg::Transform</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents a transform used in partitioning or sorting in Iceberg. <a href="classiceberg_1_1Transform.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TransformFunction.html">iceberg::TransformFunction</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A transform function used for partitioning. <a href="classiceberg_1_1TransformFunction.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a> |
| Enumerations</h2></td></tr> |
| <tr class="memitem:a78b299cfdfb0b9631ca6fc520bd1b131" id="r_a78b299cfdfb0b9631ca6fc520bd1b131"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131">iceberg::TransformType</a> { <br /> |
|   <a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131a25c2dc47991b3df171ed5192bcf70390">kUnknown</a> |
| , <a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131ac7c5a181d7cc5f5733d84dd9bd778967">kIdentity</a> |
| , <a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131a0226618c5258d9e1e71a400e0735314d">kBucket</a> |
| , <a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131a6393f5467404a20b7754c5032eb69bfd">kTruncate</a> |
| , <br /> |
|   <a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131ae5f29bf7f42ebe083f06960f4fbe6edc">kYear</a> |
| , <a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131abc4d3195c11185792391cc43d779d01d">kMonth</a> |
| , <a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131a8f642cb82e8f76aabc6e3ff8d1dd5119">kDay</a> |
| , <a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131a818152297c27d28aa4c1341db214c84b">kHour</a> |
| , <br /> |
|   <a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131abd383557eb16fc23863cf3fc70b77ab3">kVoid</a> |
| <br /> |
| }</td></tr> |
| <tr class="memdesc:a78b299cfdfb0b9631ca6fc520bd1b131"><td class="mdescLeft"> </td><td class="mdescRight">Transform types used for partitioning. <a href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131">More...</a><br /></td></tr> |
| <tr class="separator:a78b299cfdfb0b9631ca6fc520bd1b131"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a165e3b4437918cd461bfabe9fe5d3a91" id="r_a165e3b4437918cd461bfabe9fe5d3a91"><td class="memItemLeft" align="right" valign="top"><a id="a165e3b4437918cd461bfabe9fe5d3a91" name="a165e3b4437918cd461bfabe9fe5d3a91"></a> |
| ICEBERG_EXPORT constexpr std::string_view </td><td class="memItemRight" valign="bottom"><b>iceberg::TransformTypeToString</b> (<a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131">TransformType</a> type)</td></tr> |
| <tr class="memdesc:a165e3b4437918cd461bfabe9fe5d3a91"><td class="mdescLeft"> </td><td class="mdescRight">Get the relative transform name. <br /></td></tr> |
| <tr class="separator:a165e3b4437918cd461bfabe9fe5d3a91"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a01618a62c6221ea8682246168e74a8a3" id="r_a01618a62c6221ea8682246168e74a8a3"><td class="memItemLeft" align="right" valign="top">Result< std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="transform_8cc.html#a01618a62c6221ea8682246168e74a8a3">iceberg::TransformFromString</a> (std::string_view transform_str)</td></tr> |
| <tr class="memdesc:a01618a62c6221ea8682246168e74a8a3"><td class="mdescLeft"> </td><td class="mdescRight">Converts a string representation of a transform into a <a class="el" href="classiceberg_1_1Transform.html" title="Represents a transform used in partitioning or sorting in Iceberg.">Transform</a> instance. <br /></td></tr> |
| <tr class="separator:a01618a62c6221ea8682246168e74a8a3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Enumeration Type Documentation</h2> |
| <a id="a78b299cfdfb0b9631ca6fc520bd1b131" name="a78b299cfdfb0b9631ca6fc520bd1b131"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a78b299cfdfb0b9631ca6fc520bd1b131">◆ </a></span>TransformType</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum class <a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131">iceberg::TransformType</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">strong</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Transform types used for partitioning. </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a78b299cfdfb0b9631ca6fc520bd1b131a25c2dc47991b3df171ed5192bcf70390" name="a78b299cfdfb0b9631ca6fc520bd1b131a25c2dc47991b3df171ed5192bcf70390"></a>kUnknown </td><td class="fielddoc"><p>Used to represent some customized transform that can't be recognized or supported now. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a78b299cfdfb0b9631ca6fc520bd1b131ac7c5a181d7cc5f5733d84dd9bd778967" name="a78b299cfdfb0b9631ca6fc520bd1b131ac7c5a181d7cc5f5733d84dd9bd778967"></a>kIdentity </td><td class="fielddoc"><p>Equal to source value, unmodified. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a78b299cfdfb0b9631ca6fc520bd1b131a0226618c5258d9e1e71a400e0735314d" name="a78b299cfdfb0b9631ca6fc520bd1b131a0226618c5258d9e1e71a400e0735314d"></a>kBucket </td><td class="fielddoc"><p>Hash of value, mod <code>N</code> </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a78b299cfdfb0b9631ca6fc520bd1b131a6393f5467404a20b7754c5032eb69bfd" name="a78b299cfdfb0b9631ca6fc520bd1b131a6393f5467404a20b7754c5032eb69bfd"></a>kTruncate </td><td class="fielddoc"><p>Value truncated to width <code>W</code> </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a78b299cfdfb0b9631ca6fc520bd1b131ae5f29bf7f42ebe083f06960f4fbe6edc" name="a78b299cfdfb0b9631ca6fc520bd1b131ae5f29bf7f42ebe083f06960f4fbe6edc"></a>kYear </td><td class="fielddoc"><p>Extract a date or timestamp year, as years from 1970. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a78b299cfdfb0b9631ca6fc520bd1b131abc4d3195c11185792391cc43d779d01d" name="a78b299cfdfb0b9631ca6fc520bd1b131abc4d3195c11185792391cc43d779d01d"></a>kMonth </td><td class="fielddoc"><p>Extract a date or timestamp month, as months from 1970-01. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a78b299cfdfb0b9631ca6fc520bd1b131a8f642cb82e8f76aabc6e3ff8d1dd5119" name="a78b299cfdfb0b9631ca6fc520bd1b131a8f642cb82e8f76aabc6e3ff8d1dd5119"></a>kDay </td><td class="fielddoc"><p>Extract a date or timestamp day, as days from 1970-01-01. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a78b299cfdfb0b9631ca6fc520bd1b131a818152297c27d28aa4c1341db214c84b" name="a78b299cfdfb0b9631ca6fc520bd1b131a818152297c27d28aa4c1341db214c84b"></a>kHour </td><td class="fielddoc"><p>Extract a timestamp hour, as hours from 1970-01-01 00:00:00. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a78b299cfdfb0b9631ca6fc520bd1b131abd383557eb16fc23863cf3fc70b77ab3" name="a78b299cfdfb0b9631ca6fc520bd1b131abd383557eb16fc23863cf3fc70b77ab3"></a>kVoid </td><td class="fielddoc"><p>Always produces <code>null</code> </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="a01618a62c6221ea8682246168e74a8a3" name="a01618a62c6221ea8682246168e74a8a3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a01618a62c6221ea8682246168e74a8a3">◆ </a></span>TransformFromString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ICEBERG_EXPORT Result< std::shared_ptr< Transform > > iceberg::TransformFromString </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>transform_str</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Converts a string representation of a transform into a Transform instance. </p> |
| <p>This function parses the provided string to identify the corresponding transform type (e.g., "identity", "year", "bucket[16]"), and creates a shared pointer to the corresponding Transform object. It supports both simple transforms (like "identity") and parameterized transforms (like "bucket[16]" or "truncate[4]").</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">transform_str</td><td>The string representation of the transform type. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A Result containing either a shared pointer to the corresponding Transform instance or an Error if the string does not match any valid transform type. </dd></dl> |
| |
| </div> |
| </div> |
| </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> |
