org.apache.hadoop.hbase.client

Class TableDescriptorBuilder

java.lang.Object

org.apache.hadoop.hbase.client.TableDescriptorBuilder

@InterfaceAudience.Public
public class TableDescriptorBuilder
extends Object

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.
private static Bytes	COMPACTION_ENABLED_KEY
private static Pattern	CP_HTD_ATTR_KEY_PATTERN
private static String	CP_HTD_ATTR_VALUE_PARAM_KEY_PATTERN
private static Pattern	CP_HTD_ATTR_VALUE_PARAM_PATTERN
private static String	CP_HTD_ATTR_VALUE_PARAM_VALUE_PATTERN
private static Pattern	CP_HTD_ATTR_VALUE_PATTERN Pattern that matches a coprocessor specification.
static boolean	DEFAULT_COMPACTION_ENABLED Constant that denotes whether the table is compaction enabled by default
private static Durability	DEFAULT_DURABLITY Default durability for HTD is USE_DEFAULT, which defaults to HBase-global default value
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_NORMALIZATION_ENABLED Constant that denotes whether the table is normalized by default.
private static int	DEFAULT_PRIORITY Relative priority of the table used for rpc scheduling
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
private static Map<String,String>	DEFAULT_VALUES
private TableDescriptorBuilder.ModifyableTableDescriptor	desc
static String	DURABILITY Durability setting for the table.
private static Bytes	DURABILITY_KEY
static String	FLUSH_POLICY
private static Bytes	FLUSH_POLICY_KEY
static 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 Bytes	IS_META_KEY
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.
private static Bytes	MAX_FILESIZE_KEY
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.
private static Bytes	MEMSTORE_FLUSHSIZE_KEY
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.
private static Bytes	NORMALIZATION_ENABLED_KEY
static String	OWNER
static Bytes	OWNER_KEY
static String	PRIORITY
private static Bytes	PRIORITY_KEY
static String	READONLY Used by rest interface to access this metadata attribute which denotes if the table is Read Only.
private static Bytes	READONLY_KEY
static String	REGION_MEMSTORE_REPLICATION The flag to indicate whether or not the memstore should be replicated for read-replicas (CONSISTENCY => TIMELINE).
private static Bytes	REGION_MEMSTORE_REPLICATION_KEY
private static Bytes	REGION_REPLICA_WAIT_FOR_PRIMARY_FLUSH_CONF_KEY
static String	REGION_REPLICATION The number of region replicas for the table.
private static Bytes	REGION_REPLICATION_KEY
private static Set<Bytes>	RESERVED_KEYWORDS
static String	SPLIT_POLICY
private static Bytes	SPLIT_POLICY_KEY

Constructor Summary

Constructors

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

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)
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	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	setMemStoreFlushSize(long memstoreFlushSize)
TableDescriptorBuilder	setNormalizationEnabled(boolean isEnable)
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	setRegionSplitPolicyClassName(String clazz)
TableDescriptorBuilder	setReplicationScope(int scope) Sets replication scope all & only the columns already in the builder.
TableDescriptorBuilder	setValue(byte[] key, byte[] value)
TableDescriptorBuilder	setValue(Bytes key, Bytes value)
TableDescriptorBuilder	setValue(String key, String value)
static byte[]	toByteArray(TableDescriptor desc)
private static Optional<CoprocessorDescriptor>	toCoprocessorDescriptor(String spec)

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

SPLIT_POLICY_KEY

private static final Bytes SPLIT_POLICY_KEY

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

MAX_FILESIZE_KEY

private static final Bytes MAX_FILESIZE_KEY

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

READONLY_KEY

private static final Bytes READONLY_KEY

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

COMPACTION_ENABLED_KEY

private static final Bytes COMPACTION_ENABLED_KEY

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

MEMSTORE_FLUSHSIZE_KEY

private static final Bytes MEMSTORE_FLUSHSIZE_KEY

FLUSH_POLICY

@InterfaceAudience.Private
public static final String FLUSH_POLICY

See Also:

Constant Field Values

FLUSH_POLICY_KEY

private static final Bytes FLUSH_POLICY_KEY

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

IS_META_KEY

private static final Bytes IS_META_KEY

DURABILITY

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

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

@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

REGION_MEMSTORE_REPLICATION_KEY

private static final Bytes REGION_MEMSTORE_REPLICATION_KEY

REGION_REPLICA_WAIT_FOR_PRIMARY_FLUSH_CONF_KEY

private static final Bytes REGION_REPLICA_WAIT_FOR_PRIMARY_FLUSH_CONF_KEY

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

NORMALIZATION_ENABLED_KEY

private static final Bytes NORMALIZATION_ENABLED_KEY

DEFAULT_DURABLITY

private static final Durability DEFAULT_DURABLITY

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

PRIORITY

@InterfaceAudience.Private
public static final String PRIORITY

See Also:

Constant Field Values

PRIORITY_KEY

private static final Bytes PRIORITY_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_NORMALIZATION_ENABLED

public static final boolean DEFAULT_NORMALIZATION_ENABLED

Constant that denotes whether the table is normalized 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

@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

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

public static final TableDescriptor NAMESPACE_TABLEDESC

Table descriptor for namespace table

desc

private final TableDescriptorBuilder.ModifyableTableDescriptor desc

Constructor Detail

TableDescriptorBuilder

private TableDescriptorBuilder(TableName name)

TableDescriptorBuilder

private TableDescriptorBuilder(TableDescriptor desc)

Method Detail

toByteArray

public static byte[] toByteArray(TableDescriptor desc)

Parameters:

desc - The table descriptor to serialize

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

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

setDurability

public TableDescriptorBuilder setDurability(Durability durability)

setFlushPolicyClassName

public TableDescriptorBuilder setFlushPolicyClassName(String clazz)

setMaxFileSize

public TableDescriptorBuilder setMaxFileSize(long maxFileSize)

setMemStoreFlushSize

public TableDescriptorBuilder setMemStoreFlushSize(long memstoreFlushSize)

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.

See Also:

HBASE-15583

setOwnerString

@Deprecated
public TableDescriptorBuilder setOwnerString(String ownerString)

Deprecated. since 2.0.0 and will be removed in 3.0.0.

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)

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

build

public TableDescriptor build()

toCoprocessorDescriptor

private static Optional<CoprocessorDescriptor> toCoprocessorDescriptor(String spec)