org.apache.hadoop.hbase.client

Class TableDescriptorBuilder

java.lang.Object

org.apache.hadoop.hbase.client.TableDescriptorBuilder

@InterfaceAudience.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 and Description
static class	TableDescriptorBuilder.ModifyableTableDescriptor TODO: make this private after removing the HTableDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPACTION_ENABLED Used by HBase Shell interface to access this metadata attribute which denotes if the table is compaction enabled.
static boolean	DEFAULT_COMPACTION_ENABLED Constant that denotes whether the table is compaction enabled by default
static 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 boolean	DEFAULT_MERGE_ENABLED Constant that denotes whether the table is merge enabled by default
static boolean	DEFAULT_NORMALIZATION_ENABLED Deprecated.
static boolean	DEFAULT_READONLY Constant that denotes whether the table is READONLY by default and is false
static boolean	DEFAULT_REGION_MEMSTORE_REPLICATION
static int	DEFAULT_REGION_REPLICATION
static boolean	DEFAULT_SPLIT_ENABLED Constant that denotes whether the table is split enabled by default
static String	DURABILITY Durability setting for the table.
static String	FLUSH_POLICY
static String	IS_META Used by rest interface to access this metadata attribute which denotes if it is a catalog table, either hbase:meta .
static org.slf4j.Logger	LOG
static 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.
static 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.
static String	MERGE_ENABLED Used by HBase Shell interface to access this metadata attribute which denotes if the table is merge enabled.
static byte[]	NAMESPACE_COL_DESC_BYTES
static String	NAMESPACE_FAMILY_INFO
static byte[]	NAMESPACE_FAMILY_INFO_BYTES
static TableDescriptor	NAMESPACE_TABLEDESC Table descriptor for namespace table
static String	NORMALIZATION_ENABLED Used by shell/rest interface to access this metadata attribute which denotes if the table should be treated by region normalizer.
static String	NORMALIZER_TARGET_REGION_COUNT
static String	NORMALIZER_TARGET_REGION_SIZE Deprecated.
static String	NORMALIZER_TARGET_REGION_SIZE_MB
static String	OWNER
static Bytes	OWNER_KEY
static String	PRIORITY
static String	READONLY Used by rest interface to access this metadata attribute which denotes if the table is Read Only.
static String	REGION_MEMSTORE_REPLICATION The flag to indicate whether or not the memstore should be replicated for read-replicas (CONSISTENCY => TIMELINE).
static String	REGION_REPLICATION The number of region replicas for the table.
static String	SPLIT_ENABLED Used by HBase Shell interface to access this metadata attribute which denotes if the table is split enabled.
static String	SPLIT_POLICY

Method Summary

Modifier and Type	Method and Description
TableDescriptorBuilder	addColumnFamily(ColumnFamilyDescriptor family) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use setColumnFamily(ColumnFamilyDescriptor) instead
TableDescriptorBuilder	addCoprocessor(String className) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use setCoprocessor(String) instead
TableDescriptorBuilder	addCoprocessor(String className, org.apache.hadoop.fs.Path jarFilePath, int priority, Map<String,String> kvs) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use setCoprocessor(CoprocessorDescriptor) instead
TableDescriptorBuilder	addCoprocessorWithSpec(String specStr) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use setCoprocessor(CoprocessorDescriptor) instead
TableDescriptor	build()
static TableDescriptor	copy(TableDescriptor desc)
static TableDescriptor	copy(TableName name, TableDescriptor desc)
static PrettyPrinter.Unit	getUnit(String key)
String	getValue(String key)
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(Bytes key)
TableDescriptorBuilder	removeValue(String key)
TableDescriptorBuilder	setColumnFamilies(Collection<ColumnFamilyDescriptor> families)
TableDescriptorBuilder	setColumnFamily(ColumnFamilyDescriptor family)
TableDescriptorBuilder	setCompactionEnabled(boolean isEnable)
TableDescriptorBuilder	setCoprocessor(CoprocessorDescriptor cpDesc)
TableDescriptorBuilder	setCoprocessor(String className)
TableDescriptorBuilder	setCoprocessors(Collection<CoprocessorDescriptor> cpDescs)
TableDescriptorBuilder	setDurability(Durability durability)
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	setOwner(User owner) Deprecated. since 2.0.0 and will be removed in 3.0.0.
TableDescriptorBuilder	setOwnerString(String ownerString) Deprecated. since 2.0.0 and will be removed in 3.0.0.
TableDescriptorBuilder	setPriority(int priority)
TableDescriptorBuilder	setReadOnly(boolean readOnly)
TableDescriptorBuilder	setRegionMemStoreReplication(boolean memstoreReplication)
TableDescriptorBuilder	setRegionReplication(int regionReplication)
TableDescriptorBuilder	setRegionServerGroup(String group) Set the RSGroup for this table, specified RSGroup must exist before create or modify table.
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(Bytes key, Bytes value)
TableDescriptorBuilder	setValue(String key, String value)
static byte[]	toByteArray(TableDescriptor desc) Returns This instance serialized with pb with pb magic prefix

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

SPLIT_POLICY

@InterfaceAudience.Private
public static final String SPLIT_POLICY

See Also:

Constant Field Values

MAX_FILESIZE

@InterfaceAudience.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

OWNER

@InterfaceAudience.Private
public static final String OWNER

See Also:

Constant Field Values

OWNER_KEY

@InterfaceAudience.Private
public static final Bytes OWNER_KEY

READONLY

@InterfaceAudience.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

COMPACTION_ENABLED

@InterfaceAudience.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

SPLIT_ENABLED

@InterfaceAudience.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

MERGE_ENABLED

@InterfaceAudience.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

MEMSTORE_FLUSHSIZE

@InterfaceAudience.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

FLUSH_POLICY

@InterfaceAudience.Private
public static final String FLUSH_POLICY

See Also:

Constant Field Values

IS_META

@InterfaceAudience.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

DURABILITY

@InterfaceAudience.Private
public static final String DURABILITY

Durability setting for the table.

See Also:

Constant Field Values

REGION_REPLICATION

@InterfaceAudience.Private
public static final String REGION_REPLICATION

The number of region replicas for the table.

See Also:

Constant Field Values

REGION_MEMSTORE_REPLICATION

@InterfaceAudience.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

NORMALIZATION_ENABLED

@InterfaceAudience.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

DEFAULT_NORMALIZATION_ENABLED

@InterfaceAudience.Private
 @Deprecated
public static final boolean DEFAULT_NORMALIZATION_ENABLED

Deprecated.

See Also:

Constant Field Values

NORMALIZER_TARGET_REGION_COUNT

@InterfaceAudience.Private
public static final String NORMALIZER_TARGET_REGION_COUNT

See Also:

Constant Field Values

NORMALIZER_TARGET_REGION_SIZE_MB

@InterfaceAudience.Private
public static final String NORMALIZER_TARGET_REGION_SIZE_MB

See Also:

Constant Field Values

NORMALIZER_TARGET_REGION_SIZE

@InterfaceAudience.Private
 @Deprecated
public static final String NORMALIZER_TARGET_REGION_SIZE

Deprecated.

See Also:

Constant Field Values

PRIORITY

@InterfaceAudience.Private
public static final String PRIORITY

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

NAMESPACE_FAMILY_INFO

@InterfaceAudience.Private
public static final String NAMESPACE_FAMILY_INFO

See Also:

Constant Field Values

NAMESPACE_FAMILY_INFO_BYTES

@InterfaceAudience.Private
public static final byte[] NAMESPACE_FAMILY_INFO_BYTES

NAMESPACE_COL_DESC_BYTES

@InterfaceAudience.Private
public static final byte[] NAMESPACE_COL_DESC_BYTES

NAMESPACE_TABLEDESC

public static final TableDescriptor NAMESPACE_TABLEDESC

Table descriptor for namespace table

Method Detail

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

addCoprocessor

@Deprecated
public TableDescriptorBuilder addCoprocessor(String className)
                                                  throws IOException

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

Throws:

IOException

addCoprocessor

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

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

Throws:

IOException

addCoprocessorWithSpec

@Deprecated
public TableDescriptorBuilder addCoprocessorWithSpec(String specStr)
                                                          throws IOException

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

Throws:

IOException

addColumnFamily

@Deprecated
public TableDescriptorBuilder addColumnFamily(ColumnFamilyDescriptor family)

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

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

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)

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)

setOwner

@Deprecated
public TableDescriptorBuilder 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 setOwnerString(String ownerString)

Deprecated. since 2.0.0 and will be removed in 3.0.0.

Set the table owner

See Also:

HBASE-15583

setPriority

public TableDescriptorBuilder setPriority(int priority)

setReadOnly

public TableDescriptorBuilder setReadOnly(boolean readOnly)

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)

Set the RSGroup for this table, specified RSGroup must exist before create or modify table.

Parameters:

group - rsgroup name

Returns:

a TableDescriptorBuilder

build

public TableDescriptor build()