blob: ab8f01bf6ef1f15933547e76c486c4869715c87e [file]
<!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::ScanTestBase 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&amp;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&amp;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_1ScanTestBase.html">ScanTestBase</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-static-methods">Static Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classiceberg_1_1ScanTestBase-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::ScanTestBase Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Base class for scan-related tests providing common test utilities.
<a href="classiceberg_1_1ScanTestBase.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="scan__test__base_8h_source.html">scan_test_base.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::ScanTestBase:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1ScanTestBase.png" usemap="#iceberg::ScanTestBase_map" alt=""/>
<map id="iceberg::ScanTestBase_map" name="iceberg::ScanTestBase_map">
<area href="classiceberg_1_1IncrementalAppendScanTest.html" alt="iceberg::IncrementalAppendScanTest" shape="rect" coords="0,112,222,136"/>
<area href="classiceberg_1_1TableScanTest.html" alt="iceberg::TableScanTest" shape="rect" coords="232,112,454,136"/>
</map>
</div></div>
<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:a7d984b1850d6179f47086590adcd6ada" id="r_a7d984b1850d6179f47086590adcd6ada"><td class="memItemLeft" align="right" valign="top"><a id="a7d984b1850d6179f47086590adcd6ada" name="a7d984b1850d6179f47086590adcd6ada"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetUp</b> () override</td></tr>
<tr class="separator:a7d984b1850d6179f47086590adcd6ada"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a531a6f46b4e9244aec66f4f67303d5fd" id="r_a531a6f46b4e9244aec66f4f67303d5fd"><td class="memItemLeft" align="right" valign="top"><a id="a531a6f46b4e9244aec66f4f67303d5fd" name="a531a6f46b4e9244aec66f4f67303d5fd"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>MakeManifestPath</b> ()</td></tr>
<tr class="memdesc:a531a6f46b4e9244aec66f4f67303d5fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a unique manifest file path. <br /></td></tr>
<tr class="separator:a531a6f46b4e9244aec66f4f67303d5fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62601933ba9acd4946bb8d8efc2f2438" id="r_a62601933ba9acd4946bb8d8efc2f2438"><td class="memItemLeft" align="right" valign="top"><a id="a62601933ba9acd4946bb8d8efc2f2438" name="a62601933ba9acd4946bb8d8efc2f2438"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>MakeManifestListPath</b> ()</td></tr>
<tr class="memdesc:a62601933ba9acd4946bb8d8efc2f2438"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a unique manifest list file path. <br /></td></tr>
<tr class="separator:a62601933ba9acd4946bb8d8efc2f2438"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65b6a03e0f275c05c23eb4dddc972dfd" id="r_a65b6a03e0f275c05c23eb4dddc972dfd"><td class="memItemLeft" align="right" valign="top"><a id="a65b6a03e0f275c05c23eb4dddc972dfd" name="a65b6a03e0f275c05c23eb4dddc972dfd"></a>
<a class="el" href="structiceberg_1_1ManifestEntry.html">ManifestEntry</a>&#160;</td><td class="memItemRight" valign="bottom"><b>MakeEntry</b> (ManifestStatus status, int64_t snapshot_id, int64_t sequence_number, std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt; file)</td></tr>
<tr class="memdesc:a65b6a03e0f275c05c23eb4dddc972dfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a manifest entry. <br /></td></tr>
<tr class="separator:a65b6a03e0f275c05c23eb4dddc972dfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a915cde90b0e82ca35f82c5b2dc3a179a" id="r_a915cde90b0e82ca35f82c5b2dc3a179a"><td class="memItemLeft" align="right" valign="top"><a id="a915cde90b0e82ca35f82c5b2dc3a179a" name="a915cde90b0e82ca35f82c5b2dc3a179a"></a>
<a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a>&#160;</td><td class="memItemRight" valign="bottom"><b>WriteDataManifest</b> (int8_t format_version, int64_t snapshot_id, std::vector&lt; <a class="el" href="structiceberg_1_1ManifestEntry.html">ManifestEntry</a> &gt; entries, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &gt; spec=<a class="el" href="classiceberg_1_1PartitionSpec.html#a2955a97e29cf0637fa5275b031b198dc">PartitionSpec::Unpartitioned</a>())</td></tr>
<tr class="memdesc:a915cde90b0e82ca35f82c5b2dc3a179a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a data manifest file. <br /></td></tr>
<tr class="separator:a915cde90b0e82ca35f82c5b2dc3a179a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cd158eb02042c5143d542164b36f5a8" id="r_a6cd158eb02042c5143d542164b36f5a8"><td class="memItemLeft" align="right" valign="top"><a id="a6cd158eb02042c5143d542164b36f5a8" name="a6cd158eb02042c5143d542164b36f5a8"></a>
<a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a>&#160;</td><td class="memItemRight" valign="bottom"><b>WriteDeleteManifest</b> (int8_t format_version, int64_t snapshot_id, std::vector&lt; <a class="el" href="structiceberg_1_1ManifestEntry.html">ManifestEntry</a> &gt; entries, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &gt; spec)</td></tr>
<tr class="memdesc:a6cd158eb02042c5143d542164b36f5a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a delete manifest file. <br /></td></tr>
<tr class="separator:a6cd158eb02042c5143d542164b36f5a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5bebd19b60592f04d7068259573e8a1" id="r_ab5bebd19b60592f04d7068259573e8a1"><td class="memItemLeft" align="right" valign="top"><a id="ab5bebd19b60592f04d7068259573e8a1" name="ab5bebd19b60592f04d7068259573e8a1"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>WriteManifestList</b> (int8_t format_version, int64_t snapshot_id, int64_t parent_snapshot_id, int64_t sequence_number, const std::vector&lt; <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> &gt; &amp;manifests)</td></tr>
<tr class="memdesc:ab5bebd19b60592f04d7068259573e8a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a manifest list file. <br /></td></tr>
<tr class="separator:ab5bebd19b60592f04d7068259573e8a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a383202528f71a86960b82e773fe9ff8f" id="r_a383202528f71a86960b82e773fe9ff8f"><td class="memItemLeft" align="right" valign="top"><a id="a383202528f71a86960b82e773fe9ff8f" name="a383202528f71a86960b82e773fe9ff8f"></a>
std::shared_ptr&lt; <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>MakeTableMetadata</b> (const std::vector&lt; std::shared_ptr&lt; <a class="el" href="structiceberg_1_1Snapshot.html">Snapshot</a> &gt; &gt; &amp;snapshots, int64_t current_snapshot_id, const std::unordered_map&lt; std::string, std::shared_ptr&lt; <a class="el" href="structiceberg_1_1SnapshotRef.html">SnapshotRef</a> &gt; &gt; &amp;refs={}, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &gt; default_spec=nullptr)</td></tr>
<tr class="memdesc:a383202528f71a86960b82e773fe9ff8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create table metadata with the given snapshots. <br /></td></tr>
<tr class="separator:a383202528f71a86960b82e773fe9ff8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c417159642f386980b313d2414385a6" id="r_a9c417159642f386980b313d2414385a6"><td class="memItemLeft" align="right" valign="top"><a id="a9c417159642f386980b313d2414385a6" name="a9c417159642f386980b313d2414385a6"></a>
std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>MakeDataFile</b> (const std::string &amp;path, <a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> partition=<a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a>(std::vector&lt; <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt;{}), std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &gt; spec=nullptr, int64_t record_count=1)</td></tr>
<tr class="memdesc:a9c417159642f386980b313d2414385a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a data file with optional partition values. <br /></td></tr>
<tr class="separator:a9c417159642f386980b313d2414385a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77335f2bfbfa69666114ac896c7ebacf" id="r_a77335f2bfbfa69666114ac896c7ebacf"><td class="memItemLeft" align="right" valign="top"><a id="a77335f2bfbfa69666114ac896c7ebacf" name="a77335f2bfbfa69666114ac896c7ebacf"></a>
std::shared_ptr&lt; <a class="el" href="structiceberg_1_1Snapshot.html">Snapshot</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>MakeAppendSnapshot</b> (int8_t format_version, int64_t snapshot_id, std::optional&lt; int64_t &gt; parent_snapshot_id, int64_t sequence_number, const std::vector&lt; std::string &gt; &amp;added_files, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &gt; spec=nullptr)</td></tr>
<tr class="memdesc:a77335f2bfbfa69666114ac896c7ebacf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an append snapshot with the given files (string paths). <br /></td></tr>
<tr class="separator:a77335f2bfbfa69666114ac896c7ebacf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7562f7ad766908b35b920a31c6cb5e92" id="r_a7562f7ad766908b35b920a31c6cb5e92"><td class="memItemLeft" align="right" valign="top"><a id="a7562f7ad766908b35b920a31c6cb5e92" name="a7562f7ad766908b35b920a31c6cb5e92"></a>
std::shared_ptr&lt; <a class="el" href="structiceberg_1_1Snapshot.html">Snapshot</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>MakeAppendSnapshotWithPartitionValues</b> (int8_t format_version, int64_t snapshot_id, std::optional&lt; int64_t &gt; parent_snapshot_id, int64_t sequence_number, const std::vector&lt; std::pair&lt; std::string, <a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &gt; &gt; &amp;added_files, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &gt; spec=nullptr)</td></tr>
<tr class="memdesc:a7562f7ad766908b35b920a31c6cb5e92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an append snapshot with the given files (with partition values). <br /></td></tr>
<tr class="separator:a7562f7ad766908b35b920a31c6cb5e92"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-methods" name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:a8a67d321ba16ace662003af87fc5300f" id="r_a8a67d321ba16ace662003af87fc5300f"><td class="memItemLeft" align="right" valign="top"><a id="a8a67d321ba16ace662003af87fc5300f" name="a8a67d321ba16ace662003af87fc5300f"></a>
static std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetPaths</b> (const std::vector&lt; std::shared_ptr&lt; <a class="el" href="classiceberg_1_1FileScanTask.html">FileScanTask</a> &gt; &gt; &amp;tasks)</td></tr>
<tr class="memdesc:a8a67d321ba16ace662003af87fc5300f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract file paths from scan tasks. <br /></td></tr>
<tr class="separator:a8a67d321ba16ace662003af87fc5300f"><td class="memSeparator" colspan="2">&#160;</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:ad0ae1af25cbfee26219ea1203e58213f" id="r_ad0ae1af25cbfee26219ea1203e58213f"><td class="memItemLeft" align="right" valign="top"><a id="ad0ae1af25cbfee26219ea1203e58213f" name="ad0ae1af25cbfee26219ea1203e58213f"></a>
std::shared_ptr&lt; <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>file_io_</b></td></tr>
<tr class="separator:ad0ae1af25cbfee26219ea1203e58213f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a141036d1db1d5606e5b10c7727929026" id="r_a141036d1db1d5606e5b10c7727929026"><td class="memItemLeft" align="right" valign="top"><a id="a141036d1db1d5606e5b10c7727929026" name="a141036d1db1d5606e5b10c7727929026"></a>
std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>schema_</b></td></tr>
<tr class="separator:a141036d1db1d5606e5b10c7727929026"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e8cb5d500aed6cbf94b0f8c1d3c8789" id="r_a2e8cb5d500aed6cbf94b0f8c1d3c8789"><td class="memItemLeft" align="right" valign="top"><a id="a2e8cb5d500aed6cbf94b0f8c1d3c8789" name="a2e8cb5d500aed6cbf94b0f8c1d3c8789"></a>
std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>partitioned_spec_</b></td></tr>
<tr class="separator:a2e8cb5d500aed6cbf94b0f8c1d3c8789"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a46fcd0ba36ea941018c102faac1472" id="r_a5a46fcd0ba36ea941018c102faac1472"><td class="memItemLeft" align="right" valign="top"><a id="a5a46fcd0ba36ea941018c102faac1472" name="a5a46fcd0ba36ea941018c102faac1472"></a>
std::shared_ptr&lt; <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>unpartitioned_spec_</b></td></tr>
<tr class="separator:a5a46fcd0ba36ea941018c102faac1472"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for scan-related tests providing common test utilities. </p>
<p>This class provides common setup and helper functions for testing <a class="el" href="classiceberg_1_1TableScan.html" title="Represents a configured scan operation on a table.">TableScan</a> and <a class="el" href="classiceberg_1_1IncrementalScan.html" title="A base template class for incremental scans that read changes between snapshots, and return scan task...">IncrementalScan</a> implementations. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/test/<a class="el" href="scan__test__base_8h_source.html">scan_test_base.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>