| <!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 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"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1Transform.html">Transform</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="#friends">Friends</a> | |
| <a href="classiceberg_1_1Transform-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::Transform Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Represents a transform used in partitioning or sorting in Iceberg. |
| <a href="classiceberg_1_1Transform.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="transform_8h_source.html">transform.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::Transform:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1Transform.png" usemap="#iceberg::Transform_map" alt=""/> |
| <map id="iceberg::Transform_map" name="iceberg::Transform_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:afbed008e01be5d67004e7aaa24fb75f2" id="r_afbed008e01be5d67004e7aaa24fb75f2"><td class="memItemLeft" align="right" valign="top"><a id="afbed008e01be5d67004e7aaa24fb75f2" name="afbed008e01be5d67004e7aaa24fb75f2"></a> |
| <a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131">TransformType</a> </td><td class="memItemRight" valign="bottom"><b>transform_type</b> () const</td></tr> |
| <tr class="memdesc:afbed008e01be5d67004e7aaa24fb75f2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the transform type. <br /></td></tr> |
| <tr class="separator:afbed008e01be5d67004e7aaa24fb75f2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4028210e3c0b3d5bfaed8bb07ef4dae6" id="r_a4028210e3c0b3d5bfaed8bb07ef4dae6"><td class="memItemLeft" align="right" valign="top">Result< std::shared_ptr< <a class="el" href="classiceberg_1_1TransformFunction.html">TransformFunction</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#a4028210e3c0b3d5bfaed8bb07ef4dae6">Bind</a> (const std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > &source_type) const</td></tr> |
| <tr class="memdesc:a4028210e3c0b3d5bfaed8bb07ef4dae6"><td class="mdescLeft"> </td><td class="mdescRight">Binds this transform to a source type, returning a typed <a class="el" href="classiceberg_1_1TransformFunction.html" title="A transform function used for partitioning.">TransformFunction</a>. <br /></td></tr> |
| <tr class="separator:a4028210e3c0b3d5bfaed8bb07ef4dae6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a51284bd3b85cd5951be730b2c887708e" id="r_a51284bd3b85cd5951be730b2c887708e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#a51284bd3b85cd5951be730b2c887708e">CanTransform</a> (const <a class="el" href="classiceberg_1_1Type.html">Type</a> &source_type) const</td></tr> |
| <tr class="memdesc:a51284bd3b85cd5951be730b2c887708e"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether this function can be applied to the given <a class="el" href="classiceberg_1_1Type.html" title="Interface for a data type for a field.">Type</a>. <br /></td></tr> |
| <tr class="separator:a51284bd3b85cd5951be730b2c887708e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afb27bac92bade0469d6f5ed436ac28d0" id="r_afb27bac92bade0469d6f5ed436ac28d0"><td class="memItemLeft" align="right" valign="top"><a id="afb27bac92bade0469d6f5ed436ac28d0" name="afb27bac92bade0469d6f5ed436ac28d0"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>PreservesOrder</b> () const</td></tr> |
| <tr class="memdesc:afb27bac92bade0469d6f5ed436ac28d0"><td class="mdescLeft"> </td><td class="mdescRight">Whether the transform preserves the order of values (is monotonic). <br /></td></tr> |
| <tr class="separator:afb27bac92bade0469d6f5ed436ac28d0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab8dd9a9699f039f5bb4c0133687ec1a0" id="r_ab8dd9a9699f039f5bb4c0133687ec1a0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#ab8dd9a9699f039f5bb4c0133687ec1a0">SatisfiesOrderOf</a> (const <a class="el" href="classiceberg_1_1Transform.html">Transform</a> &other) const</td></tr> |
| <tr class="memdesc:ab8dd9a9699f039f5bb4c0133687ec1a0"><td class="mdescLeft"> </td><td class="mdescRight">Whether ordering by this transform's result satisfies the ordering of another transform's result. <br /></td></tr> |
| <tr class="separator:ab8dd9a9699f039f5bb4c0133687ec1a0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac0a1ac335d0816a473bd3e811fce9b25" id="r_ac0a1ac335d0816a473bd3e811fce9b25"><td class="memItemLeft" align="right" valign="top">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1UnboundPredicate.html">UnboundPredicate</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#ac0a1ac335d0816a473bd3e811fce9b25">Project</a> (std::string_view name, const std::shared_ptr< <a class="el" href="classiceberg_1_1BoundPredicate.html">BoundPredicate</a> > &predicate)</td></tr> |
| <tr class="memdesc:ac0a1ac335d0816a473bd3e811fce9b25"><td class="mdescLeft"> </td><td class="mdescRight">Transforms a <a class="el" href="classiceberg_1_1BoundPredicate.html" title="Bound predicates contain bound terms and can be evaluated.">BoundPredicate</a> to an inclusive predicate on the partition values produced by the transform. <br /></td></tr> |
| <tr class="separator:ac0a1ac335d0816a473bd3e811fce9b25"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2779a1a98eadc543af8ff3ecb128215e" id="r_a2779a1a98eadc543af8ff3ecb128215e"><td class="memItemLeft" align="right" valign="top">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1UnboundPredicate.html">UnboundPredicate</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#a2779a1a98eadc543af8ff3ecb128215e">ProjectStrict</a> (std::string_view name, const std::shared_ptr< <a class="el" href="classiceberg_1_1BoundPredicate.html">BoundPredicate</a> > &predicate)</td></tr> |
| <tr class="memdesc:a2779a1a98eadc543af8ff3ecb128215e"><td class="mdescLeft"> </td><td class="mdescRight">Transforms a <a class="el" href="classiceberg_1_1BoundPredicate.html" title="Bound predicates contain bound terms and can be evaluated.">BoundPredicate</a> to a strict predicate on the partition values produced by the transform. <br /></td></tr> |
| <tr class="separator:a2779a1a98eadc543af8ff3ecb128215e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afd2e4a6210b3f51f8ea8b44c84428988" id="r_afd2e4a6210b3f51f8ea8b44c84428988"><td class="memItemLeft" align="right" valign="top">Result< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#afd2e4a6210b3f51f8ea8b44c84428988">ToHumanString</a> (const <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &value)</td></tr> |
| <tr class="memdesc:afd2e4a6210b3f51f8ea8b44c84428988"><td class="mdescLeft"> </td><td class="mdescRight">Returns a human-readable string representation of a transformed value. <br /></td></tr> |
| <tr class="separator:afd2e4a6210b3f51f8ea8b44c84428988"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af5c8b537969e36e0c2f35a5baf3f6d10" id="r_af5c8b537969e36e0c2f35a5baf3f6d10"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#af5c8b537969e36e0c2f35a5baf3f6d10">ToString</a> () const override</td></tr> |
| <tr class="memdesc:af5c8b537969e36e0c2f35a5baf3f6d10"><td class="mdescLeft"> </td><td class="mdescRight">Returns a string representation of this transform (e.g., "bucket[16]"). <br /></td></tr> |
| <tr class="separator:af5c8b537969e36e0c2f35a5baf3f6d10"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a59dba809ed7b418964c77f46301633eb" id="r_a59dba809ed7b418964c77f46301633eb"><td class="memItemLeft" align="right" valign="top"><a id="a59dba809ed7b418964c77f46301633eb" name="a59dba809ed7b418964c77f46301633eb"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>DedupName</b> () const</td></tr> |
| <tr class="memdesc:a59dba809ed7b418964c77f46301633eb"><td class="mdescLeft"> </td><td class="mdescRight">Return the unique transform name to check if similar transforms for the same source field are added multiple times in partition spec builder. <br /></td></tr> |
| <tr class="separator:a59dba809ed7b418964c77f46301633eb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a33f12e4ac4082a9fa0c159c8fd84fa52" id="r_a33f12e4ac4082a9fa0c159c8fd84fa52"><td class="memItemLeft" align="right" valign="top">Result< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#a33f12e4ac4082a9fa0c159c8fd84fa52">GeneratePartitionName</a> (std::string_view source_name) const</td></tr> |
| <tr class="memdesc:a33f12e4ac4082a9fa0c159c8fd84fa52"><td class="mdescLeft"> </td><td class="mdescRight">Generates a partition name for the transform. <br /></td></tr> |
| <tr class="separator:a33f12e4ac4082a9fa0c159c8fd84fa52"><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:ac4af9a6b608050712db9b11906e6f198" id="r_ac4af9a6b608050712db9b11906e6f198"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#ac4af9a6b608050712db9b11906e6f198">Identity</a> ()</td></tr> |
| <tr class="memdesc:ac4af9a6b608050712db9b11906e6f198"><td class="mdescLeft"> </td><td class="mdescRight">Returns a shared singleton instance of the Identity transform. <br /></td></tr> |
| <tr class="separator:ac4af9a6b608050712db9b11906e6f198"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac8370cf16ba3c26216f314dbdac5259a" id="r_ac8370cf16ba3c26216f314dbdac5259a"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#ac8370cf16ba3c26216f314dbdac5259a">Bucket</a> (int32_t num_buckets)</td></tr> |
| <tr class="memdesc:ac8370cf16ba3c26216f314dbdac5259a"><td class="mdescLeft"> </td><td class="mdescRight">Creates a shared instance of the Bucket transform. <br /></td></tr> |
| <tr class="separator:ac8370cf16ba3c26216f314dbdac5259a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5322807a616aecc18389f959e9d51373" id="r_a5322807a616aecc18389f959e9d51373"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#a5322807a616aecc18389f959e9d51373">Truncate</a> (int32_t width)</td></tr> |
| <tr class="memdesc:a5322807a616aecc18389f959e9d51373"><td class="mdescLeft"> </td><td class="mdescRight">Creates a shared instance of the Truncate transform. <br /></td></tr> |
| <tr class="separator:a5322807a616aecc18389f959e9d51373"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a203252162bb4d5a1e89b18cbf9ba2278" id="r_a203252162bb4d5a1e89b18cbf9ba2278"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#a203252162bb4d5a1e89b18cbf9ba2278">Year</a> ()</td></tr> |
| <tr class="memdesc:a203252162bb4d5a1e89b18cbf9ba2278"><td class="mdescLeft"> </td><td class="mdescRight">Creates a shared singleton instance of the Year transform. <br /></td></tr> |
| <tr class="separator:a203252162bb4d5a1e89b18cbf9ba2278"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a95c96711e4ed3b6c1a505cd751fbdfc7" id="r_a95c96711e4ed3b6c1a505cd751fbdfc7"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#a95c96711e4ed3b6c1a505cd751fbdfc7">Month</a> ()</td></tr> |
| <tr class="memdesc:a95c96711e4ed3b6c1a505cd751fbdfc7"><td class="mdescLeft"> </td><td class="mdescRight">Creates a shared singleton instance of the Month transform. <br /></td></tr> |
| <tr class="separator:a95c96711e4ed3b6c1a505cd751fbdfc7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abeb248059ada6671e05717a38b50497c" id="r_abeb248059ada6671e05717a38b50497c"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#abeb248059ada6671e05717a38b50497c">Day</a> ()</td></tr> |
| <tr class="memdesc:abeb248059ada6671e05717a38b50497c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a shared singleton instance of the Day transform. <br /></td></tr> |
| <tr class="separator:abeb248059ada6671e05717a38b50497c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aab85234514c19efe355af652a80862f8" id="r_aab85234514c19efe355af652a80862f8"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#aab85234514c19efe355af652a80862f8">Hour</a> ()</td></tr> |
| <tr class="memdesc:aab85234514c19efe355af652a80862f8"><td class="mdescLeft"> </td><td class="mdescRight">Creates a shared singleton instance of the Hour transform. <br /></td></tr> |
| <tr class="separator:aab85234514c19efe355af652a80862f8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae6c5257d00a7fcba4ee3803d4020d412" id="r_ae6c5257d00a7fcba4ee3803d4020d412"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Transform.html#ae6c5257d00a7fcba4ee3803d4020d412">Void</a> ()</td></tr> |
| <tr class="memdesc:ae6c5257d00a7fcba4ee3803d4020d412"><td class="mdescLeft"> </td><td class="mdescRight">Creates a shared singleton instance of the Void transform. <br /></td></tr> |
| <tr class="separator:ae6c5257d00a7fcba4ee3803d4020d412"><td class="memSeparator" colspan="2"> </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:a5ca5534f6d0509012ab3f8e05c752c69" id="r_a5ca5534f6d0509012ab3f8e05c752c69"><td class="memItemLeft" align="right" valign="top"><a id="a5ca5534f6d0509012ab3f8e05c752c69" name="a5ca5534f6d0509012ab3f8e05c752c69"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classiceberg_1_1Transform.html">Transform</a> &lhs, const <a class="el" href="classiceberg_1_1Transform.html">Transform</a> &rhs)</td></tr> |
| <tr class="memdesc:a5ca5534f6d0509012ab3f8e05c752c69"><td class="mdescLeft"> </td><td class="mdescRight">Equality comparison. <br /></td></tr> |
| <tr class="separator:a5ca5534f6d0509012ab3f8e05c752c69"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Represents a transform used in partitioning or sorting in Iceberg. </p> |
| <p>This class supports binding to a source type and instantiating the corresponding <a class="el" href="classiceberg_1_1TransformFunction.html" title="A transform function used for partitioning.">TransformFunction</a>, as well as serialization-friendly introspection. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a4028210e3c0b3d5bfaed8bb07ef4dae6" name="a4028210e3c0b3d5bfaed8bb07ef4dae6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4028210e3c0b3d5bfaed8bb07ef4dae6">◆ </a></span>Bind()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::shared_ptr< <a class="el" href="classiceberg_1_1TransformFunction.html">TransformFunction</a> > > iceberg::Transform::Bind </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > & </td> |
| <td class="paramname"><em>source_type</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Binds this transform to a source type, returning a typed <a class="el" href="classiceberg_1_1TransformFunction.html" title="A transform function used for partitioning.">TransformFunction</a>. </p> |
| <p>This creates a concrete transform implementation based on the transform type and parameter. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">source_type</td><td>The source column type to bind to. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classiceberg_1_1TransformFunction.html" title="A transform function used for partitioning.">TransformFunction</a> instance wrapped in <code>expected</code>, or an error on failure. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ac8370cf16ba3c26216f314dbdac5259a" name="ac8370cf16ba3c26216f314dbdac5259a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac8370cf16ba3c26216f314dbdac5259a">◆ </a></span>Bucket()</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_1Transform.html">Transform</a> > iceberg::Transform::Bucket </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>num_buckets</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>Creates a shared instance of the Bucket transform. </p> |
| <p>Buckets values using a hash modulo operation. Commonly used for distributing data. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">num_buckets</td><td>The number of buckets. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A shared pointer to the Bucket transform. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a51284bd3b85cd5951be730b2c887708e" name="a51284bd3b85cd5951be730b2c887708e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a51284bd3b85cd5951be730b2c887708e">◆ </a></span>CanTransform()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool iceberg::Transform::CanTransform </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1Type.html">Type</a> & </td> |
| <td class="paramname"><em>source_type</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Checks whether this function can be applied to the given <a class="el" href="classiceberg_1_1Type.html" title="Interface for a data type for a field.">Type</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">source_type</td><td>The source type to check. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if this transform can be applied to the type, false otherwise </dd></dl> |
| |
| </div> |
| </div> |
| <a id="abeb248059ada6671e05717a38b50497c" name="abeb248059ada6671e05717a38b50497c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abeb248059ada6671e05717a38b50497c">◆ </a></span>Day()</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_1Transform.html">Transform</a> > iceberg::Transform::Day </td> |
| <td>(</td> |
| <td class="paramname"></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>Creates a shared singleton instance of the Day transform. </p> |
| <p>Extracts the number of days from a date or timestamp since the epoch. </p><dl class="section return"><dt>Returns</dt><dd>A shared pointer to the Day transform. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a33f12e4ac4082a9fa0c159c8fd84fa52" name="a33f12e4ac4082a9fa0c159c8fd84fa52"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a33f12e4ac4082a9fa0c159c8fd84fa52">◆ </a></span>GeneratePartitionName()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::string > iceberg::Transform::GeneratePartitionName </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>source_name</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Generates a partition name for the transform. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">source_name</td><td>The name of the source column. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A string representation of the partition name. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aab85234514c19efe355af652a80862f8" name="aab85234514c19efe355af652a80862f8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aab85234514c19efe355af652a80862f8">◆ </a></span>Hour()</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_1Transform.html">Transform</a> > iceberg::Transform::Hour </td> |
| <td>(</td> |
| <td class="paramname"></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>Creates a shared singleton instance of the Hour transform. </p> |
| <p>Extracts the number of hours from a timestamp since the epoch. </p><dl class="section return"><dt>Returns</dt><dd>A shared pointer to the Hour transform. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ac4af9a6b608050712db9b11906e6f198" name="ac4af9a6b608050712db9b11906e6f198"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac4af9a6b608050712db9b11906e6f198">◆ </a></span>Identity()</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_1Transform.html">Transform</a> > iceberg::Transform::Identity </td> |
| <td>(</td> |
| <td class="paramname"></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>Returns a shared singleton instance of the Identity transform. </p> |
| <p>This transform leaves values unchanged and is commonly used for direct partitioning. </p><dl class="section return"><dt>Returns</dt><dd>A shared pointer to the Identity transform. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a95c96711e4ed3b6c1a505cd751fbdfc7" name="a95c96711e4ed3b6c1a505cd751fbdfc7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a95c96711e4ed3b6c1a505cd751fbdfc7">◆ </a></span>Month()</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_1Transform.html">Transform</a> > iceberg::Transform::Month </td> |
| <td>(</td> |
| <td class="paramname"></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>Creates a shared singleton instance of the Month transform. </p> |
| <p>Extracts the number of months from a date or timestamp since the epoch. </p><dl class="section return"><dt>Returns</dt><dd>A shared pointer to the Month transform. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ac0a1ac335d0816a473bd3e811fce9b25" name="ac0a1ac335d0816a473bd3e811fce9b25"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac0a1ac335d0816a473bd3e811fce9b25">◆ </a></span>Project()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1UnboundPredicate.html">UnboundPredicate</a> > > iceberg::Transform::Project </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="classiceberg_1_1BoundPredicate.html">BoundPredicate</a> > & </td> |
| <td class="paramname"><em>predicate</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Transforms a <a class="el" href="classiceberg_1_1BoundPredicate.html" title="Bound predicates contain bound terms and can be evaluated.">BoundPredicate</a> to an inclusive predicate on the partition values produced by the transform. </p> |
| <p>This inclusive transform guarantees that if predicate->Test(value) is true, then Projected(transform(value)) is true. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the partition column. </td></tr> |
| <tr><td class="paramname">predicate</td><td>The predicate to project. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A Result containing either a unique pointer to the projected predicate, nullptr if the projection cannot be performed, or an <a class="el" href="structiceberg_1_1Error.html" title="Error with a kind and a message.">Error</a> if the projection fails. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a2779a1a98eadc543af8ff3ecb128215e" name="a2779a1a98eadc543af8ff3ecb128215e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2779a1a98eadc543af8ff3ecb128215e">◆ </a></span>ProjectStrict()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1UnboundPredicate.html">UnboundPredicate</a> > > iceberg::Transform::ProjectStrict </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="classiceberg_1_1BoundPredicate.html">BoundPredicate</a> > & </td> |
| <td class="paramname"><em>predicate</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Transforms a <a class="el" href="classiceberg_1_1BoundPredicate.html" title="Bound predicates contain bound terms and can be evaluated.">BoundPredicate</a> to a strict predicate on the partition values produced by the transform. </p> |
| <p>This strict transform guarantees that if Projected(transform(value)) is true, then predicate->Test(value) is also true. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the partition column. </td></tr> |
| <tr><td class="paramname">predicate</td><td>The predicate to project. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A Result containing either a unique pointer to the projected predicate, nullptr if the projection cannot be performed, or an <a class="el" href="structiceberg_1_1Error.html" title="Error with a kind and a message.">Error</a> if the projection fails. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ab8dd9a9699f039f5bb4c0133687ec1a0" name="ab8dd9a9699f039f5bb4c0133687ec1a0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab8dd9a9699f039f5bb4c0133687ec1a0">◆ </a></span>SatisfiesOrderOf()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool iceberg::Transform::SatisfiesOrderOf </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1Transform.html">Transform</a> & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Whether ordering by this transform's result satisfies the ordering of another transform's result. </p> |
| <p>For example, sorting by day(ts) will produce an ordering that is also by month(ts) or year(ts). However, sorting by day(ts) will not satisfy the order of hour(ts) or identity(ts). </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">other</td><td>The other transform to compare with. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if ordering by this transform is equivalent to ordering by the other transform. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="afd2e4a6210b3f51f8ea8b44c84428988" name="afd2e4a6210b3f51f8ea8b44c84428988"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afd2e4a6210b3f51f8ea8b44c84428988">◆ </a></span>ToHumanString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::string > iceberg::Transform::ToHumanString </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1Literal.html">Literal</a> & </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a human-readable string representation of a transformed value. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">value</td><td>The literal value to be transformed. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A human-readable string representation of the value </dd></dl> |
| |
| </div> |
| </div> |
| <a id="af5c8b537969e36e0c2f35a5baf3f6d10" name="af5c8b537969e36e0c2f35a5baf3f6d10"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af5c8b537969e36e0c2f35a5baf3f6d10">◆ </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::Transform::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>Returns a string representation of this transform (e.g., "bucket[16]"). </p> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1util_1_1Formattable.html#a79618aca5b3bf63610d9c87ac5ae0386">iceberg::util::Formattable</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a5322807a616aecc18389f959e9d51373" name="a5322807a616aecc18389f959e9d51373"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5322807a616aecc18389f959e9d51373">◆ </a></span>Truncate()</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_1Transform.html">Transform</a> > iceberg::Transform::Truncate </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>width</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>Creates a shared instance of the Truncate transform. </p> |
| <p>Truncates values to a fixed width (e.g., for strings or binary data). </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">width</td><td>The width to truncate to. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A shared pointer to the Truncate transform. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ae6c5257d00a7fcba4ee3803d4020d412" name="ae6c5257d00a7fcba4ee3803d4020d412"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae6c5257d00a7fcba4ee3803d4020d412">◆ </a></span>Void()</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_1Transform.html">Transform</a> > iceberg::Transform::Void </td> |
| <td>(</td> |
| <td class="paramname"></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>Creates a shared singleton instance of the Void transform. </p> |
| <p>Ignores values and always returns null. Useful for testing or special cases. </p><dl class="section return"><dt>Returns</dt><dd>A shared pointer to the Void transform. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a203252162bb4d5a1e89b18cbf9ba2278" name="a203252162bb4d5a1e89b18cbf9ba2278"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a203252162bb4d5a1e89b18cbf9ba2278">◆ </a></span>Year()</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_1Transform.html">Transform</a> > iceberg::Transform::Year </td> |
| <td>(</td> |
| <td class="paramname"></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>Creates a shared singleton instance of the Year transform. </p> |
| <p>Extracts the number of years from a date or timestamp since the epoch. </p><dl class="section return"><dt>Returns</dt><dd>A shared pointer to the Year transform. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/<a class="el" href="transform_8h_source.html">transform.h</a></li> |
| <li>iceberg/<b>transform.cc</b></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> |
