| <!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::TableScan 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_1TableScan.html">TableScan</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="classiceberg_1_1TableScan-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::TableScan Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Represents a configured scan operation on a table. |
| <a href="classiceberg_1_1TableScan.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="table__scan_8h_source.html">table_scan.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::TableScan:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1TableScan.png" usemap="#iceberg::TableScan_map" alt=""/> |
| <map id="iceberg::TableScan_map" name="iceberg::TableScan_map"> |
| <area href="classiceberg_1_1IncrementalScan.html" alt="iceberg::IncrementalScan< FileScanTask >" shape="rect" coords="0,56,295,80"/> |
| <area href="classiceberg_1_1IncrementalScan.html" alt="iceberg::IncrementalScan< ChangelogScanTask >" shape="rect" coords="305,56,600,80"/> |
| <area href="classiceberg_1_1DataTableScan.html" title="A scan that reads data files and applies delete files to filter rows." alt="iceberg::DataTableScan" shape="rect" coords="610,56,905,80"/> |
| <area href="classiceberg_1_1IncrementalScan.html" title="A base template class for incremental scans that read changes between snapshots, and return scan task..." alt="iceberg::IncrementalScan< ScanTaskType >" shape="rect" coords="915,56,1210,80"/> |
| <area href="classiceberg_1_1IncrementalAppendScan.html" title="A scan that reads data files added between snapshots (incremental appends)." alt="iceberg::IncrementalAppendScan" shape="rect" coords="0,112,295,136"/> |
| <area href="classiceberg_1_1IncrementalChangelogScan.html" title="A scan that reads changelog entries between snapshots." alt="iceberg::IncrementalChangelogScan" shape="rect" coords="305,112,600,136"/> |
| </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:a2cc2acd4c4babdcd6fa51db2769da27f" id="r_a2cc2acd4c4babdcd6fa51db2769da27f"><td class="memItemLeft" align="right" valign="top"><a id="a2cc2acd4c4babdcd6fa51db2769da27f" name="a2cc2acd4c4babdcd6fa51db2769da27f"></a> |
| const std::shared_ptr< <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> > & </td><td class="memItemRight" valign="bottom"><b>metadata</b> () const</td></tr> |
| <tr class="memdesc:a2cc2acd4c4babdcd6fa51db2769da27f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the table metadata being scanned. <br /></td></tr> |
| <tr class="separator:a2cc2acd4c4babdcd6fa51db2769da27f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a132a6a7fdfaf3a5c9c9ad193d4d7e91f" id="r_a132a6a7fdfaf3a5c9c9ad193d4d7e91f"><td class="memItemLeft" align="right" valign="top"><a id="a132a6a7fdfaf3a5c9c9ad193d4d7e91f" name="a132a6a7fdfaf3a5c9c9ad193d4d7e91f"></a> |
| Result< std::shared_ptr< <a class="el" href="structiceberg_1_1Snapshot.html">Snapshot</a> > > </td><td class="memItemRight" valign="bottom"><b>snapshot</b> () const</td></tr> |
| <tr class="memdesc:a132a6a7fdfaf3a5c9c9ad193d4d7e91f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the snapshot to scan. If there is no snapshot, returns nullptr. <br /></td></tr> |
| <tr class="separator:a132a6a7fdfaf3a5c9c9ad193d4d7e91f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0c126aee72c822b3862b84517dc51e2b" id="r_a0c126aee72c822b3862b84517dc51e2b"><td class="memItemLeft" align="right" valign="top"><a id="a0c126aee72c822b3862b84517dc51e2b" name="a0c126aee72c822b3862b84517dc51e2b"></a> |
| Result< std::shared_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > > </td><td class="memItemRight" valign="bottom"><b>schema</b> () const</td></tr> |
| <tr class="memdesc:a0c126aee72c822b3862b84517dc51e2b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the projected schema for the scan. <br /></td></tr> |
| <tr class="separator:a0c126aee72c822b3862b84517dc51e2b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a66d5d4c54b1af0d4912c39993c2f5720" id="r_a66d5d4c54b1af0d4912c39993c2f5720"><td class="memItemLeft" align="right" valign="top"><a id="a66d5d4c54b1af0d4912c39993c2f5720" name="a66d5d4c54b1af0d4912c39993c2f5720"></a> |
| const <a class="el" href="structiceberg_1_1internal_1_1TableScanContext.html">internal::TableScanContext</a> & </td><td class="memItemRight" valign="bottom"><b>context</b> () const</td></tr> |
| <tr class="memdesc:a66d5d4c54b1af0d4912c39993c2f5720"><td class="mdescLeft"> </td><td class="mdescRight">Returns the scan context. <br /></td></tr> |
| <tr class="separator:a66d5d4c54b1af0d4912c39993c2f5720"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a390effbf41d8465b4c604ee8e45834c0" id="r_a390effbf41d8465b4c604ee8e45834c0"><td class="memItemLeft" align="right" valign="top"><a id="a390effbf41d8465b4c604ee8e45834c0" name="a390effbf41d8465b4c604ee8e45834c0"></a> |
| const std::shared_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > & </td><td class="memItemRight" valign="bottom"><b>io</b> () const</td></tr> |
| <tr class="memdesc:a390effbf41d8465b4c604ee8e45834c0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the file I/O instance used for reading files. <br /></td></tr> |
| <tr class="separator:a390effbf41d8465b4c604ee8e45834c0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac55275136f3b7712325529a1ee3f2995" id="r_ac55275136f3b7712325529a1ee3f2995"><td class="memItemLeft" align="right" valign="top"><a id="ac55275136f3b7712325529a1ee3f2995" name="ac55275136f3b7712325529a1ee3f2995"></a> |
| const std::shared_ptr< <a class="el" href="classiceberg_1_1Expression.html">Expression</a> > & </td><td class="memItemRight" valign="bottom"><b>filter</b> () const</td></tr> |
| <tr class="memdesc:ac55275136f3b7712325529a1ee3f2995"><td class="mdescLeft"> </td><td class="mdescRight">Returns this scan's filter expression. <br /></td></tr> |
| <tr class="separator:ac55275136f3b7712325529a1ee3f2995"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6a9482354ac1979bf49df7482f1e6c2d" id="r_a6a9482354ac1979bf49df7482f1e6c2d"><td class="memItemLeft" align="right" valign="top"><a id="a6a9482354ac1979bf49df7482f1e6c2d" name="a6a9482354ac1979bf49df7482f1e6c2d"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>is_case_sensitive</b> () const</td></tr> |
| <tr class="memdesc:a6a9482354ac1979bf49df7482f1e6c2d"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether this scan is case-sensitive. <br /></td></tr> |
| <tr class="separator:a6a9482354ac1979bf49df7482f1e6c2d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a3fc83d20b4ac4295813c975cb580d5a3" id="r_a3fc83d20b4ac4295813c975cb580d5a3"><td class="memItemLeft" align="right" valign="top"><a id="a3fc83d20b4ac4295813c975cb580d5a3" name="a3fc83d20b4ac4295813c975cb580d5a3"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>TableScan</b> (std::shared_ptr< <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> > <a class="el" href="classiceberg_1_1TableScan.html#a2cc2acd4c4babdcd6fa51db2769da27f">metadata</a>, std::shared_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > <a class="el" href="classiceberg_1_1TableScan.html#a0c126aee72c822b3862b84517dc51e2b">schema</a>, std::shared_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > <a class="el" href="classiceberg_1_1TableScan.html#a390effbf41d8465b4c604ee8e45834c0">io</a>, <a class="el" href="structiceberg_1_1internal_1_1TableScanContext.html">internal::TableScanContext</a> <a class="el" href="classiceberg_1_1TableScan.html#a66d5d4c54b1af0d4912c39993c2f5720">context</a>)</td></tr> |
| <tr class="separator:a3fc83d20b4ac4295813c975cb580d5a3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1cd2e8bf8a11a52399277ba3134f41e0" id="r_a1cd2e8bf8a11a52399277ba3134f41e0"><td class="memItemLeft" align="right" valign="top"><a id="a1cd2e8bf8a11a52399277ba3134f41e0" name="a1cd2e8bf8a11a52399277ba3134f41e0"></a> |
| Result< std::reference_wrapper< const std::shared_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > > > </td><td class="memItemRight" valign="bottom"><b>ResolveProjectedSchema</b> () const</td></tr> |
| <tr class="separator:a1cd2e8bf8a11a52399277ba3134f41e0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aff69ea2b8c9ff2c7e9bf14ee48854b52" id="r_aff69ea2b8c9ff2c7e9bf14ee48854b52"><td class="memItemLeft" align="right" valign="top"><a id="aff69ea2b8c9ff2c7e9bf14ee48854b52" name="aff69ea2b8c9ff2c7e9bf14ee48854b52"></a> |
| virtual const std::vector< std::string > & </td><td class="memItemRight" valign="bottom"><b>ScanColumns</b> () const</td></tr> |
| <tr class="separator:aff69ea2b8c9ff2c7e9bf14ee48854b52"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:a82859b6ad01f78883f03c99378c9aa05" id="r_a82859b6ad01f78883f03c99378c9aa05"><td class="memItemLeft" align="right" valign="top"><a id="a82859b6ad01f78883f03c99378c9aa05" name="a82859b6ad01f78883f03c99378c9aa05"></a> |
| const std::shared_ptr< <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> > </td><td class="memItemRight" valign="bottom"><b>metadata_</b></td></tr> |
| <tr class="separator:a82859b6ad01f78883f03c99378c9aa05"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a706e2b5c91c60a89df385d24ad5d2399" id="r_a706e2b5c91c60a89df385d24ad5d2399"><td class="memItemLeft" align="right" valign="top"><a id="a706e2b5c91c60a89df385d24ad5d2399" name="a706e2b5c91c60a89df385d24ad5d2399"></a> |
| const std::shared_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > </td><td class="memItemRight" valign="bottom"><b>schema_</b></td></tr> |
| <tr class="separator:a706e2b5c91c60a89df385d24ad5d2399"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa806188a2ac9759f3a172f335f0d0162" id="r_aa806188a2ac9759f3a172f335f0d0162"><td class="memItemLeft" align="right" valign="top"><a id="aa806188a2ac9759f3a172f335f0d0162" name="aa806188a2ac9759f3a172f335f0d0162"></a> |
| const std::shared_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > </td><td class="memItemRight" valign="bottom"><b>io_</b></td></tr> |
| <tr class="separator:aa806188a2ac9759f3a172f335f0d0162"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8e489e45902839a08ab76ad18f8ea5f2" id="r_a8e489e45902839a08ab76ad18f8ea5f2"><td class="memItemLeft" align="right" valign="top"><a id="a8e489e45902839a08ab76ad18f8ea5f2" name="a8e489e45902839a08ab76ad18f8ea5f2"></a> |
| const <a class="el" href="structiceberg_1_1internal_1_1TableScanContext.html">internal::TableScanContext</a> </td><td class="memItemRight" valign="bottom"><b>context_</b></td></tr> |
| <tr class="separator:a8e489e45902839a08ab76ad18f8ea5f2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a097a1d184db89e9685432b7ea9ca570b" id="r_a097a1d184db89e9685432b7ea9ca570b"><td class="memItemLeft" align="right" valign="top"><a id="a097a1d184db89e9685432b7ea9ca570b" name="a097a1d184db89e9685432b7ea9ca570b"></a> |
| std::shared_ptr< <a class="el" href="classiceberg_1_1Schema.html">Schema</a> > </td><td class="memItemRight" valign="bottom"><b>projected_schema_</b></td></tr> |
| <tr class="separator:a097a1d184db89e9685432b7ea9ca570b"><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 configured scan operation on a table. </p> |
| </div><hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/<a class="el" href="table__scan_8h_source.html">table_scan.h</a></li> |
| <li>iceberg/<b>table_scan.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> |
