Google Git
Sign in
apache / impala / asf-site / . / doc / html / classimpala_1_1HBaseTableFactory.html
blob: 507ef7ab012dfde82ad2081dbe105375777802dd [file] [log] [blame]
<!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.6"/>
<title>Impala: impala::HBaseTableFactory 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">Impala
</div>
<div id="projectbrief">Impalaistheopensource,nativeanalyticdatabaseforApacheHadoop.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</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">
$(document).ready(function(){initNavTree('classimpala_1_1HBaseTableFactory.html','');});
</script>
<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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="classimpala_1_1HBaseTableFactory-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">impala::HBaseTableFactory Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="hbase-table-factory_8h_source.html">hbase-table-factory.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for impala::HBaseTableFactory:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1HBaseTableFactory__coll__graph.svg" width="383" height="272"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<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:aea080f7128422463b0500e635f7de0a4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1HBaseTableFactory.html#aea080f7128422463b0500e635f7de0a4">~HBaseTableFactory</a> ()</td></tr>
<tr class="separator:aea080f7128422463b0500e635f7de0a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2c95838564669dd767c071cde9afac4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1HBaseTableFactory.html#ae2c95838564669dd767c071cde9afac4">GetTable</a> (const std::string &amp;table_name, boost::scoped_ptr&lt; <a class="el" href="classimpala_1_1HBaseTable.html">HBaseTable</a> &gt; *hbase_table)</td></tr>
<tr class="separator:ae2c95838564669dd767c071cde9afac4"><td class="memSeparator" colspan="2">&#160;</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:af855c4e6f453cdad8bf24d2112910a10"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classimpala_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1HBaseTableFactory.html#af855c4e6f453cdad8bf24d2112910a10">Init</a> ()</td></tr>
<tr class="separator:af855c4e6f453cdad8bf24d2112910a10"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:af1646e636b599655ca991dfa8156a0f2"><td class="memItemLeft" align="right" valign="top">static jclass&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1HBaseTableFactory.html#af1646e636b599655ca991dfa8156a0f2">executor_cl_</a> = NULL</td></tr>
<tr class="memdesc:af1646e636b599655ca991dfa8156a0f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">ExecutorService class and methods. <a href="#af1646e636b599655ca991dfa8156a0f2">More...</a><br/></td></tr>
<tr class="separator:af1646e636b599655ca991dfa8156a0f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a376ded9dd6d030b53a8ddb888a656b9a"><td class="memItemLeft" align="right" valign="top">static jmethodID&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1HBaseTableFactory.html#a376ded9dd6d030b53a8ddb888a656b9a">executor_shutdown_id_</a> = NULL</td></tr>
<tr class="separator:a376ded9dd6d030b53a8ddb888a656b9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4d5109c9025c7b29d556f80aa2204a6"><td class="memItemLeft" align="right" valign="top">static jobject&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1HBaseTableFactory.html#ac4d5109c9025c7b29d556f80aa2204a6">conf_</a> = NULL</td></tr>
<tr class="memdesc:ac4d5109c9025c7b29d556f80aa2204a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration and executor jobject's. Initialized in <a class="el" href="classimpala_1_1HBaseTableFactory.html#af855c4e6f453cdad8bf24d2112910a10">Init()</a>. <a href="#ac4d5109c9025c7b29d556f80aa2204a6">More...</a><br/></td></tr>
<tr class="separator:ac4d5109c9025c7b29d556f80aa2204a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1becbc83508764f7455b3044a6cd5753"><td class="memItemLeft" align="right" valign="top">static jobject&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1HBaseTableFactory.html#a1becbc83508764f7455b3044a6cd5753">executor_</a> = NULL</td></tr>
<tr class="separator:a1becbc83508764f7455b3044a6cd5753"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A (process-wide) factory of HTable java objects. This object keeps java objects around to ease creation of HTables that share a pool of threads and connections. TODO: Consider writing factory in Java to save JNI logic (and to avoid having to mark objects as global refs) TODO: Implement a cache to avoid creating more HTables than necessary TODO: Add metrics to track the number of tables outstanding </p>
<p>Definition at line <a class="el" href="hbase-table-factory_8h_source.html#l00034">34</a> of file <a class="el" href="hbase-table-factory_8h_source.html">hbase-table-factory.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aea080f7128422463b0500e635f7de0a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">impala::HBaseTableFactory::~HBaseTableFactory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hbase-table-factory_8cc_source.html#l00093">93</a> of file <a class="el" href="hbase-table-factory_8cc_source.html">hbase-table-factory.cc</a>.</p>
<p>References <a class="el" href="hbase-table-factory_8h_source.html#l00055">conf_</a>, <a class="el" href="hbase-table-factory_8h_source.html#l00056">executor_</a>, <a class="el" href="hbase-table-factory_8h_source.html#l00052">executor_shutdown_id_</a>, and <a class="el" href="jni-util_8h.html#a5469ac47d225e5773fe76593a75f29c6">getJNIEnv()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae2c95838564669dd767c071cde9afac4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classimpala_1_1Status.html">Status</a> impala::HBaseTableFactory::GetTable </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>table_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::scoped_ptr&lt; <a class="el" href="classimpala_1_1HBaseTable.html">HBaseTable</a> &gt; *&#160;</td>
<td class="paramname"><em>hbase_table</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>create an HTable java object for the given table name. The new htable is returned in global_htable It is the caller's responsibility to close the <a class="el" href="classimpala_1_1HBaseTable.html" title="Class to wrap JNI calls into HTable. ">HBaseTable</a> using <a class="el" href="classimpala_1_1HBaseTable.html#a03ece6791c03869f9a3698729ad2732d" title="Close and release the HTable wrapped by this class. ">HBaseTable::Close()</a>. </p>
<p>Definition at line <a class="el" href="hbase-table-factory_8cc_source.html#l00107">107</a> of file <a class="el" href="hbase-table-factory_8cc_source.html">hbase-table-factory.cc</a>.</p>
<p>References <a class="el" href="hbase-table-factory_8h_source.html#l00055">conf_</a>, <a class="el" href="hbase-table-factory_8h_source.html#l00056">executor_</a>, <a class="el" href="status_8h_source.html#l00087">impala::Status::OK</a>, and <a class="el" href="status_8h_source.html#l00242">RETURN_IF_ERROR</a>.</p>
<p>Referenced by <a class="el" href="hbase-table-writer_8cc_source.html#l00052">impala::HBaseTableWriter::Init()</a>, and <a class="el" href="hbase-table-scanner_8cc_source.html#l00290">impala::HBaseTableScanner::ScanSetup()</a>.</p>
</div>
</div>
<a class="anchor" id="af855c4e6f453cdad8bf24d2112910a10"></a>
<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="classimpala_1_1Status.html">Status</a> impala::HBaseTableFactory::Init </td>
<td>(</td>
<td class="paramname"></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">
<p>JNI setup. Create global references to classes, and find method ids. </p>
<p>Definition at line <a class="el" href="hbase-table-factory_8cc_source.html#l00032">32</a> of file <a class="el" href="hbase-table-factory_8cc_source.html">hbase-table-factory.cc</a>.</p>
<p>References <a class="el" href="hbase-table-factory_8h_source.html#l00055">conf_</a>, <a class="el" href="hbase-table-factory_8h_source.html#l00056">executor_</a>, <a class="el" href="hbase-table-factory_8h_source.html#l00051">executor_cl_</a>, <a class="el" href="hbase-table-factory_8h_source.html#l00052">executor_shutdown_id_</a>, <a class="el" href="jni-util_8h.html#a5469ac47d225e5773fe76593a75f29c6">getJNIEnv()</a>, <a class="el" href="hbase-table_8cc_source.html#l00092">impala::HBaseTable::InitJNI()</a>, <a class="el" href="jni-util_8cc_source.html#l00067">impala::JniUtil::LocalToGlobalRef()</a>, <a class="el" href="status_8h_source.html#l00087">impala::Status::OK</a>, <a class="el" href="jni-util_8h_source.html#l00099">RETURN_ERROR_IF_EXC</a>, and <a class="el" href="status_8h_source.html#l00242">RETURN_IF_ERROR</a>.</p>
<p>Referenced by <a class="el" href="impalad-main_8cc_source.html#l00054">main()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ac4d5109c9025c7b29d556f80aa2204a6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">jobject impala::HBaseTableFactory::conf_ = NULL</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Configuration and executor jobject's. Initialized in <a class="el" href="classimpala_1_1HBaseTableFactory.html#af855c4e6f453cdad8bf24d2112910a10">Init()</a>. </p>
<p>Definition at line <a class="el" href="hbase-table-factory_8h_source.html#l00055">55</a> of file <a class="el" href="hbase-table-factory_8h_source.html">hbase-table-factory.h</a>.</p>
<p>Referenced by <a class="el" href="hbase-table-factory_8cc_source.html#l00107">GetTable()</a>, <a class="el" href="hbase-table-factory_8cc_source.html#l00032">Init()</a>, and <a class="el" href="hbase-table-factory_8cc_source.html#l00093">~HBaseTableFactory()</a>.</p>
</div>
</div>
<a class="anchor" id="a1becbc83508764f7455b3044a6cd5753"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">jobject impala::HBaseTableFactory::executor_ = NULL</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hbase-table-factory_8h_source.html#l00056">56</a> of file <a class="el" href="hbase-table-factory_8h_source.html">hbase-table-factory.h</a>.</p>
<p>Referenced by <a class="el" href="hbase-table-factory_8cc_source.html#l00107">GetTable()</a>, <a class="el" href="hbase-table-factory_8cc_source.html#l00032">Init()</a>, and <a class="el" href="hbase-table-factory_8cc_source.html#l00093">~HBaseTableFactory()</a>.</p>
</div>
</div>
<a class="anchor" id="af1646e636b599655ca991dfa8156a0f2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">jclass impala::HBaseTableFactory::executor_cl_ = NULL</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>ExecutorService class and methods. </p>
<p>Definition at line <a class="el" href="hbase-table-factory_8h_source.html#l00051">51</a> of file <a class="el" href="hbase-table-factory_8h_source.html">hbase-table-factory.h</a>.</p>
<p>Referenced by <a class="el" href="hbase-table-factory_8cc_source.html#l00032">Init()</a>.</p>
</div>
</div>
<a class="anchor" id="a376ded9dd6d030b53a8ddb888a656b9a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">jmethodID impala::HBaseTableFactory::executor_shutdown_id_ = NULL</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="hbase-table-factory_8h_source.html#l00052">52</a> of file <a class="el" href="hbase-table-factory_8h_source.html">hbase-table-factory.h</a>.</p>
<p>Referenced by <a class="el" href="hbase-table-factory_8cc_source.html#l00032">Init()</a>, and <a class="el" href="hbase-table-factory_8cc_source.html#l00093">~HBaseTableFactory()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>be/src/runtime/<a class="el" href="hbase-table-factory_8h_source.html">hbase-table-factory.h</a></li>
<li>be/src/runtime/<a class="el" href="hbase-table-factory_8cc_source.html">hbase-table-factory.cc</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceimpala.html">impala</a></li><li class="navelem"><a class="el" href="classimpala_1_1HBaseTableFactory.html">HBaseTableFactory</a></li>
<li class="footer">Generated on Thu May 7 2015 16:10:49 for Impala by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>