| <!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::Projections Struct 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="structiceberg_1_1Projections.html">Projections</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="structiceberg_1_1Projections-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::Projections Struct Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Utils to project expressions on rows to expressions on partitions. |
| <a href="structiceberg_1_1Projections.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="projections_8h_source.html">projections.h</a>></code></p> |
| <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:a6164aec49dce234a9326ce4d8e782c0e" id="r_a6164aec49dce234a9326ce4d8e782c0e"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr< <a class="el" href="classiceberg_1_1ProjectionEvaluator.html">ProjectionEvaluator</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1Projections.html#a6164aec49dce234a9326ce4d8e782c0e">Inclusive</a> (const <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &spec, const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &schema, bool case_sensitive=true)</td></tr> |
| <tr class="memdesc:a6164aec49dce234a9326ce4d8e782c0e"><td class="mdescLeft"> </td><td class="mdescRight">Creates an inclusive <a class="el" href="classiceberg_1_1ProjectionEvaluator.html" title="A class that projects expressions for a table's data rows into expressions on the table's partition v...">ProjectionEvaluator</a> for the partition spec. <br /></td></tr> |
| <tr class="separator:a6164aec49dce234a9326ce4d8e782c0e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab9b43869bd3002fc795ba41352f7531e" id="r_ab9b43869bd3002fc795ba41352f7531e"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr< <a class="el" href="classiceberg_1_1ProjectionEvaluator.html">ProjectionEvaluator</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1Projections.html#ab9b43869bd3002fc795ba41352f7531e">Strict</a> (const <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &spec, const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &schema, bool case_sensitive=true)</td></tr> |
| <tr class="memdesc:ab9b43869bd3002fc795ba41352f7531e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a strict <a class="el" href="classiceberg_1_1ProjectionEvaluator.html" title="A class that projects expressions for a table's data rows into expressions on the table's partition v...">ProjectionEvaluator</a> for the partition spec. <br /></td></tr> |
| <tr class="separator:ab9b43869bd3002fc795ba41352f7531e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Utils to project expressions on rows to expressions on partitions. </p> |
| <p>There are two types of projections: inclusive and strict.</p> |
| <p>An inclusive projection guarantees that if an expression matches a row, the projected expression will match the row's partition.</p> |
| <p>A strict projection guarantees that if a partition matches a projected expression, then all rows in that partition will match the original expression. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a6164aec49dce234a9326ce4d8e782c0e" name="a6164aec49dce234a9326ce4d8e782c0e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6164aec49dce234a9326ce4d8e782c0e">◆ </a></span>Inclusive()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::unique_ptr< <a class="el" href="classiceberg_1_1ProjectionEvaluator.html">ProjectionEvaluator</a> > iceberg::Projections::Inclusive </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> & </td> |
| <td class="paramname"><em>spec</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> & </td> |
| <td class="paramname"><em>schema</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>case_sensitive</em> = <code>true</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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 an inclusive <a class="el" href="classiceberg_1_1ProjectionEvaluator.html" title="A class that projects expressions for a table's data rows into expressions on the table's partition v...">ProjectionEvaluator</a> for the partition spec. </p> |
| <p>An evaluator is used to project expressions for a table's data rows into expressions on the table's partition values. The evaluator returned by this function is inclusive and will build expressions with the following guarantee: if the original expression matches a row, then the projected expression will match that row's partition.</p> |
| <p>Each predicate in the expression is projected using <a class="el" href="classiceberg_1_1Transform.html#ac0a1ac335d0816a473bd3e811fce9b25" title="Transforms a BoundPredicate to an inclusive predicate on the partition values produced by the transfo...">Transform::Project</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">spec</td><td>a partition spec </td></tr> |
| <tr><td class="paramname">schema</td><td>a schema </td></tr> |
| <tr><td class="paramname">case_sensitive</td><td>whether the Projection should consider case sensitivity on column names or not. Defaults to true (case sensitive). </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an inclusive projection evaluator for the partition spec </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ab9b43869bd3002fc795ba41352f7531e" name="ab9b43869bd3002fc795ba41352f7531e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab9b43869bd3002fc795ba41352f7531e">◆ </a></span>Strict()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::unique_ptr< <a class="el" href="classiceberg_1_1ProjectionEvaluator.html">ProjectionEvaluator</a> > iceberg::Projections::Strict </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> & </td> |
| <td class="paramname"><em>spec</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> & </td> |
| <td class="paramname"><em>schema</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>case_sensitive</em> = <code>true</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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 strict <a class="el" href="classiceberg_1_1ProjectionEvaluator.html" title="A class that projects expressions for a table's data rows into expressions on the table's partition v...">ProjectionEvaluator</a> for the partition spec. </p> |
| <p>An evaluator is used to project expressions for a table's data rows into expressions on the table's partition values. The evaluator returned by this function is strict and will build expressions with the following guarantee: if the projected expression matches a partition, then the original expression will match all rows in that partition.</p> |
| <p>Each predicate in the expression is projected using <a class="el" href="classiceberg_1_1Transform.html#a2779a1a98eadc543af8ff3ecb128215e" title="Transforms a BoundPredicate to a strict predicate on the partition values produced by the transform.">Transform::ProjectStrict</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">spec</td><td>a partition spec </td></tr> |
| <tr><td class="paramname">schema</td><td>a schema </td></tr> |
| <tr><td class="paramname">case_sensitive</td><td>whether the Projection should consider case sensitivity on column names or not. Defaults to true (case sensitive). </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a strict projection evaluator for the partition spec </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following files:<ul> |
| <li>iceberg/expression/<a class="el" href="projections_8h_source.html">projections.h</a></li> |
| <li>iceberg/expression/<b>projections.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> |
