apidoc/html/structpaimon_1_1_read_hints.html - paimon-cpp - Git at Google

 <!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>Paimon-cpp: paimon::ReadHints 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">Paimon-cpp
    </div>
    <div id="projectbrief">A high-performance C++ implementation of Apache Paimon</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="namespacepaimon.html">paimon</a></li><li class="navelem"><a class="el" href="structpaimon_1_1_read_hints.html">ReadHints</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#pub-attribs">Public Attributes</a> &#124;
 <a href="structpaimon_1_1_read_hints-members.html">List of all members</a>  </div>
   <div class="headertitle"><div class="title">paimon::ReadHints Struct Reference</div></div>
 </div><!--header-->
 <div class="contents">

 <p>Runtime state of the framework read path, passed to format layers via <code><a class="el" href="classpaimon_1_1_reader_builder.html#a9210e4d8b69174bc5d494b9773b96f37" title="Inject runtime read state from the framework layer, so the format can adapt its internal behavior acc...">ReaderBuilder::WithReadHints</a></code> so each format can adapt its internal behavior (e.g.
  <a href="structpaimon_1_1_read_hints.html#details">More...</a></p>

 <p><code>#include &lt;<a class="el" href="read__hints_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/format/read_hints.h</a>&gt;</code></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
 Public Attributes</h2></td></tr>
 <tr class="memitem:adc73b08d68e296280358dc578a930dc5" id="r_adc73b08d68e296280358dc578a930dc5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpaimon_1_1_read_hints.html#adc73b08d68e296280358dc578a930dc5">prefetch_enabled</a> = <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">false</a></td></tr>
 <tr class="memdesc:adc73b08d68e296280358dc578a930dc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether framework-level prefetch is enabled for this read.  <br /></td></tr>
 <tr class="separator:adc73b08d68e296280358dc578a930dc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a7c251ec41f6d11284fab3c1b567538ca" id="r_a7c251ec41f6d11284fab3c1b567538ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpaimon_1_1_read_hints.html#a7c251ec41f6d11284fab3c1b567538ca">read_ahead_cache_enabled</a> = <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">false</a></td></tr>
 <tr class="memdesc:a7c251ec41f6d11284fab3c1b567538ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the shared read-ahead cache is enabled for this read.  <br /></td></tr>
 <tr class="separator:a7c251ec41f6d11284fab3c1b567538ca"><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>Runtime state of the framework read path, passed to format layers via <code><a class="el" href="classpaimon_1_1_reader_builder.html#a9210e4d8b69174bc5d494b9773b96f37" title="Inject runtime read state from the framework layer, so the format can adapt its internal behavior acc...">ReaderBuilder::WithReadHints</a></code> so each format can adapt its internal behavior (e.g. </p>
 <p>whether parquet enables its own pre-buffering). </p>
 </div><h2 class="groupheader">Member Data Documentation</h2>
 <a id="adc73b08d68e296280358dc578a930dc5" name="adc73b08d68e296280358dc578a930dc5"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#adc73b08d68e296280358dc578a930dc5">&#9670;&#160;</a></span>prefetch_enabled</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> paimon::ReadHints::prefetch_enabled = <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">false</a></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Whether framework-level prefetch is enabled for this read. </p>

 </div>
 </div>
 <a id="a7c251ec41f6d11284fab3c1b567538ca" name="a7c251ec41f6d11284fab3c1b567538ca"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a7c251ec41f6d11284fab3c1b567538ca">&#9670;&#160;</a></span>read_ahead_cache_enabled</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> paimon::ReadHints::read_ahead_cache_enabled = <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">false</a></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Whether the shared read-ahead cache is enabled for this read. </p>

 </div>
 </div>
 <hr/>The documentation for this struct was generated from the following file:<ul>
 <li>/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/format/<a class="el" href="read__hints_8h_source.html">read_hints.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>
	<!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>Paimon-cpp: paimon::ReadHints 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">Paimon-cpp
	</div>
	<div id="projectbrief">A high-performance C++ implementation of Apache Paimon</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"><a class="el" href="namespacepaimon.html">paimon</a></li><li class="navelem"><a class="el" href="structpaimon_1_1_read_hints.html">ReadHints</a></li> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#pub-attribs">Public Attributes</a> \|
	<a href="structpaimon_1_1_read_hints-members.html">List of all members</a> </div>
	<div class="headertitle"><div class="title">paimon::ReadHints Struct Reference</div></div>
	</div><!--header-->
	<div class="contents">

	<p>Runtime state of the framework read path, passed to format layers via <code><a class="el" href="classpaimon_1_1_reader_builder.html#a9210e4d8b69174bc5d494b9773b96f37" title="Inject runtime read state from the framework layer, so the format can adapt its internal behavior acc...">ReaderBuilder::WithReadHints</a></code> so each format can adapt its internal behavior (e.g.
	<a href="structpaimon_1_1_read_hints.html#details">More...</a></p>

	<p><code>#include <<a class="el" href="read__hints_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/format/read_hints.h</a>></code></p>
	<table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
	Public Attributes</h2></td></tr>
	<tr class="memitem:adc73b08d68e296280358dc578a930dc5" id="r_adc73b08d68e296280358dc578a930dc5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpaimon_1_1_read_hints.html#adc73b08d68e296280358dc578a930dc5">prefetch_enabled</a> = <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">false</a></td></tr>
	<tr class="memdesc:adc73b08d68e296280358dc578a930dc5"><td class="mdescLeft"> </td><td class="mdescRight">Whether framework-level prefetch is enabled for this read. <br /></td></tr>
	<tr class="separator:adc73b08d68e296280358dc578a930dc5"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a7c251ec41f6d11284fab3c1b567538ca" id="r_a7c251ec41f6d11284fab3c1b567538ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpaimon_1_1_read_hints.html#a7c251ec41f6d11284fab3c1b567538ca">read_ahead_cache_enabled</a> = <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">false</a></td></tr>
	<tr class="memdesc:a7c251ec41f6d11284fab3c1b567538ca"><td class="mdescLeft"> </td><td class="mdescRight">Whether the shared read-ahead cache is enabled for this read. <br /></td></tr>
	<tr class="separator:a7c251ec41f6d11284fab3c1b567538ca"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>Runtime state of the framework read path, passed to format layers via <code><a class="el" href="classpaimon_1_1_reader_builder.html#a9210e4d8b69174bc5d494b9773b96f37" title="Inject runtime read state from the framework layer, so the format can adapt its internal behavior acc...">ReaderBuilder::WithReadHints</a></code> so each format can adapt its internal behavior (e.g. </p>
	<p>whether parquet enables its own pre-buffering). </p>
	</div><h2 class="groupheader">Member Data Documentation</h2>
	<a id="adc73b08d68e296280358dc578a930dc5" name="adc73b08d68e296280358dc578a930dc5"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#adc73b08d68e296280358dc578a930dc5">◆ </a></span>prefetch_enabled</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> paimon::ReadHints::prefetch_enabled = <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">false</a></td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Whether framework-level prefetch is enabled for this read. </p>

	</div>
	</div>
	<a id="a7c251ec41f6d11284fab3c1b567538ca" name="a7c251ec41f6d11284fab3c1b567538ca"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a7c251ec41f6d11284fab3c1b567538ca">◆ </a></span>read_ahead_cache_enabled</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> paimon::ReadHints::read_ahead_cache_enabled = <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">false</a></td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Whether the shared read-ahead cache is enabled for this read. </p>

	</div>
	</div>
	<hr/>The documentation for this struct was generated from the following file:<ul>
	<li>/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/format/<a class="el" href="read__hints_8h_source.html">read_hints.h</a></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>