Google Git
Sign in
apache / kudu-site / refs/heads/asf-site / . / cpp-client-api / classkudu_1_1client_1_1KuduValue.html
blob: 1ec061b17fa1c956418efe50183470fcbaf08b84 [file] [log] [blame]
<!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>Kudu C++ client API: kudu::client::KuduValue Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Kudu C++ client API
</div>
</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>
<!-- 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 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_1KuduValue.html">KuduValue</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classkudu_1_1client_1_1KuduValue-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">kudu::client::KuduValue Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A constant cell value with a specific type.
<a href="classkudu_1_1client_1_1KuduValue.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="value_8h_source.html">value.h</a>&gt;</code></p>
<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:a5a81eb3166b22759dff271fa80f6b89c" id="r_a5a81eb3166b22759dff271fa80f6b89c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduValue.html#a5a81eb3166b22759dff271fa80f6b89c">Clone</a> () const</td></tr>
<tr class="separator:a5a81eb3166b22759dff271fa80f6b89c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:af37a6b4928adb972dea660caa1a01fc7" id="r_af37a6b4928adb972dea660caa1a01fc7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduValue.html#af37a6b4928adb972dea660caa1a01fc7">CopyString</a> (<a class="el" href="classkudu_1_1Slice.html">Slice</a> s)</td></tr>
<tr class="separator:af37a6b4928adb972dea660caa1a01fc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Builders from integral types.</div></td></tr>
<tr class="memitem:a84eb707b3ad04dff6e8a978857da67ff" id="r_a84eb707b3ad04dff6e8a978857da67ff"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduValue.html#a84eb707b3ad04dff6e8a978857da67ff">FromInt</a> (int64_t val)</td></tr>
<tr class="separator:a84eb707b3ad04dff6e8a978857da67ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1258c55ea7df425c149eba0bdc887cd1" id="r_a1258c55ea7df425c149eba0bdc887cd1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduValue.html#a1258c55ea7df425c149eba0bdc887cd1">FromFloat</a> (float val)</td></tr>
<tr class="separator:a1258c55ea7df425c149eba0bdc887cd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae28a21a4a9fce8f9bd6c6934c637362a" id="r_ae28a21a4a9fce8f9bd6c6934c637362a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduValue.html#ae28a21a4a9fce8f9bd6c6934c637362a">FromDouble</a> (double val)</td></tr>
<tr class="separator:ae28a21a4a9fce8f9bd6c6934c637362a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66ac2abe14f1cf4e5b514c4acd411702" id="r_a66ac2abe14f1cf4e5b514c4acd411702"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduValue.html#a66ac2abe14f1cf4e5b514c4acd411702">FromBool</a> (bool val)</td></tr>
<tr class="separator:a66ac2abe14f1cf4e5b514c4acd411702"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A constant cell value with a specific type. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a5a81eb3166b22759dff271fa80f6b89c" name="a5a81eb3166b22759dff271fa80f6b89c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a81eb3166b22759dff271fa80f6b89c">&#9670;&#160;</a></span>Clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a> * kudu::client::KuduValue::Clone </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>A new identical <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> object. </dd></dl>
</div>
</div>
<a id="af37a6b4928adb972dea660caa1a01fc7" name="af37a6b4928adb972dea660caa1a01fc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af37a6b4928adb972dea660caa1a01fc7">&#9670;&#160;</a></span>CopyString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a> * kudu::client::KuduValue::CopyString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classkudu_1_1Slice.html">Slice</a>&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> by copying the value of the given <a class="el" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data.">Slice</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The slice to copy value from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> object. </dd></dl>
</div>
</div>
<a id="a66ac2abe14f1cf4e5b514c4acd411702" name="a66ac2abe14f1cf4e5b514c4acd411702"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66ac2abe14f1cf4e5b514c4acd411702">&#9670;&#160;</a></span>FromBool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a> * kudu::client::KuduValue::FromBool </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> object from the given value of integral type.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>The value to build the <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> object. </dd></dl>
</div>
</div>
<a id="ae28a21a4a9fce8f9bd6c6934c637362a" name="ae28a21a4a9fce8f9bd6c6934c637362a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae28a21a4a9fce8f9bd6c6934c637362a">&#9670;&#160;</a></span>FromDouble()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a> * kudu::client::KuduValue::FromDouble </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> object from the given value of integral type.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>The value to build the <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> object. </dd></dl>
</div>
</div>
<a id="a1258c55ea7df425c149eba0bdc887cd1" name="a1258c55ea7df425c149eba0bdc887cd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1258c55ea7df425c149eba0bdc887cd1">&#9670;&#160;</a></span>FromFloat()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a> * kudu::client::KuduValue::FromFloat </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> object from the given value of integral type.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>The value to build the <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> object. </dd></dl>
</div>
</div>
<a id="a84eb707b3ad04dff6e8a978857da67ff" name="a84eb707b3ad04dff6e8a978857da67ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84eb707b3ad04dff6e8a978857da67ff">&#9670;&#160;</a></span>FromInt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a> * kudu::client::KuduValue::FromInt </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> object from the given value of integral type.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>The value to build the <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classkudu_1_1client_1_1KuduValue.html" title="A constant cell value with a specific type.">KuduValue</a> 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="value_8h_source.html">value.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/>
<address class="footer">
<small>Generated for Kudu version 1.17.0 on Mon Sep 4 2023 19:49:30 by Doxygen 1.9.8</small>
<br>
<small>Copyright © 2023 The Apache Software Foundation.</small>
</address>
</body>
</html>