Google Git
Sign in
apache / kudu-site / b8692be453f241daf104a28ddf0364c36d679730 / . / cpp-client-api / columnar__scan__batch_8h_source.html
blob: 8a3de933408a99835b6032b7a4732a519728b027 [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">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kudu C++ client API: include/kudu/client/columnar_scan_batch.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kudu C++ client API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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">columnar_scan_batch.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// distributed with this work for additional information</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// software distributed under the License is distributed on an</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// KIND, either express or implied. See the License for the</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// specific language governing permissions and limitations</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// under the License.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef KUDU_CLIENT_COLUMNAR_SCAN_BATCH_H</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define KUDU_CLIENT_COLUMNAR_SCAN_BATCH_H</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifdef KUDU_HEADERS_NO_STUBS</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;kudu/gutil/macros.h&quot;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;kudu/client/stubs.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;kudu/util/kudu_export.h&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="status_8h.html">kudu/util/status.h</a>&quot;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">namespace </span>kudu {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">class </span>Slice;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">namespace </span>client {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classkudu_1_1client_1_1KuduColumnarScanBatch.html"> 51</a></span>&#160;<span class="keyword">class </span>KUDU_EXPORT <a class="code" href="classkudu_1_1client_1_1KuduColumnarScanBatch.html">KuduColumnarScanBatch</a> {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classkudu_1_1client_1_1KuduColumnarScanBatch.html">KuduColumnarScanBatch</a>();</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; ~<a class="code" href="classkudu_1_1client_1_1KuduColumnarScanBatch.html">KuduColumnarScanBatch</a>();</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classkudu_1_1client_1_1KuduColumnarScanBatch.html#acd1c9a1f894dc35fdb3e9e04ecb100e7"> 57</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classkudu_1_1client_1_1KuduColumnarScanBatch.html#acd1c9a1f894dc35fdb3e9e04ecb100e7">NumRows</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classkudu_1_1client_1_1KuduColumnarScanBatch.html#a407f9f0dfe0e7f489ef015a422055300"> 73</a></span>&#160; <a class="code" href="classkudu_1_1Status.html">Status</a> <a class="code" href="classkudu_1_1client_1_1KuduColumnarScanBatch.html#a407f9f0dfe0e7f489ef015a422055300">GetFixedLengthColumn</a>(<span class="keywordtype">int</span> idx, <a class="code" href="classkudu_1_1Slice.html">Slice</a>* data) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classkudu_1_1client_1_1KuduColumnarScanBatch.html#a36907b80d801e8f55fc7136e21973ed1"> 88</a></span>&#160; <a class="code" href="classkudu_1_1Status.html">Status</a> <a class="code" href="classkudu_1_1client_1_1KuduColumnarScanBatch.html#a36907b80d801e8f55fc7136e21973ed1">GetVariableLengthColumn</a>(<span class="keywordtype">int</span> idx, <a class="code" href="classkudu_1_1Slice.html">Slice</a>* offsets, <a class="code" href="classkudu_1_1Slice.html">Slice</a>* data) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="classkudu_1_1client_1_1KuduColumnarScanBatch.html#aeab3521399ba6aa8672cc9fa6e626312"> 105</a></span>&#160; <a class="code" href="classkudu_1_1Status.html">Status</a> <a class="code" href="classkudu_1_1client_1_1KuduColumnarScanBatch.html#aeab3521399ba6aa8672cc9fa6e626312">GetNonNullBitmapForColumn</a>(<span class="keywordtype">int</span> idx, <a class="code" href="classkudu_1_1Slice.html">Slice</a>* data) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keyword">class </span>KUDU_NO_EXPORT Data;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classkudu_1_1client_1_1KuduScanner.html">KuduScanner</a>;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; Data* data_;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; DISALLOW_COPY_AND_ASSIGN(<a class="code" href="classkudu_1_1client_1_1KuduColumnarScanBatch.html">KuduColumnarScanBatch</a>);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;};</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;} <span class="comment">// namespace client</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;} <span class="comment">// namespace kudu</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;<span class="preprocessor">#endif</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_1Status_html"><div class="ttname"><a href="classkudu_1_1Status.html">kudu::Status</a></div><div class="ttdoc">A representation of an operation's outcome.</div><div class="ttdef"><b>Definition:</b> status.h:165</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduColumnarScanBatch_html"><div class="ttname"><a href="classkudu_1_1client_1_1KuduColumnarScanBatch.html">kudu::client::KuduColumnarScanBatch</a></div><div class="ttdoc">A batch of columnar data returned from a scanner.</div><div class="ttdef"><b>Definition:</b> columnar_scan_batch.h:51</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduColumnarScanBatch_html_a36907b80d801e8f55fc7136e21973ed1"><div class="ttname"><a href="classkudu_1_1client_1_1KuduColumnarScanBatch.html#a36907b80d801e8f55fc7136e21973ed1">kudu::client::KuduColumnarScanBatch::GetVariableLengthColumn</a></div><div class="ttdeci">Status GetVariableLengthColumn(int idx, Slice *offsets, Slice *data) const</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduColumnarScanBatch_html_a407f9f0dfe0e7f489ef015a422055300"><div class="ttname"><a href="classkudu_1_1client_1_1KuduColumnarScanBatch.html#a407f9f0dfe0e7f489ef015a422055300">kudu::client::KuduColumnarScanBatch::GetFixedLengthColumn</a></div><div class="ttdeci">Status GetFixedLengthColumn(int idx, Slice *data) const</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduColumnarScanBatch_html_acd1c9a1f894dc35fdb3e9e04ecb100e7"><div class="ttname"><a href="classkudu_1_1client_1_1KuduColumnarScanBatch.html#acd1c9a1f894dc35fdb3e9e04ecb100e7">kudu::client::KuduColumnarScanBatch::NumRows</a></div><div class="ttdeci">int NumRows() const</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduColumnarScanBatch_html_aeab3521399ba6aa8672cc9fa6e626312"><div class="ttname"><a href="classkudu_1_1client_1_1KuduColumnarScanBatch.html#aeab3521399ba6aa8672cc9fa6e626312">kudu::client::KuduColumnarScanBatch::GetNonNullBitmapForColumn</a></div><div class="ttdeci">Status GetNonNullBitmapForColumn(int idx, Slice *data) const</div></div>
<div class="ttc" id="aclasskudu_1_1client_1_1KuduScanner_html"><div class="ttname"><a href="classkudu_1_1client_1_1KuduScanner.html">kudu::client::KuduScanner</a></div><div class="ttdoc">This class is a representation of a single scan.</div><div class="ttdef"><b>Definition:</b> client.h:2456</div></div>
<div class="ttc" id="astatus_8h_html"><div class="ttname"><a href="status_8h.html">status.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/>
<address class="footer">
<small>Generated for Kudu version 1.15.0 on Mon Jun 21 2021 20:36:36 by Doxygen 1.9.1</small>
<br>
<small>Copyright © 2021 The Apache Software Foundation.</small>
</address>
</body>
</html>