| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Kudu C++ client API: kudu::client::KuduColumnSchema Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr 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.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </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'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </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"><b>kudu</b></li><li class="navelem"><b>client</b></li><li class="navelem"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html">KuduColumnSchema</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classkudu_1_1client_1_1KuduColumnSchema-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">kudu::client::KuduColumnSchema Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Representation of the column schema. |
| <a href="classkudu_1_1client_1_1KuduColumnSchema.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="schema_8h_source.html">schema.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:aba69238e70af5c887a4fb11fa2a120c5"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#aba69238e70af5c887a4fb11fa2a120c5">DataType</a> { <br /> |
|   <b>INT8</b> = 0, |
| <b>INT16</b> = 1, |
| <b>INT32</b> = 2, |
| <b>INT64</b> = 3, |
| <br /> |
|   <b>STRING</b> = 4, |
| <b>BOOL</b> = 5, |
| <b>FLOAT</b> = 6, |
| <b>DOUBLE</b> = 7, |
| <br /> |
|   <b>BINARY</b> = 8, |
| <b>UNIXTIME_MICROS</b> = 9, |
| <b>DECIMAL</b> = 10, |
| <a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#aba69238e70af5c887a4fb11fa2a120c5a27d1b7aca7cf9a01d9258a41bbe3b505">TIMESTAMP</a> = UNIXTIME_MICROS |
| <br /> |
| }<tr class="memdesc:aba69238e70af5c887a4fb11fa2a120c5"><td class="mdescLeft"> </td><td class="mdescRight">Supported data types for columns. <a href="classkudu_1_1client_1_1KuduColumnSchema.html#aba69238e70af5c887a4fb11fa2a120c5">More...</a><br /></td></tr> |
| </td></tr> |
| <tr class="separator:aba69238e70af5c887a4fb11fa2a120c5"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:afc82e98af83ba61079ba5d30401b5872"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#afc82e98af83ba61079ba5d30401b5872">KuduColumnSchema</a> (const <a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html">KuduColumnSchema</a> &other)</td></tr> |
| <tr class="separator:afc82e98af83ba61079ba5d30401b5872"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4b58da787c8e7dc14987aa74a54f199e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html">KuduColumnSchema</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#a4b58da787c8e7dc14987aa74a54f199e">operator=</a> (const <a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html">KuduColumnSchema</a> &other)</td></tr> |
| <tr class="separator:a4b58da787c8e7dc14987aa74a54f199e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a11234db43eb8b758a65ba1b08f6b65b0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#a11234db43eb8b758a65ba1b08f6b65b0">CopyFrom</a> (const <a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html">KuduColumnSchema</a> &other)</td></tr> |
| <tr class="separator:a11234db43eb8b758a65ba1b08f6b65b0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaf2cdb1424600e420601b68b8dd05c3a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#aaf2cdb1424600e420601b68b8dd05c3a">Equals</a> (const <a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html">KuduColumnSchema</a> &other) const</td></tr> |
| <tr class="separator:aaf2cdb1424600e420601b68b8dd05c3a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a328c76411dd00f5f6a7ee063ce90c65e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduColumnTypeAttributes.html">KuduColumnTypeAttributes</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#a328c76411dd00f5f6a7ee063ce90c65e">type_attributes</a> () const</td></tr> |
| <tr class="separator:a328c76411dd00f5f6a7ee063ce90c65e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a04b9d65ed5d347bf3cffa5419a756c9f"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#a04b9d65ed5d347bf3cffa5419a756c9f">comment</a> () const</td></tr> |
| <tr class="separator:a04b9d65ed5d347bf3cffa5419a756c9f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr><td colspan="2"><div class="groupHeader">Getters to expose column schema information.</div></td></tr> |
| <tr><td colspan="2"><div class="groupText"><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000011">Todo:</a></b></dt><dd>Expose default column value and attributes?</dd></dl> |
| <dl class="section return"><dt>Returns</dt><dd>Name of the column schema. </dd></dl> |
| </div></td></tr> |
| <tr class="memitem:a1cda4c693af7226ddde29bf70da4cfcf"><td class="memItemLeft" align="right" valign="top"><a id="a1cda4c693af7226ddde29bf70da4cfcf"></a> |
| const std::string & </td><td class="memItemRight" valign="bottom"><b>name</b> () const</td></tr> |
| <tr class="separator:a1cda4c693af7226ddde29bf70da4cfcf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af790ddd7fa63b208a55da4afc0b3dc29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#aba69238e70af5c887a4fb11fa2a120c5">DataType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#af790ddd7fa63b208a55da4afc0b3dc29">type</a> () const</td></tr> |
| <tr class="separator:af790ddd7fa63b208a55da4afc0b3dc29"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3f8197dd468546ce83e21481a361c1ec"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#a3f8197dd468546ce83e21481a361c1ec">is_nullable</a> () const</td></tr> |
| <tr class="separator:a3f8197dd468546ce83e21481a361c1ec"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:af362af4f9c937c2b7fa90ef284cfbd1c"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#af362af4f9c937c2b7fa90ef284cfbd1c">DataTypeToString</a> (<a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#aba69238e70af5c887a4fb11fa2a120c5">DataType</a> <a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#af790ddd7fa63b208a55da4afc0b3dc29">type</a>)</td></tr> |
| <tr class="separator:af362af4f9c937c2b7fa90ef284cfbd1c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Representation of the column schema. </p> |
| </div><h2 class="groupheader">Member Enumeration Documentation</h2> |
| <a id="aba69238e70af5c887a4fb11fa2a120c5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aba69238e70af5c887a4fb11fa2a120c5">◆ </a></span>DataType</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#aba69238e70af5c887a4fb11fa2a120c5">kudu::client::KuduColumnSchema::DataType</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Supported data types for columns. </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aba69238e70af5c887a4fb11fa2a120c5a27d1b7aca7cf9a01d9258a41bbe3b505"></a>TIMESTAMP </td><td class="fielddoc"><p>deprecated, use UNIXTIME_MICROS </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="afc82e98af83ba61079ba5d30401b5872"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afc82e98af83ba61079ba5d30401b5872">◆ </a></span>KuduColumnSchema()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">kudu::client::KuduColumnSchema::KuduColumnSchema </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html">KuduColumnSchema</a> & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Construct <a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html" title="Representation of the column schema. ">KuduColumnSchema</a> object as a copy of another object.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>The reference object to copy from. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a04b9d65ed5d347bf3cffa5419a756c9f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a04b9d65ed5d347bf3cffa5419a756c9f">◆ </a></span>comment()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::string& kudu::client::KuduColumnSchema::comment </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>comment of the column schema.</dd></dl> |
| <dl class="section note"><dt>Note</dt><dd>An empty string will be returned if there is no comment. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a11234db43eb8b758a65ba1b08f6b65b0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a11234db43eb8b758a65ba1b08f6b65b0">◆ </a></span>CopyFrom()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void kudu::client::KuduColumnSchema::CopyFrom </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html">KuduColumnSchema</a> & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Make this object an identical copy of the other one.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>The reference object to copy from. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="af362af4f9c937c2b7fa90ef284cfbd1c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af362af4f9c937c2b7fa90ef284cfbd1c">◆ </a></span>DataTypeToString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static std::string kudu::client::KuduColumnSchema::DataTypeToString </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#aba69238e70af5c887a4fb11fa2a120c5">DataType</a> </td> |
| <td class="paramname"><em>type</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Column data type. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>String representation of the column data type. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aaf2cdb1424600e420601b68b8dd05c3a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaf2cdb1424600e420601b68b8dd05c3a">◆ </a></span>Equals()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool kudu::client::KuduColumnSchema::Equals </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html">KuduColumnSchema</a> & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Check whether the object is identical to the other one.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>The reference object to compare with. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> iff the object is identical to the specified one. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a3f8197dd468546ce83e21481a361c1ec"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3f8197dd468546ce83e21481a361c1ec">◆ </a></span>is_nullable()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool kudu::client::KuduColumnSchema::is_nullable </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> iff the column schema has the nullable attribute set. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a4b58da787c8e7dc14987aa74a54f199e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4b58da787c8e7dc14987aa74a54f199e">◆ </a></span>operator=()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html">KuduColumnSchema</a>& kudu::client::KuduColumnSchema::operator= </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html">KuduColumnSchema</a> & </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>The assignment operator.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>The reference object to assign from. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The updated object. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="af790ddd7fa63b208a55da4afc0b3dc29"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af790ddd7fa63b208a55da4afc0b3dc29">◆ </a></span>type()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduColumnSchema.html#aba69238e70af5c887a4fb11fa2a120c5">DataType</a> kudu::client::KuduColumnSchema::type </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>Type of the column schema. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a328c76411dd00f5f6a7ee063ce90c65e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a328c76411dd00f5f6a7ee063ce90c65e">◆ </a></span>type_attributes()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduColumnTypeAttributes.html">KuduColumnTypeAttributes</a> kudu::client::KuduColumnSchema::type_attributes </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>Type attributes of the column schema. </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 --> |
| <!-- start footer part --> |
| <hr class="footer"/> |
| <address class="footer"> |
| <small>Generated for Kudu version 1.11.1 on Tue Nov 19 2019 23:11:03 by Doxygen 1.8.13</small> |
| <br> |
| <small>Copyright © 2019 The Apache Software Foundation.</small> |
| </address> |
| </body> |
| </html> |
