| <!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.14.0"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Kudu C++ client API: kudu::client::KuduScanBatch 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> |
| <script type="text/javascript" src="clipboard.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript" src="cookie.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">Kudu C++ client API |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.14.0 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| </script> |
| <script type="text/javascript"> |
| $(function() { codefold.init(); }); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search',true); |
| $(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| $(function(){initNavTree('classkudu_1_1client_1_1KuduScanBatch.html','','classkudu_1_1client_1_1KuduScanBatch-members'); }); |
| </script> |
| <div id="container"> |
| <div id="doc-content"> |
| <!-- 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 class="header"> |
| <div class="headertitle"><div class="title">kudu::client::KuduScanBatch Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A batch of zero or more rows returned by a scan operation. |
| <a href="#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="scan__batch_8h_source.html">scan_batch.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:const_5Fiterator" id="r_const_5Fiterator"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch_1_1const__iterator.html">const_iterator</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Iterator to work with immutable <a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html" title="A batch of zero or more rows returned by a scan operation.">KuduScanBatch</a> instances. <a href="classkudu_1_1client_1_1KuduScanBatch_1_1const__iterator.html#details">More...</a><br /></td></tr> |
| <tr class="memitem:RowPtr" id="r_RowPtr"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch_1_1RowPtr.html">RowPtr</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A handle for a single row in <code><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html" title="A batch of zero or more rows returned by a scan operation.">KuduScanBatch</a></code>. <a href="classkudu_1_1client_1_1KuduScanBatch_1_1RowPtr.html#details">More...</a><br /></td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 id="header-pub-types" class="groupheader"><a id="pub-types" name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:ae1a827120c84eeedb703451bd5782467" id="r_ae1a827120c84eeedb703451bd5782467"><td class="memItemLeft" align="right" valign="top"><a id="ae1a827120c84eeedb703451bd5782467" name="ae1a827120c84eeedb703451bd5782467"></a> |
| typedef <a class="el" href="classkudu_1_1client_1_1KuduScanBatch_1_1RowPtr.html">RowPtr</a> </td><td class="memItemRight" valign="bottom"><b>value_type</b></td></tr> |
| <tr class="memdesc:ae1a827120c84eeedb703451bd5782467"><td class="mdescLeft"> </td><td class="mdescRight">A handy typedef for the <a class="el" href="classkudu_1_1client_1_1KuduScanBatch_1_1RowPtr.html" title="A handle for a single row in KuduScanBatch.">RowPtr</a>. <br /></td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a252ffd623dbaa7d725d623fd220fee4c" id="r_a252ffd623dbaa7d725d623fd220fee4c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a252ffd623dbaa7d725d623fd220fee4c">NumRows</a> () const</td></tr> |
| <tr class="memitem:a3f6366606eec7f0d0a8953ff6a81c320" id="r_a3f6366606eec7f0d0a8953ff6a81c320"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch_1_1RowPtr.html">KuduScanBatch::RowPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3f6366606eec7f0d0a8953ff6a81c320">Row</a> (int idx) const</td></tr> |
| <tr class="memitem:a654b2572d33e8b45836527e7b63dac21" id="r_a654b2572d33e8b45836527e7b63dac21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch_1_1const__iterator.html">const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a654b2572d33e8b45836527e7b63dac21">begin</a> () const</td></tr> |
| <tr class="memitem:a54bc996032e6b5bc0df0962d821c113c" id="r_a54bc996032e6b5bc0df0962d821c113c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch_1_1const__iterator.html">const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a54bc996032e6b5bc0df0962d821c113c">end</a> () const</td></tr> |
| <tr class="memitem:ad490176ba00e088c3f8d88c9aad7e833" id="r_ad490176ba00e088c3f8d88c9aad7e833"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classkudu_1_1client_1_1KuduSchema.html">KuduSchema</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad490176ba00e088c3f8d88c9aad7e833">projection_schema</a> () const</td></tr> |
| <tr id="pub-methods-0" class="groupHeader"><td colspan="2"><div class="groupHeader">Advanced/Unstable API</div></td></tr> |
| <tr><td colspan="2" class="ititle"><div class="groupText"><p>There are no guarantees on the stability of the format returned by these methods, which might change at any given time.</p> |
| <dl class="section note"><dt>Note</dt><dd>The Slices returned by both <a class="el" href="#a09bfd1652c0ab153ca6759317c3d3992">direct_data()</a> and <a class="el" href="#a3cb4c17aa228e680ecf088a29a075989">indirect_data()</a> are only valid for the lifetime of the <a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html" title="A batch of zero or more rows returned by a scan operation.">KuduScanBatch</a>. </dd></dl> |
| </div></td></tr> |
| <tr class="memitem:a09bfd1652c0ab153ca6759317c3d3992" id="r_a09bfd1652c0ab153ca6759317c3d3992"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Slice.html">Slice</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a09bfd1652c0ab153ca6759317c3d3992">direct_data</a> () const</td></tr> |
| <tr class="memitem:a3cb4c17aa228e680ecf088a29a075989" id="r_a3cb4c17aa228e680ecf088a29a075989"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Slice.html">Slice</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3cb4c17aa228e680ecf088a29a075989">indirect_data</a> () const</td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A batch of zero or more rows returned by a scan operation. </p> |
| <p>Every call to <a class="el" href="classkudu_1_1client_1_1KuduScanner.html#a409a42496942e93df5f4879b7a348e87">KuduScanner::NextBatch()</a> returns a batch of zero or more rows. You can iterate over the rows in the batch using:</p> |
| <p>range-foreach loop (C++11): </p><div class="fragment"><div class="line"><span class="keywordflow">for</span> (<a class="code hl_class" href="classkudu_1_1client_1_1KuduScanBatch_1_1RowPtr.html">KuduScanBatch::RowPtr</a> row : batch) {</div> |
| <div class="line"> ... row.GetInt(1, ...)</div> |
| <div class="line"> ...</div> |
| <div class="line">}</div> |
| <div class="ttc" id="aclasskudu_1_1client_1_1KuduScanBatch_1_1RowPtr_html"><div class="ttname"><a href="classkudu_1_1client_1_1KuduScanBatch_1_1RowPtr.html">kudu::client::KuduScanBatch::RowPtr</a></div><div class="ttdoc">A handle for a single row in KuduScanBatch.</div><div class="ttdef"><b>Definition</b> scan_batch.h:164</div></div> |
| </div><!-- fragment --><p>regular for loop (C++03): </p><div class="fragment"><div class="line"><span class="keywordflow">for</span> (<a class="code hl_class" href="classkudu_1_1client_1_1KuduScanBatch_1_1const__iterator.html">KuduScanBatch::const_iterator</a> it = batch.begin(), it != batch.end();</div> |
| <div class="line"> ++it) {</div> |
| <div class="line"> <a class="code hl_class" href="classkudu_1_1client_1_1KuduScanBatch_1_1RowPtr.html">KuduScanBatch::RowPtr</a> row(*it);</div> |
| <div class="line"> ...</div> |
| <div class="line">}</div> |
| <div class="ttc" id="aclasskudu_1_1client_1_1KuduScanBatch_1_1const__iterator_html"><div class="ttname"><a href="classkudu_1_1client_1_1KuduScanBatch_1_1const__iterator.html">kudu::client::KuduScanBatch::const_iterator</a></div><div class="ttdoc">Iterator to work with immutable KuduScanBatch instances.</div><div class="ttdef"><b>Definition</b> scan_batch.h:381</div></div> |
| </div><!-- fragment --><p> or </p><div class="fragment"><div class="line"><span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0, num_rows = batch.NumRows();</div> |
| <div class="line"> i < num_rows;</div> |
| <div class="line"> i++) {</div> |
| <div class="line"> <a class="code hl_class" href="classkudu_1_1client_1_1KuduScanBatch_1_1RowPtr.html">KuduScanBatch::RowPtr</a> row = batch.Row(i);</div> |
| <div class="line"> ...</div> |
| <div class="line">}</div> |
| </div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>In the above example, <a class="el" href="#a252ffd623dbaa7d725d623fd220fee4c">NumRows()</a> is only called once at the beginning of the loop to avoid extra calls to the non-inlined method. </dd></dl> |
| </div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2> |
| <a id="a654b2572d33e8b45836527e7b63dac21" name="a654b2572d33e8b45836527e7b63dac21"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a654b2572d33e8b45836527e7b63dac21">◆ </a></span>begin()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch_1_1const__iterator.html">KuduScanBatch::const_iterator</a> kudu::client::KuduScanBatch::begin </td> |
| <td>(</td> |
| <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>Forward iterator to the start of the rows in the batch. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a09bfd1652c0ab153ca6759317c3d3992" name="a09bfd1652c0ab153ca6759317c3d3992"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a09bfd1652c0ab153ca6759317c3d3992">◆ </a></span>direct_data()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classkudu_1_1Slice.html">Slice</a> kudu::client::KuduScanBatch::direct_data </td> |
| <td>(</td> |
| <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Return a slice that points to the direct row data received from the server. Users of this API must have knowledge of the data format in order to decode the data.</p> |
| <dl class="section warning"><dt>Warning</dt><dd>Unstable API</dd></dl> |
| <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data.">Slice</a> that points to the raw direct row data. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a54bc996032e6b5bc0df0962d821c113c" name="a54bc996032e6b5bc0df0962d821c113c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a54bc996032e6b5bc0df0962d821c113c">◆ </a></span>end()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch_1_1const__iterator.html">KuduScanBatch::const_iterator</a> kudu::client::KuduScanBatch::end </td> |
| <td>(</td> |
| <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>Forward iterator to the end of the rows in the batch. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a3cb4c17aa228e680ecf088a29a075989" name="a3cb4c17aa228e680ecf088a29a075989"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3cb4c17aa228e680ecf088a29a075989">◆ </a></span>indirect_data()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classkudu_1_1Slice.html">Slice</a> kudu::client::KuduScanBatch::indirect_data </td> |
| <td>(</td> |
| <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Like the method above, but for indirect data.</p> |
| <dl class="section warning"><dt>Warning</dt><dd>Unstable API</dd></dl> |
| <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data.">Slice</a> that points to the raw indirect row data. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a252ffd623dbaa7d725d623fd220fee4c" name="a252ffd623dbaa7d725d623fd220fee4c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a252ffd623dbaa7d725d623fd220fee4c">◆ </a></span>NumRows()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int kudu::client::KuduScanBatch::NumRows </td> |
| <td>(</td> |
| <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>The number of rows in this batch. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad490176ba00e088c3f8d88c9aad7e833" name="ad490176ba00e088c3f8d88c9aad7e833"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad490176ba00e088c3f8d88c9aad7e833">◆ </a></span>projection_schema()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classkudu_1_1client_1_1KuduSchema.html">KuduSchema</a> * kudu::client::KuduScanBatch::projection_schema </td> |
| <td>(</td> |
| <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>The projection schema for this batch. All <a class="el" href="classkudu_1_1client_1_1KuduScanBatch_1_1RowPtr.html" title="A handle for a single row in KuduScanBatch.">KuduScanBatch::RowPtr</a> returned by this batch are guaranteed to have this schema. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a3f6366606eec7f0d0a8953ff6a81c320" name="a3f6366606eec7f0d0a8953ff6a81c320"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3f6366606eec7f0d0a8953ff6a81c320">◆ </a></span>Row()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch_1_1RowPtr.html">KuduScanBatch::RowPtr</a> kudu::client::KuduScanBatch::Row </td> |
| <td>(</td> |
| <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>idx</em></span></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get a row at the specified index.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>The index of the row to return. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A reference to one of the rows in this batch. The returned object is only valid for as long as this <a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html" title="A batch of zero or more rows returned by a scan operation.">KuduScanBatch</a> object is valid. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>include/kudu/client/<a class="el" href="scan__batch_8h_source.html">scan_batch.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <div id="page-nav" class="page-nav-panel"> |
| <div id="page-nav-resize-handle"></div> |
| <div id="page-nav-tree"> |
| <div id="page-nav-contents"> |
| </div><!-- page-nav-contents --> |
| </div><!-- page-nav-tree --> |
| </div><!-- page-nav --> |
| </div><!-- container --> |
| <!-- start footer part --> |
| <hr class="footer"/> |
| <address class="footer"> |
| <small>Generated for Kudu version 1.18.0 on Wed Jul 9 2025 13:08:41 by Doxygen 1.14.0</small> |
| <br> |
| <small>Copyright © 2025 The Apache Software Foundation.</small> |
| </address> |
| </body> |
| </html> |
