blob: caf13b62158fb2f3329f9b31805b59d108b93908 [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: include/kudu/client/value.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_58b01e52e53886b8d78ab5060a2cd2bd.html">kudu</a></li><li class="navelem"><a class="el" href="dir_4eb331d85bb84eae27db9d0af49f6f99.html">client</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">value.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// distributed with this work for additional information</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">// to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">// with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">//</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">//</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// software distributed under the License is distributed on an</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">// &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">// KIND, either express or implied. See the License for the</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">// specific language governing permissions and limitations</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">// under the License.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#ifndef KUDU_CLIENT_VALUE_H</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#define KUDU_CLIENT_VALUE_H</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">// NOTE: using stdint.h instead of cstdint because this file is supposed</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">// to be processed by a compiler lacking C++11 support.</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#ifdef KUDU_HEADERS_NO_STUBS</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &quot;kudu/gutil/macros.h&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &quot;kudu/client/stubs.h&quot;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &quot;kudu/util/int128.h&quot;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &quot;kudu/util/kudu_export.h&quot;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include &quot;kudu/util/slice.h&quot;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">namespace </span>kudu {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">namespace </span>client {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="foldopen" id="foldopen00037" data-start="{" data-end="};">
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classkudu_1_1client_1_1KuduValue.html"> 37</a></span><span class="keyword">class </span>KUDU_EXPORT <a class="code hl_class" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a> {</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classkudu_1_1client_1_1KuduValue.html#a5a81eb3166b22759dff271fa80f6b89c"> 40</a></span> <a class="code hl_class" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a>* <a class="code hl_function" href="classkudu_1_1client_1_1KuduValue.html#a5a81eb3166b22759dff271fa80f6b89c">Clone</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classkudu_1_1client_1_1KuduValue.html#a84eb707b3ad04dff6e8a978857da67ff"> 50</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a>* <a class="code hl_function" href="classkudu_1_1client_1_1KuduValue.html#a84eb707b3ad04dff6e8a978857da67ff">FromInt</a>(int64_t val);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classkudu_1_1client_1_1KuduValue.html#a1258c55ea7df425c149eba0bdc887cd1"> 51</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a>* <a class="code hl_function" href="classkudu_1_1client_1_1KuduValue.html#a1258c55ea7df425c149eba0bdc887cd1">FromFloat</a>(<span class="keywordtype">float</span> val);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classkudu_1_1client_1_1KuduValue.html#ae28a21a4a9fce8f9bd6c6934c637362a"> 52</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a>* <a class="code hl_function" href="classkudu_1_1client_1_1KuduValue.html#ae28a21a4a9fce8f9bd6c6934c637362a">FromDouble</a>(<span class="keywordtype">double</span> val);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="classkudu_1_1client_1_1KuduValue.html#a66ac2abe14f1cf4e5b514c4acd411702"> 53</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a>* <a class="code hl_function" href="classkudu_1_1client_1_1KuduValue.html#a66ac2abe14f1cf4e5b514c4acd411702">FromBool</a>(<span class="keywordtype">bool</span> val);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#if KUDU_INT128_SUPPORTED</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">static</span> <a class="code hl_class" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a>* FromDecimal(int128_t dv, int8_t scale);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classkudu_1_1client_1_1KuduValue.html#af37a6b4928adb972dea660caa1a01fc7"> 77</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a>* <a class="code hl_function" href="classkudu_1_1client_1_1KuduValue.html#af37a6b4928adb972dea660caa1a01fc7">CopyString</a>(<a class="code hl_class" href="classkudu_1_1Slice.html">Slice</a> s);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <a class="code hl_class" href="classkudu_1_1client_1_1KuduValue.html">~KuduValue</a>();</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keyword">friend</span> <span class="keyword">class </span>ComparisonPredicateData;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">friend</span> <span class="keyword">class </span>InBloomFilterPredicateData;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">friend</span> <span class="keyword">class </span>InListPredicateData;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classkudu_1_1client_1_1KuduColumnSpec.html">KuduColumnSpec</a>;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keyword">class </span>KUDU_NO_EXPORT Data;</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a>(Data* d);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// Owned.</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> Data* data_;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> DISALLOW_COPY_AND_ASSIGN(<a class="code hl_class" href="classkudu_1_1client_1_1KuduValue.html">KuduValue</a>);</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span>};</div>
</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span>} <span class="comment">// namespace client</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span>} <span class="comment">// namespace kudu</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="preprocessor">#endif </span><span class="comment">/* KUDU_CLIENT_VALUE_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclasskudu_1_1Slice_html"><div class="ttname"><a href="classkudu_1_1Slice.html">kudu::Slice</a></div><div class="ttdoc">A wrapper around externally allocated data.</div><div class="ttdef"><b>Definition</b> slice.h:51</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduColumnSpec_html"><div class="ttname"><a href="classkudu_1_1client_1_1KuduColumnSpec.html">kudu::client::KuduColumnSpec</a></div><div class="ttdoc">Builder API for specifying or altering a column within a table schema.</div><div class="ttdef"><b>Definition</b> schema.h:370</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduValue_html"><div class="ttname"><a href="classkudu_1_1client_1_1KuduValue.html">kudu::client::KuduValue</a></div><div class="ttdoc">A constant cell value with a specific type.</div><div class="ttdef"><b>Definition</b> value.h:37</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduValue_html_a1258c55ea7df425c149eba0bdc887cd1"><div class="ttname"><a href="classkudu_1_1client_1_1KuduValue.html#a1258c55ea7df425c149eba0bdc887cd1">kudu::client::KuduValue::FromFloat</a></div><div class="ttdeci">static KuduValue * FromFloat(float val)</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduValue_html_a5a81eb3166b22759dff271fa80f6b89c"><div class="ttname"><a href="classkudu_1_1client_1_1KuduValue.html#a5a81eb3166b22759dff271fa80f6b89c">kudu::client::KuduValue::Clone</a></div><div class="ttdeci">KuduValue * Clone() const</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduValue_html_a66ac2abe14f1cf4e5b514c4acd411702"><div class="ttname"><a href="classkudu_1_1client_1_1KuduValue.html#a66ac2abe14f1cf4e5b514c4acd411702">kudu::client::KuduValue::FromBool</a></div><div class="ttdeci">static KuduValue * FromBool(bool val)</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduValue_html_a84eb707b3ad04dff6e8a978857da67ff"><div class="ttname"><a href="classkudu_1_1client_1_1KuduValue.html#a84eb707b3ad04dff6e8a978857da67ff">kudu::client::KuduValue::FromInt</a></div><div class="ttdeci">static KuduValue * FromInt(int64_t val)</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduValue_html_ae28a21a4a9fce8f9bd6c6934c637362a"><div class="ttname"><a href="classkudu_1_1client_1_1KuduValue.html#ae28a21a4a9fce8f9bd6c6934c637362a">kudu::client::KuduValue::FromDouble</a></div><div class="ttdeci">static KuduValue * FromDouble(double val)</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduValue_html_af37a6b4928adb972dea660caa1a01fc7"><div class="ttname"><a href="classkudu_1_1client_1_1KuduValue.html#af37a6b4928adb972dea660caa1a01fc7">kudu::client::KuduValue::CopyString</a></div><div class="ttdeci">static KuduValue * CopyString(Slice s)</div></div>
</div><!-- fragment --></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>