| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.11"/> |
| <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> |
| <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> |
| <script type="text/javascript"> |
| $(document).ready(function() { init_search(); }); |
| </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 style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Kudu C++ client API |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.11 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </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"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><b>kudu</b></li><li class="navelem"><b>client</b></li><li class="navelem"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html">KuduScanBatch</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classkudu_1_1client_1_1KuduScanBatch-members.html">List of all members</a> </div> |
| <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="classkudu_1_1client_1_1KuduScanBatch.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="scan__batch_8h_source.html">scan_batch.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for kudu::client::KuduScanBatch:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classkudu_1_1client_1_1KuduScanBatch.png" usemap="#kudu::client::KuduScanBatch_map" alt=""/> |
| <map id="kudu::client::KuduScanBatch_map" name="kudu::client::KuduScanBatch_map"> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:ae1a827120c84eeedb703451bd5782467"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1a827120c84eeedb703451bd5782467"></a> |
| typedef <a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">RowPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#ae1a827120c84eeedb703451bd5782467">value_type</a></td></tr> |
| <tr class="memdesc:ae1a827120c84eeedb703451bd5782467"><td class="mdescLeft"> </td><td class="mdescRight">A handy typedef for the RowPtr. <br /></td></tr> |
| <tr class="separator:ae1a827120c84eeedb703451bd5782467"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a16e45694c5932eb3decc2184c3834157"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a16e45694c5932eb3decc2184c3834157">NumRows</a> () const </td></tr> |
| <tr class="separator:a16e45694c5932eb3decc2184c3834157"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a93c2f0914140dd405a51d57e2f75014a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a93c2f0914140dd405a51d57e2f75014a">Row</a> (int idx) const </td></tr> |
| <tr class="separator:a93c2f0914140dd405a51d57e2f75014a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a30f55cf8f3c9d6fcb47537e586d82e9f"><td class="memItemLeft" align="right" valign="top">const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a30f55cf8f3c9d6fcb47537e586d82e9f">begin</a> () const </td></tr> |
| <tr class="separator:a30f55cf8f3c9d6fcb47537e586d82e9f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad30dcfafb276b5347842882cf68cb522"><td class="memItemLeft" align="right" valign="top">const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#ad30dcfafb276b5347842882cf68cb522">end</a> () const </td></tr> |
| <tr class="separator:ad30dcfafb276b5347842882cf68cb522"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3b58e77f53beea357fbb8bcddaab3137"><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="classkudu_1_1client_1_1KuduScanBatch.html#a3b58e77f53beea357fbb8bcddaab3137">projection_schema</a> () const </td></tr> |
| <tr class="separator:a3b58e77f53beea357fbb8bcddaab3137"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a92bbfa48e9b503181c2dfb5f11f14e4e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">RowPtr</a> ()</td></tr> |
| <tr class="separator:a92bbfa48e9b503181c2dfb5f11f14e4e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9a33a10d9161835271c6b0c1ff715084"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">RowPtr</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a9a33a10d9161835271c6b0c1ff715084">operator-></a> () const </td></tr> |
| <tr class="separator:a9a33a10d9161835271c6b0c1ff715084"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af37f56c4ef55f2e140fcea2a07340054"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#af37f56c4ef55f2e140fcea2a07340054">IsNull</a> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &col_name) const </td></tr> |
| <tr class="separator:af37f56c4ef55f2e140fcea2a07340054"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1b0b04656fec608919b7b6ac7c99451e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a1b0b04656fec608919b7b6ac7c99451e">IsNull</a> (int col_idx) const </td></tr> |
| <tr class="separator:a1b0b04656fec608919b7b6ac7c99451e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2c1f65ffcc1216f583f3ad1b468021f3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a2c1f65ffcc1216f583f3ad1b468021f3">IsDeleted</a> (bool *val) const WARN_UNUSED_RESULT KUDU_NO_EXPORT</td></tr> |
| <tr class="separator:a2c1f65ffcc1216f583f3ad1b468021f3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae07d3fd8616c5c69cc0a4ef3d247bf2c"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#ae07d3fd8616c5c69cc0a4ef3d247bf2c">cell</a> (int col_idx) const </td></tr> |
| <tr class="separator:ae07d3fd8616c5c69cc0a4ef3d247bf2c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a57ebd850adefa8af87f815540d890a34"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a57ebd850adefa8af87f815540d890a34">ToString</a> () const </td></tr> |
| <tr class="separator:a57ebd850adefa8af87f815540d890a34"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab057b7b1bfb713a7e8f216e3b288cb10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#ab057b7b1bfb713a7e8f216e3b288cb10">operator*</a> () const </td></tr> |
| <tr class="separator:ab057b7b1bfb713a7e8f216e3b288cb10"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a544d31af83fae1ca461d2994b52bdd5f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a544d31af83fae1ca461d2994b52bdd5f">operator-></a> () const </td></tr> |
| <tr class="separator:a544d31af83fae1ca461d2994b52bdd5f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad5df483ed3172caab5a8d6a72abfad0c"><td class="memItemLeft" align="right" valign="top">const_iterator & </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#ad5df483ed3172caab5a8d6a72abfad0c">operator++</a> ()</td></tr> |
| <tr class="separator:ad5df483ed3172caab5a8d6a72abfad0c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4b1ad47fd7d429859b6181825a063c48"><td class="memItemLeft" align="right" valign="top">const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a4b1ad47fd7d429859b6181825a063c48">operator++</a> (int)</td></tr> |
| <tr class="separator:a4b1ad47fd7d429859b6181825a063c48"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a378a5844a4b4774056b26f0003c15048"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a378a5844a4b4774056b26f0003c15048">operator==</a> (const const_iterator &other) const </td></tr> |
| <tr class="separator:a378a5844a4b4774056b26f0003c15048"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afd2b2c4cb038cbd366c2af8cf09a3a68"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#afd2b2c4cb038cbd366c2af8cf09a3a68">operator!=</a> (const const_iterator &other) const </td></tr> |
| <tr class="separator:afd2b2c4cb038cbd366c2af8cf09a3a68"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr><td colspan="2"><div class="groupHeader">Advanced/Unstable API</div></td></tr> |
| <tr><td colspan="2"><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="classkudu_1_1client_1_1KuduScanBatch.html#a1073a0c6517b126690d99527556dba51">direct_data()</a> and <a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#af41b26a5f137122454d6341a5b5c1a43">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:a1073a0c6517b126690d99527556dba51"><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="classkudu_1_1client_1_1KuduScanBatch.html#a1073a0c6517b126690d99527556dba51">direct_data</a> () const </td></tr> |
| <tr class="separator:a1073a0c6517b126690d99527556dba51"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af41b26a5f137122454d6341a5b5c1a43"><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="classkudu_1_1client_1_1KuduScanBatch.html#af41b26a5f137122454d6341a5b5c1a43">indirect_data</a> () const </td></tr> |
| <tr class="separator:af41b26a5f137122454d6341a5b5c1a43"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr><td colspan="2"><div class="groupHeader">Getters for integral type columns by column name.</div></td></tr> |
| <tr><td colspan="2"><div class="groupText"><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>The name of the target column. </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Placeholder for the result value. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classkudu_1_1Status.html" title="A representation of an operation's outcome. ">Status</a> if at least one of the following is <code>true:</code> <ul> |
| <li>The type does not match. </li> |
| <li>The value is unset. </li> |
| <li>The value is <code>NULL</code>. </li> |
| </ul> |
| </dd></dl> |
| </div></td></tr> |
| <tr class="memitem:a3b1a867cf2fd47b697fe3a68e28fadd8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b1a867cf2fd47b697fe3a68e28fadd8"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetBool</b> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &col_name, bool *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:a3b1a867cf2fd47b697fe3a68e28fadd8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7bfea7b94e64073562892445a2a2ac7b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7bfea7b94e64073562892445a2a2ac7b"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetInt8</b> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &col_name, int8_t *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:a7bfea7b94e64073562892445a2a2ac7b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afbaff6bf597df2fa0696bdc5cbdfb037"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afbaff6bf597df2fa0696bdc5cbdfb037"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetInt16</b> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &col_name, int16_t *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:afbaff6bf597df2fa0696bdc5cbdfb037"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abc5120c7aadb029e442235a7131f6fd2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc5120c7aadb029e442235a7131f6fd2"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetInt32</b> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &col_name, int32_t *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:abc5120c7aadb029e442235a7131f6fd2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a51d43f077b4510b58a2fd471ae81f7b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51d43f077b4510b58a2fd471ae81f7b0"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetInt64</b> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &col_name, int64_t *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:a51d43f077b4510b58a2fd471ae81f7b0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae1261a486faa04d0c984b50132e0a4a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1261a486faa04d0c984b50132e0a4a3"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetUnixTimeMicros</b> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &col_name, int64_t *micros_since_utc_epoch) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:ae1261a486faa04d0c984b50132e0a4a3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a160ee809dbe15fa456c509ef658368bb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a160ee809dbe15fa456c509ef658368bb"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetDate</b> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &col_name, int32_t *days_since_unix_epoch) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:a160ee809dbe15fa456c509ef658368bb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a70ea98bc135e0b86285530c58e33bff3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70ea98bc135e0b86285530c58e33bff3"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetFloat</b> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &col_name, float *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:a70ea98bc135e0b86285530c58e33bff3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7d09dafc214133f2306eebc9aefddff0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d09dafc214133f2306eebc9aefddff0"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetDouble</b> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &col_name, double *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:a7d09dafc214133f2306eebc9aefddff0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr><td colspan="2"><div class="groupHeader">Getters for integral type columns by column index.</div></td></tr> |
| <tr><td colspan="2"><div class="groupText"><p>These methods are faster than their name-based counterparts since using indices avoids a hashmap lookup, so index-based getters should be preferred in performance-sensitive code.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">col_index</td><td>The index of the column. </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classkudu_1_1Status.html" title="A representation of an operation's outcome. ">Status</a> if at least one of the following is <code>true:</code> <ul> |
| <li>The type does not match. </li> |
| <li>The value is unset. </li> |
| <li>The value is <code>NULL</code>. </li> |
| </ul> |
| </dd></dl> |
| </div></td></tr> |
| <tr class="memitem:a4b1044c3b78e5a6407c2a797005b0e21"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b1044c3b78e5a6407c2a797005b0e21"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetBool</b> (int col_idx, bool *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:a4b1044c3b78e5a6407c2a797005b0e21"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a81a30b5b89f6fa106b5d8575c3fb62b9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a81a30b5b89f6fa106b5d8575c3fb62b9"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetInt8</b> (int col_idx, int8_t *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:a81a30b5b89f6fa106b5d8575c3fb62b9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab5f35c107dc26165546065189dd53dfa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5f35c107dc26165546065189dd53dfa"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetInt16</b> (int col_idx, int16_t *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:ab5f35c107dc26165546065189dd53dfa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab321b8c245cc1748c3b3ecdf507b08fb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab321b8c245cc1748c3b3ecdf507b08fb"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetInt32</b> (int col_idx, int32_t *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:ab321b8c245cc1748c3b3ecdf507b08fb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab59039c6f073df0b57ddc16fb8d8c432"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab59039c6f073df0b57ddc16fb8d8c432"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetInt64</b> (int col_idx, int64_t *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:ab59039c6f073df0b57ddc16fb8d8c432"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acc4dfced2215c5115fecb647fa73e4e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc4dfced2215c5115fecb647fa73e4e7"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetUnixTimeMicros</b> (int col_idx, int64_t *micros_since_utc_epoch) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:acc4dfced2215c5115fecb647fa73e4e7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afed25c9aadd0c6314aa3dd0acee9da54"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afed25c9aadd0c6314aa3dd0acee9da54"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetDate</b> (int col_idx, int32_t *days_since_unix_epoch) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:afed25c9aadd0c6314aa3dd0acee9da54"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae41dd0f1e2b4bf074ded210382b825bd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae41dd0f1e2b4bf074ded210382b825bd"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetFloat</b> (int col_idx, float *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:ae41dd0f1e2b4bf074ded210382b825bd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab2b7fb17cac4571139b2eaca761a99c0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2b7fb17cac4571139b2eaca761a99c0"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetDouble</b> (int col_idx, double *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:ab2b7fb17cac4571139b2eaca761a99c0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr><td colspan="2"><div class="groupHeader">Getters for string/binary/varchar column by column name.</div></td></tr> |
| <tr><td colspan="2"><div class="groupText"><p>Get the string/binary/varchar value for a column by its name.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>Name of the column. </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting <a class="el" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data. ">Slice</a> if necessary. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classkudu_1_1Status.html" title="A representation of an operation's outcome. ">Status</a> if at least one of the following is <code>true:</code> <ul> |
| <li>The type does not match. </li> |
| <li>The value is unset. </li> |
| <li>The value is <code>NULL</code>. </li> |
| </ul> |
| </dd></dl> |
| </div></td></tr> |
| <tr class="memitem:ad8f9ba0ff9a1fcd8326b012e689ad4a7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8f9ba0ff9a1fcd8326b012e689ad4a7"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetString</b> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &col_name, <a class="el" href="classkudu_1_1Slice.html">Slice</a> *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:ad8f9ba0ff9a1fcd8326b012e689ad4a7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2fc063d4fb631b14f5651a84861ffa4b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fc063d4fb631b14f5651a84861ffa4b"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetBinary</b> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &col_name, <a class="el" href="classkudu_1_1Slice.html">Slice</a> *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:a2fc063d4fb631b14f5651a84861ffa4b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a291fde9bf246b6f9277edb8d8ef214bb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a291fde9bf246b6f9277edb8d8ef214bb"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetVarchar</b> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &col_name, <a class="el" href="classkudu_1_1Slice.html">Slice</a> *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:a291fde9bf246b6f9277edb8d8ef214bb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr><td colspan="2"><div class="groupHeader">Getters for string/binary/varchar column by column index.</div></td></tr> |
| <tr><td colspan="2"><div class="groupText"><p>Get the string/binary/varchar value for a column by its index.</p> |
| <p>These methods are faster than their name-based counterparts since using indices avoids a hashmap lookup, so index-based getters should be preferred in performance-sensitive code.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">col_index</td><td>The index of the column. </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting <a class="el" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data. ">Slice</a> if necessary. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classkudu_1_1Status.html" title="A representation of an operation's outcome. ">Status</a> if at least one of the following is <code>true:</code> <ul> |
| <li>The type does not match. </li> |
| <li>The value is unset. </li> |
| <li>The value is <code>NULL</code>. </li> |
| </ul> |
| </dd></dl> |
| </div></td></tr> |
| <tr class="memitem:a887dd6b7e20ada26ee705c315fd86b56"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a887dd6b7e20ada26ee705c315fd86b56"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetString</b> (int col_idx, <a class="el" href="classkudu_1_1Slice.html">Slice</a> *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:a887dd6b7e20ada26ee705c315fd86b56"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a921dfdeba21588f7a3c2d5e360d3268e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a921dfdeba21588f7a3c2d5e360d3268e"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetBinary</b> (int col_idx, <a class="el" href="classkudu_1_1Slice.html">Slice</a> *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:a921dfdeba21588f7a3c2d5e360d3268e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a110b51d5b7544a30c854ad64db19450b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a110b51d5b7544a30c854ad64db19450b"></a> |
| <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>GetVarchar</b> (int col_idx, <a class="el" href="classkudu_1_1Slice.html">Slice</a> *val) const WARN_UNUSED_RESULT</td></tr> |
| <tr class="separator:a110b51d5b7544a30c854ad64db19450b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 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#af365f1d3b3b34aeb7d016727a9019067">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" href="classkudu_1_1client_1_1KuduScanBatch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a> row : batch) {</div><div class="line"> ... row.GetInt(1, ...)</div><div class="line"> ...</div><div class="line">}</div></div><!-- fragment --><p>regular for loop (C++03): </p><div class="fragment"><div class="line"><span class="keywordflow">for</span> (KuduScanBatch::const_iterator it = batch.begin(), it != batch.end();</div><div class="line"> ++it) {</div><div class="line"> <a class="code" href="classkudu_1_1client_1_1KuduScanBatch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a> row(*it);</div><div class="line"> ...</div><div class="line">}</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" href="classkudu_1_1client_1_1KuduScanBatch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">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="classkudu_1_1client_1_1KuduScanBatch.html#a16e45694c5932eb3decc2184c3834157">NumRows()</a> is only called once at the beginning of the loop to avoid extra calls to the non-inlined method. </dd></dl> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a30f55cf8f3c9d6fcb47537e586d82e9f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">KuduScanBatch::const_iterator kudu::client::KuduScanBatch::begin </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">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 class="anchor" id="ae07d3fd8616c5c69cc0a4ef3d247bf2c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const void* kudu::client::KuduScanBatch::cell </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>col_idx</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the column's row data.</p> |
| <dl class="section note"><dt>Note</dt><dd>Should be avoided unless absolutely necessary. </dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Raw cell data for the specified index. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1073a0c6517b126690d99527556dba51"></a> |
| <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"></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 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 class="anchor" id="ad30dcfafb276b5347842882cf68cb522"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">KuduScanBatch::const_iterator kudu::client::KuduScanBatch::end </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">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 class="anchor" id="af41b26a5f137122454d6341a5b5c1a43"></a> |
| <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"></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 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 class="anchor" id="a2c1f65ffcc1216f583f3ad1b468021f3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classkudu_1_1Status.html">Status</a> kudu::client::KuduScanBatch::IsDeleted </td> |
| <td>(</td> |
| <td class="paramtype">bool * </td> |
| <td class="paramname"><em>val</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get the value of the IS_DELETED virtual column.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Placeholder for the result value. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classkudu_1_1Status.html" title="A representation of an operation's outcome. ">Status</a> if there is no IS_DELETED virtual column in the schema. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af37f56c4ef55f2e140fcea2a07340054"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool kudu::client::KuduScanBatch::IsNull </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classkudu_1_1Slice.html">Slice</a> & </td> |
| <td class="paramname"><em>col_name</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>Name of the column. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> iff the specified column of the row has <code>NULL</code> value. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1b0b04656fec608919b7b6ac7c99451e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool kudu::client::KuduScanBatch::IsNull </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>col_idx</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>Index of the column. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> iff the specified column of the row has <code>NULL</code> value. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a16e45694c5932eb3decc2184c3834157"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int kudu::client::KuduScanBatch::NumRows </td> |
| <td>(</td> |
| <td class="paramname"></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 class="anchor" id="afd2b2c4cb038cbd366c2af8cf09a3a68"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool kudu::client::KuduScanBatch::operator!= </td> |
| <td>(</td> |
| <td class="paramtype">const const_iterator & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>An operator to check whether two iterators are 'not equal'.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>The iterator to compare with. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> iff the other iterator points to a different row in the same batch, or to a row belonging to a different batch altogether. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab057b7b1bfb713a7e8f216e3b288cb10"></a> |
| <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.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a> kudu::client::KuduScanBatch::operator* </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>The row in the batch the iterator is pointing at. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad5df483ed3172caab5a8d6a72abfad0c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const_iterator& kudu::client::KuduScanBatch::operator++ </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Prefix increment operator: advances the iterator to the next position.</p> |
| <dl class="section return"><dt>Returns</dt><dd>The reference to the iterator, pointing to the next position. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4b1ad47fd7d429859b6181825a063c48"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const_iterator kudu::client::KuduScanBatch::operator++ </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Postfix increment operator: advances the iterator to the next position.</p> |
| <dl class="section return"><dt>Returns</dt><dd>A copy of the iterator pointing to the pre-increment position. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9a33a10d9161835271c6b0c1ff715084"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">RowPtr</a>* kudu::client::KuduScanBatch::operator-> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Overloaded operator -> to support pointer trait for access via const_iterator.</p><dl class="section return"><dt>Returns</dt><dd>Pointer to the row </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a544d31af83fae1ca461d2994b52bdd5f"></a> |
| <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.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a> kudu::client::KuduScanBatch::operator-> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section note"><dt>Note</dt><dd>Since iterator does not keep current <a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a>, we cannot return pointer to it. Instead we return <a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a>, which implements pointer operator -></dd></dl> |
| <dl class="section return"><dt>Returns</dt><dd>The row in the batch the iterator is pointing at. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a378a5844a4b4774056b26f0003c15048"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool kudu::client::KuduScanBatch::operator== </td> |
| <td>(</td> |
| <td class="paramtype">const const_iterator & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>An operator to check whether two iterators are 'equal'.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>The iterator to compare with. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> iff the other iterator points to the same row of the same batch. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3b58e77f53beea357fbb8bcddaab3137"></a> |
| <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"></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.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a> returned by this batch are guaranteed to have this schema. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a93c2f0914140dd405a51d57e2f75014a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduScanBatch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a> kudu::client::KuduScanBatch::Row </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>idx</em></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> |
| <a class="anchor" id="a92bbfa48e9b503181c2dfb5f11f14e4e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">kudu::client::KuduScanBatch::RowPtr </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Construct an invalid RowPtr. Before use, you must assign a properly-initialized value. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a57ebd850adefa8af87f815540d890a34"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string kudu::client::KuduScanBatch::ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>String representation for this row. </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 --> |
| <!-- start footer part --> |
| <hr class="footer"/> |
| <address class="footer"> |
| <small>Generated for Kudu version 1.12.0 on Thu May 14 2020 21:55:22 by Doxygen 1.8.11</small> |
| <br> |
| <small>Copyright © 2020 The Apache Software Foundation.</small> |
| </address> |
| </body> |
| </html> |
