cpp-client-api/classkudu_1_1client_1_1KuduPartitionerBuilder.html - kudu-site - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.8.11"/>
 <title>Kudu C++ client API: kudu::client::KuduPartitionerBuilder Class Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
 <link href="search/search.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="search/searchdata.js"></script>
 <script type="text/javascript" src="search/search.js"></script>
 <script type="text/javascript">
   $(document).ready(function() { init_search(); });
 </script>
 <link href="doxygen.css" rel="stylesheet" type="text/css" />
 </head>
 <body>
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 <div id="titlearea">
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Kudu C++ client API
    </div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.8.11 -->
 <script type="text/javascript">
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </script>
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
       <li>
         <div id="MSearchBox" class="MSearchBoxInactive">
         <span class="left">
           <img id="MSearchSelect" src="search/mag_sel.png"
                onmouseover="return searchBox.OnSearchSelectShow()"
                onmouseout="return searchBox.OnSearchSelectHide()"
                alt=""/>
           <input type="text" id="MSearchField" value="Search" accesskey="S"
                onfocus="searchBox.OnSearchFieldFocus(true)"
                onblur="searchBox.OnSearchFieldFocus(false)"
                onkeyup="searchBox.OnSearchFieldChange(event)"/>
           </span><span class="right">
             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
           </span>
         </div>
       </li>
     </ul>
   </div>
   <div id="navrow2" class="tabs2">
     <ul class="tablist">
       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
     </ul>
   </div>
 <!-- window showing the filter options -->
 <div id="MSearchSelectWindow"
      onmouseover="return searchBox.OnSearchSelectShow()"
      onmouseout="return searchBox.OnSearchSelectHide()"
      onkeydown="return searchBox.OnSearchSelectKey(event)">
 </div>

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

 <div id="nav-path" class="navpath">
   <ul>
 <li class="navelem"><b>kudu</b></li><li class="navelem"><b>client</b></li><li class="navelem"><a class="el" href="classkudu_1_1client_1_1KuduPartitionerBuilder.html">KuduPartitionerBuilder</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#pub-methods">Public Member Functions</a> &#124;
 <a href="classkudu_1_1client_1_1KuduPartitionerBuilder-members.html">List of all members</a>  </div>
   <div class="headertitle">
 <div class="title">kudu::client::KuduPartitionerBuilder Class Reference</div>  </div>
 </div><!--header-->
 <div class="contents">

 <p>Builder for Partitioner instances.
  <a href="classkudu_1_1client_1_1KuduPartitionerBuilder.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:a27d130235be1c2691779e1d97732a4ba"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduPartitionerBuilder.html#a27d130235be1c2691779e1d97732a4ba">KuduPartitionerBuilder</a> (sp::shared_ptr&lt; <a class="el" href="classkudu_1_1client_1_1KuduTable.html">KuduTable</a> &gt; table)</td></tr>
 <tr class="separator:a27d130235be1c2691779e1d97732a4ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a11e28b7ad87a53a92d2ad5494f2c5f14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduPartitionerBuilder.html">KuduPartitionerBuilder</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduPartitionerBuilder.html#a11e28b7ad87a53a92d2ad5494f2c5f14">SetBuildTimeout</a> (<a class="el" href="classkudu_1_1MonoDelta.html">MonoDelta</a> timeout)</td></tr>
 <tr class="separator:a11e28b7ad87a53a92d2ad5494f2c5f14"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aa8859050484de2d367781ce6ec41d0ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduPartitionerBuilder.html#aa8859050484de2d367781ce6ec41d0ba">Build</a> (<a class="el" href="classkudu_1_1client_1_1KuduPartitioner.html">KuduPartitioner</a> **partitioner)</td></tr>
 <tr class="separator:aa8859050484de2d367781ce6ec41d0ba"><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>Builder for Partitioner instances. </p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a class="anchor" id="a27d130235be1c2691779e1d97732a4ba"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">kudu::client::KuduPartitionerBuilder::KuduPartitionerBuilder </td>
           <td>(</td>
           <td class="paramtype">sp::shared_ptr&lt; <a class="el" href="classkudu_1_1client_1_1KuduTable.html">KuduTable</a> &gt;&#160;</td>
           <td class="paramname"><em>table</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">
 <p>Construct an instance of the class.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">table</td><td>The table whose rows should be partitioned. </td></tr>
   </table>
   </dd>
 </dl>

 </div>
 </div>
 <h2 class="groupheader">Member Function Documentation</h2>
 <a class="anchor" id="aa8859050484de2d367781ce6ec41d0ba"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname"><a class="el" href="classkudu_1_1Status.html">Status</a> kudu::client::KuduPartitionerBuilder::Build </td>
           <td>(</td>
           <td class="paramtype"><a class="el" href="classkudu_1_1client_1_1KuduPartitioner.html">KuduPartitioner</a> **&#160;</td>
           <td class="paramname"><em>partitioner</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>Create a <a class="el" href="classkudu_1_1client_1_1KuduPartitioner.html">KuduPartitioner</a> object for the specified table.</p>
 <p>This fetches all of the partitioning information up front if it is not already cached by the associated <a class="el" href="classkudu_1_1client_1_1KuduClient.html" title="A handle for a connection to a cluster. ">KuduClient</a> object. Thus, it may time out or have an error if the Kudu master is not accessible.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[out]</td><td class="paramname">partitioner</td><td>The resulting <a class="el" href="classkudu_1_1client_1_1KuduPartitioner.html">KuduPartitioner</a> instance; caller gets ownership.</td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section note"><dt>Note</dt><dd>If the <a class="el" href="classkudu_1_1client_1_1KuduClient.html" title="A handle for a connection to a cluster. ">KuduClient</a> object associated with the table already has some partition information cached (e.g. due to the construction of other Partitioners, or due to normal read/write activity), the resulting Partitioner will make use of that cached information. This means that the resulting partitioner is not guaranteed to have up-to-date partition information in the case that there has been a recent change to the partitioning of the target table.</dd></dl>
 <dl class="section return"><dt>Returns</dt><dd>Operation result status. </dd></dl>

 </div>
 </div>
 <a class="anchor" id="a11e28b7ad87a53a92d2ad5494f2c5f14"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduPartitionerBuilder.html">KuduPartitionerBuilder</a>* kudu::client::KuduPartitionerBuilder::SetBuildTimeout </td>
           <td>(</td>
           <td class="paramtype"><a class="el" href="classkudu_1_1MonoDelta.html">MonoDelta</a>&#160;</td>
           <td class="paramname"><em>timeout</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>Set the timeout used for building the Partitioner object.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>The timeout to set. </td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>Pointer to the result object. </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.12.0 on Mon May 18 2020 14:07:09 by Doxygen 1.8.11</small>
   <br>
   <small>Copyright © 2020 The Apache Software Foundation.</small>
 </address>
 </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml">
	<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.8.11"/>
	<title>Kudu C++ client API: kudu::client::KuduPartitionerBuilder Class Reference</title>
	<link href="tabs.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="search/searchdata.js"></script>
	<script type="text/javascript" src="search/search.js"></script>
	<script type="text/javascript">
	$(document).ready(function() { init_search(); });
	</script>
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	</head>
	<body>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
	<div id="titlearea">
	<table cellspacing="0" cellpadding="0">
	<tbody>
	<tr style="height: 56px;">
	<td id="projectalign" style="padding-left: 0.5em;">
	<div id="projectname">Kudu C++ client API
	</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<!-- Generated by Doxygen 1.8.11 -->
	<script type="text/javascript">
	var searchBox = new SearchBox("searchBox", "search",false,'Search');
	</script>
	<div id="navrow1" class="tabs">
	<ul class="tablist">
	<li><a href="index.html"><span>Main Page</span></a></li>
	<li><a href="pages.html"><span>Related Pages</span></a></li>
	<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
	<li><a href="files.html"><span>Files</span></a></li>
	<li>
	<div id="MSearchBox" class="MSearchBoxInactive">
	<span class="left">
	<img id="MSearchSelect" src="search/mag_sel.png"
	onmouseover="return searchBox.OnSearchSelectShow()"
	onmouseout="return searchBox.OnSearchSelectHide()"
	alt=""/>
	<input type="text" id="MSearchField" value="Search" accesskey="S"
	onfocus="searchBox.OnSearchFieldFocus(true)"
	onblur="searchBox.OnSearchFieldFocus(false)"
	onkeyup="searchBox.OnSearchFieldChange(event)"/>
	</span><span class="right">
	<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
	</span>
	</div>
	</li>
	</ul>
	</div>
	<div id="navrow2" class="tabs2">
	<ul class="tablist">
	<li><a href="annotated.html"><span>Class List</span></a></li>
	<li><a href="classes.html"><span>Class Index</span></a></li>
	<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
	<li><a href="functions.html"><span>Class Members</span></a></li>
	</ul>
	</div>
	<!-- window showing the filter options -->
	<div id="MSearchSelectWindow"
	onmouseover="return searchBox.OnSearchSelectShow()"
	onmouseout="return searchBox.OnSearchSelectHide()"
	onkeydown="return searchBox.OnSearchSelectKey(event)">
	</div>

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

	<div id="nav-path" class="navpath">
	<ul>
	<li class="navelem"><b>kudu</b></li><li class="navelem"><b>client</b></li><li class="navelem"><a class="el" href="classkudu_1_1client_1_1KuduPartitionerBuilder.html">KuduPartitionerBuilder</a></li> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#pub-methods">Public Member Functions</a> \|
	<a href="classkudu_1_1client_1_1KuduPartitionerBuilder-members.html">List of all members</a> </div>
	<div class="headertitle">
	<div class="title">kudu::client::KuduPartitionerBuilder Class Reference</div> </div>
	</div><!--header-->
	<div class="contents">

	<p>Builder for Partitioner instances.
	<a href="classkudu_1_1client_1_1KuduPartitionerBuilder.html#details">More...</a></p>

	<p><code>#include <<a class="el" href="client_8h_source.html">client.h</a>></code></p>
	<table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
	Public Member Functions</h2></td></tr>
	<tr class="memitem:a27d130235be1c2691779e1d97732a4ba"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduPartitionerBuilder.html#a27d130235be1c2691779e1d97732a4ba">KuduPartitionerBuilder</a> (sp::shared_ptr< <a class="el" href="classkudu_1_1client_1_1KuduTable.html">KuduTable</a> > table)</td></tr>
	<tr class="separator:a27d130235be1c2691779e1d97732a4ba"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a11e28b7ad87a53a92d2ad5494f2c5f14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduPartitionerBuilder.html">KuduPartitionerBuilder</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduPartitionerBuilder.html#a11e28b7ad87a53a92d2ad5494f2c5f14">SetBuildTimeout</a> (<a class="el" href="classkudu_1_1MonoDelta.html">MonoDelta</a> timeout)</td></tr>
	<tr class="separator:a11e28b7ad87a53a92d2ad5494f2c5f14"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:aa8859050484de2d367781ce6ec41d0ba"><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_1KuduPartitionerBuilder.html#aa8859050484de2d367781ce6ec41d0ba">Build</a> (<a class="el" href="classkudu_1_1client_1_1KuduPartitioner.html">KuduPartitioner</a> **partitioner)</td></tr>
	<tr class="separator:aa8859050484de2d367781ce6ec41d0ba"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>Builder for Partitioner instances. </p>
	</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
	<a class="anchor" id="a27d130235be1c2691779e1d97732a4ba"></a>
	<div class="memitem">
	<div class="memproto">
	<table class="mlabels">
	<tr>
	<td class="mlabels-left">
	<table class="memname">
	<tr>
	<td class="memname">kudu::client::KuduPartitionerBuilder::KuduPartitionerBuilder </td>
	<td>(</td>
	<td class="paramtype">sp::shared_ptr< <a class="el" href="classkudu_1_1client_1_1KuduTable.html">KuduTable</a> > </td>
	<td class="paramname"><em>table</em></td><td>)</td>
	<td></td>
	</tr>
	</table>
	</td>
	<td class="mlabels-right">
	<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>Construct an instance of the class.</p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramdir">[in]</td><td class="paramname">table</td><td>The table whose rows should be partitioned. </td></tr>
	</table>
	</dd>
	</dl>

	</div>
	</div>
	<h2 class="groupheader">Member Function Documentation</h2>
	<a class="anchor" id="aa8859050484de2d367781ce6ec41d0ba"></a>
	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname"><a class="el" href="classkudu_1_1Status.html">Status</a> kudu::client::KuduPartitionerBuilder::Build </td>
	<td>(</td>
	<td class="paramtype"><a class="el" href="classkudu_1_1client_1_1KuduPartitioner.html">KuduPartitioner</a> ** </td>
	<td class="paramname"><em>partitioner</em></td><td>)</td>
	<td></td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>Create a <a class="el" href="classkudu_1_1client_1_1KuduPartitioner.html">KuduPartitioner</a> object for the specified table.</p>
	<p>This fetches all of the partitioning information up front if it is not already cached by the associated <a class="el" href="classkudu_1_1client_1_1KuduClient.html" title="A handle for a connection to a cluster. ">KuduClient</a> object. Thus, it may time out or have an error if the Kudu master is not accessible.</p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramdir">[out]</td><td class="paramname">partitioner</td><td>The resulting <a class="el" href="classkudu_1_1client_1_1KuduPartitioner.html">KuduPartitioner</a> instance; caller gets ownership.</td></tr>
	</table>
	</dd>
	</dl>
	<dl class="section note"><dt>Note</dt><dd>If the <a class="el" href="classkudu_1_1client_1_1KuduClient.html" title="A handle for a connection to a cluster. ">KuduClient</a> object associated with the table already has some partition information cached (e.g. due to the construction of other Partitioners, or due to normal read/write activity), the resulting Partitioner will make use of that cached information. This means that the resulting partitioner is not guaranteed to have up-to-date partition information in the case that there has been a recent change to the partitioning of the target table.</dd></dl>
	<dl class="section return"><dt>Returns</dt><dd>Operation result status. </dd></dl>

	</div>
	</div>
	<a class="anchor" id="a11e28b7ad87a53a92d2ad5494f2c5f14"></a>
	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduPartitionerBuilder.html">KuduPartitionerBuilder</a>* kudu::client::KuduPartitionerBuilder::SetBuildTimeout </td>
	<td>(</td>
	<td class="paramtype"><a class="el" href="classkudu_1_1MonoDelta.html">MonoDelta</a> </td>
	<td class="paramname"><em>timeout</em></td><td>)</td>
	<td></td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>Set the timeout used for building the Partitioner object.</p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>The timeout to set. </td></tr>
	</table>
	</dd>
	</dl>
	<dl class="section return"><dt>Returns</dt><dd>Pointer to the result object. </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.12.0 on Mon May 18 2020 14:07:09 by Doxygen 1.8.11</small>
	<br>
	<small>Copyright © 2020 The Apache Software Foundation.</small>
	</address>
	</body>
	</html>