http://git-wip-us.apache.org/repos/asf/kudu-site/blob/09800f53/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch.html b/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch.html deleted file mode 100644 index 37e9698..0000000 --- a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch.html +++ /dev/null @@ -1,712 +0,0 @@ -<!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="inherits.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="#friends">Friends</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__inherit__graph.png" border="0" usemap="#kudu_1_1client_1_1KuduScanBatch_inherit__map" alt="Inheritance graph"/></div> -<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> -<div class="dynheader"> -Collaboration diagram for kudu::client::KuduScanBatch:</div> -<div class="dyncontent"> -<div class="center"><img src="classkudu_1_1client_1_1KuduScanBatch__coll__graph.png" border="0" usemap="#kudu_1_1client_1_1KuduScanBatch_coll__map" alt="Collaboration graph"/></div> -<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></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: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: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: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: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: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 column by column name.</div></td></tr> -<tr><td colspan="2"><div class="groupText"><p>Get the string/binary 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><td colspan="2"><div class="groupHeader">Getters for string/binary column by column index.</div></td></tr> -<tr><td colspan="2"><div class="groupText"><p>Get the string/binary 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> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> -Friends</h2></td></tr> -<tr class="memitem:a79d30f3059c783e077627a6f6d153c1b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a79d30f3059c783e077627a6f6d153c1b"></a> -class </td><td class="memItemRight" valign="bottom"><b>KuduScanner</b></td></tr> -<tr class="separator:a79d30f3059c783e077627a6f6d153c1b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aafe7501e17c36d1c5dc2971f69a776de"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aafe7501e17c36d1c5dc2971f69a776de"></a> -class </td><td class="memItemRight" valign="bottom"><b>tools::ReplicaDumper</b></td></tr> -<tr class="separator:aafe7501e17c36d1c5dc2971f69a776de"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a0f719ac1eb44a4d656839448282399a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f719ac1eb44a4d656839448282399a3"></a> -class </td><td class="memItemRight" valign="bottom"><b>KuduScanBatch</b></td></tr> -<tr class="separator:a0f719ac1eb44a4d656839448282399a3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aba9d17eb5c32bd866a8572a1d51fd64f"><td class="memTemplParams" colspan="2"><a class="anchor" id="aba9d17eb5c32bd866a8572a1d51fd64f"></a> -template<typename KeyTypeWrapper > </td></tr> -<tr class="memitem:aba9d17eb5c32bd866a8572a1d51fd64f"><td class="memTemplItemLeft" align="right" valign="top">struct </td><td class="memTemplItemRight" valign="bottom"><b>SliceKeysTestSetup</b></td></tr> -<tr class="separator:aba9d17eb5c32bd866a8572a1d51fd64f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a313ca772464ff159550ef09b986867fd"><td class="memTemplParams" colspan="2"><a class="anchor" id="a313ca772464ff159550ef09b986867fd"></a> -template<typename KeyTypeWrapper > </td></tr> -<tr class="memitem:a313ca772464ff159550ef09b986867fd"><td class="memTemplItemLeft" align="right" valign="top">struct </td><td class="memTemplItemRight" valign="bottom"><b>IntKeysTestSetup</b></td></tr> -<tr class="separator:a313ca772464ff159550ef09b986867fd"><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"> ++i) {</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="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="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.6.0 on Thu Dec 7 2017 19:52:43 by Doxygen 1.8.11</small> - <br> - <small>Copyright © 2017 The Apache Software Foundation.</small> -</address> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/kudu-site/blob/09800f53/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__coll__graph.map ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__coll__graph.map b/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__coll__graph.map deleted file mode 100644 index 732745f..0000000 --- a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__coll__graph.map +++ /dev/null @@ -1,2 +0,0 @@ -<map id="kudu::client::KuduScanBatch" name="kudu::client::KuduScanBatch"> -</map> http://git-wip-us.apache.org/repos/asf/kudu-site/blob/09800f53/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__coll__graph.md5 ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__coll__graph.md5 b/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__coll__graph.md5 deleted file mode 100644 index 70fc119..0000000 --- a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__coll__graph.md5 +++ /dev/null @@ -1 +0,0 @@ -21810149d4f30c597092c6686efcfef2 \ No newline at end of file http://git-wip-us.apache.org/repos/asf/kudu-site/blob/09800f53/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__coll__graph.png ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__coll__graph.png b/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__coll__graph.png deleted file mode 100644 index 92e3635..0000000 Binary files a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__coll__graph.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/kudu-site/blob/09800f53/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__inherit__graph.map ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__inherit__graph.map b/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__inherit__graph.map deleted file mode 100644 index 732745f..0000000 --- a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__inherit__graph.map +++ /dev/null @@ -1,2 +0,0 @@ -<map id="kudu::client::KuduScanBatch" name="kudu::client::KuduScanBatch"> -</map> http://git-wip-us.apache.org/repos/asf/kudu-site/blob/09800f53/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__inherit__graph.md5 ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__inherit__graph.md5 b/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__inherit__graph.md5 deleted file mode 100644 index 70fc119..0000000 --- a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__inherit__graph.md5 +++ /dev/null @@ -1 +0,0 @@ -21810149d4f30c597092c6686efcfef2 \ No newline at end of file http://git-wip-us.apache.org/repos/asf/kudu-site/blob/09800f53/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__inherit__graph.png ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__inherit__graph.png b/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__inherit__graph.png deleted file mode 100644 index 92e3635..0000000 Binary files a/cpp-client-api/classkudu_1_1client_1_1KuduScanBatch__inherit__graph.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/kudu-site/blob/09800f53/cpp-client-api/classkudu_1_1client_1_1KuduScanToken-members.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduScanToken-members.html b/cpp-client-api/classkudu_1_1client_1_1KuduScanToken-members.html deleted file mode 100644 index 9b483d1..0000000 --- a/cpp-client-api/classkudu_1_1client_1_1KuduScanToken-members.html +++ /dev/null @@ -1,112 +0,0 @@ -<!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: Member List</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="inherits.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_1KuduScanToken.html">KuduScanToken</a></li> </ul> -</div> -</div><!-- top --> -<div class="header"> - <div class="headertitle"> -<div class="title">kudu::client::KuduScanToken Member List</div> </div> -</div><!--header--> -<div class="contents"> - -<p>This is the complete list of members for <a class="el" href="classkudu_1_1client_1_1KuduScanToken.html">kudu::client::KuduScanToken</a>, including all inherited members.</p> -<table class="directory"> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanToken.html#ae90d9422476cf6eee5c33afb41d1f867">DeserializeIntoScanner</a>(KuduClient *client, const std::string &serialized_token, KuduScanner **scanner) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanToken.html">kudu::client::KuduScanToken</a></td><td class="entry"><span class="mlabel">static</span></td></tr> - <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanToken.html#adb95c9538bb1fc4c83963557ce487292">IntoKuduScanner</a>(KuduScanner **scanner) const WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanToken.html">kudu::client::KuduScanToken</a></td><td class="entry"></td></tr> - <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>KuduScanTokenBuilder</b> (defined in <a class="el" href="classkudu_1_1client_1_1KuduScanToken.html">kudu::client::KuduScanToken</a>)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanToken.html">kudu::client::KuduScanToken</a></td><td class="entry"><span class="mlabel">friend</span></td></tr> - <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanToken.html#a6eb749ddf0a1434596d86df88341a008">Serialize</a>(std::string *buf) const WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanToken.html">kudu::client::KuduScanToken</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanToken.html#a6513d5a02c745177d63d807de54aa301">tablet</a>() const </td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanToken.html">kudu::client::KuduScanToken</a></td><td class="entry"></td></tr> - <tr bgcolor="#f0f0f0"><td class="entry"><b>~KuduScanToken</b>() (defined in <a class="el" href="classkudu_1_1client_1_1KuduScanToken.html">kudu::client::KuduScanToken</a>)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanToken.html">kudu::client::KuduScanToken</a></td><td class="entry"></td></tr> -</table></div><!-- contents --> -<!-- start footer part --> -<hr class="footer"/> -<address class="footer"> - <small>Generated for Kudu version 1.6.0 on Thu Dec 7 2017 19:52:43 by Doxygen 1.8.11</small> - <br> - <small>Copyright © 2017 The Apache Software Foundation.</small> -</address> -</body> -</html> http://git-wip-us.apache.org/repos/asf/kudu-site/blob/09800f53/cpp-client-api/classkudu_1_1client_1_1KuduScanToken.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduScanToken.html b/cpp-client-api/classkudu_1_1client_1_1KuduScanToken.html deleted file mode 100644 index 8baeb27..0000000 --- a/cpp-client-api/classkudu_1_1client_1_1KuduScanToken.html +++ /dev/null @@ -1,260 +0,0 @@ -<!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::KuduScanToken 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="inherits.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_1KuduScanToken.html">KuduScanToken</a></li> </ul> -</div> -</div><!-- top --> -<div class="header"> - <div class="summary"> -<a href="#pub-methods">Public Member Functions</a> | -<a href="#pub-static-methods">Static Public Member Functions</a> | -<a href="#friends">Friends</a> | -<a href="classkudu_1_1client_1_1KuduScanToken-members.html">List of all members</a> </div> - <div class="headertitle"> -<div class="title">kudu::client::KuduScanToken Class Reference</div> </div> -</div><!--header--> -<div class="contents"> - -<p>A scan descriptor limited to a single physical contiguous location. - <a href="classkudu_1_1client_1_1KuduScanToken.html#details">More...</a></p> - -<p><code>#include <<a class="el" href="client_8h_source.html">client.h</a>></code></p> -<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:adb95c9538bb1fc4c83963557ce487292"><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_1KuduScanToken.html#adb95c9538bb1fc4c83963557ce487292">IntoKuduScanner</a> (<a class="el" href="classkudu_1_1client_1_1KuduScanner.html">KuduScanner</a> **scanner) const WARN_UNUSED_RESULT</td></tr> -<tr class="separator:adb95c9538bb1fc4c83963557ce487292"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6513d5a02c745177d63d807de54aa301"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classkudu_1_1client_1_1KuduTablet.html">KuduTablet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanToken.html#a6513d5a02c745177d63d807de54aa301">tablet</a> () const </td></tr> -<tr class="separator:a6513d5a02c745177d63d807de54aa301"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6eb749ddf0a1434596d86df88341a008"><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_1KuduScanToken.html#a6eb749ddf0a1434596d86df88341a008">Serialize</a> (std::string *buf) const WARN_UNUSED_RESULT</td></tr> -<tr class="separator:a6eb749ddf0a1434596d86df88341a008"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> -Static Public Member Functions</h2></td></tr> -<tr class="memitem:ae90d9422476cf6eee5c33afb41d1f867"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classkudu_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanToken.html#ae90d9422476cf6eee5c33afb41d1f867">DeserializeIntoScanner</a> (<a class="el" href="classkudu_1_1client_1_1KuduClient.html">KuduClient</a> *client, const std::string &serialized_token, <a class="el" href="classkudu_1_1client_1_1KuduScanner.html">KuduScanner</a> **scanner) WARN_UNUSED_RESULT</td></tr> -<tr class="separator:ae90d9422476cf6eee5c33afb41d1f867"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> -Friends</h2></td></tr> -<tr class="memitem:a644ef5d9d668e5772acd6dc03c4f14ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a644ef5d9d668e5772acd6dc03c4f14ee"></a> -class </td><td class="memItemRight" valign="bottom"><b>KuduScanTokenBuilder</b></td></tr> -<tr class="separator:a644ef5d9d668e5772acd6dc03c4f14ee"><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 scan descriptor limited to a single physical contiguous location. </p> -<p>A <a class="el" href="classkudu_1_1client_1_1KuduScanToken.html" title="A scan descriptor limited to a single physical contiguous location. ">KuduScanToken</a> describes a partial scan of a Kudu table limited to a single contiguous physical location. Using the <a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html" title="Builds scan tokens for a table. ">KuduScanTokenBuilder</a>, clients can describe the desired scan, including predicates, bounds, timestamps, and caching, and receive back a collection of scan tokens.</p> -<p>Each scan token may be separately turned into a scanner using <a class="el" href="classkudu_1_1client_1_1KuduScanToken.html#adb95c9538bb1fc4c83963557ce487292">KuduScanToken::IntoKuduScanner</a>, with each scanner responsible for a disjoint section of the table.</p> -<p>Scan tokens may be serialized using the <a class="el" href="classkudu_1_1client_1_1KuduScanToken.html#a6eb749ddf0a1434596d86df88341a008">KuduScanToken::Serialize</a> method and deserialized back into a scanner using the <a class="el" href="classkudu_1_1client_1_1KuduScanToken.html#ae90d9422476cf6eee5c33afb41d1f867">KuduScanToken::DeserializeIntoScanner</a> method. This allows use cases such as generating scan tokens in the planner component of a query engine, then sending the tokens to execution nodes based on locality, and then instantiating the scanners on those nodes.</p> -<p>Scan token locality information can be inspected using the <a class="el" href="classkudu_1_1client_1_1KuduScanToken.html#a6513d5a02c745177d63d807de54aa301">KuduScanToken::tablet()</a> function. </p> -</div><h2 class="groupheader">Member Function Documentation</h2> -<a class="anchor" id="ae90d9422476cf6eee5c33afb41d1f867"></a> -<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="classkudu_1_1Status.html">Status</a> kudu::client::KuduScanToken::DeserializeIntoScanner </td> - <td>(</td> - <td class="paramtype"><a class="el" href="classkudu_1_1client_1_1KuduClient.html">KuduClient</a> * </td> - <td class="paramname"><em>client</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const std::string & </td> - <td class="paramname"><em>serialized_token</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="classkudu_1_1client_1_1KuduScanner.html">KuduScanner</a> ** </td> - <td class="paramname"><em>scanner</em> </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 new scanner and set the scanner options.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">client</td><td>Client to bound to the scanner. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">serialized_token</td><td>Token containing serialized scanner parameters. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">scanner</td><td>The result scanner. The caller owns the new scanner. The scanner must be opened before use. The scanner will not be set if the returned status is an error. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Operation result status. </dd></dl> - -</div> -</div> -<a class="anchor" id="adb95c9538bb1fc4c83963557ce487292"></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::KuduScanToken::IntoKuduScanner </td> - <td>(</td> - <td class="paramtype"><a class="el" href="classkudu_1_1client_1_1KuduScanner.html">KuduScanner</a> ** </td> - <td class="paramname"><em>scanner</em></td><td>)</td> - <td> const</td> - </tr> - </table> -</div><div class="memdoc"> -<p>Create a new scanner.</p> -<p>This method creates a new scanner, setting the result scanner's options according to the scan token.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[out]</td><td class="paramname">scanner</td><td>The result scanner. The caller owns the new scanner. The scanner must be opened before use. The output parameter will not be set if the returned status is an error. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Operation result status. </dd></dl> - -</div> -</div> -<a class="anchor" id="a6eb749ddf0a1434596d86df88341a008"></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::KuduScanToken::Serialize </td> - <td>(</td> - <td class="paramtype">std::string * </td> - <td class="paramname"><em>buf</em></td><td>)</td> - <td> const</td> - </tr> - </table> -</div><div class="memdoc"> -<p>Serialize the token into a string.</p> -<p>Deserialize with <a class="el" href="classkudu_1_1client_1_1KuduScanToken.html#ae90d9422476cf6eee5c33afb41d1f867">KuduScanToken::DeserializeIntoScanner()</a>.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Result string to output the serialized token. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Operation result status. </dd></dl> - -</div> -</div> -<a class="anchor" id="a6513d5a02c745177d63d807de54aa301"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">const <a class="el" href="classkudu_1_1client_1_1KuduTablet.html">KuduTablet</a>& kudu::client::KuduScanToken::tablet </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>Tablet that this scan will retrieve rows from. </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="client_8h_source.html">client.h</a></li> -</ul> -</div><!-- contents --> -<!-- start footer part --> -<hr class="footer"/> -<address class="footer"> - <small>Generated for Kudu version 1.6.0 on Thu Dec 7 2017 19:52:43 by Doxygen 1.8.11</small> - <br> - <small>Copyright © 2017 The Apache Software Foundation.</small> -</address> -</body> -</html> http://git-wip-us.apache.org/repos/asf/kudu-site/blob/09800f53/cpp-client-api/classkudu_1_1client_1_1KuduScanTokenBuilder-members.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduScanTokenBuilder-members.html b/cpp-client-api/classkudu_1_1client_1_1KuduScanTokenBuilder-members.html deleted file mode 100644 index 6c67072..0000000 --- a/cpp-client-api/classkudu_1_1client_1_1KuduScanTokenBuilder-members.html +++ /dev/null @@ -1,122 +0,0 @@ -<!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: Member List</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="inherits.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_1KuduScanTokenBuilder.html">KuduScanTokenBuilder</a></li> </ul> -</div> -</div><!-- top --> -<div class="header"> - <div class="headertitle"> -<div class="title">kudu::client::KuduScanTokenBuilder Member List</div> </div> -</div><!--header--> -<div class="contents"> - -<p>This is the complete list of members for <a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a>, including all inherited members.</p> -<table class="directory"> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#ac40487d17b8e4dcca7ca08efeb5f195e">AddConjunctPredicate</a>(KuduPredicate *pred) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#ae11ca3d00d15138e957a2c2e89b05fcf">AddLowerBound</a>(const KuduPartialRow &key) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#ac4d0fa934e4c705ac76c424a5431566a">AddUpperBound</a>(const KuduPartialRow &key) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#acbc00b42db998f3342fa0ca7ab55dfdb">Build</a>(std::vector< KuduScanToken * > *tokens) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#aa8d300b560d419030abd503b66812484">KuduScanTokenBuilder</a>(KuduTable *table)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr> - <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#a36523ca7f2f9a2b4e3c096cf6167643c">SetBatchSizeBytes</a>(uint32_t batch_size) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#a7ab7c9c1c4f4d3bbbc18b2b35d7d5475">SetCacheBlocks</a>(bool cache_blocks) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#a4a17f27950ccd59bcb3430fb28b61dbe">SetFaultTolerant</a>() WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#a01d990e024632c7749cca96b4f857be8">SetProjectedColumnIndexes</a>(const std::vector< int > &col_indexes) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#a0dbb58301fc0e48ce44f41215d32f0ad">SetProjectedColumnNames</a>(const std::vector< std::string > &col_names) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#adb34f01a9bc52a9e23ce49124bab3892">SetReadMode</a>(KuduScanner::ReadMode read_mode) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#a168bfed43dcd754a17d4c82293dade88">SetSelection</a>(KuduClient::ReplicaSelection selection) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#aa4c1cfa570edfaab818831a2330eece5">SetSnapshotMicros</a>(uint64_t snapshot_timestamp_micros) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#a313e345dc6c1f9ccdad65df5af2cf4b7">SetSnapshotRaw</a>(uint64_t snapshot_timestamp) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html#a0f0e58d5d6fb3867ff0a03f7fc633445">SetTimeoutMillis</a>(int millis) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> - <tr bgcolor="#f0f0f0"><td class="entry"><b>~KuduScanTokenBuilder</b>() (defined in <a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a>)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduScanTokenBuilder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr> -</table></div><!-- contents --> -<!-- start footer part --> -<hr class="footer"/> -<address class="footer"> - <small>Generated for Kudu version 1.6.0 on Thu Dec 7 2017 19:52:43 by Doxygen 1.8.11</small> - <br> - <small>Copyright © 2017 The Apache Software Foundation.</small> -</address> -</body> -</html>
