Package org.apache.hadoop.hbase

Class HTableDescriptor

java.lang.Object

org.apache.hadoop.hbase.HTableDescriptor

All Implemented Interfaces:

Comparable<HTableDescriptor>, TableDescriptor

Direct Known Subclasses:

ImmutableHTableDescriptor

@Deprecated
@Public
public class HTableDescriptor
extends Object
implements TableDescriptor, Comparable<HTableDescriptor>

Deprecated.

As of release 2.0.0, this will be removed in HBase 3.0.0. Use TableDescriptorBuilder to build HTableDescriptor.

HTableDescriptor contains the details about an HBase table such as the descriptors of all the column families, is the table a catalog table, hbase:meta , if the table is read only, the maximum size of the memstore, when the region split should occur, coprocessors associated with it etc...

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPACTION_ENABLED	Deprecated.
static final boolean	DEFAULT_COMPACTION_ENABLED	Deprecated.
static final long	DEFAULT_MEMSTORE_FLUSH_SIZE	Deprecated.
static final boolean	DEFAULT_NORMALIZATION_ENABLED	Deprecated.
static final boolean	DEFAULT_READONLY	Deprecated.
static final boolean	DEFAULT_REGION_MEMSTORE_REPLICATION	Deprecated.
static final int	DEFAULT_REGION_REPLICATION	Deprecated.
protected final TableDescriptorBuilder.ModifyableTableDescriptor	delegatee	Deprecated.
static final String	DURABILITY	Deprecated.
static final String	ERASURE_CODING_POLICY	Deprecated.
static final String	FLUSH_POLICY	Deprecated.
static final String	IS_META	Deprecated.
static final String	IS_ROOT	Deprecated.
static final String	MAX_FILESIZE	Deprecated.
static final String	MEMSTORE_FLUSHSIZE	Deprecated.
static final String	MERGE_ENABLED	Deprecated.
static final byte[]	NAMESPACE_COL_DESC_BYTES	Deprecated.
static final String	NAMESPACE_FAMILY_INFO	Deprecated.
static final byte[]	NAMESPACE_FAMILY_INFO_BYTES	Deprecated.
static final HTableDescriptor	NAMESPACE_TABLEDESC	Deprecated. Table descriptor for namespace table
static final String	NORMALIZATION_ENABLED	Deprecated.
static final String	NORMALIZER_TARGET_REGION_COUNT	Deprecated.
static final String	NORMALIZER_TARGET_REGION_SIZE	Deprecated.
static final String	NORMALIZER_TARGET_REGION_SIZE_MB	Deprecated.
static final String	OWNER	Deprecated.
static final Bytes	OWNER_KEY	Deprecated.
static final String	PRIORITY	Deprecated.
static final String	READONLY	Deprecated.
static final String	REGION_MEMSTORE_REPLICATION	Deprecated.
static final String	REGION_REPLICATION	Deprecated.
static final String	SPLIT_ENABLED	Deprecated.
static final String	SPLIT_POLICY	Deprecated.

Fields inherited from interface org.apache.hadoop.hbase.client.TableDescriptor

COMPARATOR, COMPARATOR_IGNORE_REPLICATION

Constructor Summary

Constructors

Modifier	Constructor	Description
	HTableDescriptor(TableDescriptor desc)	Deprecated.
protected	HTableDescriptor(TableDescriptorBuilder.ModifyableTableDescriptor delegatee)	Deprecated.
	HTableDescriptor(HTableDescriptor desc)	Deprecated. Construct a table descriptor by cloning the descriptor passed as a parameter.
protected	HTableDescriptor(HTableDescriptor desc, boolean deepClone)	Deprecated.
	HTableDescriptor(TableName name)	Deprecated. Construct a table descriptor specifying a TableName object
	HTableDescriptor(TableName name, HTableDescriptor desc)	Deprecated. Construct a table descriptor by cloning the descriptor passed as a parameter but using a different table name.

Method Summary

Modifier and Type	Method	Description
HTableDescriptor	addCoprocessor(String className)	Deprecated. Add a table coprocessor to this table.
HTableDescriptor	addCoprocessor(String className, org.apache.hadoop.fs.Path jarFilePath, int priority, Map<String,String> kvs)	Deprecated. Add a table coprocessor to this table.
HTableDescriptor	addCoprocessorWithSpec(String specStr)	Deprecated. Add a table coprocessor to this table.
HTableDescriptor	addFamily(HColumnDescriptor family)	Deprecated. Adds a column family.
int	compareTo(HTableDescriptor other)	Deprecated. Compares the descriptor with another descriptor which is passed as a parameter.
boolean	equals(Object obj)	Deprecated. Compare the contents of the descriptor with another one passed as a parameter.
HColumnDescriptor[]	getColumnFamilies()	Deprecated. since 2.0.0 and will be removed in 3.0.0.
ColumnFamilyDescriptor	getColumnFamily(byte[] name)	Deprecated. Returns the ColumnDescriptor for a specific column family with name as specified by the parameter column.
int	getColumnFamilyCount()	Deprecated. Returns the count of the column families of the table.
Set<byte[]>	getColumnFamilyNames()	Deprecated. Returns all the column family names of the current table.
Map<String,String>	getConfiguration()	Deprecated. Getter for fetching an unmodifiable map.
String	getConfigurationValue(String key)	Deprecated. Getter for accessing the configuration value by key
Collection<CoprocessorDescriptor>	getCoprocessorDescriptors()	Deprecated. Return the list of attached co-processor represented
protected TableDescriptorBuilder.ModifyableTableDescriptor	getDelegateeForModification()	Deprecated.
Durability	getDurability()	Deprecated. Returns the durability setting for the table.
String	getErasureCodingPolicy()	Deprecated. The HDFS erasure coding policy for a table.
Collection<HColumnDescriptor>	getFamilies()	Deprecated. since 2.0.0 and will be removed in 3.0.0.
Set<byte[]>	getFamiliesKeys()	Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-18008).
HColumnDescriptor	getFamily(byte[] column)	Deprecated. since 2.0.0 and will be removed in 3.0.0.
String	getFlushPolicyClassName()	Deprecated. This gets the class associated with the flush policy which determines the stores need to be flushed when flushing a region.
long	getMaxFileSize()	Deprecated. Returns the maximum size upto which a region can grow to after which a region split is triggered.
long	getMemStoreFlushSize()	Deprecated. Returns the size of the memstore after which a flush to filesystem is triggered.
String	getNameAsString()	Deprecated. Get the name of the table as a String
int	getNormalizerTargetRegionCount()	Deprecated. Check if there is the target region count.
long	getNormalizerTargetRegionSize()	Deprecated. Check if there is the target region size.
String	getOwnerString()	Deprecated. since 0.94.1
int	getPriority()	Deprecated.
int	getRegionReplication()	Deprecated. Returns the configured replicas per region
Optional<String>	getRegionServerGroup()	Deprecated. Get the region server group this table belongs to.
String	getRegionSplitPolicyClassName()	Deprecated. This gets the class associated with the region split policy which determines when a region split should occur.
TableName	getTableName()	Deprecated. Get the name of the table
byte[]	getValue(byte[] key)	Deprecated. Getter for accessing the metadata associated with the key.
String	getValue(String key)	Deprecated. Getter for accessing the metadata associated with the key.
Bytes	getValue(Bytes key)	Deprecated. Getter for accessing the metadata associated with the key.
Map<Bytes,Bytes>	getValues()	Deprecated. Returns Getter for fetching an unmodifiable map.
boolean	hasColumnFamily(byte[] name)	Deprecated. Checks to see if this table contains the given column family
boolean	hasCoprocessor(String classNameToMatch)	Deprecated. Check if the table has an attached co-processor represented by the name className
boolean	hasFamily(byte[] familyName)	Deprecated. Checks to see if this table contains the given column family
int	hashCode()	Deprecated.
boolean	hasRegionMemstoreReplication()	Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
boolean	hasRegionMemStoreReplication()	Deprecated. Returns true if the read-replicas memstore replication is enabled.
boolean	isCompactionEnabled()	Deprecated. Check if the compaction enable flag of the table is true.
boolean	isMergeEnabled()	Deprecated. Check if the region merge enable flag of the table is true.
boolean	isMetaRegion()	Deprecated. Checks if this table is hbase:meta region.
boolean	isMetaTable()	Deprecated. Checks if the table is a hbase:meta table
boolean	isNormalizationEnabled()	Deprecated. Check if normalization enable flag of the table is true.
boolean	isReadOnly()	Deprecated. Check if the readOnly flag of the table is set.
boolean	isRootRegion()	Deprecated. This is vestigial API.
boolean	isSplitEnabled()	Deprecated. Check if the region split enable flag of the table is true.
HTableDescriptor	modifyFamily(HColumnDescriptor family)	Deprecated. Modifies the existing column family.
static HTableDescriptor	parseFrom(byte[] bytes)	Deprecated. Parse the serialized representation of a HTableDescriptor
void	remove(byte[] key)	Deprecated. Remove metadata represented by the key from the map
void	remove(String key)	Deprecated. Remove metadata represented by the key from the map
void	remove(Bytes key)	Deprecated. Remove metadata represented by the key from the map
void	removeConfiguration(String key)	Deprecated. Remove a config setting represented by the key from the map
void	removeCoprocessor(String className)	Deprecated. Remove a coprocessor from those set on the table
HColumnDescriptor	removeFamily(byte[] column)	Deprecated. Removes the HColumnDescriptor with name specified by the parameter column from the table descriptor
HTableDescriptor	setCompactionEnabled(boolean isEnable)	Deprecated. Setting the table compaction enable flag.
HTableDescriptor	setConfiguration(String key, String value)	Deprecated. Setter for storing a configuration setting in map.
HTableDescriptor	setDurability(Durability durability)	Deprecated. Sets the Durability setting for the table.
HTableDescriptor	setErasureCodingPolicy(String policy)	Deprecated. Sets the HDFS erasure coding policy for the table.
HTableDescriptor	setFlushPolicyClassName(String clazz)	Deprecated. This sets the class associated with the flush policy which determines determines the stores need to be flushed when flushing a region.
HTableDescriptor	setMaxFileSize(long maxFileSize)	Deprecated. Sets the maximum size upto which a region can grow to after which a region split is triggered.
HTableDescriptor	setMaxFileSize(String maxFileSize)	Deprecated.
HTableDescriptor	setMemStoreFlushSize(long memstoreFlushSize)	Deprecated. Represents the maximum size of the memstore after which the contents of the memstore are flushed to the filesystem.
HTableDescriptor	setMemStoreFlushSize(String memStoreFlushSize)	Deprecated.
HTableDescriptor	setMergeEnabled(boolean isEnable)	Deprecated. Setting the table region merge enable flag.
HTableDescriptor	setNormalizationEnabled(boolean isEnable)	Deprecated. Setting the table normalization enable flag.
HTableDescriptor	setNormalizerTargetRegionCount(int regionCount)	Deprecated.
HTableDescriptor	setNormalizerTargetRegionSize(long regionSize)	Deprecated.
HTableDescriptor	setOwner(User owner)	Deprecated. since 0.94.1
HTableDescriptor	setOwnerString(String ownerString)	Deprecated. since 0.94.1
HTableDescriptor	setPriority(int priority)	Deprecated.
HTableDescriptor	setReadOnly(boolean readOnly)	Deprecated. Setting the table as read only sets all the columns in the table as read only.
HTableDescriptor	setRegionMemstoreReplication(boolean memstoreReplication)	Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0.
HTableDescriptor	setRegionMemStoreReplication(boolean memstoreReplication)	Deprecated. Enable or Disable the memstore replication from the primary region to the replicas.
HTableDescriptor	setRegionReplication(int regionReplication)	Deprecated. Sets the number of replicas per region.
HTableDescriptor	setRegionSplitPolicyClassName(String clazz)	Deprecated. This sets the class associated with the region split policy which determines when a region split should occur.
HTableDescriptor	setSplitEnabled(boolean isEnable)	Deprecated. Setting the table region split enable flag.
HTableDescriptor	setValue(byte[] key, byte[] value)	Deprecated. Setter for storing metadata as a (key, value) pair in map
HTableDescriptor	setValue(String key, String value)	Deprecated. Setter for storing metadata as a (key, value) pair in map
HTableDescriptor	setValue(Bytes key, Bytes value)	Deprecated.
byte[]	toByteArray()	Deprecated. Returns This instance serialized with pb with pb magic prefix
protected HColumnDescriptor	toHColumnDescriptor(ColumnFamilyDescriptor desc)	Deprecated. Return a HColumnDescriptor for user to keep the compatibility as much as possible.
String	toString()	Deprecated.
String	toStringCustomizedValues()	Deprecated. Returns Name of this table and then a map of all of the column family descriptors (with only the non-default column family attributes)
String	toStringTableAttributes()	Deprecated. Returns map of all table attributes formatted into string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.client.TableDescriptor

getCoprocessors, hasGlobalReplicationScope, matchReplicationScope

Field Details

SPLIT_POLICY

public static final String SPLIT_POLICY

Deprecated.

See Also:

• Constant Field Values

MAX_FILESIZE

public static final String MAX_FILESIZE

Deprecated.

See Also:

• Constant Field Values

OWNER

public static final String OWNER

Deprecated.

See Also:

• Constant Field Values

OWNER_KEY

public static final Bytes OWNER_KEY

Deprecated.

READONLY

public static final String READONLY

Deprecated.

See Also:

• Constant Field Values

COMPACTION_ENABLED

public static final String COMPACTION_ENABLED

Deprecated.

See Also:

• Constant Field Values

SPLIT_ENABLED

public static final String SPLIT_ENABLED

Deprecated.

See Also:

• Constant Field Values

MERGE_ENABLED

public static final String MERGE_ENABLED

Deprecated.

See Also:

• Constant Field Values

MEMSTORE_FLUSHSIZE

public static final String MEMSTORE_FLUSHSIZE

Deprecated.

See Also:

• Constant Field Values

FLUSH_POLICY

public static final String FLUSH_POLICY

Deprecated.

See Also:

• Constant Field Values

IS_ROOT

public static final String IS_ROOT

Deprecated.

See Also:

• Constant Field Values

IS_META

public static final String IS_META

Deprecated.

See Also:

• Constant Field Values

DURABILITY

public static final String DURABILITY

Deprecated.

See Also:

• Constant Field Values

REGION_REPLICATION

public static final String REGION_REPLICATION

Deprecated.

See Also:

• Constant Field Values

REGION_MEMSTORE_REPLICATION

public static final String REGION_MEMSTORE_REPLICATION

Deprecated.

See Also:

• Constant Field Values

NORMALIZATION_ENABLED

public static final String NORMALIZATION_ENABLED

Deprecated.

See Also:

• Constant Field Values

DEFAULT_NORMALIZATION_ENABLED

public static final boolean DEFAULT_NORMALIZATION_ENABLED

Deprecated.

See Also:

• Constant Field Values

NORMALIZER_TARGET_REGION_COUNT

public static final String NORMALIZER_TARGET_REGION_COUNT

Deprecated.

See Also:

• Constant Field Values

NORMALIZER_TARGET_REGION_SIZE

public static final String NORMALIZER_TARGET_REGION_SIZE

Deprecated.

See Also:

• Constant Field Values

NORMALIZER_TARGET_REGION_SIZE_MB

public static final String NORMALIZER_TARGET_REGION_SIZE_MB

Deprecated.

See Also:

• Constant Field Values

PRIORITY

public static final String PRIORITY

Deprecated.

See Also:

• Constant Field Values

DEFAULT_READONLY

public static final boolean DEFAULT_READONLY

Deprecated.

See Also:

• Constant Field Values

DEFAULT_COMPACTION_ENABLED

public static final boolean DEFAULT_COMPACTION_ENABLED

Deprecated.

See Also:

• Constant Field Values

DEFAULT_MEMSTORE_FLUSH_SIZE

public static final long DEFAULT_MEMSTORE_FLUSH_SIZE

Deprecated.

See Also:

• Constant Field Values

DEFAULT_REGION_REPLICATION

public static final int DEFAULT_REGION_REPLICATION

Deprecated.

See Also:

• Constant Field Values

DEFAULT_REGION_MEMSTORE_REPLICATION

public static final boolean DEFAULT_REGION_MEMSTORE_REPLICATION

Deprecated.

See Also:

• Constant Field Values

ERASURE_CODING_POLICY

public static final String ERASURE_CODING_POLICY

Deprecated.

See Also:

• Constant Field Values

delegatee

protected final TableDescriptorBuilder.ModifyableTableDescriptor delegatee

Deprecated.

NAMESPACE_FAMILY_INFO

public static final String NAMESPACE_FAMILY_INFO

Deprecated.

See Also:

• Constant Field Values

NAMESPACE_FAMILY_INFO_BYTES

public static final byte[] NAMESPACE_FAMILY_INFO_BYTES

Deprecated.

NAMESPACE_COL_DESC_BYTES

public static final byte[] NAMESPACE_COL_DESC_BYTES

Deprecated.

NAMESPACE_TABLEDESC

public static final HTableDescriptor NAMESPACE_TABLEDESC

Deprecated.

Table descriptor for namespace table

Constructor Details

HTableDescriptor

public HTableDescriptor(TableName name)

Deprecated.

Construct a table descriptor specifying a TableName object

Parameters:

name - Table name.

See Also:

• HADOOP-1581 HBASE: (HBASE-174) Un-openable tablename bug

HTableDescriptor

public HTableDescriptor(HTableDescriptor desc)

Deprecated.

Construct a table descriptor by cloning the descriptor passed as a parameter.

Makes a deep copy of the supplied descriptor. Can make a modifiable descriptor from an ImmutableHTableDescriptor.

Parameters:

desc - The descriptor.

HTableDescriptor

protected HTableDescriptor(HTableDescriptor desc,
 boolean deepClone)

Deprecated.

HTableDescriptor

public HTableDescriptor(TableDescriptor desc)

Deprecated.

HTableDescriptor

public HTableDescriptor(TableName name,
 HTableDescriptor desc)

Deprecated.

Construct a table descriptor by cloning the descriptor passed as a parameter but using a different table name.

Makes a deep copy of the supplied descriptor. Can make a modifiable descriptor from an ImmutableHTableDescriptor.

Parameters:

name - Table name.

desc - The descriptor.

HTableDescriptor

protected HTableDescriptor(TableDescriptorBuilder.ModifyableTableDescriptor delegatee)

Deprecated.

Method Details

isRootRegion

public boolean isRootRegion()

Deprecated.

This is vestigial API. It will be removed in 3.0.

Returns:

always return the false

isMetaRegion

public boolean isMetaRegion()

Deprecated.

Checks if this table is hbase:meta region.

Specified by:

isMetaRegion in interface TableDescriptor

Returns:

true if this table is hbase:meta region

isMetaTable

public boolean isMetaTable()

Deprecated.

Checks if the table is a hbase:meta table

Specified by:

isMetaTable in interface TableDescriptor

Returns:

true if table is hbase:meta region.

getValues

public Map<Bytes,Bytes> getValues()

Deprecated.

Returns Getter for fetching an unmodifiable map.

Specified by:

getValues in interface TableDescriptor

setValue

public HTableDescriptor setValue(byte[] key,
 byte[] value)

Deprecated.

Setter for storing metadata as a (key, value) pair in map

Parameters:

key - The key.

value - The value. If null, removes the setting.

setValue

public HTableDescriptor setValue(Bytes key,
 Bytes value)

Deprecated.

setValue

public HTableDescriptor setValue(String key,
 String value)

Deprecated.

Setter for storing metadata as a (key, value) pair in map

Parameters:

key - The key.

value - The value. If null, removes the setting.

remove

public void remove(String key)

Deprecated.

Remove metadata represented by the key from the map

Parameters:

key - Key whose key and value we're to remove from HTableDescriptor parameters.

remove

public void remove(Bytes key)

Deprecated.

Remove metadata represented by the key from the map

Parameters:

key - Key whose key and value we're to remove from HTableDescriptor parameters.

remove

public void remove(byte[] key)

Deprecated.

Remove metadata represented by the key from the map

Parameters:

key - Key whose key and value we're to remove from HTableDescriptor parameters.

isReadOnly

public boolean isReadOnly()

Deprecated.

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.

Specified by:

isReadOnly in interface TableDescriptor

Returns:

true if all columns in the table should be read only

setReadOnly

public HTableDescriptor setReadOnly(boolean readOnly)

Deprecated.

Setting the table as read only sets all the columns in the table as read only. By default all tables are modifiable, but if the readOnly flag is set to true then the contents of the table can only be read but not modified.

Parameters:

readOnly - True if all of the columns in the table should be read only.

isCompactionEnabled

public boolean isCompactionEnabled()

Deprecated.

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.

Specified by:

isCompactionEnabled in interface TableDescriptor

Returns:

true if table compaction enabled

setCompactionEnabled

public HTableDescriptor setCompactionEnabled(boolean isEnable)

Deprecated.

Setting the table compaction enable flag.

Parameters:

isEnable - True if enable compaction.

setErasureCodingPolicy

public HTableDescriptor setErasureCodingPolicy(String policy)

Deprecated.

Sets the HDFS erasure coding policy for the table. This will be propagated to HDFS for the data dir of the table. Erasure coding is an alternative to normal replication which takes less space at the cost of locality. The policy must be available and enabled on the hdfs cluster before being set.

Parameters:

policy - the policy to set, or null to disable erasure coding

getErasureCodingPolicy

public String getErasureCodingPolicy()

Deprecated.

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.

Specified by:

getErasureCodingPolicy in interface TableDescriptor

Returns:

the current policy, or null if undefined

isSplitEnabled

public boolean isSplitEnabled()

Deprecated.

Check if the region split enable flag of the table is true. If flag is false then no split will be done.

Specified by:

isSplitEnabled in interface TableDescriptor

Returns:

true if table region split enabled

setSplitEnabled

public HTableDescriptor setSplitEnabled(boolean isEnable)

Deprecated.

Setting the table region split enable flag.

Parameters:

isEnable - True if enable split.

isMergeEnabled

public boolean isMergeEnabled()

Deprecated.

Check if the region merge enable flag of the table is true. If flag is false then no merge will be done.

Specified by:

isMergeEnabled in interface TableDescriptor

Returns:

true if table region merge enabled

setMergeEnabled

public HTableDescriptor setMergeEnabled(boolean isEnable)

Deprecated.

Setting the table region merge enable flag.

Parameters:

isEnable - True if enable merge.

isNormalizationEnabled

public boolean isNormalizationEnabled()

Deprecated.

Check if normalization enable flag of the table is true. If flag is false then no region normalizer won't attempt to normalize this table.

Specified by:

isNormalizationEnabled in interface TableDescriptor

Returns:

true if region normalization is enabled for this table

setNormalizationEnabled

public HTableDescriptor setNormalizationEnabled(boolean isEnable)

Deprecated.

Setting the table normalization enable flag.

Parameters:

isEnable - True if enable normalization.

getNormalizerTargetRegionCount

public int getNormalizerTargetRegionCount()

Deprecated.

Description copied from interface: TableDescriptor

Check if there is the target region count. If so, the normalize plan will be calculated based on the target region count.

Specified by:

getNormalizerTargetRegionCount in interface TableDescriptor

Returns:

target region count after normalize done

setNormalizerTargetRegionCount

public HTableDescriptor setNormalizerTargetRegionCount(int regionCount)

Deprecated.

getNormalizerTargetRegionSize

public long getNormalizerTargetRegionSize()

Deprecated.

Description copied from interface: TableDescriptor

Check if there is the target region size. If so, the normalize plan will be calculated based on the target region size.

Specified by:

getNormalizerTargetRegionSize in interface TableDescriptor

Returns:

target region size after normalize done

setNormalizerTargetRegionSize

public HTableDescriptor setNormalizerTargetRegionSize(long regionSize)

Deprecated.

setDurability

public HTableDescriptor setDurability(Durability durability)

Deprecated.

Sets the Durability setting for the table. This defaults to Durability.USE_DEFAULT.

Parameters:

durability - enum value

getDurability

public Durability getDurability()

Deprecated.

Returns the durability setting for the table.

Specified by:

getDurability in interface TableDescriptor

Returns:

durability setting for the table.

getTableName

public TableName getTableName()

Deprecated.

Get the name of the table

Specified by:

getTableName in interface TableDescriptor

getNameAsString

public String getNameAsString()

Deprecated.

Get the name of the table as a String

Returns:

name of table as a String

setRegionSplitPolicyClassName

public HTableDescriptor setRegionSplitPolicyClassName(String clazz)

Deprecated.

This sets 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

Parameters:

clazz - the class name

getRegionSplitPolicyClassName

public String getRegionSplitPolicyClassName()

Deprecated.

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

Specified by:

getRegionSplitPolicyClassName in interface TableDescriptor

Returns:

the class name of the region split policy for this table. If this returns null, the default split policy is used.

getMaxFileSize

public long getMaxFileSize()

Deprecated.

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.

Specified by:

getMaxFileSize in interface TableDescriptor

Returns:

max hregion size for table, -1 if not set.

See Also:

• setMaxFileSize(long)

setMaxFileSize

public HTableDescriptor setMaxFileSize(long maxFileSize)

Deprecated.

Sets 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, i.e. If the biggest store file grows beyond the maxFileSize, then the region split is triggered. This defaults to a value of 256 MB.

This is not an absolute value and might vary. Assume that a single row exceeds the maxFileSize then the storeFileSize will be greater than maxFileSize since a single row cannot be split across multiple regions

Parameters:

maxFileSize - The maximum file size that a store file can grow to before a split is triggered.

setMaxFileSize

public HTableDescriptor setMaxFileSize(String maxFileSize)
                                throws HBaseException

Deprecated.

Throws:

HBaseException

getMemStoreFlushSize

public long getMemStoreFlushSize()

Deprecated.

Returns the size of the memstore after which a flush to filesystem is triggered.

Specified by:

getMemStoreFlushSize in interface TableDescriptor

Returns:

memory cache flush size for each hregion, -1 if not set.

See Also:

• setMemStoreFlushSize(long)

setMemStoreFlushSize

public HTableDescriptor setMemStoreFlushSize(long memstoreFlushSize)

Deprecated.

Represents the maximum size of the memstore after which the contents of the memstore are flushed to the filesystem. This defaults to a size of 64 MB.

Parameters:

memstoreFlushSize - memory cache flush size for each hregion

setMemStoreFlushSize

public HTableDescriptor setMemStoreFlushSize(String memStoreFlushSize)
                                      throws HBaseException

Deprecated.

Throws:

HBaseException

setFlushPolicyClassName

public HTableDescriptor setFlushPolicyClassName(String clazz)

Deprecated.

This sets the class associated with the flush policy which determines 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.

Parameters:

clazz - the class name

getFlushPolicyClassName

public String getFlushPolicyClassName()

Deprecated.

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.

Specified by:

getFlushPolicyClassName in interface TableDescriptor

Returns:

the class name of the flush policy for this table. If this returns null, the default flush policy is used.

addFamily

public HTableDescriptor addFamily(HColumnDescriptor family)

Deprecated.

Adds a column family. For the updating purpose please use modifyFamily(HColumnDescriptor) instead.

Parameters:

family - HColumnDescriptor of family to add.

modifyFamily

public HTableDescriptor modifyFamily(HColumnDescriptor family)

Deprecated.

Modifies the existing column family.

Parameters:

family - HColumnDescriptor of family to update

Returns:

this (for chained invocation)

hasFamily

public boolean hasFamily(byte[] familyName)

Deprecated.

Checks to see if this table contains the given column family

Parameters:

familyName - Family name or column name.

Returns:

true if the table contains the specified family name

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

Returns:

Name of this table and then a map of all of the column family descriptors.

See Also:

• getNameAsString()

toStringCustomizedValues

public String toStringCustomizedValues()

Deprecated.

Description copied from interface: TableDescriptor

Returns Name of this table and then a map of all of the column family descriptors (with only the non-default column family attributes)

Specified by:

toStringCustomizedValues in interface TableDescriptor

Returns:

Name of this table and then a map of all of the column family descriptors (with only the non-default column family attributes)

toStringTableAttributes

public String toStringTableAttributes()

Deprecated.

Returns map of all table attributes formatted into string.

equals

public boolean equals(Object obj)

Deprecated.

Compare the contents of the descriptor with another one passed as a parameter. Checks if the obj passed is an instance of HTableDescriptor, if yes then the contents of the descriptors are compared.

Overrides:

equals in class Object

Returns:

true if the contents of the the two descriptors exactly match

See Also:

• Object.equals(java.lang.Object)

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

compareTo

public int compareTo(HTableDescriptor other)

Deprecated.

Compares the descriptor with another descriptor which is passed as a parameter. This compares the content of the two descriptors and not the reference.

Specified by:

compareTo in interface Comparable<HTableDescriptor>

Returns:

0 if the contents of the descriptors are exactly matching, 1 if there is a mismatch in the contents

getFamilies

@Deprecated
public Collection<HColumnDescriptor> getFamilies()

Deprecated.

since 2.0.0 and will be removed in 3.0.0. Use getColumnFamilies() instead.

Returns an unmodifiable collection of all the HColumnDescriptor of all the column families of the table.

Returns:

Immutable collection of HColumnDescriptor of all the column families.

See Also:

• getColumnFamilies()
• HBASE-18008

getRegionReplication

public int getRegionReplication()

Deprecated.

Returns the configured replicas per region

Specified by:

getRegionReplication in interface TableDescriptor

setRegionReplication

public HTableDescriptor setRegionReplication(int regionReplication)

Deprecated.

Sets the number of replicas per region.

Parameters:

regionReplication - the replication factor per region

hasRegionMemstoreReplication

@Deprecated
public boolean hasRegionMemstoreReplication()

Deprecated.

As of release 2.0.0, this will be removed in HBase 3.0.0. Use hasRegionMemStoreReplication() instead

hasRegionMemStoreReplication

public boolean hasRegionMemStoreReplication()

Deprecated.

Returns true if the read-replicas memstore replication is enabled.

Specified by:

hasRegionMemStoreReplication in interface TableDescriptor

setRegionMemstoreReplication

@Deprecated
public HTableDescriptor setRegionMemstoreReplication(boolean memstoreReplication)

Deprecated.

As of release 2.0.0, this will be removed in HBase 3.0.0. Use setRegionMemStoreReplication(boolean) instead

setRegionMemStoreReplication

public HTableDescriptor setRegionMemStoreReplication(boolean memstoreReplication)

Deprecated.

Enable or Disable the memstore replication from the primary region to the replicas. The replication will be used only for meta operations (e.g. flush, compaction, ...)

Parameters:

memstoreReplication - true if the new data written to the primary region should be replicated. false if the secondaries can tollerate to have new data only when the primary flushes the memstore.

setPriority

public HTableDescriptor setPriority(int priority)

Deprecated.

getPriority

public int getPriority()

Deprecated.

Specified by:

getPriority in interface TableDescriptor

getFamiliesKeys

@Deprecated
public Set<byte[]> getFamiliesKeys()

Deprecated.

As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-18008). Use getColumnFamilyNames().

Returns all the column family names of the current table. The map of HTableDescriptor contains mapping of family name to HColumnDescriptors. This returns all the keys of the family map which represents the column family names of the table.

Returns:

Immutable sorted set of the keys of the families.

getColumnFamilyCount

public int getColumnFamilyCount()

Deprecated.

Returns the count of the column families of the table.

Specified by:

getColumnFamilyCount in interface TableDescriptor

Returns:

Count of column families of the table

getColumnFamilies

@Deprecated
public HColumnDescriptor[] getColumnFamilies()

Deprecated.

since 2.0.0 and will be removed in 3.0.0.

Returns an array all the HColumnDescriptor of the column families of the table.

Specified by:

getColumnFamilies in interface TableDescriptor

Returns:

Array of all the HColumnDescriptors of the current table

See Also:

• getFamilies()
• HBASE-18008

getFamily

@Deprecated
public HColumnDescriptor getFamily(byte[] column)

Deprecated.

since 2.0.0 and will be removed in 3.0.0. Use getColumnFamily(byte[]) instead.

Returns the HColumnDescriptor for a specific column family with name as specified by the parameter column.

Parameters:

column - Column family name

Returns:

Column descriptor for the passed family name or the family on passed in column.

See Also:

• getColumnFamily(byte[])
• HBASE-18008

removeFamily

public HColumnDescriptor removeFamily(byte[] column)

Deprecated.

Removes the HColumnDescriptor with name specified by the parameter column from the table descriptor

Parameters:

column - Name of the column family to be removed.

Returns:

Column descriptor for the passed family name or the family on passed in column.

toHColumnDescriptor

protected HColumnDescriptor toHColumnDescriptor(ColumnFamilyDescriptor desc)

Deprecated.

Return a HColumnDescriptor for user to keep the compatibility as much as possible.

Parameters:

desc - read-only ColumnFamilyDescriptor

Returns:

The older implementation of ColumnFamilyDescriptor

addCoprocessor

public HTableDescriptor addCoprocessor(String className)
                                throws IOException

Deprecated.

Add a table coprocessor to this table. The coprocessor type must be org.apache.hadoop.hbase.coprocessor.RegionCoprocessor. It won't check if the class can be loaded or not. Whether a coprocessor is loadable or not will be determined when a region is opened.

Parameters:

className - Full class name.

Throws:

IOException

addCoprocessor

public HTableDescriptor addCoprocessor(String className,
 org.apache.hadoop.fs.Path jarFilePath,
 int priority,
 Map<String,String> kvs)
                                throws IOException

Deprecated.

Add a table coprocessor to this table. The coprocessor type must be org.apache.hadoop.hbase.coprocessor.RegionCoprocessor. It won't check if the class can be loaded or not. Whether a coprocessor is loadable or not will be determined when a region is opened.

Parameters:

jarFilePath - Path of the jar file. If it's null, the class will be loaded from default classloader.

className - Full class name.

priority - Priority

kvs - Arbitrary key-value parameter pairs passed into the coprocessor.

Throws:

IOException

addCoprocessorWithSpec

public HTableDescriptor addCoprocessorWithSpec(String specStr)
                                        throws IOException

Deprecated.

Add a table coprocessor to this table. The coprocessor type must be org.apache.hadoop.hbase.coprocessor.RegionCoprocessor. It won't check if the class can be loaded or not. Whether a coprocessor is loadable or not will be determined when a region is opened.

Parameters:

specStr - The Coprocessor specification all in in one String formatted so matches HConstants.CP_HTD_ATTR_VALUE_PATTERN

Throws:

IOException

hasCoprocessor

public boolean hasCoprocessor(String classNameToMatch)

Deprecated.

Check if the table has an attached co-processor represented by the name className

Specified by:

hasCoprocessor in interface TableDescriptor

Parameters:

classNameToMatch - - Class name of the co-processor

Returns:

true of the table has a co-processor className

getCoprocessorDescriptors

public Collection<CoprocessorDescriptor> getCoprocessorDescriptors()

Deprecated.

Description copied from interface: TableDescriptor

Return the list of attached co-processor represented

Specified by:

getCoprocessorDescriptors in interface TableDescriptor

Returns:

The list of CoprocessorDescriptor

removeCoprocessor

public void removeCoprocessor(String className)

Deprecated.

Remove a coprocessor from those set on the table

Parameters:

className - Class name of the co-processor

setOwner

@Deprecated
public HTableDescriptor setOwner(User owner)

Deprecated.

since 0.94.1

Set the table owner.

See Also:

• HBASE-6188

setOwnerString

@Deprecated
public HTableDescriptor setOwnerString(String ownerString)

Deprecated.

since 0.94.1

Set the table owner.

See Also:

• HBASE-6188

getOwnerString

@Deprecated
public String getOwnerString()

Deprecated.

since 0.94.1

Get the table owner.

Specified by:

getOwnerString in interface TableDescriptor

See Also:

• HBASE-6188

toByteArray

public byte[] toByteArray()

Deprecated.

Returns This instance serialized with pb with pb magic prefix

parseFrom

public static HTableDescriptor parseFrom(byte[] bytes)
                                  throws DeserializationException,
IOException

Deprecated.

Parse the serialized representation of a HTableDescriptor

Parameters:

bytes - A pb serialized HTableDescriptor instance with pb magic prefix

Returns:

An instance of HTableDescriptor made from bytes

Throws:

DeserializationException

IOException

See Also:

• toByteArray()

getConfigurationValue

public String getConfigurationValue(String key)

Deprecated.

Getter for accessing the configuration value by key

getConfiguration

public Map<String,String> getConfiguration()

Deprecated.

Getter for fetching an unmodifiable map.

setConfiguration

public HTableDescriptor setConfiguration(String key,
 String value)

Deprecated.

Setter for storing a configuration setting in map.

Parameters:

key - Config key. Same as XML config key e.g. hbase.something.or.other.

value - String value. If null, removes the setting.

removeConfiguration

public void removeConfiguration(String key)

Deprecated.

Remove a config setting represented by the key from the map

getValue

public Bytes getValue(Bytes key)

Deprecated.

Description copied from interface: TableDescriptor

Getter for accessing the metadata associated with the key.

Specified by:

getValue in interface TableDescriptor

Parameters:

key - The key.

Returns:

A clone value. Null if no mapping for the key

getValue

public String getValue(String key)

Deprecated.

Description copied from interface: TableDescriptor

Getter for accessing the metadata associated with the key.

Specified by:

getValue in interface TableDescriptor

Parameters:

key - The key.

Returns:

Null if no mapping for the key

getValue

public byte[] getValue(byte[] key)

Deprecated.

Description copied from interface: TableDescriptor

Getter for accessing the metadata associated with the key.

Specified by:

getValue in interface TableDescriptor

Parameters:

key - The key.

Returns:

A clone value. Null if no mapping for the key

getColumnFamilyNames

public Set<byte[]> getColumnFamilyNames()

Deprecated.

Description copied from interface: TableDescriptor

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.

Specified by:

getColumnFamilyNames in interface TableDescriptor

Returns:

Immutable sorted set of the keys of the families.

hasColumnFamily

public boolean hasColumnFamily(byte[] name)

Deprecated.

Description copied from interface: TableDescriptor

Checks to see if this table contains the given column family

Specified by:

hasColumnFamily in interface TableDescriptor

Parameters:

name - Family name or column name.

Returns:

true if the table contains the specified family name

getColumnFamily

public ColumnFamilyDescriptor getColumnFamily(byte[] name)

Deprecated.

Description copied from interface: TableDescriptor

Returns the ColumnDescriptor for a specific column family with name as specified by the parameter column.

Specified by:

getColumnFamily in interface TableDescriptor

Parameters:

name - Column family name

Returns:

Column descriptor for the passed family name or the family on passed in column.

getDelegateeForModification

protected TableDescriptorBuilder.ModifyableTableDescriptor getDelegateeForModification()

Deprecated.

getRegionServerGroup

public Optional<String> getRegionServerGroup()

Deprecated.

Description copied from interface: TableDescriptor

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 RSGroupInfo.DEFAULT_GROUP.

Specified by:

getRegionServerGroup in interface TableDescriptor