Google Git
Sign in
apache / incubator-resilientdb-python-sdk / refs/heads/gh-pages / . / classsdk_1_1ResDBKVClient.html
blob: 141a8b8196a2257f27640c9448e5c482a687f638 [file] [log] [blame]
<!-- HTML header for doxygen 1.9.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ResilientDB SDK: ResDBKVClient 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen_html_style.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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classsdk_1_1ResDBKVClient.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classsdk_1_1ResDBKVClient-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ResDBKVClient Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="resdb__kv__client_8h_source.html">resdb_kv_client.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ResDBKVClient:</div>
<div class="dyncontent">
<div class="center">
<img src="classsdk_1_1ResDBKVClient.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abda20b295f54880caa7f93717df3d503" id="r_abda20b295f54880caa7f93717df3d503"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdk_1_1ResDBKVClient.html#abda20b295f54880caa7f93717df3d503">Get</a> (const std::string &amp;key)</td></tr>
<tr class="separator:abda20b295f54880caa7f93717df3d503"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61336d6502842d7427a8c311897709c0" id="r_a61336d6502842d7427a8c311897709c0"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdk_1_1ResDBKVClient.html#a61336d6502842d7427a8c311897709c0">GetAllValues</a> ()</td></tr>
<tr class="separator:a61336d6502842d7427a8c311897709c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36ee03106575cba87b9539f78f772580" id="r_a36ee03106575cba87b9539f78f772580"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdk_1_1ResDBKVClient.html#a36ee03106575cba87b9539f78f772580">GetRange</a> (const std::string &amp;min_key, const std::string &amp;max_key)</td></tr>
<tr class="separator:a36ee03106575cba87b9539f78f772580"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07ed2589783d3fa90e1dc8dd1ead4121" id="r_a07ed2589783d3fa90e1dc8dd1ead4121"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdk_1_1ResDBKVClient.html#a07ed2589783d3fa90e1dc8dd1ead4121">ResDBKVClient</a> (const resdb::ResDBConfig &amp;config)</td></tr>
<tr class="separator:a07ed2589783d3fa90e1dc8dd1ead4121"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad346b83101b41b711125059146cd2af" id="r_aad346b83101b41b711125059146cd2af"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdk_1_1ResDBKVClient.html#aad346b83101b41b711125059146cd2af">Set</a> (const std::string &amp;key, const std::string &amp;data)</td></tr>
<tr class="separator:aad346b83101b41b711125059146cd2af"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a07ed2589783d3fa90e1dc8dd1ead4121" name="a07ed2589783d3fa90e1dc8dd1ead4121"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07ed2589783d3fa90e1dc8dd1ead4121">&#9670;&#160;</a></span>ResDBKVClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsdk_1_1ResDBKVClient.html">ResDBKVClient</a> </td>
<td>(</td>
<td class="paramtype">const resdb::ResDBConfig &amp;&#160;</td>
<td class="paramname"><em>config</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abda20b295f54880caa7f93717df3d503" name="abda20b295f54880caa7f93717df3d503"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abda20b295f54880caa7f93717df3d503">&#9670;&#160;</a></span>Get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt; std::string &gt; Get </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a61336d6502842d7427a8c311897709c0" name="a61336d6502842d7427a8c311897709c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61336d6502842d7427a8c311897709c0">&#9670;&#160;</a></span>GetAllValues()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt; std::string &gt; GetAllValues </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a36ee03106575cba87b9539f78f772580" name="a36ee03106575cba87b9539f78f772580"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36ee03106575cba87b9539f78f772580">&#9670;&#160;</a></span>GetRange()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt; std::string &gt; GetRange </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>min_key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>max_key</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aad346b83101b41b711125059146cd2af" name="aad346b83101b41b711125059146cd2af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad346b83101b41b711125059146cd2af">&#9670;&#160;</a></span>Set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Set </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>data</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/github/workspace/service/kv_service/<a class="el" href="resdb__kv__client_8h_source.html">resdb_kv_client.h</a></li>
<li>/github/workspace/service/kv_service/<a class="el" href="resdb__kv__client_8cpp.html">resdb_kv_client.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacesdk.html">sdk</a></li><li class="navelem"><a class="el" href="classsdk_1_1ResDBKVClient.html">ResDBKVClient</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>