| <!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>TableDescriptor (Apache HBase 4.0.0-alpha-1-SNAPSHOT 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="TableDescriptor (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":17,"i5":6,"i6":6,"i7":18,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":18,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":18,"i34":6}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/TableDescriptor.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/client/TableBuilderBase.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptorBuilder.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/client/TableDescriptor.html" target="_top">Frames</a></li> |
| <li><a href="TableDescriptor.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>Constr | </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>Constr | </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.client</div> |
| <h2 title="Interface TableDescriptor" class="title">Interface TableDescriptor</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptorBuilder.ModifyableTableDescriptor.html" title="class in org.apache.hadoop.hbase.client">TableDescriptorBuilder.ModifyableTableDescriptor</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.40">TableDescriptor</a></pre> |
| <div class="block">TableDescriptor contains the details about an HBase table such as the descriptors of all the |
| column families, is the table a catalog table, <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="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#COMPARATOR">COMPARATOR</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#COMPARATOR_IGNORE_REPLICATION">COMPARATOR_IGNORE_REPLICATION</a></span></code> </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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/client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client">ColumnFamilyDescriptor</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#getColumnFamilies--">getColumnFamilies</a></span>()</code> |
| <div class="block">Returns an unmodifiable collection of all the <a href="../../../../../org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client"><code>ColumnFamilyDescriptor</code></a> of all the column |
| families of the table.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client">ColumnFamilyDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#getColumnFamily-byte:A-">getColumnFamily</a></span>(byte[] name)</code> |
| <div class="block">Returns the ColumnDescriptor for a specific column family with name as specified by the |
| parameter column.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#getColumnFamilyCount--">getColumnFamilyCount</a></span>()</code> |
| <div class="block">Returns the count of the column families of the table.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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/client/TableDescriptor.html#getColumnFamilyNames--">getColumnFamilyNames</a></span>()</code> |
| <div class="block">Returns all the column family names of the current table.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#getComparator-java.util.Comparator-">getComparator</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<a href="../../../../../org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client">ColumnFamilyDescriptor</a>> cfComparator)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/client/CoprocessorDescriptor.html" title="interface in org.apache.hadoop.hbase.client">CoprocessorDescriptor</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#getCoprocessorDescriptors--">getCoprocessorDescriptors</a></span>()</code> |
| <div class="block">Return the list of attached co-processor represented</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/client/TableDescriptor.html#getDurability--">getDurability</a></span>()</code> |
| <div class="block">Returns the durability setting for the table.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/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/client/TableDescriptor.html#getErasureCodingPolicy--">getErasureCodingPolicy</a></span>()</code> |
| <div class="block">The HDFS erasure coding policy for a table.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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/client/TableDescriptor.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="i9" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.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="i10" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.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="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#getNormalizerTargetRegionCount--">getNormalizerTargetRegionCount</a></span>()</code> |
| <div class="block">Check if there is the target region count.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#getNormalizerTargetRegionSize--">getNormalizerTargetRegionSize</a></span>()</code> |
| <div class="block">Check if there is the target region size.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#getPriority--">getPriority</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#getRegionReplication--">getRegionReplication</a></span>()</code> |
| <div class="block">Returns Returns the configured replicas per region</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="https://docs.oracle.com/javase/8/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/client/TableDescriptor.html#getRegionServerGroup--">getRegionServerGroup</a></span>()</code> |
| <div class="block">Get the region server group this table belongs to.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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/client/TableDescriptor.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="i17" 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/client/TableDescriptor.html#getTableName--">getTableName</a></span>()</code> |
| <div class="block">Get the name of the table</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.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="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/util/Bytes.html" title="class in org.apache.hadoop.hbase.util">Bytes</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#getValue-org.apache.hadoop.hbase.util.Bytes-">getValue</a></span>(<a href="../../../../../org/apache/hadoop/hbase/util/Bytes.html" title="class in org.apache.hadoop.hbase.util">Bytes</a> key)</code> |
| <div class="block">Getter for accessing the metadata associated with the key.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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/client/TableDescriptor.html#getValue-java.lang.String-">getValue</a></span>(<a href="https://docs.oracle.com/javase/8/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="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/hadoop/hbase/util/Bytes.html" title="class in org.apache.hadoop.hbase.util">Bytes</a>,<a href="../../../../../org/apache/hadoop/hbase/util/Bytes.html" title="class in org.apache.hadoop.hbase.util">Bytes</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#getValues--">getValues</a></span>()</code> |
| <div class="block">Returns Getter for fetching an unmodifiable map.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#hasColumnFamily-byte:A-">hasColumnFamily</a></span>(byte[] name)</code> |
| <div class="block">Checks to see if this table contains the given column family</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#hasCoprocessor-java.lang.String-">hasCoprocessor</a></span>(<a href="https://docs.oracle.com/javase/8/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="i24" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#hasGlobalReplicationScope--">hasGlobalReplicationScope</a></span>()</code> |
| <div class="block">Check if any of the table's cfs' replication scope are set to |
| <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#REPLICATION_SCOPE_GLOBAL"><code>HConstants.REPLICATION_SCOPE_GLOBAL</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#hasRegionMemStoreReplication--">hasRegionMemStoreReplication</a></span>()</code> |
| <div class="block">Returns true if the read-replicas memstore replication is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.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="i27" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#isMergeEnabled--">isMergeEnabled</a></span>()</code> |
| <div class="block">Check if the merge enable flag of the table is true.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#isMetaRegion--">isMetaRegion</a></span>()</code> |
| <div class="block">Checks if this table is <code> hbase:meta </code> region.</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/client/TableDescriptor.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="i30" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#isNormalizationEnabled--">isNormalizationEnabled</a></span>()</code> |
| <div class="block">Check if normalization enable flag of the table is true.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#isReadOnly--">isReadOnly</a></span>()</code> |
| <div class="block">Check if the readOnly flag of the table is set.</div> |
| </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/client/TableDescriptor.html#isSplitEnabled--">isSplitEnabled</a></span>()</code> |
| <div class="block">Check if the split enable flag of the table is true.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html#matchReplicationScope-boolean-">matchReplicationScope</a></span>(boolean enabled)</code> |
| <div class="block">Check if the table's cfs' replication scope matched with the replication state</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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/client/TableDescriptor.html#toStringCustomizedValues--">toStringCustomizedValues</a></span>()</code> |
| <div class="block">Returns Name of this table and then a map of all of the column family descriptors (with only |
| the non-default column family attributes)</div> |
| </td> |
| </tr> |
| </table> |
| </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="COMPARATOR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>COMPARATOR</h4> |
| <pre>@InterfaceAudience.Private |
| static final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.43">COMPARATOR</a></pre> |
| </li> |
| </ul> |
| <a name="COMPARATOR_IGNORE_REPLICATION"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>COMPARATOR_IGNORE_REPLICATION</h4> |
| <pre>@InterfaceAudience.Private |
| static final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.46">COMPARATOR_IGNORE_REPLICATION</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getComparator-java.util.Comparator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComparator</h4> |
| <pre>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.50">getComparator</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<a href="../../../../../org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client">ColumnFamilyDescriptor</a>> cfComparator)</pre> |
| </li> |
| </ul> |
| <a name="getColumnFamilyCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnFamilyCount</h4> |
| <pre>int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.79">getColumnFamilyCount</a>()</pre> |
| <div class="block">Returns the count of the column families of the table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Count of column families of the table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCoprocessorDescriptors--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCoprocessorDescriptors</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/client/CoprocessorDescriptor.html" title="interface in org.apache.hadoop.hbase.client">CoprocessorDescriptor</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.85">getCoprocessorDescriptors</a>()</pre> |
| <div class="block">Return the list of attached co-processor represented</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The list of CoprocessorDescriptor</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDurability--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDurability</h4> |
| <pre><a href="../../../../../org/apache/hadoop/hbase/client/Durability.html" title="enum in org.apache.hadoop.hbase.client">Durability</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.91">getDurability</a>()</pre> |
| <div class="block">Returns the durability setting for the table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>durability setting for the table.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getColumnFamilies--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnFamilies</h4> |
| <pre><a href="../../../../../org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client">ColumnFamilyDescriptor</a>[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.98">getColumnFamilies</a>()</pre> |
| <div class="block">Returns an unmodifiable collection of all the <a href="../../../../../org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client"><code>ColumnFamilyDescriptor</code></a> of all the column |
| families of the table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An array of <a href="../../../../../org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client"><code>ColumnFamilyDescriptor</code></a> of all the column families.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getColumnFamilyNames--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnFamilyNames</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><byte[]> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.106">getColumnFamilyNames</a>()</pre> |
| <div class="block">Returns all the column family names of the current table. The map of TableDescriptor contains |
| mapping of family name to ColumnDescriptor. This returns all the keys of the family map which |
| represents the column family names of the table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Immutable sorted set of the keys of the families.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getColumnFamily-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnFamily</h4> |
| <pre><a href="../../../../../org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client">ColumnFamilyDescriptor</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.114">getColumnFamily</a>(byte[] name)</pre> |
| <div class="block">Returns the ColumnDescriptor for a specific column family with name as specified by the |
| parameter column.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Column family name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Column descriptor for the passed family name or the family on passed in column.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFlushPolicyClassName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlushPolicyClassName</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.123">getFlushPolicyClassName</a>()</pre> |
| <div class="block">This gets the class associated with the flush policy which determines the stores need to be |
| flushed when flushing a region. The class used by default is defined in |
| org.apache.hadoop.hbase.regionserver.FlushPolicy.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the class name of the flush policy for this table. If this returns null, the default |
| flush policy is used.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxFileSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxFileSize</h4> |
| <pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.130">getMaxFileSize</a>()</pre> |
| <div class="block">Returns the maximum size upto which a region can grow to after which a region split is |
| triggered. The region size is represented by the size of the biggest store file in that region.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>max hregion size for table, -1 if not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMemStoreFlushSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMemStoreFlushSize</h4> |
| <pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.136">getMemStoreFlushSize</a>()</pre> |
| <div class="block">Returns the size of the memstore after which a flush to filesystem is triggered.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>memory cache flush size for each hregion, -1 if not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPriority--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPriority</h4> |
| <pre>int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.141">getPriority</a>()</pre> |
| </li> |
| </ul> |
| <a name="getRegionReplication--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionReplication</h4> |
| <pre>int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.144">getRegionReplication</a>()</pre> |
| <div class="block">Returns Returns the configured replicas per region</div> |
| </li> |
| </ul> |
| <a name="getRegionSplitPolicyClassName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionSplitPolicyClassName</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.153">getRegionSplitPolicyClassName</a>()</pre> |
| <div class="block">This gets the class associated with the region split policy which determines when a region |
| split should occur. The class used by default is defined in |
| org.apache.hadoop.hbase.regionserver.RegionSplitPolicy</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the class name of the region split policy for this table. If this returns null, the |
| default split policy is used.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTableName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTableName</h4> |
| <pre><a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.158">getTableName</a>()</pre> |
| <div class="block">Get the name of the table</div> |
| </li> |
| </ul> |
| <a name="getRegionServerGroup--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionServerGroup</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.165">getRegionServerGroup</a>()</pre> |
| <div class="block">Get the region server group this table belongs to. The regions of this table will be placed |
| only on the region servers within this group. If not present, will be placed on |
| <a href="../../../../../org/apache/hadoop/hbase/rsgroup/RSGroupInfo.html#DEFAULT_GROUP"><code>RSGroupInfo.DEFAULT_GROUP</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getValue-org.apache.hadoop.hbase.util.Bytes-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre><a href="../../../../../org/apache/hadoop/hbase/util/Bytes.html" title="class in org.apache.hadoop.hbase.util">Bytes</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.172">getValue</a>(<a href="../../../../../org/apache/hadoop/hbase/util/Bytes.html" title="class in org.apache.hadoop.hbase.util">Bytes</a> key)</pre> |
| <div class="block">Getter for accessing the metadata associated with the key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A clone value. Null if no mapping for the key</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValue-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre>byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.179">getValue</a>(byte[] key)</pre> |
| <div class="block">Getter for accessing the metadata associated with the key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A clone value. Null if no mapping for the key</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValue-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.186">getValue</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Getter for accessing the metadata associated with the key.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - The key.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Null if no mapping for the key</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValues--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValues</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/hadoop/hbase/util/Bytes.html" title="class in org.apache.hadoop.hbase.util">Bytes</a>,<a href="../../../../../org/apache/hadoop/hbase/util/Bytes.html" title="class in org.apache.hadoop.hbase.util">Bytes</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.189">getValues</a>()</pre> |
| <div class="block">Returns Getter for fetching an unmodifiable map.</div> |
| </li> |
| </ul> |
| <a name="hasCoprocessor-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasCoprocessor</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.196">hasCoprocessor</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> classNameToMatch)</pre> |
| <div class="block">Check if the table has an attached co-processor represented by the name className</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classNameToMatch</code> - - Class name of the co-processor</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true of the table has a co-processor className</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasColumnFamily-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasColumnFamily</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.203">hasColumnFamily</a>(byte[] name)</pre> |
| <div class="block">Checks to see if this table contains the given column family</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Family name or column name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the table contains the specified family name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasRegionMemStoreReplication--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasRegionMemStoreReplication</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.206">hasRegionMemStoreReplication</a>()</pre> |
| <div class="block">Returns true if the read-replicas memstore replication is enabled.</div> |
| </li> |
| </ul> |
| <a name="isCompactionEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCompactionEnabled</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.213">isCompactionEnabled</a>()</pre> |
| <div class="block">Check if the compaction enable flag of the table is true. If flag is false then no minor/major |
| compactions will be done in real.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if table compaction enabled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSplitEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSplitEnabled</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.220">isSplitEnabled</a>()</pre> |
| <div class="block">Check if the split enable flag of the table is true. If flag is false then no region split will |
| be done.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if table region split enabled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isMergeEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMergeEnabled</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.227">isMergeEnabled</a>()</pre> |
| <div class="block">Check if the merge enable flag of the table is true. If flag is false then no region merge will |
| be done.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if table region merge enabled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isMetaRegion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMetaRegion</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.233">isMetaRegion</a>()</pre> |
| <div class="block">Checks if this table is <code> hbase:meta </code> region.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this table is <code> hbase:meta </code> region</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isMetaTable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMetaTable</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.239">isMetaTable</a>()</pre> |
| <div class="block">Checks if the table is a <code>hbase:meta</code> table</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if table is <code> hbase:meta </code> region.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isNormalizationEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNormalizationEnabled</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.246">isNormalizationEnabled</a>()</pre> |
| <div class="block">Check if normalization enable flag of the table is true. If flag is false then region |
| normalizer won't attempt to normalize this table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if region normalization is enabled for this table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNormalizerTargetRegionCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNormalizerTargetRegionCount</h4> |
| <pre>int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.253">getNormalizerTargetRegionCount</a>()</pre> |
| <div class="block">Check if there is the target region count. If so, the normalize plan will be calculated based |
| on the target region count.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>target region count after normalize done</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNormalizerTargetRegionSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNormalizerTargetRegionSize</h4> |
| <pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.260">getNormalizerTargetRegionSize</a>()</pre> |
| <div class="block">Check if there is the target region size. If so, the normalize plan will be calculated based on |
| the target region size.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>target region size after normalize done</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isReadOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReadOnly</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.267">isReadOnly</a>()</pre> |
| <div class="block">Check if the readOnly flag of the table is set. If the readOnly flag is set then the contents |
| of the table can only be read from but not modified.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if all columns in the table should be read only</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getErasureCodingPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getErasureCodingPolicy</h4> |
| <pre>default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.274">getErasureCodingPolicy</a>()</pre> |
| <div class="block">The HDFS erasure coding policy for a table. This will be set on the data dir of the table, and |
| is an alternative to normal replication which takes less space at the cost of locality.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current policy, or null if undefined</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toStringCustomizedValues--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toStringCustomizedValues</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.282">toStringCustomizedValues</a>()</pre> |
| <div class="block">Returns Name of this table and then a map of all of the column family descriptors (with only |
| the non-default column family attributes)</div> |
| </li> |
| </ul> |
| <a name="hasGlobalReplicationScope--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasGlobalReplicationScope</h4> |
| <pre>default boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.289">hasGlobalReplicationScope</a>()</pre> |
| <div class="block">Check if any of the table's cfs' replication scope are set to |
| <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#REPLICATION_SCOPE_GLOBAL"><code>HConstants.REPLICATION_SCOPE_GLOBAL</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if we have, otherwise <code>false</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="matchReplicationScope-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>matchReplicationScope</h4> |
| <pre>default boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/TableDescriptor.html#line.299">matchReplicationScope</a>(boolean enabled)</pre> |
| <div class="block">Check if the table's cfs' replication scope matched with the replication state</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enabled</code> - replication state</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if matched, otherwise false</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.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/TableDescriptor.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/client/TableBuilderBase.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/client/TableDescriptorBuilder.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/client/TableDescriptor.html" target="_top">Frames</a></li> |
| <li><a href="TableDescriptor.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| 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>Constr | </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>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
