Google Git
Sign in
apache / kudu / gh-pages / . / releases / 1.18.0 / cpp-client-api / classkudu_1_1client_1_1KuduColumnStorageAttributes.html
blob: 0b0d36627e810069e1fc897cfc12d98ff6b20302 [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: kudu::client::KuduColumnStorageAttributes 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('classkudu_1_1client_1_1KuduColumnStorageAttributes.html','','classkudu_1_1client_1_1KuduColumnStorageAttributes-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">kudu::client::KuduColumnStorageAttributes Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Representation of column storage attributes.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="schema_8h_source.html">schema.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-types" class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aeb835a12e6f40b1a619afa8abd773b6d" id="r_aeb835a12e6f40b1a619afa8abd773b6d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeb835a12e6f40b1a619afa8abd773b6d">EncodingType</a> { <br />
&#160;&#160;<b>AUTO_ENCODING</b> = 0
, <b>PLAIN_ENCODING</b> = 1
, <b>PREFIX_ENCODING</b> = 2
, <b>RLE</b> = 4
, <br />
&#160;&#160;<b>DICT_ENCODING</b> = 5
, <b>BIT_SHUFFLE</b> = 6
, <a class="el" href="#aeb835a12e6f40b1a619afa8abd773b6da28c1ed31be30579070232164c24b4b82">GROUP_VARINT</a> = 3
<br />
}</td></tr>
<tr class="memdesc:aeb835a12e6f40b1a619afa8abd773b6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Column encoding types. <a href="#aeb835a12e6f40b1a619afa8abd773b6d">More...</a><br /></td></tr>
<tr class="memitem:af579406931a40daa5cb9e10603341a78" id="r_af579406931a40daa5cb9e10603341a78"><td class="memItemLeft" align="right" valign="top"><a id="af579406931a40daa5cb9e10603341a78" name="af579406931a40daa5cb9e10603341a78"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af579406931a40daa5cb9e10603341a78">CompressionType</a> { <br />
&#160;&#160;<b>DEFAULT_COMPRESSION</b> = 0
, <b>NO_COMPRESSION</b> = 1
, <b>SNAPPY</b> = 2
, <b>LZ4</b> = 3
, <br />
&#160;&#160;<b>ZLIB</b> = 4
<br />
}</td></tr>
<tr class="memdesc:af579406931a40daa5cb9e10603341a78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Column compression types. <br /></td></tr>
</table><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:a9bd5f6bce0a7369da5cd1f60341d1d71" id="r_a9bd5f6bce0a7369da5cd1f60341d1d71"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9bd5f6bce0a7369da5cd1f60341d1d71">KuduColumnStorageAttributes</a> (<a class="el" href="#aeb835a12e6f40b1a619afa8abd773b6d">EncodingType</a> <a class="el" href="#a7d0f25ffc47a1f00a17697dd0fe1d12b">encoding</a>=AUTO_ENCODING, <a class="el" href="#af579406931a40daa5cb9e10603341a78">CompressionType</a> <a class="el" href="#a46e1dace4602244a3b7b6f43bf7f5554">compression</a>=DEFAULT_COMPRESSION, int32_t block_size=0)</td></tr>
<tr class="memitem:a7d0f25ffc47a1f00a17697dd0fe1d12b" id="r_a7d0f25ffc47a1f00a17697dd0fe1d12b"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="#aeb835a12e6f40b1a619afa8abd773b6d">EncodingType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7d0f25ffc47a1f00a17697dd0fe1d12b">encoding</a> () const</td></tr>
<tr class="memitem:a46e1dace4602244a3b7b6f43bf7f5554" id="r_a46e1dace4602244a3b7b6f43bf7f5554"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="#af579406931a40daa5cb9e10603341a78">CompressionType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a46e1dace4602244a3b7b6f43bf7f5554">compression</a> () const</td></tr>
<tr class="memitem:a0da01080a8e4c078d6bf3d9fe749db11" id="r_a0da01080a8e4c078d6bf3d9fe749db11"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0da01080a8e4c078d6bf3d9fe749db11">ToString</a> () const</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-static-methods" class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a5422435108d868ad7379e03c8bf516db" id="r_a5422435108d868ad7379e03c8bf516db"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5422435108d868ad7379e03c8bf516db">StringToEncodingType</a> (const std::string &amp;<a class="el" href="#a7d0f25ffc47a1f00a17697dd0fe1d12b">encoding</a>, <a class="el" href="#aeb835a12e6f40b1a619afa8abd773b6d">EncodingType</a> *type)</td></tr>
<tr class="memitem:af497b47eaaa28205a8a6a5a4362954af" id="r_af497b47eaaa28205a8a6a5a4362954af"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af497b47eaaa28205a8a6a5a4362954af">StringToCompressionType</a> (const std::string &amp;<a class="el" href="#a46e1dace4602244a3b7b6f43bf7f5554">compression</a>, <a class="el" href="#af579406931a40daa5cb9e10603341a78">CompressionType</a> *type)</td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Representation of column storage attributes. </p>
</div><a name="doc-enum-members" id="doc-enum-members"></a><h2 id="header-doc-enum-members" class="groupheader">Member Enumeration Documentation</h2>
<a id="aeb835a12e6f40b1a619afa8abd773b6d" name="aeb835a12e6f40b1a619afa8abd773b6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb835a12e6f40b1a619afa8abd773b6d">&#9670;&#160;</a></span>EncodingType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#aeb835a12e6f40b1a619afa8abd773b6d">kudu::client::KuduColumnStorageAttributes::EncodingType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Column encoding types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aeb835a12e6f40b1a619afa8abd773b6da28c1ed31be30579070232164c24b4b82" name="aeb835a12e6f40b1a619afa8abd773b6da28c1ed31be30579070232164c24b4b82"></a>GROUP_VARINT&#160;</td><td class="fielddoc"><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated</a></b></dt><dd>GROUP_VARINT is not supported for valid types, and will fall back to another encoding on the server side. </dd></dl>
</td></tr>
</table>
</div>
</div>
<a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9bd5f6bce0a7369da5cd1f60341d1d71" name="a9bd5f6bce0a7369da5cd1f60341d1d71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bd5f6bce0a7369da5cd1f60341d1d71">&#9670;&#160;</a></span>KuduColumnStorageAttributes()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">kudu::client::KuduColumnStorageAttributes::KuduColumnStorageAttributes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#aeb835a12e6f40b1a619afa8abd773b6d">EncodingType</a></td> <td class="paramname"><span class="paramname"><em>encoding</em></span><span class="paramdefsep"> = </span><span class="paramdefval">AUTO_ENCODING</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#af579406931a40daa5cb9e10603341a78">CompressionType</a></td> <td class="paramname"><span class="paramname"><em>compression</em></span><span class="paramdefsep"> = </span><span class="paramdefval">DEFAULT_COMPRESSION</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t</td> <td class="paramname"><span class="paramname"><em>block_size</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel explicit">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated</a></b></dt><dd>This constructor is deprecated for external use, and will be made private in a future release.</dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000010">Todo</a></b></dt><dd>Make this constructor private.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">encoding</td><td>Encoding type for the column storage. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">compression</td><td>Compression type for the column storage. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">block_size</td><td>Block size (in bytes, uncompressed data) for the column storage. </td></tr>
</table>
</dd>
</dl>
</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="a46e1dace4602244a3b7b6f43bf7f5554" name="a46e1dace4602244a3b7b6f43bf7f5554"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46e1dace4602244a3b7b6f43bf7f5554">&#9670;&#160;</a></span>compression()</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="#af579406931a40daa5cb9e10603341a78">CompressionType</a> kudu::client::KuduColumnStorageAttributes::compression </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">
<dl class="section return"><dt>Returns</dt><dd>Compression type for the column storage. </dd></dl>
</div>
</div>
<a id="a7d0f25ffc47a1f00a17697dd0fe1d12b" name="a7d0f25ffc47a1f00a17697dd0fe1d12b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d0f25ffc47a1f00a17697dd0fe1d12b">&#9670;&#160;</a></span>encoding()</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="#aeb835a12e6f40b1a619afa8abd773b6d">EncodingType</a> kudu::client::KuduColumnStorageAttributes::encoding </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">
<dl class="section return"><dt>Returns</dt><dd>Encoding type for the column storage. </dd></dl>
</div>
</div>
<a id="af497b47eaaa28205a8a6a5a4362954af" name="af497b47eaaa28205a8a6a5a4362954af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af497b47eaaa28205a8a6a5a4362954af">&#9670;&#160;</a></span>StringToCompressionType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkudu_1_1Status.html">Status</a> kudu::client::KuduColumnStorageAttributes::StringToCompressionType </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>compression</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#af579406931a40daa5cb9e10603341a78">CompressionType</a> *</td> <td class="paramname"><span class="paramname"><em>type</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </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">compression</td><td>String representation of the column compression type </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">type</td><td>Enum representation of the column compression type, Converted from string format. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. </dd></dl>
</div>
</div>
<a id="a5422435108d868ad7379e03c8bf516db" name="a5422435108d868ad7379e03c8bf516db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5422435108d868ad7379e03c8bf516db">&#9670;&#160;</a></span>StringToEncodingType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkudu_1_1Status.html">Status</a> kudu::client::KuduColumnStorageAttributes::StringToEncodingType </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>encoding</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#aeb835a12e6f40b1a619afa8abd773b6d">EncodingType</a> *</td> <td class="paramname"><span class="paramname"><em>type</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </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">encoding</td><td>String representation of the column encoding type </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">type</td><td>Enum representation of the column encoding type, Converted from string format. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Operation result status. </dd></dl>
</div>
</div>
<a id="a0da01080a8e4c078d6bf3d9fe749db11" name="a0da01080a8e4c078d6bf3d9fe749db11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0da01080a8e4c078d6bf3d9fe749db11">&#9670;&#160;</a></span>ToString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string kudu::client::KuduColumnStorageAttributes::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 of the storage attributes. </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="schema_8h_source.html">schema.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>