Package org.apache.hadoop.hbase.client

Class TableDescriptorBuilder.ModifyableTableDescriptor

java.lang.Object

org.apache.hadoop.hbase.client.TableDescriptorBuilder.ModifyableTableDescriptor

All Implemented Interfaces:

Comparable<TableDescriptorBuilder.ModifyableTableDescriptor>, TableDescriptor

Enclosing class:

TableDescriptorBuilder

@Private
public static class TableDescriptorBuilder.ModifyableTableDescriptor
extends Object
implements TableDescriptor, Comparable<TableDescriptorBuilder.ModifyableTableDescriptor>

TODO: make this private after removing the HTableDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<byte[],ColumnFamilyDescriptor>	families	Maps column family name to the respective FamilyDescriptors
private final TableName	name
private final Map<Bytes,Bytes>	values	A map which holds the metadata information of the table.

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

COMPARATOR, COMPARATOR_IGNORE_REPLICATION

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ModifyableTableDescriptor(TableDescriptor desc)
	ModifyableTableDescriptor(TableName name)	Construct a table descriptor specifying a TableName object
private	ModifyableTableDescriptor(TableName name, Collection<ColumnFamilyDescriptor> families, Map<Bytes,Bytes> values)
	ModifyableTableDescriptor(TableName name, TableDescriptor desc)	Deprecated.

Method Summary

Modifier and Type	Method	Description
private void	checkHasCoprocessor(String className)
int	compareTo(TableDescriptorBuilder.ModifyableTableDescriptor other)	Compares the descriptor with another descriptor which is passed as a parameter.
boolean	equals(Object obj)	Compare the contents of the descriptor with another one passed as a parameter.
ColumnFamilyDescriptor[]	getColumnFamilies()	Returns an unmodifiable collection of all the ColumnFamilyDescriptor of all the column families of the table.
ColumnFamilyDescriptor	getColumnFamily(byte[] column)	Returns the ColumnFamilyDescriptor for a specific column family with name as specified by the parameter column.
int	getColumnFamilyCount()	Returns the count of the column families of the table.
Set<byte[]>	getColumnFamilyNames()	Returns all the column family names of the current table.
List<CoprocessorDescriptor>	getCoprocessorDescriptors()	Return the list of attached co-processor represented by their name className
Durability	getDurability()	Returns the durability setting for the table.
String	getErasureCodingPolicy()	The HDFS erasure coding policy for a table.
String	getFlushPolicyClassName()	This gets the class associated with the flush policy which determines the stores need to be flushed when flushing a region.
long	getMaxFileSize()	Returns the maximum size upto which a region can grow to after which a region split is triggered.
long	getMemStoreFlushSize()	Returns the size of the memstore after which a flush to filesystem is triggered.
int	getNormalizerTargetRegionCount()	Check if there is the target region count.
long	getNormalizerTargetRegionSize()	Check if there is the target region size.
private <T> T	getOrDefault(Bytes key, Function<String,T> function, T defaultValue)
String	getOwnerString()	Deprecated. since 2.0.0 and will be removed in 3.0.0.
int	getPriority()
int	getRegionReplication()	Returns the configured replicas per region
Optional<String>	getRegionServerGroup()	Get the region server group this table belongs to.
String	getRegionSplitPolicyClassName()	This gets the class associated with the region split policy which determines when a region split should occur.
TableName	getTableName()	Get the name of the table
byte[]	getValue(byte[] key)	Getter for accessing the metadata associated with the key.
String	getValue(String key)	Getter for accessing the metadata associated with the key.
Bytes	getValue(Bytes key)	Getter for accessing the metadata associated with the key.
Map<Bytes,Bytes>	getValues()	Getter for fetching an unmodifiable values map.
private StringBuilder	getValues(boolean printDefaults)
boolean	hasColumnFamily(byte[] familyName)	Checks to see if this table contains the given column family
boolean	hasCoprocessor(String classNameToMatch)	Check if the table has an attached co-processor represented by the name className
int	hashCode()	Returns hash code
boolean	hasRegionMemStoreReplication()	Returns true if the read-replicas memstore replication is enabled.
boolean	isCompactionEnabled()	Check if the compaction enable flag of the table is true.
boolean	isMergeEnabled()	Check if the region merge enable flag of the table is true.
boolean	isMetaRegion()	Checks if this table is hbase:meta region.
boolean	isMetaTable()	Checks if the table is a hbase:meta table
boolean	isNormalizationEnabled()	Check if normalization enable flag of the table is true.
boolean	isReadOnly()	Check if the readOnly flag of the table is set.
boolean	isSplitEnabled()	Check if the split enable flag of the table is true.
TableDescriptorBuilder.ModifyableTableDescriptor	modifyColumnFamily(ColumnFamilyDescriptor family)	Modifies the existing column family.
private static TableDescriptor	parseFrom(byte[] bytes)	Parse the serialized representation of a TableDescriptorBuilder.ModifyableTableDescriptor
private TableDescriptorBuilder.ModifyableTableDescriptor	putColumnFamily(ColumnFamilyDescriptor family)
ColumnFamilyDescriptor	removeColumnFamily(byte[] column)	Removes the ColumnFamilyDescriptor with name specified by the parameter column from the table descriptor
void	removeCoprocessor(String className)	Remove a coprocessor from those set on the table
TableDescriptorBuilder.ModifyableTableDescriptor	removeValue(byte[] key)	Remove metadata represented by the key from the values map
TableDescriptorBuilder.ModifyableTableDescriptor	removeValue(String key)	Remove metadata represented by the key from the values map
TableDescriptorBuilder.ModifyableTableDescriptor	removeValue(Bytes key)	Remove metadata represented by the key from the values map
TableDescriptorBuilder.ModifyableTableDescriptor	setColumnFamily(ColumnFamilyDescriptor family)	Adds a column family.
TableDescriptorBuilder.ModifyableTableDescriptor	setCompactionEnabled(boolean isEnable)	Setting the table compaction enable flag.
TableDescriptorBuilder.ModifyableTableDescriptor	setCoprocessor(String className)	Add a table coprocessor to this table.
TableDescriptorBuilder.ModifyableTableDescriptor	setCoprocessor(CoprocessorDescriptor cp)	Add a table coprocessor to this table.
private TableDescriptorBuilder.ModifyableTableDescriptor	setCoprocessorToMap(String specStr)	Add coprocessor to values Map
TableDescriptorBuilder.ModifyableTableDescriptor	setCoprocessorWithSpec(String specStr)	Deprecated. used by HTableDescriptor and admin.rb.
TableDescriptorBuilder.ModifyableTableDescriptor	setDurability(Durability durability)	Sets the Durability setting for the table.
TableDescriptorBuilder.ModifyableTableDescriptor	setErasureCodingPolicy(String policy)	Sets the HDFS erasure coding policy for the table.
TableDescriptorBuilder.ModifyableTableDescriptor	setFlushPolicyClassName(String clazz)	This sets the class associated with the flush policy which determines determines the stores need to be flushed when flushing a region.
TableDescriptorBuilder.ModifyableTableDescriptor	setMaxFileSize(long maxFileSize)	Sets the maximum size upto which a region can grow to after which a region split is triggered.
TableDescriptorBuilder.ModifyableTableDescriptor	setMaxFileSize(String maxFileSize)
TableDescriptorBuilder.ModifyableTableDescriptor	setMemStoreFlushSize(long memstoreFlushSize)	Represents the maximum size of the memstore after which the contents of the memstore are flushed to the filesystem.
TableDescriptorBuilder.ModifyableTableDescriptor	setMemStoreFlushSize(String memStoreFlushSize)
TableDescriptorBuilder.ModifyableTableDescriptor	setMergeEnabled(boolean isEnable)	Setting the table region merge enable flag.
TableDescriptorBuilder.ModifyableTableDescriptor	setNormalizationEnabled(boolean isEnable)	Setting the table normalization enable flag.
TableDescriptorBuilder.ModifyableTableDescriptor	setNormalizerTargetRegionCount(int regionCount)	Setting the target region count of table normalization .
TableDescriptorBuilder.ModifyableTableDescriptor	setNormalizerTargetRegionSize(long regionSize)	Setting the target region size of table normalization.
TableDescriptorBuilder.ModifyableTableDescriptor	setOwner(User owner)	Deprecated. since 2.0.0 and will be removed in 3.0.0.
TableDescriptorBuilder.ModifyableTableDescriptor	setOwnerString(String ownerString)	Deprecated. since 2.0.0 and will be removed in 3.0.0.
TableDescriptorBuilder.ModifyableTableDescriptor	setPriority(int priority)
TableDescriptorBuilder.ModifyableTableDescriptor	setReadOnly(boolean readOnly)	Setting the table as read only sets all the columns in the table as read only.
TableDescriptorBuilder.ModifyableTableDescriptor	setRegionMemStoreReplication(boolean memstoreReplication)	Enable or Disable the memstore replication from the primary region to the replicas.
TableDescriptorBuilder.ModifyableTableDescriptor	setRegionReplication(int regionReplication)	Sets the number of replicas per region.
TableDescriptorBuilder.ModifyableTableDescriptor	setRegionSplitPolicyClassName(String clazz)	This sets the class associated with the region split policy which determines when a region split should occur.
TableDescriptorBuilder.ModifyableTableDescriptor	setSplitEnabled(boolean isEnable)	Setting the table region split enable flag.
TableDescriptorBuilder.ModifyableTableDescriptor	setValue(byte[] key, byte[] value)	Setter for storing metadata as a (key, value) pair in values map
TableDescriptorBuilder.ModifyableTableDescriptor	setValue(String key, String value)
private TableDescriptorBuilder.ModifyableTableDescriptor	setValue(Bytes key, String value)
TableDescriptorBuilder.ModifyableTableDescriptor	setValue(Bytes key, Bytes value)	Setter for storing metadata as a (key, value) pair in values map
private byte[]	toByteArray()	Returns the bytes in pb format
private static <T> Bytes	toBytesOrNull(T t, Function<T,byte[]> f)
String	toString()	Returns Name of this table and then a map of all of the column family descriptors.
String	toStringCustomizedValues()	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()	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

name

private final TableName name

values

private final Map<Bytes,Bytes> values

A map which holds the metadata information of the table. This metadata includes values like IS_META, SPLIT_POLICY, MAX_FILE_SIZE, READONLY, MEMSTORE_FLUSHSIZE etc...

families

private final Map<byte[],ColumnFamilyDescriptor> families

Maps column family name to the respective FamilyDescriptors

Constructor Details

ModifyableTableDescriptor

@Private
public ModifyableTableDescriptor(TableName name)

Construct a table descriptor specifying a TableName object

Parameters:

name - Table name. TODO: make this private after removing the HTableDescriptor

ModifyableTableDescriptor

private ModifyableTableDescriptor(TableDescriptor desc)

ModifyableTableDescriptor

@Private
@Deprecated
public ModifyableTableDescriptor(TableName name,
 TableDescriptor desc)

Deprecated.

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

Makes a deep copy of the supplied descriptor.

Parameters:

name - The new name

desc - The descriptor. TODO: make this private after removing the HTableDescriptor

ModifyableTableDescriptor

private ModifyableTableDescriptor(TableName name,
 Collection<ColumnFamilyDescriptor> families,
 Map<Bytes,Bytes> values)

Method Details

isMetaRegion

public boolean isMetaRegion()

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()

Checks if the table is a hbase:meta table

Specified by:

isMetaTable in interface TableDescriptor

Returns:

true if table is hbase:meta region.

getValue

public Bytes getValue(Bytes key)

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)

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)

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

getOrDefault

private <T> T getOrDefault(Bytes key,
 Function<String,T> function,
 T defaultValue)

getValues

public Map<Bytes,Bytes> getValues()

Getter for fetching an unmodifiable values map.

Specified by:

getValues in interface TableDescriptor

Returns:

unmodifiable map values.

See Also:

• values

setValue

public TableDescriptorBuilder.ModifyableTableDescriptor setValue(byte[] key,
 byte[] value)

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

Parameters:

key - The key.

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

Returns:

the modifyable TD

See Also:

• values

setValue

public TableDescriptorBuilder.ModifyableTableDescriptor setValue(String key,
 String value)

setValue

private TableDescriptorBuilder.ModifyableTableDescriptor setValue(Bytes key,
 String value)

Parameters:

key - The key.

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

setValue

public TableDescriptorBuilder.ModifyableTableDescriptor setValue(Bytes key,
 Bytes value)

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

Parameters:

key - The key.

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

toBytesOrNull

private static <T> Bytes toBytesOrNull(T t,
 Function<T,byte[]> f)

removeValue

public TableDescriptorBuilder.ModifyableTableDescriptor removeValue(String key)

Remove metadata represented by the key from the values map

Parameters:

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

Returns:

the modifyable TD

removeValue

public TableDescriptorBuilder.ModifyableTableDescriptor removeValue(Bytes key)

Remove metadata represented by the key from the values map

Parameters:

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

Returns:

the modifyable TD

removeValue

public TableDescriptorBuilder.ModifyableTableDescriptor removeValue(byte[] key)

Remove metadata represented by the key from the values map

Parameters:

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

Returns:

the modifyable TD

isReadOnly

public boolean isReadOnly()

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 TableDescriptorBuilder.ModifyableTableDescriptor setReadOnly(boolean readOnly)

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.

Returns:

the modifyable TD

getErasureCodingPolicy

public String getErasureCodingPolicy()

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

setErasureCodingPolicy

public TableDescriptorBuilder.ModifyableTableDescriptor setErasureCodingPolicy(String policy)

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

Returns:

the modifyable TD

isCompactionEnabled

public boolean isCompactionEnabled()

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 TableDescriptorBuilder.ModifyableTableDescriptor setCompactionEnabled(boolean isEnable)

Setting the table compaction enable flag.

Parameters:

isEnable - True if enable compaction.

Returns:

the modifyable TD

isSplitEnabled

public boolean isSplitEnabled()

Check if the 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 TableDescriptorBuilder.ModifyableTableDescriptor setSplitEnabled(boolean isEnable)

Setting the table region split enable flag.

Parameters:

isEnable - True if enable region split.

Returns:

the modifyable TD

isMergeEnabled

public boolean isMergeEnabled()

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 TableDescriptorBuilder.ModifyableTableDescriptor setMergeEnabled(boolean isEnable)

Setting the table region merge enable flag.

Parameters:

isEnable - True if enable region merge.

Returns:

the modifyable TD

isNormalizationEnabled

public boolean isNormalizationEnabled()

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

getNormalizerTargetRegionCount

public int getNormalizerTargetRegionCount()

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

getNormalizerTargetRegionSize

public long getNormalizerTargetRegionSize()

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

setNormalizationEnabled

public TableDescriptorBuilder.ModifyableTableDescriptor setNormalizationEnabled(boolean isEnable)

Setting the table normalization enable flag.

Parameters:

isEnable - True if enable normalization.

Returns:

the modifyable TD

setNormalizerTargetRegionCount

public TableDescriptorBuilder.ModifyableTableDescriptor setNormalizerTargetRegionCount(int regionCount)

Setting the target region count of table normalization .

Parameters:

regionCount - the target region count.

Returns:

the modifyable TD

setNormalizerTargetRegionSize

public TableDescriptorBuilder.ModifyableTableDescriptor setNormalizerTargetRegionSize(long regionSize)

Setting the target region size of table normalization.

Parameters:

regionSize - the target region size.

Returns:

the modifyable TD

setDurability

public TableDescriptorBuilder.ModifyableTableDescriptor setDurability(Durability durability)

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

Parameters:

durability - enum value

Returns:

the modifyable TD

getDurability

public Durability getDurability()

Returns the durability setting for the table.

Specified by:

getDurability in interface TableDescriptor

Returns:

durability setting for the table.

getTableName

public TableName getTableName()

Get the name of the table

Specified by:

getTableName in interface TableDescriptor

setRegionSplitPolicyClassName

public TableDescriptorBuilder.ModifyableTableDescriptor setRegionSplitPolicyClassName(String clazz)

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

Returns:

the modifyable TD

getRegionSplitPolicyClassName

public String getRegionSplitPolicyClassName()

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()

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 TableDescriptorBuilder.ModifyableTableDescriptor setMaxFileSize(long maxFileSize)

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.

Returns:

the modifyable TD

setMaxFileSize

public TableDescriptorBuilder.ModifyableTableDescriptor setMaxFileSize(String maxFileSize)
                                                                throws HBaseException

Throws:

HBaseException

getMemStoreFlushSize

public long getMemStoreFlushSize()

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 TableDescriptorBuilder.ModifyableTableDescriptor setMemStoreFlushSize(long memstoreFlushSize)

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

Returns:

the modifyable TD

setMemStoreFlushSize

public TableDescriptorBuilder.ModifyableTableDescriptor setMemStoreFlushSize(String memStoreFlushSize)
                                                                      throws HBaseException

Throws:

HBaseException

setFlushPolicyClassName

public TableDescriptorBuilder.ModifyableTableDescriptor setFlushPolicyClassName(String clazz)

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

Returns:

the modifyable TD

getFlushPolicyClassName

public String getFlushPolicyClassName()

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.

setColumnFamily

public TableDescriptorBuilder.ModifyableTableDescriptor setColumnFamily(ColumnFamilyDescriptor family)

Adds a column family. For the updating purpose please use modifyColumnFamily(ColumnFamilyDescriptor) instead.

Parameters:

family - to add.

Returns:

the modifyable TD

modifyColumnFamily

public TableDescriptorBuilder.ModifyableTableDescriptor modifyColumnFamily(ColumnFamilyDescriptor family)

Modifies the existing column family.

Parameters:

family - to update

Returns:

this (for chained invocation)

putColumnFamily

private TableDescriptorBuilder.ModifyableTableDescriptor putColumnFamily(ColumnFamilyDescriptor family)

hasColumnFamily

public boolean hasColumnFamily(byte[] familyName)

Checks to see if this table contains the given column family

Specified by:

hasColumnFamily in interface TableDescriptor

Parameters:

familyName - Family name or column name.

Returns:

true if the table contains the specified family name

toString

public String toString()

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

Overrides:

toString in class Object

toStringCustomizedValues

public String toStringCustomizedValues()

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()

Returns map of all table attributes formatted into string.

getValues

private StringBuilder getValues(boolean printDefaults)

equals

public boolean equals(Object obj)

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

Overrides:

equals in class Object

Parameters:

obj - The object to compare

Returns:

true if the contents of the the two descriptors exactly match

See Also:

• Object.equals(java.lang.Object)

hashCode

public int hashCode()

Returns hash code

Overrides:

hashCode in class Object

compareTo

public int compareTo(TableDescriptorBuilder.ModifyableTableDescriptor other)

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<TableDescriptorBuilder.ModifyableTableDescriptor>

Parameters:

other - The MTD to compare

Returns:

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

getColumnFamilies

public ColumnFamilyDescriptor[] getColumnFamilies()

Description copied from interface: TableDescriptor

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

Specified by:

getColumnFamilies in interface TableDescriptor

Returns:

An array of ColumnFamilyDescriptor of all the column families.

getRegionReplication

public int getRegionReplication()

Returns the configured replicas per region

Specified by:

getRegionReplication in interface TableDescriptor

setRegionReplication

public TableDescriptorBuilder.ModifyableTableDescriptor setRegionReplication(int regionReplication)

Sets the number of replicas per region.

Parameters:

regionReplication - the replication factor per region

Returns:

the modifyable TD

hasRegionMemStoreReplication

public boolean hasRegionMemStoreReplication()

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

Specified by:

hasRegionMemStoreReplication in interface TableDescriptor

setRegionMemStoreReplication

public TableDescriptorBuilder.ModifyableTableDescriptor setRegionMemStoreReplication(boolean memstoreReplication)

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.

Returns:

the modifyable TD

setPriority

public TableDescriptorBuilder.ModifyableTableDescriptor setPriority(int priority)

getPriority

public int getPriority()

Specified by:

getPriority in interface TableDescriptor

getColumnFamilyNames

public Set<byte[]> getColumnFamilyNames()

Returns all the column family names of the current table. The map of TableDescriptor contains mapping of family name to ColumnFamilyDescriptor. 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.

getColumnFamily

public ColumnFamilyDescriptor getColumnFamily(byte[] column)

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

Specified by:

getColumnFamily in interface TableDescriptor

Parameters:

column - Column family name

Returns:

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

removeColumnFamily

public ColumnFamilyDescriptor removeColumnFamily(byte[] column)

Removes the ColumnFamilyDescriptor 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.

setCoprocessor

public TableDescriptorBuilder.ModifyableTableDescriptor setCoprocessor(String className)
                                                                throws IOException

Add a table coprocessor to this table. The coprocessor type must be org.apache.hadoop.hbase.coprocessor.RegionObserver or Endpoint. 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.

Returns:

the modifyable TD

Throws:

IOException

setCoprocessor

public TableDescriptorBuilder.ModifyableTableDescriptor setCoprocessor(CoprocessorDescriptor cp)
                                                                throws IOException

Add a table coprocessor to this table. The coprocessor type must be org.apache.hadoop.hbase.coprocessor.RegionObserver or Endpoint. 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.

Returns:

the modifyable TD

Throws:

IOException - any illegal parameter key/value

setCoprocessorWithSpec

@Deprecated
public TableDescriptorBuilder.ModifyableTableDescriptor setCoprocessorWithSpec(String specStr)
                                                                        throws IOException

Deprecated.

used by HTableDescriptor and admin.rb. As of release 2.0.0, this will be removed in HBase 3.0.0.

Add a table coprocessor to this table. The coprocessor type must be org.apache.hadoop.hbase.coprocessor.RegionObserver or Endpoint. 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

Returns:

the modifyable TD

Throws:

IOException

checkHasCoprocessor

private void checkHasCoprocessor(String className)
                          throws IOException

Throws:

IOException

setCoprocessorToMap

private TableDescriptorBuilder.ModifyableTableDescriptor setCoprocessorToMap(String specStr)

Add coprocessor to values Map

Parameters:

specStr - The Coprocessor specification all in in one String

Returns:

Returns this

hasCoprocessor

public boolean hasCoprocessor(String classNameToMatch)

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 List<CoprocessorDescriptor> getCoprocessorDescriptors()

Return the list of attached co-processor represented by their name className

Specified by:

getCoprocessorDescriptors in interface TableDescriptor

Returns:

The list of co-processors classNames

removeCoprocessor

public void removeCoprocessor(String className)

Remove a coprocessor from those set on the table

Parameters:

className - Class name of the co-processor

setOwner

@Deprecated
public TableDescriptorBuilder.ModifyableTableDescriptor setOwner(User owner)

Deprecated.

since 2.0.0 and will be removed in 3.0.0.

Set the table owner

See Also:

• HBASE-15583

setOwnerString

@Deprecated
public TableDescriptorBuilder.ModifyableTableDescriptor setOwnerString(String ownerString)

Deprecated.

since 2.0.0 and will be removed in 3.0.0.

Set the table owner.

See Also:

• HBASE-15583

getOwnerString

@Deprecated
public String getOwnerString()

Deprecated.

since 2.0.0 and will be removed in 3.0.0.

Set the table owner.

Specified by:

getOwnerString in interface TableDescriptor

See Also:

• HBASE-15583

toByteArray

private byte[] toByteArray()

Returns the bytes in pb format

parseFrom

private static TableDescriptor parseFrom(byte[] bytes)
                                  throws DeserializationException

Parse the serialized representation of a TableDescriptorBuilder.ModifyableTableDescriptor

Parameters:

bytes - A pb serialized TableDescriptorBuilder.ModifyableTableDescriptor instance with pb magic prefix

Returns:

An instance of TableDescriptorBuilder.ModifyableTableDescriptor made from bytes

Throws:

DeserializationException

See Also:

• toByteArray()

getColumnFamilyCount

public int getColumnFamilyCount()

Description copied from interface: TableDescriptor

Returns the count of the column families of the table.

Specified by:

getColumnFamilyCount in interface TableDescriptor

Returns:

Count of column families of the table

getRegionServerGroup

public Optional<String> getRegionServerGroup()

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