Package org.apache.hadoop.hbase.client

Class TableDescriptorBuilder

java.lang.Object

org.apache.hadoop.hbase.client.TableDescriptorBuilder

@Public
public class TableDescriptorBuilder
extends Object

Convenience class for composing an instance of TableDescriptor.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	TableDescriptorBuilder.ModifyableTableDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPACTION_ENABLED	Used by HBase Shell interface to access this metadata attribute which denotes if the table is compaction enabled.
private static final Bytes	COMPACTION_ENABLED_KEY
private static final Pattern	CP_HTD_ATTR_KEY_PATTERN
private static final String	CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN
private static final Pattern	CP_HTD_ATTR_VALUE_PARAM_PATTERN
private static final String	CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN
private static final Pattern	CP_HTD_ATTR_VALUE_PATTERN	Pattern that matches a coprocessor specification.
static final boolean	DEFAULT_COMPACTION_ENABLED	Constant that denotes whether the table is compaction enabled by default
private static final Durability	DEFAULT_DURABLITY	Default durability for HTD is USE_DEFAULT, which defaults to HBase-global default value
private static final String	DEFAULT_ERASURE_CODING_POLICY
static final long	DEFAULT_MEMSTORE_FLUSH_SIZE	Constant that denotes the maximum default size of the memstore in bytes after which the contents are flushed to the store files.
static final boolean	DEFAULT_MERGE_ENABLED	Constant that denotes whether the table is merge enabled by default
private static final int	DEFAULT_PRIORITY	Relative priority of the table used for rpc scheduling
static final boolean	DEFAULT_READONLY	Constant that denotes whether the table is READONLY by default and is false
static final boolean	DEFAULT_REGION_MEMSTORE_REPLICATION
static final int	DEFAULT_REGION_REPLICATION
static final boolean	DEFAULT_SPLIT_ENABLED	Constant that denotes whether the table is split enabled by default
private static final Map<String,String>	DEFAULT_VALUES
private final TableDescriptorBuilder.ModifyableTableDescriptor	desc
static final String	DURABILITY	Durability setting for the table.
private static final Bytes	DURABILITY_KEY
static final String	ERASURE_CODING_POLICY	If non-null, the HDFS erasure coding policy to set on the data dir of the table
private static final Bytes	ERASURE_CODING_POLICY_KEY
static final String	FLUSH_POLICY
private static final Bytes	FLUSH_POLICY_KEY
static final String	IS_META	Used by rest interface to access this metadata attribute which denotes if it is a catalog table, either hbase:meta .
private static final Bytes	IS_META_KEY
static final org.slf4j.Logger	LOG
static final String	MAX_FILESIZE	Used by HBase Shell interface to access this metadata attribute which denotes the maximum size of the store file after which a region split occurs.
private static final Bytes	MAX_FILESIZE_KEY
static final String	MEMSTORE_FLUSHSIZE	Used by HBase Shell interface to access this metadata attribute which represents the maximum size of the memstore after which its contents are flushed onto the disk.
private static final Bytes	MEMSTORE_FLUSHSIZE_KEY
static final String	MERGE_ENABLED	Used by HBase Shell interface to access this metadata attribute which denotes if the table is merge enabled.
private static final Bytes	MERGE_ENABLED_KEY
static final byte[]	NAMESPACE_COL_DESC_BYTES	Deprecated. namespace table has been folded into the ns family in meta table, do not use this any more.
static final String	NAMESPACE_FAMILY_INFO	Deprecated. namespace table has been folded into the ns family in meta table, do not use this any more.
static final byte[]	NAMESPACE_FAMILY_INFO_BYTES	Deprecated. namespace table has been folded into the ns family in meta table, do not use this any more.
static final TableDescriptor	NAMESPACE_TABLEDESC	Deprecated. since 3.0.0 and will be removed in 4.0.0.
static final String	NORMALIZATION_ENABLED	Used by shell/rest interface to access this metadata attribute which denotes if the table should be treated by region normalizer.
private static final Bytes	NORMALIZATION_ENABLED_KEY
static final String	NORMALIZER_TARGET_REGION_COUNT
private static final Bytes	NORMALIZER_TARGET_REGION_COUNT_KEY
static final String	NORMALIZER_TARGET_REGION_SIZE	Deprecated.
private static final Bytes	NORMALIZER_TARGET_REGION_SIZE_KEY	Deprecated.
static final String	NORMALIZER_TARGET_REGION_SIZE_MB
private static final Bytes	NORMALIZER_TARGET_REGION_SIZE_MB_KEY
static final String	PRIORITY
private static final Bytes	PRIORITY_KEY
static final String	READONLY	Used by rest interface to access this metadata attribute which denotes if the table is Read Only.
private static final Bytes	READONLY_KEY
static final String	REGION_MEMSTORE_REPLICATION	The flag to indicate whether or not the memstore should be replicated for read-replicas (CONSISTENCY => TIMELINE).
private static final Bytes	REGION_MEMSTORE_REPLICATION_KEY
static final String	REGION_REPLICATION	The number of region replicas for the table.
private static final Bytes	REGION_REPLICATION_KEY
private static final Set<Bytes>	RESERVED_KEYWORDS
private static final Bytes	RSGROUP_KEY
static final String	SPLIT_ENABLED	Used by HBase Shell interface to access this metadata attribute which denotes if the table is split enabled.
private static final Bytes	SPLIT_ENABLED_KEY
static final String	SPLIT_POLICY
private static final Bytes	SPLIT_POLICY_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TableDescriptorBuilder(TableDescriptor desc)
private	TableDescriptorBuilder(TableName name)

Method Summary

Modifier and Type	Method	Description
TableDescriptor	build()
static TableDescriptor	copy(TableDescriptor desc)
static TableDescriptor	copy(TableName name, TableDescriptor desc)
static PrettyPrinter.Unit	getUnit(String key)
String	getValue(String key)
boolean	hasCoprocessor(String classNameToMatch)
TableDescriptorBuilder	modifyColumnFamily(ColumnFamilyDescriptor family)
static TableDescriptorBuilder	newBuilder(TableDescriptor desc)	Copy all values, families, and name from the input.
static TableDescriptorBuilder	newBuilder(TableName name)
static TableDescriptor	parseFrom(byte[] pbBytes)	The input should be created by toByteArray(org.apache.hadoop.hbase.client.TableDescriptor).
TableDescriptorBuilder	removeColumnFamily(byte[] name)
TableDescriptorBuilder	removeCoprocessor(String className)
TableDescriptorBuilder	removeValue(byte[] key)
TableDescriptorBuilder	removeValue(String key)
TableDescriptorBuilder	removeValue(BiPredicate<Bytes,Bytes> predicate)
TableDescriptorBuilder	removeValue(Bytes key)
TableDescriptorBuilder	setColumnFamilies(Collection<ColumnFamilyDescriptor> families)
TableDescriptorBuilder	setColumnFamily(ColumnFamilyDescriptor family)
TableDescriptorBuilder	setCompactionEnabled(boolean isEnable)
TableDescriptorBuilder	setCoprocessor(String className)
TableDescriptorBuilder	setCoprocessor(CoprocessorDescriptor cpDesc)
TableDescriptorBuilder	setCoprocessors(Collection<CoprocessorDescriptor> cpDescs)
TableDescriptorBuilder	setDurability(Durability durability)
TableDescriptorBuilder	setErasureCodingPolicy(String policy)
TableDescriptorBuilder	setFlushPolicyClassName(String clazz)
TableDescriptorBuilder	setMaxFileSize(long maxFileSize)
TableDescriptorBuilder	setMaxFileSize(String maxFileSize)
TableDescriptorBuilder	setMemStoreFlushSize(long memstoreFlushSize)
TableDescriptorBuilder	setMemStoreFlushSize(String memStoreFlushSize)
TableDescriptorBuilder	setMergeEnabled(boolean isEnable)
TableDescriptorBuilder	setNormalizationEnabled(boolean isEnable)
TableDescriptorBuilder	setNormalizerTargetRegionCount(int regionCount)
TableDescriptorBuilder	setNormalizerTargetRegionSize(long regionSize)
TableDescriptorBuilder	setPriority(int priority)
TableDescriptorBuilder	setReadOnly(boolean readOnly)
TableDescriptorBuilder	setRegionMemStoreReplication(boolean memstoreReplication)
TableDescriptorBuilder	setRegionReplication(int regionReplication)
TableDescriptorBuilder	setRegionServerGroup(String group)
TableDescriptorBuilder	setRegionSplitPolicyClassName(String clazz)
TableDescriptorBuilder	setReplicationScope(int scope)	Sets replication scope all & only the columns already in the builder.
TableDescriptorBuilder	setSplitEnabled(boolean isEnable)
TableDescriptorBuilder	setValue(byte[] key, byte[] value)
TableDescriptorBuilder	setValue(String key, String value)
TableDescriptorBuilder	setValue(Bytes key, Bytes value)
static byte[]	toByteArray(TableDescriptor desc)	Returns This instance serialized with pb with pb magic prefix
private static Optional<CoprocessorDescriptor>	toCoprocessorDescriptor(String spec)	This method is mostly intended for internal use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOG

public static final org.slf4j.Logger LOG

SPLIT_POLICY

@Private
public static final String SPLIT_POLICY

See Also:

• Constant Field Values

SPLIT_POLICY_KEY

private static final Bytes SPLIT_POLICY_KEY

MAX_FILESIZE

@Private
public static final String MAX_FILESIZE

Used by HBase Shell interface to access this metadata attribute which denotes the maximum size of the store file after which a region split occurs.

See Also:

• Constant Field Values

MAX_FILESIZE_KEY

private static final Bytes MAX_FILESIZE_KEY

READONLY

@Private
public static final String READONLY

Used by rest interface to access this metadata attribute which denotes if the table is Read Only.

See Also:

• Constant Field Values

READONLY_KEY

private static final Bytes READONLY_KEY

COMPACTION_ENABLED

@Private
public static final String COMPACTION_ENABLED

Used by HBase Shell interface to access this metadata attribute which denotes if the table is compaction enabled.

See Also:

• Constant Field Values

COMPACTION_ENABLED_KEY

private static final Bytes COMPACTION_ENABLED_KEY

SPLIT_ENABLED

@Private
public static final String SPLIT_ENABLED

Used by HBase Shell interface to access this metadata attribute which denotes if the table is split enabled.

See Also:

• Constant Field Values

SPLIT_ENABLED_KEY

private static final Bytes SPLIT_ENABLED_KEY

MERGE_ENABLED

@Private
public static final String MERGE_ENABLED

Used by HBase Shell interface to access this metadata attribute which denotes if the table is merge enabled.

See Also:

• Constant Field Values

MERGE_ENABLED_KEY

private static final Bytes MERGE_ENABLED_KEY

MEMSTORE_FLUSHSIZE

@Private
public static final String MEMSTORE_FLUSHSIZE

Used by HBase Shell interface to access this metadata attribute which represents the maximum size of the memstore after which its contents are flushed onto the disk.

See Also:

• Constant Field Values

MEMSTORE_FLUSHSIZE_KEY

private static final Bytes MEMSTORE_FLUSHSIZE_KEY

FLUSH_POLICY

@Private
public static final String FLUSH_POLICY

See Also:

• Constant Field Values

FLUSH_POLICY_KEY

private static final Bytes FLUSH_POLICY_KEY

IS_META

@Private
public static final String IS_META

Used by rest interface to access this metadata attribute which denotes if it is a catalog table, either hbase:meta .

See Also:

• Constant Field Values

IS_META_KEY

private static final Bytes IS_META_KEY

DURABILITY

@Private
public static final String DURABILITY

Durability setting for the table.

See Also:

• Constant Field Values

DURABILITY_KEY

private static final Bytes DURABILITY_KEY

REGION_REPLICATION

@Private
public static final String REGION_REPLICATION

The number of region replicas for the table.

See Also:

• Constant Field Values

REGION_REPLICATION_KEY

private static final Bytes REGION_REPLICATION_KEY

REGION_MEMSTORE_REPLICATION

@Private
public static final String REGION_MEMSTORE_REPLICATION

The flag to indicate whether or not the memstore should be replicated for read-replicas (CONSISTENCY => TIMELINE).

See Also:

• Constant Field Values

REGION_MEMSTORE_REPLICATION_KEY

private static final Bytes REGION_MEMSTORE_REPLICATION_KEY

ERASURE_CODING_POLICY

public static final String ERASURE_CODING_POLICY

If non-null, the HDFS erasure coding policy to set on the data dir of the table

See Also:

• Constant Field Values

ERASURE_CODING_POLICY_KEY

private static final Bytes ERASURE_CODING_POLICY_KEY

DEFAULT_ERASURE_CODING_POLICY

private static final String DEFAULT_ERASURE_CODING_POLICY

NORMALIZATION_ENABLED

@Private
public static final String NORMALIZATION_ENABLED

Used by shell/rest interface to access this metadata attribute which denotes if the table should be treated by region normalizer.

See Also:

• Constant Field Values

NORMALIZATION_ENABLED_KEY

private static final Bytes NORMALIZATION_ENABLED_KEY

NORMALIZER_TARGET_REGION_COUNT

@Private
public static final String NORMALIZER_TARGET_REGION_COUNT

See Also:

• Constant Field Values

NORMALIZER_TARGET_REGION_COUNT_KEY

private static final Bytes NORMALIZER_TARGET_REGION_COUNT_KEY

NORMALIZER_TARGET_REGION_SIZE_MB

@Private
public static final String NORMALIZER_TARGET_REGION_SIZE_MB

See Also:

• Constant Field Values

NORMALIZER_TARGET_REGION_SIZE_MB_KEY

private static final Bytes NORMALIZER_TARGET_REGION_SIZE_MB_KEY

NORMALIZER_TARGET_REGION_SIZE

@Private
@Deprecated
public static final String NORMALIZER_TARGET_REGION_SIZE

Deprecated.

See Also:

• Constant Field Values

NORMALIZER_TARGET_REGION_SIZE_KEY

@Deprecated
private static final Bytes NORMALIZER_TARGET_REGION_SIZE_KEY

Deprecated.

DEFAULT_DURABLITY

private static final Durability DEFAULT_DURABLITY

Default durability for HTD is USE_DEFAULT, which defaults to HBase-global default value

PRIORITY

@Private
public static final String PRIORITY

See Also:

• Constant Field Values

PRIORITY_KEY

private static final Bytes PRIORITY_KEY

RSGROUP_KEY

private static final Bytes RSGROUP_KEY

DEFAULT_PRIORITY

private static final int DEFAULT_PRIORITY

Relative priority of the table used for rpc scheduling

See Also:

• Constant Field Values

DEFAULT_READONLY

public static final boolean DEFAULT_READONLY

Constant that denotes whether the table is READONLY by default and is false

See Also:

• Constant Field Values

DEFAULT_COMPACTION_ENABLED

public static final boolean DEFAULT_COMPACTION_ENABLED

Constant that denotes whether the table is compaction enabled by default

See Also:

• Constant Field Values

DEFAULT_SPLIT_ENABLED

public static final boolean DEFAULT_SPLIT_ENABLED

Constant that denotes whether the table is split enabled by default

See Also:

• Constant Field Values

DEFAULT_MERGE_ENABLED

public static final boolean DEFAULT_MERGE_ENABLED

Constant that denotes whether the table is merge enabled by default

See Also:

• Constant Field Values

DEFAULT_MEMSTORE_FLUSH_SIZE

public static final long DEFAULT_MEMSTORE_FLUSH_SIZE

Constant that denotes the maximum default size of the memstore in bytes after which the contents are flushed to the store files.

See Also:

• Constant Field Values

DEFAULT_REGION_REPLICATION

public static final int DEFAULT_REGION_REPLICATION

See Also:

• Constant Field Values

DEFAULT_REGION_MEMSTORE_REPLICATION

public static final boolean DEFAULT_REGION_MEMSTORE_REPLICATION

See Also:

• Constant Field Values

DEFAULT_VALUES

private static final Map<String,String> DEFAULT_VALUES

RESERVED_KEYWORDS

private static final Set<Bytes> RESERVED_KEYWORDS

NAMESPACE_FAMILY_INFO

@Private
@Deprecated
public static final String NAMESPACE_FAMILY_INFO

Deprecated.

namespace table has been folded into the ns family in meta table, do not use this any more.

See Also:

• Constant Field Values

NAMESPACE_FAMILY_INFO_BYTES

@Private
@Deprecated
public static final byte[] NAMESPACE_FAMILY_INFO_BYTES

Deprecated.

namespace table has been folded into the ns family in meta table, do not use this any more.

NAMESPACE_COL_DESC_BYTES

@Private
@Deprecated
public static final byte[] NAMESPACE_COL_DESC_BYTES

Deprecated.

namespace table has been folded into the ns family in meta table, do not use this any more.

CP_HTD_ATTR_VALUE_PATTERN

private static final Pattern CP_HTD_ATTR_VALUE_PATTERN

 Pattern that matches a coprocessor specification. Form is:
 <coprocessor jar file location> '|' <class name> ['|' <priority> ['|' <arguments>]]
 where arguments are <KEY> '=' <VALUE> [,...]
 For example: hdfs:///foo.jar|com.foo.FooRegionObserver|1001|arg1=1,arg2=2
 

CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN

private static final String CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN

See Also:

• Constant Field Values

CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN

private static final String CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN

See Also:

• Constant Field Values

CP_HTD_ATTR_VALUE_PARAM_PATTERN

private static final Pattern CP_HTD_ATTR_VALUE_PARAM_PATTERN

CP_HTD_ATTR_KEY_PATTERN

private static final Pattern CP_HTD_ATTR_KEY_PATTERN

NAMESPACE_TABLEDESC

@Deprecated
public static final TableDescriptor NAMESPACE_TABLEDESC

Deprecated.

since 3.0.0 and will be removed in 4.0.0. We have folded the data in namespace table into meta table, so do not use it any more.

Table descriptor for namespace table

See Also:

• HBASE-21154

desc

private final TableDescriptorBuilder.ModifyableTableDescriptor desc

Constructor Details

TableDescriptorBuilder

private TableDescriptorBuilder(TableName name)

TableDescriptorBuilder

private TableDescriptorBuilder(TableDescriptor desc)

Method Details

getUnit

public static PrettyPrinter.Unit getUnit(String key)

toByteArray

public static byte[] toByteArray(TableDescriptor desc)

Returns This instance serialized with pb with pb magic prefix

parseFrom

public static TableDescriptor parseFrom(byte[] pbBytes)
                                 throws DeserializationException

The input should be created by toByteArray(org.apache.hadoop.hbase.client.TableDescriptor).

Parameters:

pbBytes - A pb serialized TableDescriptor instance with pb magic prefix

Returns:

This instance serialized with pb with pb magic prefix

Throws:

DeserializationException - if an error occurred

newBuilder

public static TableDescriptorBuilder newBuilder(TableName name)

copy

public static TableDescriptor copy(TableDescriptor desc)

copy

public static TableDescriptor copy(TableName name,
 TableDescriptor desc)

newBuilder

public static TableDescriptorBuilder newBuilder(TableDescriptor desc)

Copy all values, families, and name from the input.

Parameters:

desc - The desciptor to copy

Returns:

A clone of input

setCoprocessor

public TableDescriptorBuilder setCoprocessor(String className)
                                      throws IOException

Throws:

IOException

setCoprocessor

public TableDescriptorBuilder setCoprocessor(CoprocessorDescriptor cpDesc)
                                      throws IOException

Throws:

IOException

setCoprocessors

public TableDescriptorBuilder setCoprocessors(Collection<CoprocessorDescriptor> cpDescs)
                                       throws IOException

Throws:

IOException

hasCoprocessor

public boolean hasCoprocessor(String classNameToMatch)

setColumnFamily

public TableDescriptorBuilder setColumnFamily(ColumnFamilyDescriptor family)

setColumnFamilies

public TableDescriptorBuilder setColumnFamilies(Collection<ColumnFamilyDescriptor> families)

modifyColumnFamily

public TableDescriptorBuilder modifyColumnFamily(ColumnFamilyDescriptor family)

removeValue

public TableDescriptorBuilder removeValue(String key)

removeValue

public TableDescriptorBuilder removeValue(Bytes key)

removeValue

public TableDescriptorBuilder removeValue(byte[] key)

removeValue

public TableDescriptorBuilder removeValue(BiPredicate<Bytes,Bytes> predicate)

removeColumnFamily

public TableDescriptorBuilder removeColumnFamily(byte[] name)

removeCoprocessor

public TableDescriptorBuilder removeCoprocessor(String className)

setCompactionEnabled

public TableDescriptorBuilder setCompactionEnabled(boolean isEnable)

setSplitEnabled

public TableDescriptorBuilder setSplitEnabled(boolean isEnable)

setMergeEnabled

public TableDescriptorBuilder setMergeEnabled(boolean isEnable)

setDurability

public TableDescriptorBuilder setDurability(Durability durability)

setFlushPolicyClassName

public TableDescriptorBuilder setFlushPolicyClassName(String clazz)

setMaxFileSize

public TableDescriptorBuilder setMaxFileSize(long maxFileSize)

setMaxFileSize

public TableDescriptorBuilder setMaxFileSize(String maxFileSize)
                                      throws HBaseException

Throws:

HBaseException

setMemStoreFlushSize

public TableDescriptorBuilder setMemStoreFlushSize(long memstoreFlushSize)

setMemStoreFlushSize

public TableDescriptorBuilder setMemStoreFlushSize(String memStoreFlushSize)
                                            throws HBaseException

Throws:

HBaseException

setNormalizerTargetRegionCount

public TableDescriptorBuilder setNormalizerTargetRegionCount(int regionCount)

setNormalizerTargetRegionSize

public TableDescriptorBuilder setNormalizerTargetRegionSize(long regionSize)

setNormalizationEnabled

public TableDescriptorBuilder setNormalizationEnabled(boolean isEnable)

setPriority

public TableDescriptorBuilder setPriority(int priority)

setReadOnly

public TableDescriptorBuilder setReadOnly(boolean readOnly)

setErasureCodingPolicy

public TableDescriptorBuilder setErasureCodingPolicy(String policy)

setRegionMemStoreReplication

public TableDescriptorBuilder setRegionMemStoreReplication(boolean memstoreReplication)

setRegionReplication

public TableDescriptorBuilder setRegionReplication(int regionReplication)

setRegionSplitPolicyClassName

public TableDescriptorBuilder setRegionSplitPolicyClassName(String clazz)

setValue

public TableDescriptorBuilder setValue(String key,
 String value)

setValue

public TableDescriptorBuilder setValue(Bytes key,
 Bytes value)

setValue

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

getValue

public String getValue(String key)

setReplicationScope

public TableDescriptorBuilder setReplicationScope(int scope)

Sets replication scope all & only the columns already in the builder. Columns added later won't be backfilled with replication scope.

Parameters:

scope - replication scope

Returns:

a TableDescriptorBuilder

setRegionServerGroup

public TableDescriptorBuilder setRegionServerGroup(String group)

build

public TableDescriptor build()

toCoprocessorDescriptor

private static Optional<CoprocessorDescriptor> toCoprocessorDescriptor(String spec)

This method is mostly intended for internal use. However, it it also relied on by hbase-shell for backwards compatibility.