http://git-wip-us.apache.org/repos/asf/hbase-site/blob/dbfeb6d6/1.2/apidocs/org/apache/hadoop/hbase/HTableDescriptor.html ---------------------------------------------------------------------- diff --git a/1.2/apidocs/org/apache/hadoop/hbase/HTableDescriptor.html b/1.2/apidocs/org/apache/hadoop/hbase/HTableDescriptor.html new file mode 100644 index 0000000..3d2ca78 --- /dev/null +++ b/1.2/apidocs/org/apache/hadoop/hbase/HTableDescriptor.html @@ -0,0 +1,2618 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>HTableDescriptor (Apache HBase 1.2.4 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="HTableDescriptor (Apache HBase 1.2.4 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":42,"i20":10,"i21":42,"i22":10,"i23":10,"i24":41,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":9,"i40":10,"i41":9,"i42":42,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":42,"i57":42,"i58":10,"i59":42,"i60":42,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":42}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/HTableDescriptor.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/hadoop/hbase/HRegionLocation.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/InvalidFamilyOperationException.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/HTableDescriptor.html" target="_top">Frames</a></li> +<li><a href="HTableDescriptor.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hadoop.hbase</div> +<h2 title="Class HTableDescriptor" class="title">Class HTableDescriptor</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.HTableDescriptor</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a>>, org.apache.hadoop.io.Writable, org.apache.hadoop.io.WritableComparable<<a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a>></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/hadoop/hbase/client/UnmodifyableHTableDescriptor.html" title="class in org.apache.hadoop.hbase.client">UnmodifyableHTableDescriptor</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceAudience.Public + @InterfaceStability.Evolving +public class <span class="typeNameLabel">HTableDescriptor</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements org.apache.hadoop.io.WritableComparable<<a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a>></pre> +<div class="block">HTableDescriptor contains the details about an HBase table such as the descriptors of + all the column families, is the table a catalog table, <code> -ROOT- </code> or + <code> hbase:meta </code>, if the table is read only, the maximum size of the memstore, + when the region split should occur, coprocessors associated with it etc...</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#COMPACTION_ENABLED">COMPACTION_ENABLED</a></span></code> +<div class="block"><em>INTERNAL</em> Used by HBase Shell interface to access this metadata + attribute which denotes if the table is compaction enabled</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#DEFAULT_COMPACTION_ENABLED">DEFAULT_COMPACTION_ENABLED</a></span></code> +<div class="block">Constant that denotes whether the table is compaction enabled by default</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#DEFAULT_MEMSTORE_FLUSH_SIZE">DEFAULT_MEMSTORE_FLUSH_SIZE</a></span></code> +<div class="block">Constant that denotes the maximum default size of the memstore after which + the contents are flushed to the store files</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#DEFAULT_NORMALIZATION_ENABLED">DEFAULT_NORMALIZATION_ENABLED</a></span></code> +<div class="block">Constant that denotes whether the table is normalized by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#DEFAULT_READONLY">DEFAULT_READONLY</a></span></code> +<div class="block">Constant that denotes whether the table is READONLY by default and is false</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#DEFAULT_REGION_MEMSTORE_REPLICATION">DEFAULT_REGION_MEMSTORE_REPLICATION</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#DEFAULT_REGION_REPLICATION">DEFAULT_REGION_REPLICATION</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#DEFERRED_LOG_FLUSH">DEFERRED_LOG_FLUSH</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#DURABILITY"><code>DURABILITY</code></a> instead.</span></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#DURABILITY">DURABILITY</a></span></code> +<div class="block"><em>INTERNAL</em> <a href="../../../../org/apache/hadoop/hbase/client/Durability.html" title="enum in org.apache.hadoop.hbase.client"><code>Durability</code></a> setting for the table.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#FLUSH_POLICY">FLUSH_POLICY</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#IS_META">IS_META</a></span></code> +<div class="block"><em>INTERNAL</em> Used by rest interface to access this metadata + attribute which denotes if it is a catalog table, either + <code> hbase:meta </code> or <code> -ROOT- </code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#IS_ROOT">IS_ROOT</a></span></code> +<div class="block"><em>INTERNAL</em> Used by rest interface to access this metadata + attribute which denotes if the table is a -ROOT- region or not</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#MAX_FILESIZE">MAX_FILESIZE</a></span></code> +<div class="block"><em>INTERNAL</em> Used by HBase Shell interface to access this metadata + attribute which denotes the maximum size of the store file after which + a region split occurs</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#MEMSTORE_FLUSHSIZE">MEMSTORE_FLUSHSIZE</a></span></code> +<div class="block"><em>INTERNAL</em> Used by HBase Shell interface to access this metadata + attribute which represents the maximum size of the memstore after which + its contents are flushed onto the disk</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#META_TABLEDESC">META_TABLEDESC</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Use TableDescriptors#get(TableName.META_TABLE_NAME) or + HBaseAdmin#getTableDescriptor(TableName.META_TABLE_NAME) instead.</span></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#NAMESPACE_COL_DESC_BYTES">NAMESPACE_COL_DESC_BYTES</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#NAMESPACE_FAMILY_INFO">NAMESPACE_FAMILY_INFO</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#NAMESPACE_FAMILY_INFO_BYTES">NAMESPACE_FAMILY_INFO_BYTES</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#NAMESPACE_TABLEDESC">NAMESPACE_TABLEDESC</a></span></code> +<div class="block">Table descriptor for namespace table</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#NORMALIZATION_ENABLED">NORMALIZATION_ENABLED</a></span></code> +<div class="block"><em>INTERNAL</em> Used by shell/rest interface to access this metadata + attribute which denotes if the table should be treated by region normalizer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#OWNER">OWNER</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#OWNER_KEY">OWNER_KEY</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#READONLY">READONLY</a></span></code> +<div class="block"><em>INTERNAL</em> Used by rest interface to access this metadata + attribute which denotes if the table is Read Only</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#REGION_MEMSTORE_REPLICATION">REGION_MEMSTORE_REPLICATION</a></span></code> +<div class="block"><em>INTERNAL</em> flag to indicate whether or not the memstore should be replicated + for read-replicas (CONSISTENCY => TIMELINE).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#REGION_REPLICATION">REGION_REPLICATION</a></span></code> +<div class="block"><em>INTERNAL</em> number of region replicas for the table.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#SPLIT_POLICY">SPLIT_POLICY</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#HTableDescriptor--">HTableDescriptor</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">As of release 0.96 + (<a href="https://issues.apache.org/jira/browse/HBASE-5453">HBASE-5453</a>). + This will be removed in HBase 2.0.0. + Used by Writables and Writables are going away.</span></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#HTableDescriptor-byte:A-">HTableDescriptor</a></span>(byte[] name)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#HTableDescriptor-org.apache.hadoop.hbase.HTableDescriptor-">HTableDescriptor</a></span>(<a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a> desc)</code> +<div class="block">Construct a table descriptor by cloning the descriptor passed as a parameter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#HTableDescriptor-java.lang.String-">HTableDescriptor</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#HTableDescriptor-org.apache.hadoop.hbase.TableName-">HTableDescriptor</a></span>(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> name)</code> +<div class="block">Construct a table descriptor specifying a TableName object</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#HTableDescriptor-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.HColumnDescriptor:A-">HTableDescriptor</a></span>(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> name, + <a href="../../../../org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase">HColumnDescriptor</a>[] families)</code> +<div class="block"><em> INTERNAL </em> Private constructor used internally creating table descriptors for + catalog tables, <code>hbase:meta</code> and <code>-ROOT-</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#HTableDescriptor-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.HColumnDescriptor:A-java.util.Map-">HTableDescriptor</a></span>(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> name, + <a href="../../../../org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase">HColumnDescriptor</a>[] families, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/hadoop/hbase/io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<a href="../../../../org/apache/hadoop/hbase/io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>> values)</code> +<div class="block"><em> INTERNAL </em>Private constructor used internally creating table descriptors for + catalog tables, <code>hbase:meta</code> and <code>-ROOT-</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#HTableDescriptor-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.HTableDescriptor-">HTableDescriptor</a></span>(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> name, + <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a> desc)</code> +<div class="block">Construct a table descriptor by cloning the descriptor passed as a parameter + but using a different table name.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#addCoprocessor-java.lang.String-">addCoprocessor</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className)</code> +<div class="block">Add a table coprocessor to this table.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#addCoprocessor-java.lang.String-org.apache.hadoop.fs.Path-int-java.util.Map-">addCoprocessor</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className, + org.apache.hadoop.fs.Path jarFilePath, + int priority, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> kvs)</code> +<div class="block">Add a table coprocessor to this table.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#addCoprocessorWithSpec-java.lang.String-">addCoprocessorWithSpec</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> specStr)</code> +<div class="block">Add a table coprocessor to this table.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#addFamily-org.apache.hadoop.hbase.HColumnDescriptor-">addFamily</a></span>(<a href="../../../../org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase">HColumnDescriptor</a> family)</code> +<div class="block">Adds a column family.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#compareTo-org.apache.hadoop.hbase.HTableDescriptor-">compareTo</a></span>(<a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a> other)</code> +<div class="block">Compares the descriptor with another descriptor which is passed as a parameter.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.TableSchema</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#convert--">convert</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#convert-org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.TableSchema-">convert</a></span>(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.TableSchema ts)</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#equals-java.lang.Object-">equals</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> +<div class="block">Compare the contents of the descriptor with another one passed as a parameter.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase">HColumnDescriptor</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getColumnFamilies--">getColumnFamilies</a></span>()</code> +<div class="block">Returns an array all the <a href="../../../../org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase"><code>HColumnDescriptor</code></a> of the column families + of the table.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getConfiguration--">getConfiguration</a></span>()</code> +<div class="block">Getter for fetching an unmodifiable <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#configuration"><code>configuration</code></a> map.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getConfigurationValue-java.lang.String-">getConfigurationValue</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> +<div class="block">Getter for accessing the configuration value by key</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getCoprocessors--">getCoprocessors</a></span>()</code> +<div class="block">Return the list of attached co-processor represented by their name className</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/client/Durability.html" title="enum in org.apache.hadoop.hbase.client">Durability</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getDurability--">getDurability</a></span>()</code> +<div class="block">Returns the durability setting for the table.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase">HColumnDescriptor</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getFamilies--">getFamilies</a></span>()</code> +<div class="block">Returns an unmodifiable collection of all the <a href="../../../../org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase"><code>HColumnDescriptor</code></a> + of all the column families of the table.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><byte[]></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getFamiliesKeys--">getFamiliesKeys</a></span>()</code> +<div class="block">Returns all the column family names of the current table.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase">HColumnDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getFamily-byte:A-">getFamily</a></span>(byte[] column)</code> +<div class="block">Returns the HColumnDescriptor for a specific column family with name as + specified by the parameter column.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getFlushPolicyClassName--">getFlushPolicyClassName</a></span>()</code> +<div class="block">This gets the class associated with the flush policy which determines the stores need to be + flushed when flushing a region.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getMaxFileSize--">getMaxFileSize</a></span>()</code> +<div class="block">Returns the maximum size upto which a region can grow to after which a region + split is triggered.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getMemStoreFlushSize--">getMemStoreFlushSize</a></span>()</code> +<div class="block">Returns the size of the memstore after which a flush to filesystem is triggered.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getName--">getName</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getTableName--"><code>getTableName()</code></a> instead</span></div> +</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getNameAsString--">getNameAsString</a></span>()</code> +<div class="block">Get the name of the table as a String</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getOwnerString--">getOwnerString</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getRegionReplication--">getRegionReplication</a></span>()</code> +<div class="block">Returns the configured replicas per region</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getRegionSplitPolicyClassName--">getRegionSplitPolicyClassName</a></span>()</code> +<div class="block">This gets the class associated with the region split policy which + determines when a region split should occur.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getTableDir-org.apache.hadoop.fs.Path-byte:A-">getTableDir</a></span>(org.apache.hadoop.fs.Path rootdir, + byte[] tableName)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getTableName--">getTableName</a></span>()</code> +<div class="block">Get the name of the table</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getValue-byte:A-">getValue</a></span>(byte[] key)</code> +<div class="block">Getter for accessing the metadata associated with the key</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getValue-java.lang.String-">getValue</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> +<div class="block">Getter for accessing the metadata associated with the key</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/hadoop/hbase/io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<a href="../../../../org/apache/hadoop/hbase/io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getValues--">getValues</a></span>()</code> +<div class="block">Getter for fetching an unmodifiable <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#values"><code>values</code></a> map.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#hasCoprocessor-java.lang.String-">hasCoprocessor</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> classNameToMatch)</code> +<div class="block">Check if the table has an attached co-processor represented by the name className</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#hasFamily-byte:A-">hasFamily</a></span>(byte[] familyName)</code> +<div class="block">Checks to see if this table contains the given column family</div> +</td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#hasRegionMemstoreReplication--">hasRegionMemstoreReplication</a></span>()</code> </td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#isCompactionEnabled--">isCompactionEnabled</a></span>()</code> +<div class="block">Check if the compaction enable flag of the table is true.</div> +</td> +</tr> +<tr id="i34" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#isMetaRegion--">isMetaRegion</a></span>()</code> +<div class="block">Checks if this table is <code> hbase:meta </code> + region.</div> +</td> +</tr> +<tr id="i35" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#isMetaTable--">isMetaTable</a></span>()</code> +<div class="block">Checks if the table is a <code>hbase:meta</code> table</div> +</td> +</tr> +<tr id="i36" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#isNormalizationEnabled--">isNormalizationEnabled</a></span>()</code> +<div class="block">Check if normalization enable flag of the table is true.</div> +</td> +</tr> +<tr id="i37" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#isReadOnly--">isReadOnly</a></span>()</code> +<div class="block">Check if the readOnly flag of the table is set.</div> +</td> +</tr> +<tr id="i38" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#isRootRegion--">isRootRegion</a></span>()</code> +<div class="block">Check if the descriptor represents a <code> -ROOT- </code> region.</div> +</td> +</tr> +<tr id="i39" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#metaTableDescriptor-org.apache.hadoop.conf.Configuration-">metaTableDescriptor</a></span>(org.apache.hadoop.conf.Configuration conf)</code> </td> +</tr> +<tr id="i40" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#modifyFamily-org.apache.hadoop.hbase.HColumnDescriptor-">modifyFamily</a></span>(<a href="../../../../org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase">HColumnDescriptor</a> family)</code> +<div class="block">Modifies the existing column family.</div> +</td> +</tr> +<tr id="i41" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] bytes)</code> </td> +</tr> +<tr id="i42" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#readFields-java.io.DataInput-">readFields</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</a> in)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Writables are going away. Use pb <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#parseFrom-byte:A-"><code>parseFrom(byte[])</code></a> instead.</span></div> +</div> +</td> +</tr> +<tr id="i43" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#remove-byte:A-">remove</a></span>(byte[] key)</code> +<div class="block">Remove metadata represented by the key from the <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#values"><code>values</code></a> map</div> +</td> +</tr> +<tr id="i44" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#remove-org.apache.hadoop.hbase.io.ImmutableBytesWritable-">remove</a></span>(<a href="../../../../org/apache/hadoop/hbase/io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a> key)</code> +<div class="block">Remove metadata represented by the key from the <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#values"><code>values</code></a> map</div> +</td> +</tr> +<tr id="i45" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#remove-java.lang.String-">remove</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> +<div class="block">Remove metadata represented by the key from the <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#values"><code>values</code></a> map</div> +</td> +</tr> +<tr id="i46" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#removeConfiguration-java.lang.String-">removeConfiguration</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> +<div class="block">Remove a config setting represented by the key from the <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#configuration"><code>configuration</code></a> map</div> +</td> +</tr> +<tr id="i47" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#removeCoprocessor-java.lang.String-">removeCoprocessor</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className)</code> +<div class="block">Remove a coprocessor from those set on the table</div> +</td> +</tr> +<tr id="i48" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase">HColumnDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#removeFamily-byte:A-">removeFamily</a></span>(byte[] column)</code> +<div class="block">Removes the HColumnDescriptor with name specified by the parameter column + from the table descriptor</div> +</td> +</tr> +<tr id="i49" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setCompactionEnabled-boolean-">setCompactionEnabled</a></span>(boolean isEnable)</code> +<div class="block">Setting the table compaction enable flag.</div> +</td> +</tr> +<tr id="i50" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setConfiguration-java.lang.String-java.lang.String-">setConfiguration</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code> +<div class="block">Setter for storing a configuration setting in <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#configuration"><code>configuration</code></a> map.</div> +</td> +</tr> +<tr id="i51" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setDurability-org.apache.hadoop.hbase.client.Durability-">setDurability</a></span>(<a href="../../../../org/apache/hadoop/hbase/client/Durability.html" title="enum in org.apache.hadoop.hbase.client">Durability</a> durability)</code> +<div class="block">Sets the <a href="../../../../org/apache/hadoop/hbase/client/Durability.html" title="enum in org.apache.hadoop.hbase.client"><code>Durability</code></a> setting for the table.</div> +</td> +</tr> +<tr id="i52" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setFlushPolicyClassName-java.lang.String-">setFlushPolicyClassName</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clazz)</code> +<div class="block">This sets the class associated with the flush policy which determines determines the stores + need to be flushed when flushing a region.</div> +</td> +</tr> +<tr id="i53" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setMaxFileSize-long-">setMaxFileSize</a></span>(long maxFileSize)</code> +<div class="block">Sets the maximum size upto which a region can grow to after which a region + split is triggered.</div> +</td> +</tr> +<tr id="i54" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setMemStoreFlushSize-long-">setMemStoreFlushSize</a></span>(long memstoreFlushSize)</code> +<div class="block">Represents the maximum size of the memstore after which the contents of the + memstore are flushed to the filesystem.</div> +</td> +</tr> +<tr id="i55" class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setMetaRegion-boolean-">setMetaRegion</a></span>(boolean isMeta)</code> +<div class="block"><em> INTERNAL </em> Used to denote if the current table represents + <code> -ROOT- </code> or <code> hbase:meta </code> region.</div> +</td> +</tr> +<tr id="i56" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setName-byte:A-">setName</a></span>(byte[] name)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr id="i57" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setName-org.apache.hadoop.hbase.TableName-">setName</a></span>(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> name)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr id="i58" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setNormalizationEnabled-boolean-">setNormalizationEnabled</a></span>(boolean isEnable)</code> +<div class="block">Setting the table normalization enable flag.</div> +</td> +</tr> +<tr id="i59" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setOwner-org.apache.hadoop.hbase.security.User-">setOwner</a></span>(<a href="../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> owner)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr id="i60" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setOwnerString-java.lang.String-">setOwnerString</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ownerString)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr id="i61" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setReadOnly-boolean-">setReadOnly</a></span>(boolean readOnly)</code> +<div class="block">Setting the table as read only sets all the columns in the table as read + only.</div> +</td> +</tr> +<tr id="i62" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setRegionMemstoreReplication-boolean-">setRegionMemstoreReplication</a></span>(boolean memstoreReplication)</code> +<div class="block">Enable or Disable the memstore replication from the primary region to the replicas.</div> +</td> +</tr> +<tr id="i63" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setRegionReplication-int-">setRegionReplication</a></span>(int regionReplication)</code> +<div class="block">Sets the number of replicas per region.</div> +</td> +</tr> +<tr id="i64" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setRegionSplitPolicyClassName-java.lang.String-">setRegionSplitPolicyClassName</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clazz)</code> +<div class="block">This sets the class associated with the region split policy which + determines when a region split should occur.</div> +</td> +</tr> +<tr id="i65" class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setRootRegion-boolean-">setRootRegion</a></span>(boolean isRoot)</code> +<div class="block"><em> INTERNAL </em> Used to denote if the current table represents + <code> -ROOT- </code> region.</div> +</td> +</tr> +<tr id="i66" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setValue-byte:A-byte:A-">setValue</a></span>(byte[] key, + byte[] value)</code> +<div class="block">Setter for storing metadata as a (key, value) pair in <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#values"><code>values</code></a> map</div> +</td> +</tr> +<tr id="i67" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setValue-org.apache.hadoop.hbase.io.ImmutableBytesWritable-org.apache.hadoop.hbase.io.ImmutableBytesWritable-">setValue</a></span>(<a href="../../../../org/apache/hadoop/hbase/io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a> key, + <a href="../../../../org/apache/hadoop/hbase/io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a> value)</code> </td> +</tr> +<tr id="i68" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#setValue-java.lang.String-java.lang.String-">setValue</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code> +<div class="block">Setter for storing metadata as a (key, value) pair in <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#values"><code>values</code></a> map</div> +</td> +</tr> +<tr id="i69" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#toByteArray--">toByteArray</a></span>()</code> </td> +</tr> +<tr id="i70" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#toString--">toString</a></span>()</code> </td> +</tr> +<tr id="i71" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#toStringCustomizedValues--">toStringCustomizedValues</a></span>()</code> </td> +</tr> +<tr id="i72" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#toStringTableAttributes--">toStringTableAttributes</a></span>()</code> </td> +</tr> +<tr id="i73" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#write-java.io.DataOutput-">write</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</a> out)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Writables are going away. + Use <code>MessageLite.toByteArray()</code> instead.</span></div> +</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-ex ternal=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="SPLIT_POLICY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SPLIT_POLICY</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SPLIT_POLICY</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.SPLIT_POLICY">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="MAX_FILESIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MAX_FILESIZE</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAX_FILESIZE</pre> +<div class="block"><em>INTERNAL</em> Used by HBase Shell interface to access this metadata + attribute which denotes the maximum size of the store file after which + a region split occurs</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getMaxFileSize--"><code>getMaxFileSize()</code></a>, +<a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.MAX_FILESIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="OWNER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OWNER</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OWNER</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.OWNER">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="OWNER_KEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OWNER_KEY</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a> OWNER_KEY</pre> +</li> +</ul> +<a name="READONLY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>READONLY</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> READONLY</pre> +<div class="block"><em>INTERNAL</em> Used by rest interface to access this metadata + attribute which denotes if the table is Read Only</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#isReadOnly--"><code>isReadOnly()</code></a>, +<a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.READONLY">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="COMPACTION_ENABLED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COMPACTION_ENABLED</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> COMPACTION_ENABLED</pre> +<div class="block"><em>INTERNAL</em> Used by HBase Shell interface to access this metadata + attribute which denotes if the table is compaction enabled</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#isCompactionEnabled--"><code>isCompactionEnabled()</code></a>, +<a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.COMPACTION_ENABLED">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="MEMSTORE_FLUSHSIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MEMSTORE_FLUSHSIZE</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MEMSTORE_FLUSHSIZE</pre> +<div class="block"><em>INTERNAL</em> Used by HBase Shell interface to access this metadata + attribute which represents the maximum size of the memstore after which + its contents are flushed onto the disk</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#getMemStoreFlushSize--"><code>getMemStoreFlushSize()</code></a>, +<a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.MEMSTORE_FLUSHSIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="FLUSH_POLICY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FLUSH_POLICY</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> FLUSH_POLICY</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.FLUSH_POLICY">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="IS_ROOT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_ROOT</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> IS_ROOT</pre> +<div class="block"><em>INTERNAL</em> Used by rest interface to access this metadata + attribute which denotes if the table is a -ROOT- region or not</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#isRootRegion--"><code>isRootRegion()</code></a>, +<a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.IS_ROOT">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="IS_META"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_META</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> IS_META</pre> +<div class="block"><em>INTERNAL</em> Used by rest interface to access this metadata + attribute which denotes if it is a catalog table, either + <code> hbase:meta </code> or <code> -ROOT- </code></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#isMetaRegion--"><code>isMetaRegion()</code></a>, +<a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.IS_META">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFERRED_LOG_FLUSH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFERRED_LOG_FLUSH</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFERRED_LOG_FLUSH</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#DURABILITY"><code>DURABILITY</code></a> instead.</span></div> +<div class="block"><em>INTERNAL</em> Used by HBase Shell interface to access this metadata + attribute which denotes if the deferred log flush option is enabled.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.DEFERRED_LOG_FLUSH">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DURABILITY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DURABILITY</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DURABILITY</pre> +<div class="block"><em>INTERNAL</em> <a href="../../../../org/apache/hadoop/hbase/client/Durability.html" title="enum in org.apache.hadoop.hbase.client"><code>Durability</code></a> setting for the table.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.DURABILITY">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="REGION_REPLICATION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>REGION_REPLICATION</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> REGION_REPLICATION</pre> +<div class="block"><em>INTERNAL</em> number of region replicas for the table.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.REGION_REPLICATION">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="REGION_MEMSTORE_REPLICATION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>REGION_MEMSTORE_REPLICATION</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> REGION_MEMSTORE_REPLICATION</pre> +<div class="block"><em>INTERNAL</em> flag to indicate whether or not the memstore should be replicated + for read-replicas (CONSISTENCY => TIMELINE).</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.REGION_MEMSTORE_REPLICATION">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="NORMALIZATION_ENABLED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NORMALIZATION_ENABLED</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> NORMALIZATION_ENABLED</pre> +<div class="block"><em>INTERNAL</em> Used by shell/rest interface to access this metadata + attribute which denotes if the table should be treated by region normalizer.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html#isNormalizationEnabled--"><code>isNormalizationEnabled()</code></a>, +<a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.NORMALIZATION_ENABLED">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_READONLY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_READONLY</h4> +<pre>public static final boolean DEFAULT_READONLY</pre> +<div class="block">Constant that denotes whether the table is READONLY by default and is false</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.DEFAULT_READONLY">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_COMPACTION_ENABLED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_COMPACTION_ENABLED</h4> +<pre>public static final boolean DEFAULT_COMPACTION_ENABLED</pre> +<div class="block">Constant that denotes whether the table is compaction enabled by default</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.DEFAULT_COMPACTION_ENABLED">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_NORMALIZATION_ENABLED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_NORMALIZATION_ENABLED</h4> +<pre>public static final boolean DEFAULT_NORMALIZATION_ENABLED</pre> +<div class="block">Constant that denotes whether the table is normalized by default.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.DEFAULT_NORMALIZATION_ENABLED">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_MEMSTORE_FLUSH_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_MEMSTORE_FLUSH_SIZE</h4> +<pre>public static final long DEFAULT_MEMSTORE_FLUSH_SIZE</pre> +<div class="block">Constant that denotes the maximum default size of the memstore after which + the contents are flushed to the store files</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.DEFAULT_MEMSTORE_FLUSH_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_REGION_REPLICATION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_REGION_REPLICATION</h4> +<pre>public static final int DEFAULT_REGION_REPLICATION</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.DEFAULT_REGION_REPLICATION">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_REGION_MEMSTORE_REPLICATION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_REGION_MEMSTORE_REPLICATION</h4> +<pre>public static final boolean DEFAULT_REGION_MEMSTORE_REPLICATION</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.DEFAULT_REGION_MEMSTORE_REPLICATION">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="META_TABLEDESC"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>META_TABLEDESC</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +public static final <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a> META_TABLEDESC</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use TableDescriptors#get(TableName.META_TABLE_NAME) or + HBaseAdmin#getTableDescriptor(TableName.META_TABLE_NAME) instead.</span></div> +<div class="block">Table descriptor for <code>hbase:meta</code> catalog table</div> +</li> +</ul> +<a name="NAMESPACE_FAMILY_INFO"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NAMESPACE_FAMILY_INFO</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> NAMESPACE_FAMILY_INFO</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HTableDescriptor.NAMESPACE_FAMILY_INFO">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="NAMESPACE_FAMILY_INFO_BYTES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NAMESPACE_FAMILY_INFO_BYTES</h4> +<pre>public static final byte[] NAMESPACE_FAMILY_INFO_BYTES</pre> +</li> +</ul> +<a name="NAMESPACE_COL_DESC_BYTES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NAMESPACE_COL_DESC_BYTES</h4> +<pre>public static final byte[] NAMESPACE_COL_DESC_BYTES</pre> +</li> +</ul> +<a name="NAMESPACE_TABLEDESC"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NAMESPACE_TABLEDESC</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a> NAMESPACE_TABLEDESC</pre> +<div class="block">Table descriptor for namespace table</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="HTableDescriptor-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.HColumnDescriptor:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HTableDescriptor</h4> +<pre>@InterfaceAudience.Private +protected HTableDescriptor(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> name, + <a href="../../../../org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase">HColumnDescriptor</a>[] families)</pre> +<div class="block"><em> INTERNAL </em> Private constructor used internally creating table descriptors for + catalog tables, <code>hbase:meta</code> and <code>-ROOT-</code>.</div> +</li> +</ul> +<a name="HTableDescriptor-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.HColumnDescriptor:A-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HTableDescriptor</h4> +<pre>protected HTableDescriptor(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> name, + <a href="../../../../org/apache/hadoop/hbase/HColumnDescriptor.html" title="class in org.apache.hadoop.hbase">HColumnDescriptor</a>[] families, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/hadoop/hbase/io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<a href="../../../../org/apache/hadoop/hbase/io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>> values)</pre> +<div class="block"><em> INTERNAL </em>Private constructor used internally creating table descriptors for + catalog tables, <code>hbase:meta</code> and <code>-ROOT-</code>.</div> +</li> +</ul> +<a name="HTableDescriptor--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HTableDescriptor</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +public HTableDescriptor()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of release 0.96 + (<a href="https://issues.apache.org/jira/browse/HBASE-5453">HBASE-5453</a>). + This will be removed in HBase 2.0.0. + Used by Writables and Writables are going away.</span></div> +<div class="block">Default constructor which constructs an empty object. + For deserializing an HTableDescriptor instance only.</div> +</li> +</ul> +<a name="HTableDescriptor-org.apache.hadoop.hbase.TableName-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HTableDescriptor</h4> +<pre>public HTableDescriptor(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> name)</pre> +<div class="block">Construct a table descriptor specifying a TableName object</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - Table name.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="HADOOP-1581">HADOOP-1581 HBASE: Un-openable tablename bug</a></dd> +</dl> +</li> +</ul> +<a name="HTableDescriptor-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HTableDescriptor</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +public HTableDescriptor(byte[] name)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Construct a table descriptor specifying a byte array table name</div> +<dl> +<dt><span class="paramLabel"
<TRUNCATED>