http://git-wip-us.apache.org/repos/asf/kudu-site/blob/854be1d3/cpp-client-api/classkudu_1_1client_1_1KuduClient.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduClient.html b/cpp-client-api/classkudu_1_1client_1_1KuduClient.html deleted file mode 100644 index df52c69..0000000 --- a/cpp-client-api/classkudu_1_1client_1_1KuduClient.html +++ /dev/null @@ -1,760 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml";> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.5"/> -<title>Kudu C++ client API: kudu::client::KuduClient 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/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</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 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.5 --> -<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)"> -<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:vo id(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>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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_1KuduClient.html">KuduClient</a></li> </ul> -</div> -</div><!-- top --> -<div class="header"> - <div class="summary"> -<a href="#pub-types">Public Types</a> | -<a href="#pub-methods">Public Member Functions</a> | -<a href="#pub-static-attribs">Static Public Attributes</a> | -<a href="#friends">Friends</a> | -<a href="classkudu_1_1client_1_1KuduClient-members.html">List of all members</a> </div> - <div class="headertitle"> -<div class="title">kudu::client::KuduClient Class Reference</div> </div> -</div><!--header--> -<div class="contents"> - -<p>A handle for a connection to a cluster. - <a href="classkudu_1_1client_1_1KuduClient.html#details">More...</a></p> - -<p><code>#include <<a class="el" href="client_8h_source.html">client.h</a>></code></p> -<div class="dynheader"> -Inheritance diagram for kudu::client::KuduClient:</div> -<div class="dyncontent"> - <div class="center"> - <img src="classkudu_1_1client_1_1KuduClient.png" usemap="#kudu::client::KuduClient_map" alt=""/> - <map id="kudu::client::KuduClient_map" name="kudu::client::KuduClient_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:aef70c7f3a596ecda4040f9d46514b11a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClient.html#aef70c7f3a596ecda4040f9d46514b11a">ReplicaSelection</a> { <a class="el" href="classkudu_1_1client_1_1KuduClient.html#aef70c7f3a596ecda4040f9d46514b11aafb912836db348061379d0e0a9055e239">LEADER_ONLY</a>, -<a class="el" href="classkudu_1_1client_1_1KuduClient.html#aef70c7f3a596ecda4040f9d46514b11aa801886067da41dacd0c9c2b8091f08d8">CLOSEST_REPLICA</a>, -<a class="el" href="classkudu_1_1client_1_1KuduClient.html#aef70c7f3a596ecda4040f9d46514b11aaa060fb6126a3e3fa80079f885dc7d48f">FIRST_REPLICA</a> - }</td></tr> -<tr class="memdesc:aef70c7f3a596ecda4040f9d46514b11a"><td class="mdescLeft"> </td><td class="mdescRight">Policy with which to choose amongst multiple replicas. <a href="classkudu_1_1client_1_1KuduClient.html#aef70c7f3a596ecda4040f9d46514b11a">More...</a><br/></td></tr> -<tr class="separator:aef70c7f3a596ecda4040f9d46514b11a"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> -Public Member Functions</h2></td></tr> -<tr class="memitem:a003f13604b4fb378f61e133a9b49d153"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduTableCreator.html">KuduTableCreator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClient.html#a003f13604b4fb378f61e133a9b49d153">NewTableCreator</a> ()</td></tr> -<tr class="separator:a003f13604b4fb378f61e133a9b49d153"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2f0323b439d8658b2ac31fde7f46de63"><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_1KuduClient.html#a2f0323b439d8658b2ac31fde7f46de63">IsCreateTableInProgress</a> (const std::string &table_name, bool *create_in_progress)</td></tr> -<tr class="separator:a2f0323b439d8658b2ac31fde7f46de63"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a9d7cbad036bc74c71873a428abce5c1d"><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_1KuduClient.html#a9d7cbad036bc74c71873a428abce5c1d">DeleteTable</a> (const std::string &table_name)</td></tr> -<tr class="separator:a9d7cbad036bc74c71873a428abce5c1d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a116bbcf13dc0991ad2a3129630075aea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduTableAlterer.html">KuduTableAlterer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClient.html#a116bbcf13dc0991ad2a3129630075aea">NewTableAlterer</a> (const std::string &table_name)</td></tr> -<tr class="separator:a116bbcf13dc0991ad2a3129630075aea"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a7a331e528759296089837b4611c01809"><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_1KuduClient.html#a7a331e528759296089837b4611c01809">IsAlterTableInProgress</a> (const std::string &table_name, bool *alter_in_progress)</td></tr> -<tr class="separator:a7a331e528759296089837b4611c01809"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2aa649e05e0cfb0e10ebce98fb4d7a65"><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_1KuduClient.html#a2aa649e05e0cfb0e10ebce98fb4d7a65">GetTableSchema</a> (const std::string &table_name, <a class="el" href="classkudu_1_1client_1_1KuduSchema.html">KuduSchema</a> *schema)</td></tr> -<tr class="separator:a2aa649e05e0cfb0e10ebce98fb4d7a65"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ae283a49551a081524b41f5d8e51e68d9"><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_1KuduClient.html#ae283a49551a081524b41f5d8e51e68d9">ListTabletServers</a> (std::vector< <a class="el" href="classkudu_1_1client_1_1KuduTabletServer.html">KuduTabletServer</a> * > *tablet_servers)</td></tr> -<tr class="separator:ae283a49551a081524b41f5d8e51e68d9"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a3ab09f69753b8c99ac7b2eeed03faa1d"><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_1KuduClient.html#a3ab09f69753b8c99ac7b2eeed03faa1d">ListTables</a> (std::vector< std::string > *tables, const std::string &filter="")</td></tr> -<tr class="separator:a3ab09f69753b8c99ac7b2eeed03faa1d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a96e9a6c0a16a8825c291528ac27af818"><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_1KuduClient.html#a96e9a6c0a16a8825c291528ac27af818">TableExists</a> (const std::string &table_name, bool *exists)</td></tr> -<tr class="separator:a96e9a6c0a16a8825c291528ac27af818"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa82a09718ffe68d3255195e736aec8d7"><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_1KuduClient.html#aa82a09718ffe68d3255195e736aec8d7">OpenTable</a> (const std::string &table_name, sp::shared_ptr< <a class="el" href="classkudu_1_1client_1_1KuduTable.html">KuduTable</a> > *table)</td></tr> -<tr class="separator:aa82a09718ffe68d3255195e736aec8d7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1f5b9bf8767b44f03f4d3220dfd5f925"><td class="memItemLeft" align="right" valign="top">sp::shared_ptr< <a class="el" href="classkudu_1_1client_1_1KuduSession.html">KuduSession</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClient.html#a1f5b9bf8767b44f03f4d3220dfd5f925">NewSession</a> ()</td></tr> -<tr class="separator:a1f5b9bf8767b44f03f4d3220dfd5f925"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6f52dff0717d6e96863aff068bfb3795"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClient.html#a6f52dff0717d6e96863aff068bfb3795">IsMultiMaster</a> () const </td></tr> -<tr class="separator:a6f52dff0717d6e96863aff068bfb3795"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aacfcd61c7cc1bf7817d1aa0bb738414f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classkudu_1_1MonoDelta.html">MonoDelta</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClient.html#aacfcd61c7cc1bf7817d1aa0bb738414f">default_admin_operation_timeout</a> () const </td></tr> -<tr class="separator:aacfcd61c7cc1bf7817d1aa0bb738414f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2d0e8397e979e651a23eb240513a5556"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classkudu_1_1MonoDelta.html">MonoDelta</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClient.html#a2d0e8397e979e651a23eb240513a5556">default_rpc_timeout</a> () const </td></tr> -<tr class="separator:a2d0e8397e979e651a23eb240513a5556"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a3a671b3540c74ef7c358bb98e95031e0"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClient.html#a3a671b3540c74ef7c358bb98e95031e0">GetLatestObservedTimestamp</a> () const </td></tr> -<tr class="separator:a3a671b3540c74ef7c358bb98e95031e0"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a0809b055eda76fd68988462f2a9791dd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClient.html#a0809b055eda76fd68988462f2a9791dd">SetLatestObservedTimestamp</a> (uint64_t ht_timestamp)</td></tr> -<tr class="separator:a0809b055eda76fd68988462f2a9791dd"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a974b491e5d0864f4aa3f60347fa1b62e"><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_1KuduClient.html#a974b491e5d0864f4aa3f60347fa1b62e">ExportAuthenticationCredentials</a> (std::string *authn_creds) const </td></tr> -<tr class="separator:a974b491e5d0864f4aa3f60347fa1b62e"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> -Static Public Attributes</h2></td></tr> -<tr class="memitem:a196f1a18c000cdca309d05161caaddaa"><td class="memItemLeft" align="right" valign="top">static const uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClient.html#a196f1a18c000cdca309d05161caaddaa">kNoTimestamp</a></td></tr> -<tr class="separator:a196f1a18c000cdca309d05161caaddaa"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> -Friends</h2></td></tr> -<tr class="memitem:ada57057f15990c8cc54770c782fa9ad4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada57057f15990c8cc54770c782fa9ad4"></a> -class </td><td class="memItemRight" valign="bottom"><b>internal::Batcher</b></td></tr> -<tr class="separator:ada57057f15990c8cc54770c782fa9ad4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1d6afdd81ae5d2f0207f7224a058132c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d6afdd81ae5d2f0207f7224a058132c"></a> -class </td><td class="memItemRight" valign="bottom"><b>internal::GetTableSchemaRpc</b></td></tr> -<tr class="separator:a1d6afdd81ae5d2f0207f7224a058132c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a78c0756675d700d01d123aea8ca18751"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78c0756675d700d01d123aea8ca18751"></a> -class </td><td class="memItemRight" valign="bottom"><b>internal::LookupRpc</b></td></tr> -<tr class="separator:a78c0756675d700d01d123aea8ca18751"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:acb6757f44c88e6b23da105cca0299aee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb6757f44c88e6b23da105cca0299aee"></a> -class </td><td class="memItemRight" valign="bottom"><b>internal::MetaCache</b></td></tr> -<tr class="separator:acb6757f44c88e6b23da105cca0299aee"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a01410a9ff63da146890f75dcda841e99"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01410a9ff63da146890f75dcda841e99"></a> -class </td><td class="memItemRight" valign="bottom"><b>internal::RemoteTablet</b></td></tr> -<tr class="separator:a01410a9ff63da146890f75dcda841e99"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2cd42cd8503e7c94b878c96c42b2fd10"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2cd42cd8503e7c94b878c96c42b2fd10"></a> -class </td><td class="memItemRight" valign="bottom"><b>internal::RemoteTabletServer</b></td></tr> -<tr class="separator:a2cd42cd8503e7c94b878c96c42b2fd10"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a8241e8597925b7121abc27b5024c9773"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8241e8597925b7121abc27b5024c9773"></a> -class </td><td class="memItemRight" valign="bottom"><b>internal::WriteRpc</b></td></tr> -<tr class="separator:a8241e8597925b7121abc27b5024c9773"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2e3829217429361e4071ed983aa36b63"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e3829217429361e4071ed983aa36b63"></a> -class </td><td class="memItemRight" valign="bottom"><b>ConnectToClusterBaseTest</b></td></tr> -<tr class="separator:a2e3829217429361e4071ed983aa36b63"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aba2affbf999dd265d3a7f8c30598fec7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba2affbf999dd265d3a7f8c30598fec7"></a> -class </td><td class="memItemRight" valign="bottom"><b>ClientTest</b></td></tr> -<tr class="separator:aba2affbf999dd265d3a7f8c30598fec7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ad396ed74a6421797a2320caf02bec46c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad396ed74a6421797a2320caf02bec46c"></a> -class </td><td class="memItemRight" valign="bottom"><b>KuduClientBuilder</b></td></tr> -<tr class="separator:ad396ed74a6421797a2320caf02bec46c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a4a88b01a7cf6a8b126e310af8a973077"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a88b01a7cf6a8b126e310af8a973077"></a> -class </td><td class="memItemRight" valign="bottom"><b>KuduPartitionerBuilder</b></td></tr> -<tr class="separator:a4a88b01a7cf6a8b126e310af8a973077"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a79d30f3059c783e077627a6f6d153c1b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a79d30f3059c783e077627a6f6d153c1b"></a> -class </td><td class="memItemRight" valign="bottom"><b>KuduScanner</b></td></tr> -<tr class="separator:a79d30f3059c783e077627a6f6d153c1b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a08335df27491aef74f8ed104799ab541"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08335df27491aef74f8ed104799ab541"></a> -class </td><td class="memItemRight" valign="bottom"><b>KuduScanToken</b></td></tr> -<tr class="separator:a08335df27491aef74f8ed104799ab541"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a644ef5d9d668e5772acd6dc03c4f14ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a644ef5d9d668e5772acd6dc03c4f14ee"></a> -class </td><td class="memItemRight" valign="bottom"><b>KuduScanTokenBuilder</b></td></tr> -<tr class="separator:a644ef5d9d668e5772acd6dc03c4f14ee"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ae192dc54e7e8c25675182bacad0d0b6e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae192dc54e7e8c25675182bacad0d0b6e"></a> -class </td><td class="memItemRight" valign="bottom"><b>KuduSession</b></td></tr> -<tr class="separator:ae192dc54e7e8c25675182bacad0d0b6e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a770744f0111b5919212173a7efaf85cd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a770744f0111b5919212173a7efaf85cd"></a> -class </td><td class="memItemRight" valign="bottom"><b>KuduTable</b></td></tr> -<tr class="separator:a770744f0111b5919212173a7efaf85cd"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a3460d221abb050e895feac294530a58f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3460d221abb050e895feac294530a58f"></a> -class </td><td class="memItemRight" valign="bottom"><b>KuduTableAlterer</b></td></tr> -<tr class="separator:a3460d221abb050e895feac294530a58f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:af500eb2379d14e4e6603db2c69faa783"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af500eb2379d14e4e6603db2c69faa783"></a> -class </td><td class="memItemRight" valign="bottom"><b>KuduTableCreator</b></td></tr> -<tr class="separator:af500eb2379d14e4e6603db2c69faa783"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6ea0a9ac656faa8d48cc1f0b413fb7a7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ea0a9ac656faa8d48cc1f0b413fb7a7"></a> -class </td><td class="memItemRight" valign="bottom"><b>::kudu::SecurityUnknownTskTest</b></td></tr> -<tr class="separator:a6ea0a9ac656faa8d48cc1f0b413fb7a7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:abd8d8500650a19511fc193f5f2f09220"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd8d8500650a19511fc193f5f2f09220"></a> -class </td><td class="memItemRight" valign="bottom"><b>tools::LeaderMasterProxy</b></td></tr> -<tr class="separator:abd8d8500650a19511fc193f5f2f09220"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p>A handle for a connection to a cluster. </p> -<p>The <a class="el" href="classkudu_1_1client_1_1KuduClient.html" title="A handle for a connection to a cluster. ">KuduClient</a> class represents a connection to a cluster. From the user perspective, they should only need to create one of these in their application, likely a singleton – but it is not a singleton in Kudu in any way. Different <a class="el" href="classkudu_1_1client_1_1KuduClient.html" title="A handle for a connection to a cluster. ">KuduClient</a> objects do not interact with each other – no connection pooling, etc. With the exception of common properties managed by free (non-member) functions in the kudu::client namespace, each <a class="el" href="classkudu_1_1client_1_1KuduClient.html" title="A handle for a connection to a cluster. ">KuduClient</a> object is sandboxed with no global cross-client state.</p> -<p>In the implementation, the client holds various pieces of common infrastructure which is not table-specific: </p> -<ul> -<li>RPC messenger: reactor threads and RPC connections are pooled here </li> -<li>Authentication: the client is initialized with some credentials, and all accesses through it share those credentials. </li> -<li>Caches: caches of table schemas, tablet locations, tablet server IP addresses, etc are shared per-client.</li> -</ul> -<p>In order to actually write data to the cluster, callers must first create a <a class="el" href="classkudu_1_1client_1_1KuduSession.html" title="Representation of a Kudu client session. ">KuduSession</a> object using <a class="el" href="classkudu_1_1client_1_1KuduClient.html#a1f5b9bf8767b44f03f4d3220dfd5f925">NewSession()</a>. A <a class="el" href="classkudu_1_1client_1_1KuduClient.html" title="A handle for a connection to a cluster. ">KuduClient</a> may have several associated sessions.</p> -<dl class="section note"><dt>Note</dt><dd>This class is thread-safe.</dd></dl> -<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Cluster administration functions are likely to be in this class as well. </dd></dl> -</div><h2 class="groupheader">Member Enumeration Documentation</h2> -<a class="anchor" id="aef70c7f3a596ecda4040f9d46514b11a"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">enum <a class="el" href="classkudu_1_1client_1_1KuduClient.html#aef70c7f3a596ecda4040f9d46514b11a">kudu::client::KuduClient::ReplicaSelection</a></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Policy with which to choose amongst multiple replicas. </p> -<table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="aef70c7f3a596ecda4040f9d46514b11aafb912836db348061379d0e0a9055e239"></a>LEADER_ONLY</em> </td><td class="fielddoc"> -<p>Select the LEADER replica. </p> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="aef70c7f3a596ecda4040f9d46514b11aa801886067da41dacd0c9c2b8091f08d8"></a>CLOSEST_REPLICA</em> </td><td class="fielddoc"> -<p>Select the closest replica to the client, or a random one if all replicas are equidistant. </p> -</td></tr> -<tr><td class="fieldname"><em><a class="anchor" id="aef70c7f3a596ecda4040f9d46514b11aaa060fb6126a3e3fa80079f885dc7d48f"></a>FIRST_REPLICA</em> </td><td class="fielddoc"> -<p>Select the first replica in the list. </p> -</td></tr> -</table> - -</div> -</div> -<h2 class="groupheader">Member Function Documentation</h2> -<a class="anchor" id="aacfcd61c7cc1bf7817d1aa0bb738414f"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">const <a class="el" href="classkudu_1_1MonoDelta.html">MonoDelta</a>& kudu::client::KuduClient::default_admin_operation_timeout </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>Default timeout for admin operations. </dd></dl> - -</div> -</div> -<a class="anchor" id="a2d0e8397e979e651a23eb240513a5556"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">const <a class="el" href="classkudu_1_1MonoDelta.html">MonoDelta</a>& kudu::client::KuduClient::default_rpc_timeout </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>Default timeout for RPCs. </dd></dl> - -</div> -</div> -<a class="anchor" id="a9d7cbad036bc74c71873a428abce5c1d"></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::KuduClient::DeleteTable </td> - <td>(</td> - <td class="paramtype">const std::string & </td> - <td class="paramname"><em>table_name</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Delete/drop a table.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">table_name</td><td>Name of the table to drop. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Operation status. </dd></dl> - -</div> -</div> -<a class="anchor" id="a974b491e5d0864f4aa3f60347fa1b62e"></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::KuduClient::ExportAuthenticationCredentials </td> - <td>(</td> - <td class="paramtype">std::string * </td> - <td class="paramname"><em>authn_creds</em></td><td>)</td> - <td> const</td> - </tr> - </table> -</div><div class="memdoc"> -<p>Export the current authentication credentials from this client. This includes the necessary credentials to authenticate to the cluster, as well as to authenticate the cluster to the client.</p> -<p>The resulting binary string may be passed into a new C++ client via the <code><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#a5c411bc4638cbf77e5d318f5049b0b7e">KuduClientBuilder::import_authentication_credentials</a></code> method, or into a new Java client via <code>KuduClient::importAuthenticationCredentials</code>.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[out]</td><td class="paramname">authn_creds</td><td>The resulting binary authentication credentials. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classkudu_1_1Status.html" title="A representation of an operation's outcome. ">Status</a> object for the operation. </dd></dl> - -</div> -</div> -<a class="anchor" id="a3a671b3540c74ef7c358bb98e95031e0"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">uint64_t kudu::client::KuduClient::GetLatestObservedTimestamp </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td> const</td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get the highest HybridTime timestamp observed by the client.</p> -<p>The latest observed timestamp can be used to start a snapshot scan on a table which is guaranteed to contain all data written or previously read by this client. See <a class="el" href="classkudu_1_1client_1_1KuduScanner.html" title="This class is a representation of a single scan. ">KuduScanner</a> for more details on timestamps.</p> -<p>How to get Read-Your-Writes consistency: the code snippet below uses <a class="el" href="classkudu_1_1client_1_1KuduClient.html#a3a671b3540c74ef7c358bb98e95031e0">KuduClient::GetLatestObservedTimestamp()</a> along with <a class="el" href="classkudu_1_1client_1_1KuduScanner.html#ab13dbb301197b411dec4cd6870801bae">KuduScanner::SetSnapshotRaw()</a> to perform READ_AT_SNAPSHOT scan containing the data which has just been written. Notice extra 1 added to the timestamp passed to <a class="el" href="classkudu_1_1client_1_1KuduScanner.html#ab13dbb301197b411dec4cd6870801bae">KuduScanner::SetSnapshotRaw()</a>: </p> -<div class="fragment"><div class="line">* shared_ptr<KuduClient> client;</div> -<div class="line">* ... <span class="comment">// open/initialize the client</span></div> -<div class="line">* shared_ptr<KuduSession> session(client->NewSession());</div> -<div class="line">* ... <span class="comment">// set Kudu session properties</span></div> -<div class="line">* shared_ptr<KuduTable> table;</div> -<div class="line">* ... <span class="comment">// open the table</span></div> -<div class="line">* unique_ptr<KuduInsert> insert_op(table->NewInsert());</div> -<div class="line">* ... <span class="comment">// populate new insert operation with data</span></div> -<div class="line">* RETURN_NOT_OK(session->Apply(insert_op.release()));</div> -<div class="line">* RETURN_NOT_OK(session->Flush());</div> -<div class="line">* uint64_t snapshot_timestamp = client->GetLatestObservedTimestamp() + 1;</div> -<div class="line">* KuduScanner scanner(table.get());</div> -<div class="line">* RETURN_NOT_OK(scanner.SetSnapshotRaw(snapshot_timestamp));</div> -<div class="line">* RETURN_NOT_OK(scanner.SetSelection(<a class="code" href="classkudu_1_1client_1_1KuduClient.html#aef70c7f3a596ecda4040f9d46514b11aafb912836db348061379d0e0a9055e239">KuduClient::LEADER_ONLY</a>));</div> -<div class="line">* RETURN_NOT_OK(scanner.SetReadMode(<a class="code" href="classkudu_1_1client_1_1KuduScanner.html#a36fdb59d6488618363331269d3f58348a380798cc81589d865b7b2549e186b2e2">KuduScanner::READ_AT_SNAPSHOT</a>));</div> -<div class="line">* RETURN_NOT_OK(scanner.Open());</div> -<div class="line">* ... <span class="comment">// retrieve scanned rows</span></div> -<div class="line">* </div> -</div><!-- fragment --><p> There are currently races in which, in rare occasions, Read-Your-Writes consistency might not hold even in this case. These are being taken care of as part of <a href="https://issues.apache.org/jira/browse/KUDU-430";>KUDU-430</a></p> -<dl class="section note"><dt>Note</dt><dd>This method is experimental and will either disappear or change in a future release.</dd></dl> -<dl class="section return"><dt>Returns</dt><dd>Highest HybridTime timestamp observed by the client. </dd></dl> - -</div> -</div> -<a class="anchor" id="a2aa649e05e0cfb0e10ebce98fb4d7a65"></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::KuduClient::GetTableSchema </td> - <td>(</td> - <td class="paramtype">const std::string & </td> - <td class="paramname"><em>table_name</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="classkudu_1_1client_1_1KuduSchema.html">KuduSchema</a> * </td> - <td class="paramname"><em>schema</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get table's schema.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">table_name</td><td>Name of the table. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">schema</td><td>Raw pointer to the schema object; caller gets ownership. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Operation status. </dd></dl> - -</div> -</div> -<a class="anchor" id="a7a331e528759296089837b4611c01809"></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::KuduClient::IsAlterTableInProgress </td> - <td>(</td> - <td class="paramtype">const std::string & </td> - <td class="paramname"><em>table_name</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">bool * </td> - <td class="paramname"><em>alter_in_progress</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Check if table alteration is in-progress.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">table_name</td><td>Name of the table. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">alter_in_progress</td><td>The value is set only in case of success; it is <code>true</code> iff the operation is in progress. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Operation status. </dd></dl> - -</div> -</div> -<a class="anchor" id="a2f0323b439d8658b2ac31fde7f46de63"></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::KuduClient::IsCreateTableInProgress </td> - <td>(</td> - <td class="paramtype">const std::string & </td> - <td class="paramname"><em>table_name</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">bool * </td> - <td class="paramname"><em>create_in_progress</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Check whether a create table operation is in-progress.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">table_name</td><td>Name of the table. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">create_in_progress</td><td>The value is set only in case of success; it is <code>true</code> iff the operation is in progress. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Operation status. </dd></dl> - -</div> -</div> -<a class="anchor" id="a6f52dff0717d6e96863aff068bfb3795"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">bool kudu::client::KuduClient::IsMultiMaster </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><code>true</code> iff client is configured to talk to multiple Kudu master servers. </dd></dl> - -</div> -</div> -<a class="anchor" id="a3ab09f69753b8c99ac7b2eeed03faa1d"></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::KuduClient::ListTables </td> - <td>(</td> - <td class="paramtype">std::vector< std::string > * </td> - <td class="paramname"><em>tables</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const std::string & </td> - <td class="paramname"><em>filter</em> = <code>""</code> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>List only those tables whose names pass a substring match on <code>filter</code>.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[out]</td><td class="paramname">tables</td><td>The placeholder for the result. Appended only on success. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">filter</td><td>Substring filter to use; empty sub-string filter matches all tables. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classkudu_1_1Status.html" title="A representation of an operation's outcome. ">Status</a> object for the operation. </dd></dl> - -</div> -</div> -<a class="anchor" id="ae283a49551a081524b41f5d8e51e68d9"></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::KuduClient::ListTabletServers </td> - <td>(</td> - <td class="paramtype">std::vector< <a class="el" href="classkudu_1_1client_1_1KuduTabletServer.html">KuduTabletServer</a> * > * </td> - <td class="paramname"><em>tablet_servers</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get information on current tablet servers.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[out]</td><td class="paramname">tablet_servers</td><td>The placeholder for the result. The caller takes ownership of the container's elements. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Operation status. </dd></dl> - -</div> -</div> -<a class="anchor" id="a1f5b9bf8767b44f03f4d3220dfd5f925"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">sp::shared_ptr<<a class="el" href="classkudu_1_1client_1_1KuduSession.html">KuduSession</a>> kudu::client::KuduClient::NewSession </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Create a new session for interacting with the cluster.</p> -<p>This is a fully local operation (no RPCs or blocking).</p> -<dl class="section return"><dt>Returns</dt><dd>A new session object; caller is responsible for destroying it. </dd></dl> - -</div> -</div> -<a class="anchor" id="a116bbcf13dc0991ad2a3129630075aea"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduTableAlterer.html">KuduTableAlterer</a>* kudu::client::KuduClient::NewTableAlterer </td> - <td>(</td> - <td class="paramtype">const std::string & </td> - <td class="paramname"><em>table_name</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Create a <a class="el" href="classkudu_1_1client_1_1KuduTableAlterer.html" title="Alters an existing table based on the provided steps. ">KuduTableAlterer</a> object.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">table_name</td><td>Name of the table to alter. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Pointer to newly created object: it is the caller's responsibility to free it. </dd></dl> - -</div> -</div> -<a class="anchor" id="a003f13604b4fb378f61e133a9b49d153"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduTableCreator.html">KuduTableCreator</a>* kudu::client::KuduClient::NewTableCreator </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Create a <a class="el" href="classkudu_1_1client_1_1KuduTableCreator.html" title="A helper class to create a new table with the desired options. ">KuduTableCreator</a> object.</p> -<dl class="section return"><dt>Returns</dt><dd>Pointer to newly created object; it is the caller's responsibility to free it. </dd></dl> - -</div> -</div> -<a class="anchor" id="aa82a09718ffe68d3255195e736aec8d7"></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::KuduClient::OpenTable </td> - <td>(</td> - <td class="paramtype">const std::string & </td> - <td class="paramname"><em>table_name</em>, </td> - </tr> - <tr> - <td class="paramkey"></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> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Open table with the given name.</p> -<p>This method does an RPC to ensure that the table exists and looks up its schema.</p> -<dl class="section note"><dt>Note</dt><dd>New range partitions created by other clients will immediately be available after opening the table.</dd></dl> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">table_name</td><td>Name of the table. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">table</td><td>The result table. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Operation status.</dd></dl> -<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd><p class="startdd">Should we offer an async version of this as well? </p> -<p class="enddd">Probably should have a configurable timeout in <a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html" title="A "factory" for KuduClient objects. ">KuduClientBuilder</a>? </p> -</dd></dl> - -</div> -</div> -<a class="anchor" id="a0809b055eda76fd68988462f2a9791dd"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void kudu::client::KuduClient::SetLatestObservedTimestamp </td> - <td>(</td> - <td class="paramtype">uint64_t </td> - <td class="paramname"><em>ht_timestamp</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Sets the latest observed HybridTime timestamp.</p> -<p>This is only useful when forwarding timestamps between clients to enforce external consistency when using <a class="el" href="classkudu_1_1client_1_1KuduSession.html#aabd55109ba3b086bbe33b277cdd40d22ae978fab7451faebf4399830b603c855c">KuduSession::CLIENT_PROPAGATED</a> external consistency mode.</p> -<p>The HybridTime encoded timestamp should be obtained from another client's <a class="el" href="classkudu_1_1client_1_1KuduClient.html#a3a671b3540c74ef7c358bb98e95031e0">KuduClient::GetLatestObservedTimestamp()</a> method.</p> -<dl class="section note"><dt>Note</dt><dd>This method is experimental and will either disappear or change in a future release.</dd></dl> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">ht_timestamp</td><td>Timestamp encoded in HybridTime format. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a class="anchor" id="a96e9a6c0a16a8825c291528ac27af818"></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::KuduClient::TableExists </td> - <td>(</td> - <td class="paramtype">const std::string & </td> - <td class="paramname"><em>table_name</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">bool * </td> - <td class="paramname"><em>exists</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Check if the table given by 'table_name' exists.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">table_name</td><td>Name of the table. </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">exists</td><td>Set only on success; set to <code>true</code> iff table exists. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classkudu_1_1Status.html" title="A representation of an operation's outcome. ">Status</a> object for the operation. </dd></dl> - -</div> -</div> -<h2 class="groupheader">Member Data Documentation</h2> -<a class="anchor" id="a196f1a18c000cdca309d05161caaddaa"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">const uint64_t kudu::client::KuduClient::kNoTimestamp</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>Value for the latest observed timestamp when none has been observed or set. </p> - -</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.1 on Mon Jun 18 2018 07:37:41 by Doxygen 1.8.5</small> - <br> - <small>Copyright © 2018 The Apache Software Foundation.</small> -</address> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/kudu-site/blob/854be1d3/cpp-client-api/classkudu_1_1client_1_1KuduClient.png ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduClient.png b/cpp-client-api/classkudu_1_1client_1_1KuduClient.png deleted file mode 100644 index 322f4eb..0000000 Binary files a/cpp-client-api/classkudu_1_1client_1_1KuduClient.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/kudu-site/blob/854be1d3/cpp-client-api/classkudu_1_1client_1_1KuduClientBuilder-members.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduClientBuilder-members.html b/cpp-client-api/classkudu_1_1client_1_1KuduClientBuilder-members.html deleted file mode 100644 index 164baff..0000000 --- a/cpp-client-api/classkudu_1_1client_1_1KuduClientBuilder-members.html +++ /dev/null @@ -1,115 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml";> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.5"/> -<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/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</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 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.5 --> -<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)"> -<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:vo id(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>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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_1KuduClientBuilder.html">KuduClientBuilder</a></li> </ul> -</div> -</div><!-- top --> -<div class="header"> - <div class="headertitle"> -<div class="title">kudu::client::KuduClientBuilder 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_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</a>, including all inherited members.</p> -<table class="directory"> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#add149f1c1c2d3653e6a6cae4f44fa90c">add_master_server_addr</a>(const std::string &addr)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#a1585dd6eff82519fe81088d1cfd35b77">Build</a>(sp::shared_ptr< KuduClient > *client)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#a08f4d2bf7053c6336e625ee2e6eeddd1">clear_master_server_addrs</a>()</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#a6114bb56e4d9d1231df0ef73c9aec752">default_admin_operation_timeout</a>(const MonoDelta &timeout)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#a1813e8c8d24e92a0a710724000e2b3df">default_rpc_timeout</a>(const MonoDelta &timeout)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#a5c411bc4638cbf77e5d318f5049b0b7e">import_authentication_credentials</a>(std::string authn_creds)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</a></td><td class="entry"></td></tr> - <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>internal::ReplicaController</b> (defined in <a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</a>)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</a></td><td class="entry"><span class="mlabel">friend</span></td></tr> - <tr bgcolor="#f0f0f0"><td class="entry"><b>KuduClientBuilder</b>() (defined in <a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</a>)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#a0c1b92afad7a6e21c5ea781fb7d42114">master_server_addrs</a>(const std::vector< std::string > &addrs)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</a></td><td class="entry"></td></tr> - <tr bgcolor="#f0f0f0"><td class="entry"><b>~KuduClientBuilder</b>() (defined in <a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</a>)</td><td class="entry"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">kudu::client::KuduClientBuilder</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.1 on Mon Jun 18 2018 07:37:41 by Doxygen 1.8.5</small> - <br> - <small>Copyright © 2018 The Apache Software Foundation.</small> -</address> -</body> -</html> http://git-wip-us.apache.org/repos/asf/kudu-site/blob/854be1d3/cpp-client-api/classkudu_1_1client_1_1KuduClientBuilder.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduClientBuilder.html b/cpp-client-api/classkudu_1_1client_1_1KuduClientBuilder.html deleted file mode 100644 index ddc0b01..0000000 --- a/cpp-client-api/classkudu_1_1client_1_1KuduClientBuilder.html +++ /dev/null @@ -1,307 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml";> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.5"/> -<title>Kudu C++ client API: kudu::client::KuduClientBuilder 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/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</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 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.5 --> -<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)"> -<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:vo id(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>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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_1KuduClientBuilder.html">KuduClientBuilder</a></li> </ul> -</div> -</div><!-- top --> -<div class="header"> - <div class="summary"> -<a href="#pub-methods">Public Member Functions</a> | -<a href="#friends">Friends</a> | -<a href="classkudu_1_1client_1_1KuduClientBuilder-members.html">List of all members</a> </div> - <div class="headertitle"> -<div class="title">kudu::client::KuduClientBuilder Class Reference</div> </div> -</div><!--header--> -<div class="contents"> - -<p>A "factory" for <a class="el" href="classkudu_1_1client_1_1KuduClient.html" title="A handle for a connection to a cluster. ">KuduClient</a> objects. - <a href="classkudu_1_1client_1_1KuduClientBuilder.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:a08f4d2bf7053c6336e625ee2e6eeddd1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">KuduClientBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#a08f4d2bf7053c6336e625ee2e6eeddd1">clear_master_server_addrs</a> ()</td></tr> -<tr class="separator:a08f4d2bf7053c6336e625ee2e6eeddd1"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a0c1b92afad7a6e21c5ea781fb7d42114"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">KuduClientBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#a0c1b92afad7a6e21c5ea781fb7d42114">master_server_addrs</a> (const std::vector< std::string > &addrs)</td></tr> -<tr class="separator:a0c1b92afad7a6e21c5ea781fb7d42114"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:add149f1c1c2d3653e6a6cae4f44fa90c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">KuduClientBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#add149f1c1c2d3653e6a6cae4f44fa90c">add_master_server_addr</a> (const std::string &addr)</td></tr> -<tr class="separator:add149f1c1c2d3653e6a6cae4f44fa90c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6114bb56e4d9d1231df0ef73c9aec752"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">KuduClientBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#a6114bb56e4d9d1231df0ef73c9aec752">default_admin_operation_timeout</a> (const <a class="el" href="classkudu_1_1MonoDelta.html">MonoDelta</a> &timeout)</td></tr> -<tr class="separator:a6114bb56e4d9d1231df0ef73c9aec752"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1813e8c8d24e92a0a710724000e2b3df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">KuduClientBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#a1813e8c8d24e92a0a710724000e2b3df">default_rpc_timeout</a> (const <a class="el" href="classkudu_1_1MonoDelta.html">MonoDelta</a> &timeout)</td></tr> -<tr class="separator:a1813e8c8d24e92a0a710724000e2b3df"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a5c411bc4638cbf77e5d318f5049b0b7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">KuduClientBuilder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html#a5c411bc4638cbf77e5d318f5049b0b7e">import_authentication_credentials</a> (std::string authn_creds)</td></tr> -<tr class="separator:a5c411bc4638cbf77e5d318f5049b0b7e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1585dd6eff82519fe81088d1cfd35b77"><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_1KuduClientBuilder.html#a1585dd6eff82519fe81088d1cfd35b77">Build</a> (sp::shared_ptr< <a class="el" href="classkudu_1_1client_1_1KuduClient.html">KuduClient</a> > *client)</td></tr> -<tr class="separator:a1585dd6eff82519fe81088d1cfd35b77"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> -Friends</h2></td></tr> -<tr class="memitem:a1a7f7cea629079f5f49d99dc88206d30"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a7f7cea629079f5f49d99dc88206d30"></a> -class </td><td class="memItemRight" valign="bottom"><b>internal::ReplicaController</b></td></tr> -<tr class="separator:a1a7f7cea629079f5f49d99dc88206d30"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p>A "factory" for <a class="el" href="classkudu_1_1client_1_1KuduClient.html" title="A handle for a connection to a cluster. ">KuduClient</a> objects. </p> -<p>This class is used to create instances of the <a class="el" href="classkudu_1_1client_1_1KuduClient.html" title="A handle for a connection to a cluster. ">KuduClient</a> class with pre-set options/parameters. </p> -</div><h2 class="groupheader">Member Function Documentation</h2> -<a class="anchor" id="add149f1c1c2d3653e6a6cae4f44fa90c"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">KuduClientBuilder</a>& kudu::client::KuduClientBuilder::add_master_server_addr </td> - <td>(</td> - <td class="paramtype">const std::string & </td> - <td class="paramname"><em>addr</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Add an RPC address of a master to work with.</p> -<p>At least one master is required.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>RPC address of master server to add. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Reference to the updated object. </dd></dl> - -</div> -</div> -<a class="anchor" id="a1585dd6eff82519fe81088d1cfd35b77"></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::KuduClientBuilder::Build </td> - <td>(</td> - <td class="paramtype">sp::shared_ptr< <a class="el" href="classkudu_1_1client_1_1KuduClient.html">KuduClient</a> > * </td> - <td class="paramname"><em>client</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Create a client object.</p> -<dl class="section note"><dt>Note</dt><dd>KuduClients objects are shared amongst multiple threads and, as such, are stored in shared pointers.</dd></dl> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[out]</td><td class="paramname">client</td><td>The newly created object wrapped in a shared pointer. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Operation status. The return value may indicate an error in the create operation, or a misuse of the builder; in the latter case, only the last error is returned. </dd></dl> - -</div> -</div> -<a class="anchor" id="a08f4d2bf7053c6336e625ee2e6eeddd1"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">KuduClientBuilder</a>& kudu::client::KuduClientBuilder::clear_master_server_addrs </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Clear the set of master addresses.</p> -<dl class="section return"><dt>Returns</dt><dd>Reference to the updated object. </dd></dl> - -</div> -</div> -<a class="anchor" id="a6114bb56e4d9d1231df0ef73c9aec752"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">KuduClientBuilder</a>& kudu::client::KuduClientBuilder::default_admin_operation_timeout </td> - <td>(</td> - <td class="paramtype">const <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 default timeout for administrative operations.</p> -<p>Using this method it is possible to modify the default timeout for operations like CreateTable, AlterTable, etc. By default it is 30 seconds.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>Timeout value to set. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Reference to the updated object. </dd></dl> - -</div> -</div> -<a class="anchor" id="a1813e8c8d24e92a0a710724000e2b3df"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">KuduClientBuilder</a>& kudu::client::KuduClientBuilder::default_rpc_timeout </td> - <td>(</td> - <td class="paramtype">const <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 default timeout for individual RPCs.</p> -<p>If not provided, defaults to 10 seconds.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>Timeout value to set. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Reference to the updated object. </dd></dl> - -</div> -</div> -<a class="anchor" id="a5c411bc4638cbf77e5d318f5049b0b7e"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">KuduClientBuilder</a>& kudu::client::KuduClientBuilder::import_authentication_credentials </td> - <td>(</td> - <td class="paramtype">std::string </td> - <td class="paramname"><em>authn_creds</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Import serialized authentication credentials from another client.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">authn_creds</td><td>The serialized authentication credentials, provided by a call to <code><a class="el" href="classkudu_1_1client_1_1KuduClient.html#a974b491e5d0864f4aa3f60347fa1b62e">KuduClient.ExportAuthenticationCredentials</a></code> in the C++ client or <code>KuduClient::exportAuthenticationCredentials</code> in the Java client. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Reference to the updated object. </dd></dl> - -</div> -</div> -<a class="anchor" id="a0c1b92afad7a6e21c5ea781fb7d42114"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduClientBuilder.html">KuduClientBuilder</a>& kudu::client::KuduClientBuilder::master_server_addrs </td> - <td>(</td> - <td class="paramtype">const std::vector< std::string > & </td> - <td class="paramname"><em>addrs</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Add RPC addresses of multiple masters.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramdir">[in]</td><td class="paramname">addrs</td><td>RPC addresses of masters to add. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Reference to the updated 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.7.1 on Mon Jun 18 2018 07:37:41 by Doxygen 1.8.5</small> - <br> - <small>Copyright © 2018 The Apache Software Foundation.</small> -</address> -</body> -</html>
