kudu-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mpe...@apache.org
Subject [15/51] [partial] kudu git commit: Fix 1.7.0 apidocs and cpp-client-api
Date Thu, 22 Mar 2018 21:17:14 GMT
http://git-wip-us.apache.org/repos/asf/kudu/blob/33b93347/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_batch.html
----------------------------------------------------------------------
diff --git a/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_batch.html b/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_batch.html
new file mode 100644
index 0000000..13bdd7a
--- /dev/null
+++ b/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_batch.html
@@ -0,0 +1,722 @@
+<!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.14"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Kudu C++ client API: kudu::client::KuduScanBatch Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr 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.14 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+/* @license-end */</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<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_1_kudu_scan_batch.html">KuduScanBatch</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#pub-types">Public Types</a> &#124;
+<a href="#pub-methods">Public Member Functions</a> &#124;
+<a href="#friends">Friends</a> &#124;
+<a href="classkudu_1_1client_1_1_kudu_scan_batch-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_1_kudu_scan_batch.html#details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="scan__batch_8h_source.html">scan_batch.h</a>&gt;</code></p>
+<div class="dynheader">
+Inheritance diagram for kudu::client::KuduScanBatch:</div>
+<div class="dyncontent">
+ <div class="center">
+  <img src="classkudu_1_1client_1_1_kudu_scan_batch.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 id="ae1a827120c84eeedb703451bd5782467"></a>
+typedef <a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">RowPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#ae1a827120c84eeedb703451bd5782467">value_type</a></td></tr>
+<tr class="memdesc:ae1a827120c84eeedb703451bd5782467"><td class="mdescLeft">&#160;</td><td class="mdescRight">A handy typedef for the RowPtr. <br /></td></tr>
+<tr class="separator:ae1a827120c84eeedb703451bd5782467"><td class="memSeparator" colspan="2">&#160;</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:a252ffd623dbaa7d725d623fd220fee4c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a252ffd623dbaa7d725d623fd220fee4c">NumRows</a> () const</td></tr>
+<tr class="separator:a252ffd623dbaa7d725d623fd220fee4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3f6366606eec7f0d0a8953ff6a81c320"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a3f6366606eec7f0d0a8953ff6a81c320">Row</a> (int idx) const</td></tr>
+<tr class="separator:a3f6366606eec7f0d0a8953ff6a81c320"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a654b2572d33e8b45836527e7b63dac21"><td class="memItemLeft" align="right" valign="top">const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a654b2572d33e8b45836527e7b63dac21">begin</a> () const</td></tr>
+<tr class="separator:a654b2572d33e8b45836527e7b63dac21"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a54bc996032e6b5bc0df0962d821c113c"><td class="memItemLeft" align="right" valign="top">const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a54bc996032e6b5bc0df0962d821c113c">end</a> () const</td></tr>
+<tr class="separator:a54bc996032e6b5bc0df0962d821c113c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0c99e4ac2a6b822e693fe7c6625cb324"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classkudu_1_1client_1_1_kudu_schema.html">KuduSchema</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a0c99e4ac2a6b822e693fe7c6625cb324">projection_schema</a> () const</td></tr>
+<tr class="separator:a0c99e4ac2a6b822e693fe7c6625cb324"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a92bbfa48e9b503181c2dfb5f11f14e4e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">RowPtr</a> ()</td></tr>
+<tr class="separator:a92bbfa48e9b503181c2dfb5f11f14e4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad1bdf4368f87e0d83d9066584b2b2047"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#ad1bdf4368f87e0d83d9066584b2b2047">IsNull</a> (const <a class="el" href="classkudu_1_1_slice.html">Slice</a> &amp;col_name) const</td></tr>
+<tr class="separator:ad1bdf4368f87e0d83d9066584b2b2047"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a63aa794845d41cc5251ee5d30547e520"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a63aa794845d41cc5251ee5d30547e520">IsNull</a> (int col_idx) const</td></tr>
+<tr class="separator:a63aa794845d41cc5251ee5d30547e520"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a2ff4e572251b5873491dfe827ec2c5af"><td class="memItemLeft" align="right" valign="top">const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a2ff4e572251b5873491dfe827ec2c5af">cell</a> (int col_idx) const</td></tr>
+<tr class="separator:a2ff4e572251b5873491dfe827ec2c5af"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aca10e03eeb078908c09e552cceb1e4c3"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#aca10e03eeb078908c09e552cceb1e4c3">ToString</a> () const</td></tr>
+<tr class="separator:aca10e03eeb078908c09e552cceb1e4c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5fd788bcce7344ebe1fe33f22c734ab9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a5fd788bcce7344ebe1fe33f22c734ab9">operator*</a> () const</td></tr>
+<tr class="separator:a5fd788bcce7344ebe1fe33f22c734ab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad5df483ed3172caab5a8d6a72abfad0c"><td class="memItemLeft" align="right" valign="top">const_iterator &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#ad5df483ed3172caab5a8d6a72abfad0c">operator++</a> ()</td></tr>
+<tr class="separator:ad5df483ed3172caab5a8d6a72abfad0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a4b1ad47fd7d429859b6181825a063c48"><td class="memItemLeft" align="right" valign="top">const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a4b1ad47fd7d429859b6181825a063c48">operator++</a> (int)</td></tr>
+<tr class="separator:a4b1ad47fd7d429859b6181825a063c48"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a78f4a33eed6ee9031c1b04146d124a63"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a78f4a33eed6ee9031c1b04146d124a63">operator==</a> (const const_iterator &amp;other) const</td></tr>
+<tr class="separator:a78f4a33eed6ee9031c1b04146d124a63"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a2bf8a53b3486a8b7c62b8d38d5f64ef0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a2bf8a53b3486a8b7c62b8d38d5f64ef0">operator!=</a> (const const_iterator &amp;other) const</td></tr>
+<tr class="separator:a2bf8a53b3486a8b7c62b8d38d5f64ef0"><td class="memSeparator" colspan="2">&#160;</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_1_kudu_scan_batch.html#a09bfd1652c0ab153ca6759317c3d3992">direct_data()</a> and <a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a3cb4c17aa228e680ecf088a29a075989">indirect_data()</a> are only valid for the lifetime of the <a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html" title="A batch of zero or more rows returned by a scan operation. ">KuduScanBatch</a>. </dd></dl>
+</div></td></tr>
+<tr class="memitem:a09bfd1652c0ab153ca6759317c3d3992"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1_slice.html">Slice</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a09bfd1652c0ab153ca6759317c3d3992">direct_data</a> () const</td></tr>
+<tr class="separator:a09bfd1652c0ab153ca6759317c3d3992"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3cb4c17aa228e680ecf088a29a075989"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1_slice.html">Slice</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a3cb4c17aa228e680ecf088a29a075989">indirect_data</a> () const</td></tr>
+<tr class="separator:a3cb4c17aa228e680ecf088a29a075989"><td class="memSeparator" colspan="2">&#160;</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_1_status.html" title="A representation of an operation&#39;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 id="a3b1a867cf2fd47b697fe3a68e28fadd8"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetBool</b> (const <a class="el" href="classkudu_1_1_slice.html">Slice</a> &amp;col_name, bool *val) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:a3b1a867cf2fd47b697fe3a68e28fadd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a7bfea7b94e64073562892445a2a2ac7b"><td class="memItemLeft" align="right" valign="top"><a id="a7bfea7b94e64073562892445a2a2ac7b"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetInt8</b> (const <a class="el" href="classkudu_1_1_slice.html">Slice</a> &amp;col_name, int8_t *val) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:a7bfea7b94e64073562892445a2a2ac7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:afbaff6bf597df2fa0696bdc5cbdfb037"><td class="memItemLeft" align="right" valign="top"><a id="afbaff6bf597df2fa0696bdc5cbdfb037"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetInt16</b> (const <a class="el" href="classkudu_1_1_slice.html">Slice</a> &amp;col_name, int16_t *val) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:afbaff6bf597df2fa0696bdc5cbdfb037"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:abc5120c7aadb029e442235a7131f6fd2"><td class="memItemLeft" align="right" valign="top"><a id="abc5120c7aadb029e442235a7131f6fd2"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetInt32</b> (const <a class="el" href="classkudu_1_1_slice.html">Slice</a> &amp;col_name, int32_t *val) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:abc5120c7aadb029e442235a7131f6fd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a51d43f077b4510b58a2fd471ae81f7b0"><td class="memItemLeft" align="right" valign="top"><a id="a51d43f077b4510b58a2fd471ae81f7b0"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetInt64</b> (const <a class="el" href="classkudu_1_1_slice.html">Slice</a> &amp;col_name, int64_t *val) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:a51d43f077b4510b58a2fd471ae81f7b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae1261a486faa04d0c984b50132e0a4a3"><td class="memItemLeft" align="right" valign="top"><a id="ae1261a486faa04d0c984b50132e0a4a3"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetUnixTimeMicros</b> (const <a class="el" href="classkudu_1_1_slice.html">Slice</a> &amp;col_name, int64_t *micros_since_utc_epoch) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:ae1261a486faa04d0c984b50132e0a4a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a70ea98bc135e0b86285530c58e33bff3"><td class="memItemLeft" align="right" valign="top"><a id="a70ea98bc135e0b86285530c58e33bff3"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetFloat</b> (const <a class="el" href="classkudu_1_1_slice.html">Slice</a> &amp;col_name, float *val) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:a70ea98bc135e0b86285530c58e33bff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a7d09dafc214133f2306eebc9aefddff0"><td class="memItemLeft" align="right" valign="top"><a id="a7d09dafc214133f2306eebc9aefddff0"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetDouble</b> (const <a class="el" href="classkudu_1_1_slice.html">Slice</a> &amp;col_name, double *val) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:a7d09dafc214133f2306eebc9aefddff0"><td class="memSeparator" colspan="2">&#160;</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_1_status.html" title="A representation of an operation&#39;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 id="a4b1044c3b78e5a6407c2a797005b0e21"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</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">&#160;</td></tr>
+<tr class="memitem:a81a30b5b89f6fa106b5d8575c3fb62b9"><td class="memItemLeft" align="right" valign="top"><a id="a81a30b5b89f6fa106b5d8575c3fb62b9"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</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">&#160;</td></tr>
+<tr class="memitem:ab5f35c107dc26165546065189dd53dfa"><td class="memItemLeft" align="right" valign="top"><a id="ab5f35c107dc26165546065189dd53dfa"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</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">&#160;</td></tr>
+<tr class="memitem:ab321b8c245cc1748c3b3ecdf507b08fb"><td class="memItemLeft" align="right" valign="top"><a id="ab321b8c245cc1748c3b3ecdf507b08fb"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</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">&#160;</td></tr>
+<tr class="memitem:ab59039c6f073df0b57ddc16fb8d8c432"><td class="memItemLeft" align="right" valign="top"><a id="ab59039c6f073df0b57ddc16fb8d8c432"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</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">&#160;</td></tr>
+<tr class="memitem:acc4dfced2215c5115fecb647fa73e4e7"><td class="memItemLeft" align="right" valign="top"><a id="acc4dfced2215c5115fecb647fa73e4e7"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</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">&#160;</td></tr>
+<tr class="memitem:ae41dd0f1e2b4bf074ded210382b825bd"><td class="memItemLeft" align="right" valign="top"><a id="ae41dd0f1e2b4bf074ded210382b825bd"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</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">&#160;</td></tr>
+<tr class="memitem:ab2b7fb17cac4571139b2eaca761a99c0"><td class="memItemLeft" align="right" valign="top"><a id="ab2b7fb17cac4571139b2eaca761a99c0"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</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">&#160;</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_1_slice.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_1_status.html" title="A representation of an operation&#39;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 id="ad8f9ba0ff9a1fcd8326b012e689ad4a7"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetString</b> (const <a class="el" href="classkudu_1_1_slice.html">Slice</a> &amp;col_name, <a class="el" href="classkudu_1_1_slice.html">Slice</a> *val) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:ad8f9ba0ff9a1fcd8326b012e689ad4a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a2fc063d4fb631b14f5651a84861ffa4b"><td class="memItemLeft" align="right" valign="top"><a id="a2fc063d4fb631b14f5651a84861ffa4b"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetBinary</b> (const <a class="el" href="classkudu_1_1_slice.html">Slice</a> &amp;col_name, <a class="el" href="classkudu_1_1_slice.html">Slice</a> *val) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:a2fc063d4fb631b14f5651a84861ffa4b"><td class="memSeparator" colspan="2">&#160;</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_1_slice.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_1_status.html" title="A representation of an operation&#39;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 id="a887dd6b7e20ada26ee705c315fd86b56"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetString</b> (int col_idx, <a class="el" href="classkudu_1_1_slice.html">Slice</a> *val) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:a887dd6b7e20ada26ee705c315fd86b56"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a921dfdeba21588f7a3c2d5e360d3268e"><td class="memItemLeft" align="right" valign="top"><a id="a921dfdeba21588f7a3c2d5e360d3268e"></a>
+<a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetBinary</b> (int col_idx, <a class="el" href="classkudu_1_1_slice.html">Slice</a> *val) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:a921dfdeba21588f7a3c2d5e360d3268e"><td class="memSeparator" colspan="2">&#160;</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 id="a79d30f3059c783e077627a6f6d153c1b"></a>
+class&#160;</td><td class="memItemRight" valign="bottom"><b>KuduScanner</b></td></tr>
+<tr class="separator:a79d30f3059c783e077627a6f6d153c1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aafe7501e17c36d1c5dc2971f69a776de"><td class="memItemLeft" align="right" valign="top"><a id="aafe7501e17c36d1c5dc2971f69a776de"></a>
+class&#160;</td><td class="memItemRight" valign="bottom"><b>tools::ReplicaDumper</b></td></tr>
+<tr class="separator:aafe7501e17c36d1c5dc2971f69a776de"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0f719ac1eb44a4d656839448282399a3"><td class="memItemLeft" align="right" valign="top"><a id="a0f719ac1eb44a4d656839448282399a3"></a>
+class&#160;</td><td class="memItemRight" valign="bottom"><b>KuduScanBatch</b></td></tr>
+<tr class="separator:a0f719ac1eb44a4d656839448282399a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aba9d17eb5c32bd866a8572a1d51fd64f"><td class="memTemplParams" colspan="2"><a id="aba9d17eb5c32bd866a8572a1d51fd64f"></a>
+template&lt;typename KeyTypeWrapper &gt; </td></tr>
+<tr class="memitem:aba9d17eb5c32bd866a8572a1d51fd64f"><td class="memTemplItemLeft" align="right" valign="top">struct&#160;</td><td class="memTemplItemRight" valign="bottom"><b>SliceKeysTestSetup</b></td></tr>
+<tr class="separator:aba9d17eb5c32bd866a8572a1d51fd64f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a313ca772464ff159550ef09b986867fd"><td class="memTemplParams" colspan="2"><a id="a313ca772464ff159550ef09b986867fd"></a>
+template&lt;typename KeyTypeWrapper &gt; </td></tr>
+<tr class="memitem:a313ca772464ff159550ef09b986867fd"><td class="memTemplItemLeft" align="right" valign="top">struct&#160;</td><td class="memTemplItemRight" valign="bottom"><b>IntKeysTestSetup</b></td></tr>
+<tr class="separator:a313ca772464ff159550ef09b986867fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>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_1_kudu_scanner.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_1_kudu_scan_batch.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_1_kudu_scan_batch.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.N
 umRows();</div><div class="line">     i &lt; num_rows;</div><div class="line">     i++) {</div><div class="line">  <a class="code" href="classkudu_1_1client_1_1_kudu_scan_batch.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_1_kudu_scan_batch.html#a252ffd623dbaa7d725d623fd220fee4c">NumRows()</a> is only called once at the beginning of the loop to avoid extra calls to the non-inlined method. </dd></dl>
+</div><h2 class="groupheader">Member Function Documentation</h2>
+<a id="a654b2572d33e8b45836527e7b63dac21"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a654b2572d33e8b45836527e7b63dac21">&#9670;&nbsp;</a></span>begin()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">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 id="a2ff4e572251b5873491dfe827ec2c5af"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a2ff4e572251b5873491dfe827ec2c5af">&#9670;&nbsp;</a></span>cell()</h2>
+
+<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&#160;</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 id="a09bfd1652c0ab153ca6759317c3d3992"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a09bfd1652c0ab153ca6759317c3d3992">&#9670;&nbsp;</a></span>direct_data()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classkudu_1_1_slice.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_1_slice.html" title="A wrapper around externally allocated data. ">Slice</a> that points to the raw direct row data. </dd></dl>
+
+</div>
+</div>
+<a id="a54bc996032e6b5bc0df0962d821c113c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a54bc996032e6b5bc0df0962d821c113c">&#9670;&nbsp;</a></span>end()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">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 id="a3cb4c17aa228e680ecf088a29a075989"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3cb4c17aa228e680ecf088a29a075989">&#9670;&nbsp;</a></span>indirect_data()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classkudu_1_1_slice.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_1_slice.html" title="A wrapper around externally allocated data. ">Slice</a> that points to the raw indirect row data. </dd></dl>
+
+</div>
+</div>
+<a id="ad1bdf4368f87e0d83d9066584b2b2047"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad1bdf4368f87e0d83d9066584b2b2047">&#9670;&nbsp;</a></span>IsNull() <span class="overload">[1/2]</span></h2>
+
+<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_1_slice.html">Slice</a> &amp;&#160;</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 id="a63aa794845d41cc5251ee5d30547e520"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a63aa794845d41cc5251ee5d30547e520">&#9670;&nbsp;</a></span>IsNull() <span class="overload">[2/2]</span></h2>
+
+<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&#160;</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 id="a252ffd623dbaa7d725d623fd220fee4c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a252ffd623dbaa7d725d623fd220fee4c">&#9670;&nbsp;</a></span>NumRows()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int kudu::client::KuduScanBatch::NumRows </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<dl class="section return"><dt>Returns</dt><dd>The number of rows in this batch. </dd></dl>
+
+</div>
+</div>
+<a id="a2bf8a53b3486a8b7c62b8d38d5f64ef0"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a2bf8a53b3486a8b7c62b8d38d5f64ef0">&#9670;&nbsp;</a></span>operator!=()</h2>
+
+<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 &amp;&#160;</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 id="a5fd788bcce7344ebe1fe33f22c734ab9"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5fd788bcce7344ebe1fe33f22c734ab9">&#9670;&nbsp;</a></span>operator*()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.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 id="ad5df483ed3172caab5a8d6a72abfad0c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad5df483ed3172caab5a8d6a72abfad0c">&#9670;&nbsp;</a></span>operator++() <span class="overload">[1/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">const_iterator&amp; 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 id="a4b1ad47fd7d429859b6181825a063c48"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a4b1ad47fd7d429859b6181825a063c48">&#9670;&nbsp;</a></span>operator++() <span class="overload">[2/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">const_iterator kudu::client::KuduScanBatch::operator++ </td>
+          <td>(</td>
+          <td class="paramtype">int&#160;</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 id="a78f4a33eed6ee9031c1b04146d124a63"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a78f4a33eed6ee9031c1b04146d124a63">&#9670;&nbsp;</a></span>operator==()</h2>
+
+<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 &amp;&#160;</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 id="a0c99e4ac2a6b822e693fe7c6625cb324"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0c99e4ac2a6b822e693fe7c6625cb324">&#9670;&nbsp;</a></span>projection_schema()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const <a class="el" href="classkudu_1_1client_1_1_kudu_schema.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_1_kudu_scan_batch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a> returned by this batch are guaranteed to have this schema. </dd></dl>
+
+</div>
+</div>
+<a id="a3f6366606eec7f0d0a8953ff6a81c320"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3f6366606eec7f0d0a8953ff6a81c320">&#9670;&nbsp;</a></span>Row()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_batch.html#a92bbfa48e9b503181c2dfb5f11f14e4e">KuduScanBatch::RowPtr</a> kudu::client::KuduScanBatch::Row </td>
+          <td>(</td>
+          <td class="paramtype">int&#160;</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_1_kudu_scan_batch.html" title="A batch of zero or more rows returned by a scan operation. ">KuduScanBatch</a> object is valid. </dd></dl>
+
+</div>
+</div>
+<a id="a92bbfa48e9b503181c2dfb5f11f14e4e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a92bbfa48e9b503181c2dfb5f11f14e4e">&#9670;&nbsp;</a></span>RowPtr()</h2>
+
+<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 id="aca10e03eeb078908c09e552cceb1e4c3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aca10e03eeb078908c09e552cceb1e4c3">&#9670;&nbsp;</a></span>ToString()</h2>
+
+<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.7.0 on Thu Mar 22 2018 13:30:02 by Doxygen 1.8.14</small>
+  <br>
+  <small>Copyright © 2018 The Apache Software Foundation.</small>
+</address>
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/kudu/blob/33b93347/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_batch.png
----------------------------------------------------------------------
diff --git a/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_batch.png b/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_batch.png
new file mode 100644
index 0000000..0021be2
Binary files /dev/null and b/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_batch.png differ

http://git-wip-us.apache.org/repos/asf/kudu/blob/33b93347/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_token-members.html
----------------------------------------------------------------------
diff --git a/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_token-members.html b/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_token-members.html
new file mode 100644
index 0000000..c68bd9b
--- /dev/null
+++ b/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_token-members.html
@@ -0,0 +1,90 @@
+<!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.14"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<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>
+<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.14 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+/* @license-end */</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<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_1_kudu_scan_token.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_1_kudu_scan_token.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_1_kudu_scan_token.html#ae90d9422476cf6eee5c33afb41d1f867">DeserializeIntoScanner</a>(KuduClient *client, const std::string &amp;serialized_token, KuduScanner **scanner) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token.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_1_kudu_scan_token.html#adb95c9538bb1fc4c83963557ce487292">IntoKuduScanner</a>(KuduScanner **scanner) const WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token.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_1_kudu_scan_token.html">kudu::client::KuduScanToken</a>)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token.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_1_kudu_scan_token.html#a6eb749ddf0a1434596d86df88341a008">Serialize</a>(std::string *buf) const WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token.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_1_kudu_scan_token.html#a63abcf53607bdc4346b86b98a3d0ec96">tablet</a>() const</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token.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_1_kudu_scan_token.html">kudu::client::KuduScanToken</a>)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token.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.7.0 on Thu Mar 22 2018 13:30:02 by Doxygen 1.8.14</small>
+  <br>
+  <small>Copyright © 2018 The Apache Software Foundation.</small>
+</address>
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/kudu/blob/33b93347/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_token.html
----------------------------------------------------------------------
diff --git a/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_token.html b/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_token.html
new file mode 100644
index 0000000..db5dd3b
--- /dev/null
+++ b/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_token.html
@@ -0,0 +1,246 @@
+<!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.14"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<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>
+<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.14 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+/* @license-end */</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<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_1_kudu_scan_token.html">KuduScanToken</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#pub-methods">Public Member Functions</a> &#124;
+<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
+<a href="#friends">Friends</a> &#124;
+<a href="classkudu_1_1client_1_1_kudu_scan_token-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_1_kudu_scan_token.html#details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="client_8h_source.html">client.h</a>&gt;</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_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token.html#adb95c9538bb1fc4c83963557ce487292">IntoKuduScanner</a> (<a class="el" href="classkudu_1_1client_1_1_kudu_scanner.html">KuduScanner</a> **scanner) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:adb95c9538bb1fc4c83963557ce487292"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a63abcf53607bdc4346b86b98a3d0ec96"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classkudu_1_1client_1_1_kudu_tablet.html">KuduTablet</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token.html#a63abcf53607bdc4346b86b98a3d0ec96">tablet</a> () const</td></tr>
+<tr class="separator:a63abcf53607bdc4346b86b98a3d0ec96"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6eb749ddf0a1434596d86df88341a008"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token.html#a6eb749ddf0a1434596d86df88341a008">Serialize</a> (std::string *buf) const WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:a6eb749ddf0a1434596d86df88341a008"><td class="memSeparator" colspan="2">&#160;</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_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token.html#ae90d9422476cf6eee5c33afb41d1f867">DeserializeIntoScanner</a> (<a class="el" href="classkudu_1_1client_1_1_kudu_client.html">KuduClient</a> *client, const std::string &amp;serialized_token, <a class="el" href="classkudu_1_1client_1_1_kudu_scanner.html">KuduScanner</a> **scanner) WARN_UNUSED_RESULT</td></tr>
+<tr class="separator:ae90d9422476cf6eee5c33afb41d1f867"><td class="memSeparator" colspan="2">&#160;</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 id="a644ef5d9d668e5772acd6dc03c4f14ee"></a>
+class&#160;</td><td class="memItemRight" valign="bottom"><b>KuduScanTokenBuilder</b></td></tr>
+<tr class="separator:a644ef5d9d668e5772acd6dc03c4f14ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>A scan descriptor limited to a single physical contiguous location. </p>
+<p>A <a class="el" href="classkudu_1_1client_1_1_kudu_scan_token.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_1_kudu_scan_token_builder.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_1_kudu_scan_token.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_1_kudu_scan_token.html#a6eb749ddf0a1434596d86df88341a008">KuduScanToken::Serialize</a> method and deserialized back into a scanner using the <a class="el" href="classkudu_1_1client_1_1_kudu_scan_token.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_1_kudu_scan_token.html#a63abcf53607bdc4346b86b98a3d0ec96">KuduScanToken::tablet()</a> function. </p>
+</div><h2 class="groupheader">Member Function Documentation</h2>
+<a id="ae90d9422476cf6eee5c33afb41d1f867"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae90d9422476cf6eee5c33afb41d1f867">&#9670;&nbsp;</a></span>DeserializeIntoScanner()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">static <a class="el" href="classkudu_1_1_status.html">Status</a> kudu::client::KuduScanToken::DeserializeIntoScanner </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classkudu_1_1client_1_1_kudu_client.html">KuduClient</a> *&#160;</td>
+          <td class="paramname"><em>client</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const std::string &amp;&#160;</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_1_kudu_scanner.html">KuduScanner</a> **&#160;</td>
+          <td class="paramname"><em>scanner</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">static</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<p>Create a 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 id="adb95c9538bb1fc4c83963557ce487292"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#adb95c9538bb1fc4c83963557ce487292">&#9670;&nbsp;</a></span>IntoKuduScanner()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classkudu_1_1_status.html">Status</a> kudu::client::KuduScanToken::IntoKuduScanner </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classkudu_1_1client_1_1_kudu_scanner.html">KuduScanner</a> **&#160;</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 id="a6eb749ddf0a1434596d86df88341a008"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a6eb749ddf0a1434596d86df88341a008">&#9670;&nbsp;</a></span>Serialize()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="classkudu_1_1_status.html">Status</a> kudu::client::KuduScanToken::Serialize </td>
+          <td>(</td>
+          <td class="paramtype">std::string *&#160;</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_1_kudu_scan_token.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 id="a63abcf53607bdc4346b86b98a3d0ec96"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a63abcf53607bdc4346b86b98a3d0ec96">&#9670;&nbsp;</a></span>tablet()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const <a class="el" href="classkudu_1_1client_1_1_kudu_tablet.html">KuduTablet</a>&amp; 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.7.0 on Thu Mar 22 2018 13:30:02 by Doxygen 1.8.14</small>
+  <br>
+  <small>Copyright © 2018 The Apache Software Foundation.</small>
+</address>
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/kudu/blob/33b93347/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_token_builder-members.html
----------------------------------------------------------------------
diff --git a/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_token_builder-members.html b/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_token_builder-members.html
new file mode 100644
index 0000000..2228de3
--- /dev/null
+++ b/cpp-client-api/classkudu_1_1client_1_1_kudu_scan_token_builder-members.html
@@ -0,0 +1,100 @@
+<!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.14"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<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>
+<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.14 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+/* @license-end */</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<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_1_kudu_scan_token_builder.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_1_kudu_scan_token_builder.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_1_kudu_scan_token_builder.html#ac40487d17b8e4dcca7ca08efeb5f195e">AddConjunctPredicate</a>(KuduPredicate *pred) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.html#ae11ca3d00d15138e957a2c2e89b05fcf">AddLowerBound</a>(const KuduPartialRow &amp;key) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.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_1_kudu_scan_token_builder.html#ac4d0fa934e4c705ac76c424a5431566a">AddUpperBound</a>(const KuduPartialRow &amp;key) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.html#a7eacf0a7e7616b1515170cf6fe833694">Build</a>(std::vector&lt; KuduScanToken *&gt; *tokens) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.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_1_kudu_scan_token_builder.html#aa8d300b560d419030abd503b66812484">KuduScanTokenBuilder</a>(KuduTable *table)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.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_1_kudu_scan_token_builder.html#a36523ca7f2f9a2b4e3c096cf6167643c">SetBatchSizeBytes</a>(uint32_t batch_size) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.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_1_kudu_scan_token_builder.html#a7ab7c9c1c4f4d3bbbc18b2b35d7d5475">SetCacheBlocks</a>(bool cache_blocks) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.html#a4a17f27950ccd59bcb3430fb28b61dbe">SetFaultTolerant</a>() WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.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_1_kudu_scan_token_builder.html#a01d990e024632c7749cca96b4f857be8">SetProjectedColumnIndexes</a>(const std::vector&lt; int &gt; &amp;col_indexes) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.html#a0dbb58301fc0e48ce44f41215d32f0ad">SetProjectedColumnNames</a>(const std::vector&lt; std::string &gt; &amp;col_names) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.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_1_kudu_scan_token_builder.html#adb34f01a9bc52a9e23ce49124bab3892">SetReadMode</a>(KuduScanner::ReadMode read_mode) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.html#a168bfed43dcd754a17d4c82293dade88">SetSelection</a>(KuduClient::ReplicaSelection selection) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.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_1_kudu_scan_token_builder.html#aa4c1cfa570edfaab818831a2330eece5">SetSnapshotMicros</a>(uint64_t snapshot_timestamp_micros) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.html">kudu::client::KuduScanTokenBuilder</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.html#a313e345dc6c1f9ccdad65df5af2cf4b7">SetSnapshotRaw</a>(uint64_t snapshot_timestamp) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.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_1_kudu_scan_token_builder.html#a0f0e58d5d6fb3867ff0a03f7fc633445">SetTimeoutMillis</a>(int millis) WARN_UNUSED_RESULT</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.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_1_kudu_scan_token_builder.html">kudu::client::KuduScanTokenBuilder</a>)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1_kudu_scan_token_builder.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.7.0 on Thu Mar 22 2018 13:30:02 by Doxygen 1.8.14</small>
+  <br>
+  <small>Copyright © 2018 The Apache Software Foundation.</small>
+</address>
+</body>
+</html>


Mime
View raw message