Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1LocationProvider.html
blob: 2f8f3c7104294ac5566193509bf970ab1cc86df0 [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::LocationProvider 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"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1LocationProvider.html">LocationProvider</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classiceberg_1_1LocationProvider-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::LocationProvider Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Interface for providing data file locations.
<a href="classiceberg_1_1LocationProvider.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="location__provider_8h_source.html">location_provider.h</a>&gt;</code></p>
<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:a0d29eedea9a2149c98cd304d24e35400" id="r_a0d29eedea9a2149c98cd304d24e35400"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1LocationProvider.html#a0d29eedea9a2149c98cd304d24e35400">NewDataLocation</a> (std::string_view filename)=0</td></tr>
<tr class="memdesc:a0d29eedea9a2149c98cd304d24e35400"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a fully-qualified data file location for the given filename. <br /></td></tr>
<tr class="separator:a0d29eedea9a2149c98cd304d24e35400"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d887eeb0124f7221e8e062afd602609" id="r_a4d887eeb0124f7221e8e062afd602609"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1LocationProvider.html#a4d887eeb0124f7221e8e062afd602609">NewDataLocation</a> (const <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &amp;spec, const <a class="el" href="classiceberg_1_1PartitionValues.html">PartitionValues</a> &amp;partition, std::string_view filename)=0</td></tr>
<tr class="memdesc:a4d887eeb0124f7221e8e062afd602609"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a fully-qualified data file location for the given partition and filename. <br /></td></tr>
<tr class="separator:a4d887eeb0124f7221e8e062afd602609"><td class="memSeparator" colspan="2">&#160;</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:a552bf962d3128e5f85c409278cc78cee" id="r_a552bf962d3128e5f85c409278cc78cee"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1LocationProvider.html">LocationProvider</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1LocationProvider.html#a552bf962d3128e5f85c409278cc78cee">Make</a> (std::string_view location, const <a class="el" href="classiceberg_1_1TableProperties.html">TableProperties</a> &amp;properties)</td></tr>
<tr class="memdesc:a552bf962d3128e5f85c409278cc78cee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a <a class="el" href="classiceberg_1_1LocationProvider.html" title="Interface for providing data file locations.">LocationProvider</a> for the given table location and properties. <br /></td></tr>
<tr class="separator:a552bf962d3128e5f85c409278cc78cee"><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>Interface for providing data file locations. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a552bf962d3128e5f85c409278cc78cee" name="a552bf962d3128e5f85c409278cc78cee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a552bf962d3128e5f85c409278cc78cee">&#9670;&#160;</a></span>Make()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1LocationProvider.html">LocationProvider</a> &gt; &gt; iceberg::LocationProvider::Make </td>
<td>(</td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>location</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classiceberg_1_1TableProperties.html">TableProperties</a> &amp;&#160;</td>
<td class="paramname"><em>properties</em>&#160;</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>Create a <a class="el" href="classiceberg_1_1LocationProvider.html" title="Interface for providing data file locations.">LocationProvider</a> for the given table location and properties. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">location</td><td>table location </td></tr>
<tr><td class="paramname">properties</td><td>table properties </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="classiceberg_1_1LocationProvider.html" title="Interface for providing data file locations.">LocationProvider</a> instance </dd></dl>
</div>
</div>
<a id="a4d887eeb0124f7221e8e062afd602609" name="a4d887eeb0124f7221e8e062afd602609"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d887eeb0124f7221e8e062afd602609">&#9670;&#160;</a></span>NewDataLocation() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::string &gt; iceberg::LocationProvider::NewDataLocation </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classiceberg_1_1PartitionSpec.html">PartitionSpec</a> &amp;&#160;</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_1PartitionValues.html">PartitionValues</a> &amp;&#160;</td>
<td class="paramname"><em>partition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>filename</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a fully-qualified data file location for the given partition and filename. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">spec</td><td>partition spec </td></tr>
<tr><td class="paramname">partition</td><td>a tuple of partition values matching the given spec </td></tr>
<tr><td class="paramname">filename</td><td>file name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a fully-qualified location URI for a data file </dd></dl>
</div>
</div>
<a id="a0d29eedea9a2149c98cd304d24e35400" name="a0d29eedea9a2149c98cd304d24e35400"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d29eedea9a2149c98cd304d24e35400">&#9670;&#160;</a></span>NewDataLocation() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string iceberg::LocationProvider::NewDataLocation </td>
<td>(</td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a fully-qualified data file location for the given filename. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>file name to get location </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a fully-qualified location URI for a data file </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/<a class="el" href="location__provider_8h_source.html">location_provider.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>