| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>iceberg-cpp: iceberg/catalog/hive/hms_client.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">iceberg-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_a7beda0dac529a54d3cdf90e787bdce7.html">catalog</a></li><li class="navelem"><a class="el" href="dir_84b526a9b166937dfaa5c194acfccb63.html">hive</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">hms_client.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="hms__client_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <string_view></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include "<a class="code" href="hive__catalog__properties_8h.html">iceberg/catalog/hive/hive_catalog_properties.h</a>"</span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include "<a class="code" href="iceberg__hive__export_8h.html">iceberg/catalog/hive/iceberg_hive_export.h</a>"</span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">iceberg/result.h</a>"</span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg_1_1hive.html">iceberg::hive</a> {</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="namespaceiceberg_1_1hive.html#ab49e066f157b4da08ca41b933484470a"> 39</a></span><span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="namespaceiceberg_1_1hive.html#ab49e066f157b4da08ca41b933484470a">kDefaultHmsPort</a> = 9083;</div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div> |
| <div class="foldopen" id="foldopen00050" data-start="{" data-end="};"> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="structiceberg_1_1hive_1_1HmsEndpoint.html"> 50</a></span><span class="keyword">struct </span>ICEBERG_HIVE_EXPORT <a class="code hl_struct" href="structiceberg_1_1hive_1_1HmsEndpoint.html">HmsEndpoint</a> {</div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> std::string host;</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">int</span> port = <a class="code hl_variable" href="namespaceiceberg_1_1hive.html#ab49e066f157b4da08ca41b933484470a">kDefaultHmsPort</a>;</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>};</div> |
| </div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="namespaceiceberg_1_1hive.html#a27c51b7c7c62afef919b21a2eccbb491"> 61</a></span>ICEBERG_HIVE_EXPORT <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::vector<HmsEndpoint></a>> <a class="code hl_function" href="namespaceiceberg_1_1hive.html#a27c51b7c7c62afef919b21a2eccbb491">ParseHmsUris</a>(std::string_view uri);</div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div> |
| <div class="foldopen" id="foldopen00068" data-start="{" data-end="};"> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classiceberg_1_1hive_1_1HmsClient.html"> 68</a></span><span class="keyword">class </span>ICEBERG_HIVE_EXPORT <a class="code hl_class" href="classiceberg_1_1hive_1_1HmsClient.html">HmsClient</a> {</div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <a class="code hl_class" href="classiceberg_1_1hive_1_1HmsClient.html">~HmsClient</a>();</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <a class="code hl_class" href="classiceberg_1_1hive_1_1HmsClient.html">HmsClient</a>(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1hive_1_1HmsClient.html">HmsClient</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <a class="code hl_class" href="classiceberg_1_1hive_1_1HmsClient.html">HmsClient</a>& operator=(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1hive_1_1HmsClient.html">HmsClient</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <a class="code hl_class" href="classiceberg_1_1hive_1_1HmsClient.html">HmsClient</a>(<a class="code hl_class" href="classiceberg_1_1hive_1_1HmsClient.html">HmsClient</a>&&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <a class="code hl_class" href="classiceberg_1_1hive_1_1HmsClient.html">HmsClient</a>& operator=(<a class="code hl_class" href="classiceberg_1_1hive_1_1HmsClient.html">HmsClient</a>&&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div> |
| <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="classiceberg_1_1hive_1_1HmsClient.html#a7e4ec8a08726af68b7ec81a6882732d6"> 82</a></span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::unique_ptr<HmsClient></a>> <a class="code hl_function" href="classiceberg_1_1hive_1_1HmsClient.html#a7e4ec8a08726af68b7ec81a6882732d6">Connect</a>(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1hive_1_1HiveCatalogProperties.html">HiveCatalogProperties</a>& config);</div> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">class </span>Impl;</div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> std::unique_ptr<Impl> impl_;</div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1hive_1_1HmsClient.html">HmsClient</a>(std::unique_ptr<Impl> impl);</div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span>};</div> |
| </div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div> |
| <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>} <span class="comment">// namespace iceberg::hive</span></div> |
| <div class="ttc" id="aclassiceberg_1_1hive_1_1HiveCatalogProperties_html"><div class="ttname"><a href="classiceberg_1_1hive_1_1HiveCatalogProperties.html">iceberg::hive::HiveCatalogProperties</a></div><div class="ttdoc">Configuration for the iceberg_hive HiveCatalog.</div><div class="ttdef"><b>Definition</b> hive_catalog_properties.h:47</div></div> |
| <div class="ttc" id="aclassiceberg_1_1hive_1_1HmsClient_html"><div class="ttname"><a href="classiceberg_1_1hive_1_1HmsClient.html">iceberg::hive::HmsClient</a></div><div class="ttdoc">A live connection to a Hive Metastore over Thrift.</div><div class="ttdef"><b>Definition</b> hms_client.h:68</div></div> |
| <div class="ttc" id="aclassiceberg_1_1hive_1_1HmsClient_html_a7e4ec8a08726af68b7ec81a6882732d6"><div class="ttname"><a href="classiceberg_1_1hive_1_1HmsClient.html#a7e4ec8a08726af68b7ec81a6882732d6">iceberg::hive::HmsClient::Connect</a></div><div class="ttdeci">static Result< std::unique_ptr< HmsClient > > Connect(const HiveCatalogProperties &config)</div><div class="ttdoc">Connect to the Hive Metastore described by config.</div></div> |
| <div class="ttc" id="ahive__catalog__properties_8h_html"><div class="ttname"><a href="hive__catalog__properties_8h.html">hive_catalog_properties.h</a></div><div class="ttdoc">Configuration for connecting to a Hive Metastore (HMS) over Thrift.</div></div> |
| <div class="ttc" id="aiceberg__hive__export_8h_html"><div class="ttname"><a href="iceberg__hive__export_8h.html">iceberg_hive_export.h</a></div><div class="ttdoc">Define symbol visibility macros for the Hive catalog library.</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1hive_html"><div class="ttname"><a href="namespaceiceberg_1_1hive.html">iceberg::hive</a></div><div class="ttdoc">Hive catalog APIs.</div><div class="ttdef"><b>Definition</b> hive_catalog.h:34</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1hive_html_a27c51b7c7c62afef919b21a2eccbb491"><div class="ttname"><a href="namespaceiceberg_1_1hive.html#a27c51b7c7c62afef919b21a2eccbb491">iceberg::hive::ParseHmsUris</a></div><div class="ttdeci">ICEBERG_HIVE_EXPORT Result< std::vector< HmsEndpoint > > ParseHmsUris(std::string_view uri)</div><div class="ttdoc">Parse an HMS URI string into one or more endpoints.</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1hive_html_ab49e066f157b4da08ca41b933484470a"><div class="ttname"><a href="namespaceiceberg_1_1hive.html#ab49e066f157b4da08ca41b933484470a">iceberg::hive::kDefaultHmsPort</a></div><div class="ttdeci">constexpr int kDefaultHmsPort</div><div class="ttdoc">Hive's well-known metastore port, used when an HMS URI omits one.</div><div class="ttdef"><b>Definition</b> hms_client.h:39</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a9d5594e371beb516b0120e07e69d3af6"><div class="ttname"><a href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">iceberg::Result</a></div><div class="ttdeci">std::expected< T, E > Result</div><div class="ttdoc">Result alias.</div><div class="ttdef"><b>Definition</b> result.h:88</div></div> |
| <div class="ttc" id="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></div><div class="ttdoc">Define Result, Status, and error helpers.</div></div> |
| <div class="ttc" id="astructiceberg_1_1hive_1_1HmsEndpoint_html"><div class="ttname"><a href="structiceberg_1_1hive_1_1HmsEndpoint.html">iceberg::hive::HmsEndpoint</a></div><div class="ttdoc">A single host:port pair parsed from an HMS URI.</div><div class="ttdef"><b>Definition</b> hms_client.h:50</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
| </small></address> |
| </body> |
| </html> |
