releases/1.0.1/cpp-client-api/classkudu_1_1client_1_1KuduScanToken.html - kudu-site - Git at Google

 <!-- This comment will put IE 6, 7 and 8 in quirks mode -->
 <!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"/>
 <title>Kudu C++ client API: kudu::client::KuduScanToken Class Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <link href="search/search.css" rel="stylesheet" type="text/css"/>
 <script type="text/javaScript" src="search/search.js"></script>
 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
 </head>
 <body onload='searchBox.OnSelectItem(0);'>
 <!-- Generated by Doxygen 1.6.1 -->
 <script type="text/javascript"><!--
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
 --></script>
 <div class="navigation" id="top">
   <div class="tabs">
     <ul>
       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
       <li><a href="pages.html"><span>Related&nbsp;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">
         <img id="MSearchSelect" src="search/search.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)"/>
         <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
         </div>
       </li>
     </ul>
   </div>
   <div class="tabs">
     <ul>
       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
     </ul>
   </div>
   <div class="navpath"><b>kudu</b>::<b>client</b>::<a class="el" href="classkudu_1_1client_1_1KuduScanToken.html">KuduScanToken</a>
   </div>
 </div>
 <div class="contents">
 <h1>kudu::client::KuduScanToken Class Reference</h1><!-- doxytag: class="kudu::client::KuduScanToken" -->
 <p>A scan descriptor limited to a single physical contiguous location.
 <a href="#_details">More...</a></p>

 <p><code>#include &lt;<a class="el" href="client_8h_source.html">client.h</a>&gt;</code></p>

 <p><a href="classkudu_1_1client_1_1KuduScanToken-members.html">List of all members.</a></p>
 <table border="0" cellpadding="0" cellspacing="0">
 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&nbsp;</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><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classkudu_1_1client_1_1KuduTablet.html">KuduTablet</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduScanToken.html#a6513d5a02c745177d63d807de54aa301">tablet</a> () const </td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&nbsp;</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><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classkudu_1_1Status.html">Status</a>&nbsp;</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 &amp;serialized_token, <a class="el" href="classkudu_1_1client_1_1KuduScanner.html">KuduScanner</a> **scanner) WARN_UNUSED_RESULT</td></tr>
 <tr><td colspan="2"><h2>Friends</h2></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a644ef5d9d668e5772acd6dc03c4f14ee"></a><!-- doxytag: member="kudu::client::KuduScanToken::KuduScanTokenBuilder" ref="a644ef5d9d668e5772acd6dc03c4f14ee" args="" -->
 class&nbsp;</td><td class="memItemRight" valign="bottom"><b>KuduScanTokenBuilder</b></td></tr>
 </table>
 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 <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>
 <hr/><h2>Member Function Documentation</h2>
 <a class="anchor" id="ae90d9422476cf6eee5c33afb41d1f867"></a><!-- doxytag: member="kudu::client::KuduScanToken::DeserializeIntoScanner" ref="ae90d9422476cf6eee5c33afb41d1f867" args="(KuduClient *client, const std::string &amp;serialized_token, KuduScanner **scanner) WARN_UNUSED_RESULT" -->
 <div class="memitem">
 <div class="memproto">
       <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> *&nbsp;</td>
           <td class="paramname"> <em>client</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">const std::string &amp;&nbsp;</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> **&nbsp;</td>
           <td class="paramname"> <em>scanner</em></td><td>&nbsp;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</td>
           <td></td><td></td><td><code> [static]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">
 <p>Create a new scanner and set the scanner options.</p>
 <dl><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>client</em>&nbsp;</td><td>Client to bound to the scanner. </td></tr>
     <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>serialized_token</em>&nbsp;</td><td>Token containing serialized scanner parameters. </td></tr>
     <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>scanner</em>&nbsp;</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="return"><dt><b>Returns:</b></dt><dd>Operation result status. </dd></dl>

 </div>
 </div>
 <a class="anchor" id="adb95c9538bb1fc4c83963557ce487292"></a><!-- doxytag: member="kudu::client::KuduScanToken::IntoKuduScanner" ref="adb95c9538bb1fc4c83963557ce487292" args="(KuduScanner **scanner) const WARN_UNUSED_RESULT" -->
 <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> **&nbsp;</td>
           <td class="paramname"> <em>scanner</em></td>
           <td>&nbsp;)&nbsp;</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><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>scanner</em>&nbsp;</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="return"><dt><b>Returns:</b></dt><dd>Operation result status. </dd></dl>

 </div>
 </div>
 <a class="anchor" id="a6eb749ddf0a1434596d86df88341a008"></a><!-- doxytag: member="kudu::client::KuduScanToken::Serialize" ref="a6eb749ddf0a1434596d86df88341a008" args="(std::string *buf) const WARN_UNUSED_RESULT" -->
 <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 *&nbsp;</td>
           <td class="paramname"> <em>buf</em></td>
           <td>&nbsp;)&nbsp;</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><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>buf</em>&nbsp;</td><td>Result string to output the serialized token. </td></tr>
   </table>
   </dd>
 </dl>
 <dl class="return"><dt><b>Returns:</b></dt><dd>Operation result status. </dd></dl>

 </div>
 </div>
 <a class="anchor" id="a6513d5a02c745177d63d807de54aa301"></a><!-- doxytag: member="kudu::client::KuduScanToken::tablet" ref="a6513d5a02c745177d63d807de54aa301" args="() const " -->
 <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>&amp; kudu::client::KuduScanToken::tablet </td>
           <td>(</td>
           <td class="paramname"></td>
           <td>&nbsp;)&nbsp;</td>
           <td> const</td>
         </tr>
       </table>
 </div>
 <div class="memdoc">
 <dl class="return"><dt><b>Returns:</b></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>
 <!--- window showing the filter options -->
 <div id="MSearchSelectWindow"
      onmouseover="return searchBox.OnSearchSelectShow()"
      onmouseout="return searchBox.OnSearchSelectHide()"
      onkeydown="return searchBox.OnSearchSelectKey(event)">
 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&nbsp;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&nbsp;</span>Defines</a></div>

 <!-- iframe showing the search results (closed by default) -->
 <div id="MSearchResultsWindow">
 <iframe src="" frameborder="0"
         name="MSearchResults" id="MSearchResults">
 </iframe>
 </div>

 <!-- start footer part -->
 <hr class="footer"/>
 <address class="footer">
   <small>Generated for Kudu version 1.0.1 on Tue Oct 11 08:52:01 2016 by Doxygen 1.6.1</small>
   <br>
   <small>Copyright © 2016 The Apache Software Foundation.</small>
 </address>
 </body>
 </html>
	<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
	<!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"/>
	<title>Kudu C++ client API: kudu::client::KuduScanToken Class Reference</title>
	<link href="tabs.css" rel="stylesheet" type="text/css"/>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
	<script type="text/javaScript" src="search/search.js"></script>
	<link href="doxygen.css" rel="stylesheet" type="text/css"/>
	</head>
	<body onload='searchBox.OnSelectItem(0);'>
	<!-- Generated by Doxygen 1.6.1 -->
	<script type="text/javascript"><!--
	var searchBox = new SearchBox("searchBox", "search",false,'Search');
	--></script>
	<div class="navigation" id="top">
	<div class="tabs">
	<ul>
	<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">
	<img id="MSearchSelect" src="search/search.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)"/>
	<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
	</div>
	</li>
	</ul>
	</div>
	<div class="tabs">
	<ul>
	<li><a href="annotated.html"><span>Class List</span></a></li>
	<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
	<li><a href="functions.html"><span>Class Members</span></a></li>
	</ul>
	</div>
	<div class="navpath"><b>kudu</b>::<b>client</b>::<a class="el" href="classkudu_1_1client_1_1KuduScanToken.html">KuduScanToken</a>
	</div>
	</div>
	<div class="contents">
	<h1>kudu::client::KuduScanToken Class Reference</h1><!-- doxytag: class="kudu::client::KuduScanToken" -->
	<p>A scan descriptor limited to a single physical contiguous location.
	<a href="#_details">More...</a></p>

	<p><code>#include <<a class="el" href="client_8h_source.html">client.h</a>></code></p>

	<p><a href="classkudu_1_1client_1_1KuduScanToken-members.html">List of all members.</a></p>
	<table border="0" cellpadding="0" cellspacing="0">
	<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
	<tr><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><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><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><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
	<tr><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><td colspan="2"><h2>Friends</h2></td></tr>
	<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a644ef5d9d668e5772acd6dc03c4f14ee"></a><!-- doxytag: member="kudu::client::KuduScanToken::KuduScanTokenBuilder" ref="a644ef5d9d668e5772acd6dc03c4f14ee" args="" -->
	class </td><td class="memItemRight" valign="bottom"><b>KuduScanTokenBuilder</b></td></tr>
	</table>
	<hr/><a name="_details"></a><h2>Detailed Description</h2>
	<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>
	<hr/><h2>Member Function Documentation</h2>
	<a class="anchor" id="ae90d9422476cf6eee5c33afb41d1f867"></a><!-- doxytag: member="kudu::client::KuduScanToken::DeserializeIntoScanner" ref="ae90d9422476cf6eee5c33afb41d1f867" args="(KuduClient client, const std::string &serialized_token, KuduScanner *scanner) WARN_UNUSED_RESULT" -->
	<div class="memitem">
	<div class="memproto">
	<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><td> </td>
	</tr>
	<tr>
	<td></td>
	<td>)</td>
	<td></td><td></td><td><code> [static]</code></td>
	</tr>
	</table>
	</div>
	<div class="memdoc">
	<p>Create a new scanner and set the scanner options.</p>
	<dl><dt><b>Parameters:</b></dt><dd>
	<table border="0" cellspacing="2" cellpadding="0">
	<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>client</em> </td><td>Client to bound to the scanner. </td></tr>
	<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>serialized_token</em> </td><td>Token containing serialized scanner parameters. </td></tr>
	<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>scanner</em> </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="return"><dt><b>Returns:</b></dt><dd>Operation result status. </dd></dl>

	</div>
	</div>
	<a class="anchor" id="adb95c9538bb1fc4c83963557ce487292"></a><!-- doxytag: member="kudu::client::KuduScanToken::IntoKuduScanner" ref="adb95c9538bb1fc4c83963557ce487292" args="(KuduScanner **scanner) const WARN_UNUSED_RESULT" -->
	<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><dt><b>Parameters:</b></dt><dd>
	<table border="0" cellspacing="2" cellpadding="0">
	<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>scanner</em> </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="return"><dt><b>Returns:</b></dt><dd>Operation result status. </dd></dl>

	</div>
	</div>
	<a class="anchor" id="a6eb749ddf0a1434596d86df88341a008"></a><!-- doxytag: member="kudu::client::KuduScanToken::Serialize" ref="a6eb749ddf0a1434596d86df88341a008" args="(std::string *buf) const WARN_UNUSED_RESULT" -->
	<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><dt><b>Parameters:</b></dt><dd>
	<table border="0" cellspacing="2" cellpadding="0">
	<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>buf</em> </td><td>Result string to output the serialized token. </td></tr>
	</table>
	</dd>
	</dl>
	<dl class="return"><dt><b>Returns:</b></dt><dd>Operation result status. </dd></dl>

	</div>
	</div>
	<a class="anchor" id="a6513d5a02c745177d63d807de54aa301"></a><!-- doxytag: member="kudu::client::KuduScanToken::tablet" ref="a6513d5a02c745177d63d807de54aa301" args="() const " -->
	<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="return"><dt><b>Returns:</b></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>
	<!--- window showing the filter options -->
	<div id="MSearchSelectWindow"
	onmouseover="return searchBox.OnSearchSelectShow()"
	onmouseout="return searchBox.OnSearchSelectHide()"
	onkeydown="return searchBox.OnSearchSelectKey(event)">
	<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>

	<!-- iframe showing the search results (closed by default) -->
	<div id="MSearchResultsWindow">
	<iframe src="" frameborder="0"
	name="MSearchResults" id="MSearchResults">
	</iframe>
	</div>

	<!-- start footer part -->
	<hr class="footer"/>
	<address class="footer">
	<small>Generated for Kudu version 1.0.1 on Tue Oct 11 08:52:01 2016 by Doxygen 1.6.1</small>
	<br>
	<small>Copyright © 2016 The Apache Software Foundation.</small>
	</address>
	</body>
	</html>