blob: 68d9bc3364fa0020cb85c6a79c6caac1dbf6298c [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.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kudu C++ client API: KuduScanBatch::RowPtr 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</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">
$(function(){initNavTree('classKuduScanBatch_1_1RowPtr.html','','classKuduScanBatch_1_1RowPtr-members'); });
</script>
<div id="container">
<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="headertitle"><div class="title">KuduScanBatch::RowPtr Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A handle for a single row in <code><a class="el" href="classKuduScanBatch.html" title="A batch of zero or more rows returned by a scan operation.">KuduScanBatch</a></code>.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="scan__batch_8h_source.html">scan_batch.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a94c98f70ed1d84f13cb10a3b3c7eb434" id="r_a94c98f70ed1d84f13cb10a3b3c7eb434"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a94c98f70ed1d84f13cb10a3b3c7eb434">RowPtr</a> ()</td></tr>
<tr class="memitem:a8ca5e3c03046d74db7e3284ed2763d88" id="r_a8ca5e3c03046d74db7e3284ed2763d88"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classKuduScanBatch_1_1RowPtr.html">RowPtr</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ca5e3c03046d74db7e3284ed2763d88">operator-&gt;</a> () const</td></tr>
<tr class="memitem:a5901567ecb20369d76f85b402e7b31ba" id="r_a5901567ecb20369d76f85b402e7b31ba"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5901567ecb20369d76f85b402e7b31ba">IsNull</a> (const Slice &amp;col_name) const</td></tr>
<tr class="memitem:a88086180e911ca4428429ab4df56f1c8" id="r_a88086180e911ca4428429ab4df56f1c8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a88086180e911ca4428429ab4df56f1c8">IsNull</a> (int col_idx) const</td></tr>
<tr class="memitem:a254abbbffe26644f831fbd0f8edf56be" id="r_a254abbbffe26644f831fbd0f8edf56be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a254abbbffe26644f831fbd0f8edf56be">IsDeleted</a> (bool *val) const WARN_UNUSED_RESULT KUDU_NO_EXPORT</td></tr>
<tr class="memitem:ae0006f0404cf5c2a2b6bba27cb9ac0a7" id="r_ae0006f0404cf5c2a2b6bba27cb9ac0a7"><td class="memItemLeft" align="right" valign="top">const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae0006f0404cf5c2a2b6bba27cb9ac0a7">cell</a> (int col_idx) const</td></tr>
<tr class="memitem:a6d2efc35234caa87572d501a67c9f837" id="r_a6d2efc35234caa87572d501a67c9f837"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6d2efc35234caa87572d501a67c9f837">ToString</a> () const</td></tr>
<tr id="pub-methods-0" class="groupHeader"><td colspan="2"><div class="groupHeader">Getters for integral type columns by column name.</div></td></tr>
<tr class="memitem:a860df4f76dd3cca3610cfe2b87a96147" id="r_a860df4f76dd3cca3610cfe2b87a96147"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a860df4f76dd3cca3610cfe2b87a96147">GetBool</a> (const Slice &amp;col_name, bool *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a7fa0d450022a961e36d6efb9770d8d32" id="r_a7fa0d450022a961e36d6efb9770d8d32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7fa0d450022a961e36d6efb9770d8d32">GetInt8</a> (const Slice &amp;col_name, int8_t *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:abb3e5d25c02e2c9bd6a51c912a7d7865" id="r_abb3e5d25c02e2c9bd6a51c912a7d7865"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abb3e5d25c02e2c9bd6a51c912a7d7865">GetInt16</a> (const Slice &amp;col_name, int16_t *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a9c81fc1e0176f91004b0ca33e82eff73" id="r_a9c81fc1e0176f91004b0ca33e82eff73"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9c81fc1e0176f91004b0ca33e82eff73">GetInt32</a> (const Slice &amp;col_name, int32_t *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:ae378763ab75a4dbb792bd9b4605766c0" id="r_ae378763ab75a4dbb792bd9b4605766c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae378763ab75a4dbb792bd9b4605766c0">GetInt64</a> (const Slice &amp;col_name, int64_t *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:abe46412cb57d3678330af89d290d5745" id="r_abe46412cb57d3678330af89d290d5745"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abe46412cb57d3678330af89d290d5745">GetUnixTimeMicros</a> (const Slice &amp;col_name, int64_t *micros_since_utc_epoch) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a8ad7837eecabc43a0b460b8a84331f7d" id="r_a8ad7837eecabc43a0b460b8a84331f7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ad7837eecabc43a0b460b8a84331f7d">GetDate</a> (const Slice &amp;col_name, int32_t *days_since_unix_epoch) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a027159f61f5807c14f2eb59904212e00" id="r_a027159f61f5807c14f2eb59904212e00"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a027159f61f5807c14f2eb59904212e00">GetFloat</a> (const Slice &amp;col_name, float *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:acbfdfba97781506627dd8c092f639b60" id="r_acbfdfba97781506627dd8c092f639b60"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acbfdfba97781506627dd8c092f639b60">GetDouble</a> (const Slice &amp;col_name, double *val) const WARN_UNUSED_RESULT</td></tr>
<tr id="pub-methods-1" class="groupHeader"><td colspan="2"><div class="groupHeader">Getters for integral type columns by column index.</div></td></tr>
<tr><td colspan="2" class="ititle"><div class="groupText"><p>These methods are faster than their name-based counterparts since using indices avoids a hashmap lookup, so index-based getters should be preferred in performance-sensitive code. </p>
</div></td></tr>
<tr class="memitem:a9f57ed6b9860ba87588a4749f2793144" id="r_a9f57ed6b9860ba87588a4749f2793144"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9f57ed6b9860ba87588a4749f2793144">GetBool</a> (int col_idx, bool *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a2d12bf99f8f79baea8a6b05eb7eb3211" id="r_a2d12bf99f8f79baea8a6b05eb7eb3211"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2d12bf99f8f79baea8a6b05eb7eb3211">GetInt8</a> (int col_idx, int8_t *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a195b181938f08a2b02572f14ea44df6a" id="r_a195b181938f08a2b02572f14ea44df6a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a195b181938f08a2b02572f14ea44df6a">GetInt16</a> (int col_idx, int16_t *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a6aa0306d899eca91de92ddb6aa79a979" id="r_a6aa0306d899eca91de92ddb6aa79a979"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6aa0306d899eca91de92ddb6aa79a979">GetInt32</a> (int col_idx, int32_t *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a2c24d8e0aeeda5ba12efdea0cfe6bc4c" id="r_a2c24d8e0aeeda5ba12efdea0cfe6bc4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2c24d8e0aeeda5ba12efdea0cfe6bc4c">GetInt64</a> (int col_idx, int64_t *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a62007480ab32fe34f39b3698b41009f4" id="r_a62007480ab32fe34f39b3698b41009f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a62007480ab32fe34f39b3698b41009f4">GetUnixTimeMicros</a> (int col_idx, int64_t *micros_since_utc_epoch) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a1ab59ed900d58ae3ec6a708df765adba" id="r_a1ab59ed900d58ae3ec6a708df765adba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1ab59ed900d58ae3ec6a708df765adba">GetDate</a> (int col_idx, int32_t *days_since_unix_epoch) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a6232af67883c8d8b2706c48105e05815" id="r_a6232af67883c8d8b2706c48105e05815"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6232af67883c8d8b2706c48105e05815">GetFloat</a> (int col_idx, float *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a684ed4c2f88bb1704f2902b7840c95de" id="r_a684ed4c2f88bb1704f2902b7840c95de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a684ed4c2f88bb1704f2902b7840c95de">GetDouble</a> (int col_idx, double *val) const WARN_UNUSED_RESULT</td></tr>
<tr id="pub-methods-2" class="groupHeader"><td colspan="2"><div class="groupHeader">Getters for string/binary/varchar column by column name.</div></td></tr>
<tr class="memitem:a1661b402d4e88c614507ececc9ea9448" id="r_a1661b402d4e88c614507ececc9ea9448"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1661b402d4e88c614507ececc9ea9448">GetString</a> (const Slice &amp;col_name, Slice *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a87381f10d0c42e9d8122461e6425ef06" id="r_a87381f10d0c42e9d8122461e6425ef06"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a87381f10d0c42e9d8122461e6425ef06">GetBinary</a> (const Slice &amp;col_name, Slice *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:aa08ea9b4518c5dd97b5fb9a35b84f589" id="r_aa08ea9b4518c5dd97b5fb9a35b84f589"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa08ea9b4518c5dd97b5fb9a35b84f589">GetVarchar</a> (const Slice &amp;col_name, Slice *val) const WARN_UNUSED_RESULT</td></tr>
<tr id="pub-methods-3" class="groupHeader"><td colspan="2"><div class="groupHeader">Getters for string/binary/varchar column by column index.</div></td></tr>
<tr class="memitem:a640e430a209f57ede082380b8b0356c5" id="r_a640e430a209f57ede082380b8b0356c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a640e430a209f57ede082380b8b0356c5">GetString</a> (int col_idx, Slice *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a7a3c1691ff965ba111f6f938d11146ae" id="r_a7a3c1691ff965ba111f6f938d11146ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7a3c1691ff965ba111f6f938d11146ae">GetBinary</a> (int col_idx, Slice *val) const WARN_UNUSED_RESULT</td></tr>
<tr class="memitem:a896198e543bb9452f7c577b86b620036" id="r_a896198e543bb9452f7c577b86b620036"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a896198e543bb9452f7c577b86b620036">GetVarchar</a> (int col_idx, Slice *val) const WARN_UNUSED_RESULT</td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A handle for a single row in <code><a class="el" href="classKuduScanBatch.html" title="A batch of zero or more rows returned by a scan operation.">KuduScanBatch</a></code>. </p>
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a94c98f70ed1d84f13cb10a3b3c7eb434" name="a94c98f70ed1d84f13cb10a3b3c7eb434"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94c98f70ed1d84f13cb10a3b3c7eb434">&#9670;&#160;</a></span>RowPtr()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">kudu::client::KuduScanBatch::RowPtr::RowPtr </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct an invalid <a class="el" href="classKuduScanBatch_1_1RowPtr.html" title="A handle for a single row in KuduScanBatch.">RowPtr</a>. Before use, you must assign a properly-initialized value. </p>
</div>
</div>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="ae0006f0404cf5c2a2b6bba27cb9ac0a7" name="ae0006f0404cf5c2a2b6bba27cb9ac0a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0006f0404cf5c2a2b6bba27cb9ac0a7">&#9670;&#160;</a></span>cell()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void * kudu::client::KuduScanBatch::RowPtr::cell </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the column's row data.</p>
<dl class="section note"><dt>Note</dt><dd>Should be avoided unless absolutely necessary. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Raw cell data for the specified index. </dd></dl>
</div>
</div>
<a id="a87381f10d0c42e9d8122461e6425ef06" name="a87381f10d0c42e9d8122461e6425ef06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87381f10d0c42e9d8122461e6425ef06">&#9670;&#160;</a></span>GetBinary() <span class="overload">[1/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetBinary </td>
<td>(</td>
<td class="paramtype">const Slice &amp;</td> <td class="paramname"><span class="paramname"><em>col_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Slice *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the string/binary/varchar value for a column by its name.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>Name of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting Slice if necessary. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a7a3c1691ff965ba111f6f938d11146ae" name="a7a3c1691ff965ba111f6f938d11146ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a3c1691ff965ba111f6f938d11146ae">&#9670;&#160;</a></span>GetBinary() <span class="overload">[2/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetBinary </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Slice *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the string/binary/varchar value for a column by its index.</p>
<p>These methods are faster than their name-based counterparts since using indices avoids a hashmap lookup, so index-based getters should be preferred in performance-sensitive code.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting Slice if necessary. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a860df4f76dd3cca3610cfe2b87a96147" name="a860df4f76dd3cca3610cfe2b87a96147"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a860df4f76dd3cca3610cfe2b87a96147">&#9670;&#160;</a></span>GetBool() <span class="overload">[1/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetBool </td>
<td>(</td>
<td class="paramtype">const Slice &amp;</td> <td class="paramname"><span class="paramname"><em>col_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>The name of the target column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Placeholder for the result value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a9f57ed6b9860ba87588a4749f2793144" name="a9f57ed6b9860ba87588a4749f2793144"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f57ed6b9860ba87588a4749f2793144">&#9670;&#160;</a></span>GetBool() <span class="overload">[2/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetBool </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a8ad7837eecabc43a0b460b8a84331f7d" name="a8ad7837eecabc43a0b460b8a84331f7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ad7837eecabc43a0b460b8a84331f7d">&#9670;&#160;</a></span>GetDate() <span class="overload">[1/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetDate </td>
<td>(</td>
<td class="paramtype">const Slice &amp;</td> <td class="paramname"><span class="paramname"><em>col_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t *</td> <td class="paramname"><span class="paramname"><em>days_since_unix_epoch</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>The name of the target column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">days_since_unix_epoch</td><td>Placeholder for the result value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a1ab59ed900d58ae3ec6a708df765adba" name="a1ab59ed900d58ae3ec6a708df765adba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ab59ed900d58ae3ec6a708df765adba">&#9670;&#160;</a></span>GetDate() <span class="overload">[2/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetDate </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t *</td> <td class="paramname"><span class="paramname"><em>days_since_unix_epoch</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">days_since_unix_epoch</td><td>Pointer to the placeholder to put the resulting value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="acbfdfba97781506627dd8c092f639b60" name="acbfdfba97781506627dd8c092f639b60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbfdfba97781506627dd8c092f639b60">&#9670;&#160;</a></span>GetDouble() <span class="overload">[1/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetDouble </td>
<td>(</td>
<td class="paramtype">const Slice &amp;</td> <td class="paramname"><span class="paramname"><em>col_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>The name of the target column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Placeholder for the result value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a684ed4c2f88bb1704f2902b7840c95de" name="a684ed4c2f88bb1704f2902b7840c95de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a684ed4c2f88bb1704f2902b7840c95de">&#9670;&#160;</a></span>GetDouble() <span class="overload">[2/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetDouble </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a027159f61f5807c14f2eb59904212e00" name="a027159f61f5807c14f2eb59904212e00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a027159f61f5807c14f2eb59904212e00">&#9670;&#160;</a></span>GetFloat() <span class="overload">[1/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetFloat </td>
<td>(</td>
<td class="paramtype">const Slice &amp;</td> <td class="paramname"><span class="paramname"><em>col_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>The name of the target column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Placeholder for the result value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a6232af67883c8d8b2706c48105e05815" name="a6232af67883c8d8b2706c48105e05815"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6232af67883c8d8b2706c48105e05815">&#9670;&#160;</a></span>GetFloat() <span class="overload">[2/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetFloat </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="abb3e5d25c02e2c9bd6a51c912a7d7865" name="abb3e5d25c02e2c9bd6a51c912a7d7865"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb3e5d25c02e2c9bd6a51c912a7d7865">&#9670;&#160;</a></span>GetInt16() <span class="overload">[1/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetInt16 </td>
<td>(</td>
<td class="paramtype">const Slice &amp;</td> <td class="paramname"><span class="paramname"><em>col_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int16_t *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>The name of the target column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Placeholder for the result value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a195b181938f08a2b02572f14ea44df6a" name="a195b181938f08a2b02572f14ea44df6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a195b181938f08a2b02572f14ea44df6a">&#9670;&#160;</a></span>GetInt16() <span class="overload">[2/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetInt16 </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int16_t *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a9c81fc1e0176f91004b0ca33e82eff73" name="a9c81fc1e0176f91004b0ca33e82eff73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c81fc1e0176f91004b0ca33e82eff73">&#9670;&#160;</a></span>GetInt32() <span class="overload">[1/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetInt32 </td>
<td>(</td>
<td class="paramtype">const Slice &amp;</td> <td class="paramname"><span class="paramname"><em>col_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>The name of the target column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Placeholder for the result value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a6aa0306d899eca91de92ddb6aa79a979" name="a6aa0306d899eca91de92ddb6aa79a979"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6aa0306d899eca91de92ddb6aa79a979">&#9670;&#160;</a></span>GetInt32() <span class="overload">[2/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetInt32 </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ae378763ab75a4dbb792bd9b4605766c0" name="ae378763ab75a4dbb792bd9b4605766c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae378763ab75a4dbb792bd9b4605766c0">&#9670;&#160;</a></span>GetInt64() <span class="overload">[1/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetInt64 </td>
<td>(</td>
<td class="paramtype">const Slice &amp;</td> <td class="paramname"><span class="paramname"><em>col_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>The name of the target column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Placeholder for the result value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a2c24d8e0aeeda5ba12efdea0cfe6bc4c" name="a2c24d8e0aeeda5ba12efdea0cfe6bc4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c24d8e0aeeda5ba12efdea0cfe6bc4c">&#9670;&#160;</a></span>GetInt64() <span class="overload">[2/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetInt64 </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a7fa0d450022a961e36d6efb9770d8d32" name="a7fa0d450022a961e36d6efb9770d8d32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fa0d450022a961e36d6efb9770d8d32">&#9670;&#160;</a></span>GetInt8() <span class="overload">[1/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetInt8 </td>
<td>(</td>
<td class="paramtype">const Slice &amp;</td> <td class="paramname"><span class="paramname"><em>col_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int8_t *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>The name of the target column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Placeholder for the result value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a2d12bf99f8f79baea8a6b05eb7eb3211" name="a2d12bf99f8f79baea8a6b05eb7eb3211"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d12bf99f8f79baea8a6b05eb7eb3211">&#9670;&#160;</a></span>GetInt8() <span class="overload">[2/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetInt8 </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int8_t *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a1661b402d4e88c614507ececc9ea9448" name="a1661b402d4e88c614507ececc9ea9448"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1661b402d4e88c614507ececc9ea9448">&#9670;&#160;</a></span>GetString() <span class="overload">[1/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetString </td>
<td>(</td>
<td class="paramtype">const Slice &amp;</td> <td class="paramname"><span class="paramname"><em>col_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Slice *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the string/binary/varchar value for a column by its name.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>Name of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting Slice if necessary. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a640e430a209f57ede082380b8b0356c5" name="a640e430a209f57ede082380b8b0356c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a640e430a209f57ede082380b8b0356c5">&#9670;&#160;</a></span>GetString() <span class="overload">[2/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetString </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Slice *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the string/binary/varchar value for a column by its index.</p>
<p>These methods are faster than their name-based counterparts since using indices avoids a hashmap lookup, so index-based getters should be preferred in performance-sensitive code.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting Slice if necessary. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="abe46412cb57d3678330af89d290d5745" name="abe46412cb57d3678330af89d290d5745"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe46412cb57d3678330af89d290d5745">&#9670;&#160;</a></span>GetUnixTimeMicros() <span class="overload">[1/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetUnixTimeMicros </td>
<td>(</td>
<td class="paramtype">const Slice &amp;</td> <td class="paramname"><span class="paramname"><em>col_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t *</td> <td class="paramname"><span class="paramname"><em>micros_since_utc_epoch</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>The name of the target column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">micros_since_utc_epoch</td><td>Placeholder for the result value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a62007480ab32fe34f39b3698b41009f4" name="a62007480ab32fe34f39b3698b41009f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62007480ab32fe34f39b3698b41009f4">&#9670;&#160;</a></span>GetUnixTimeMicros() <span class="overload">[2/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetUnixTimeMicros </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t *</td> <td class="paramname"><span class="paramname"><em>micros_since_utc_epoch</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">micros_since_utc_epoch</td><td>Pointer to the placeholder to put the resulting value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="aa08ea9b4518c5dd97b5fb9a35b84f589" name="aa08ea9b4518c5dd97b5fb9a35b84f589"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa08ea9b4518c5dd97b5fb9a35b84f589">&#9670;&#160;</a></span>GetVarchar() <span class="overload">[1/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetVarchar </td>
<td>(</td>
<td class="paramtype">const Slice &amp;</td> <td class="paramname"><span class="paramname"><em>col_name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Slice *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the string/binary/varchar value for a column by its name.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>Name of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting Slice if necessary. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a896198e543bb9452f7c577b86b620036" name="a896198e543bb9452f7c577b86b620036"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a896198e543bb9452f7c577b86b620036">&#9670;&#160;</a></span>GetVarchar() <span class="overload">[2/2]</span></h2>
<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::KuduScanBatch::RowPtr::GetVarchar </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Slice *</td> <td class="paramname"><span class="paramname"><em>val</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the string/binary/varchar value for a column by its index.</p>
<p>These methods are faster than their name-based counterparts since using indices avoids a hashmap lookup, so index-based getters should be preferred in performance-sensitive code.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>The index of the column. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Pointer to the placeholder to put the resulting value. Note that the method does not copy the value. Callers should copy the resulting Slice if necessary. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if at least one of the following is <code>true:</code> <ul>
<li>The type does not match. </li>
<li>The value is unset. </li>
<li>The value is <code>NULL</code>. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a254abbbffe26644f831fbd0f8edf56be" name="a254abbbffe26644f831fbd0f8edf56be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a254abbbffe26644f831fbd0f8edf56be">&#9670;&#160;</a></span>IsDeleted()</h2>
<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::KuduScanBatch::RowPtr::IsDeleted </td>
<td>(</td>
<td class="paramtype">bool *</td> <td class="paramname"><span class="paramname"><em>val</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the value of the IS_DELETED virtual column.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">val</td><td>Placeholder for the result value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. Return a bad <a class="el" href="classStatus.html" title="A representation of an operation&#39;s outcome.">Status</a> if there is no IS_DELETED virtual column in the schema. </dd></dl>
</div>
</div>
<a id="a5901567ecb20369d76f85b402e7b31ba" name="a5901567ecb20369d76f85b402e7b31ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5901567ecb20369d76f85b402e7b31ba">&#9670;&#160;</a></span>IsNull() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kudu::client::KuduScanBatch::RowPtr::IsNull </td>
<td>(</td>
<td class="paramtype">const Slice &amp;</td> <td class="paramname"><span class="paramname"><em>col_name</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_name</td><td>Name of the column. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> iff the specified column of the row has <code>NULL</code> value. </dd></dl>
</div>
</div>
<a id="a88086180e911ca4428429ab4df56f1c8" name="a88086180e911ca4428429ab4df56f1c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88086180e911ca4428429ab4df56f1c8">&#9670;&#160;</a></span>IsNull() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kudu::client::KuduScanBatch::RowPtr::IsNull </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>col_idx</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">col_idx</td><td>Index of the column. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> iff the specified column of the row has <code>NULL</code> value. </dd></dl>
</div>
</div>
<a id="a8ca5e3c03046d74db7e3284ed2763d88" name="a8ca5e3c03046d74db7e3284ed2763d88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ca5e3c03046d74db7e3284ed2763d88">&#9670;&#160;</a></span>operator-&gt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classKuduScanBatch_1_1RowPtr.html">RowPtr</a> * kudu::client::KuduScanBatch::RowPtr::operator-&gt; </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overloaded operator -&gt; to support pointer trait for access via <a class="el" href="classKuduScanBatch_1_1const__iterator.html" title="Iterator to work with immutable KuduScanBatch instances.">const_iterator</a>.</p><dl class="section return"><dt>Returns</dt><dd>Pointer to the row </dd></dl>
</div>
</div>
<a id="a6d2efc35234caa87572d501a67c9f837" name="a6d2efc35234caa87572d501a67c9f837"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d2efc35234caa87572d501a67c9f837">&#9670;&#160;</a></span>ToString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string kudu::client::KuduScanBatch::RowPtr::ToString </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>String representation for this row. </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="scan__batch_8h_source.html">scan_batch.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<hr class="footer"/>
<address class="footer">
<small>Generated for Kudu version 1.18.0 on Wed Jul 9 2025 13:08:41 by Doxygen 1.14.0</small>
<br>
<small>Copyright © 2025 The Apache Software Foundation.</small>
</address>
</body>
</html>