TableDescriptorBuilder (Apache HBase 2.5.0 API)

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

Field Summary

Fields
Modifier and Type	Field and Description
`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_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 org.slf4j.Logger`	`LOG`
`static TableDescriptor`	`NAMESPACE_TABLEDESC` Table descriptor for namespace table

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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 org.apache.hadoop.hbase.util.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
```
- 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_TABLEDESC
```
public static final TableDescriptor NAMESPACE_TABLEDESC
```
  Table descriptor for namespace table

Method Detail

getUnit

public static org.apache.hadoop.hbase.util.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 org.apache.hadoop.hbase.exceptions.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:

org.apache.hadoop.hbase.exceptions.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 org.apache.hadoop.hbase.exceptions.HBaseException

Throws:: org.apache.hadoop.hbase.exceptions.HBaseException

setMemStoreFlushSize

public TableDescriptorBuilder setMemStoreFlushSize(long memstoreFlushSize)

setMemStoreFlushSize

public TableDescriptorBuilder setMemStoreFlushSize(String memStoreFlushSize)
                                            throws org.apache.hadoop.hbase.exceptions.HBaseException

Throws:: org.apache.hadoop.hbase.exceptions.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()
```

Class TableDescriptorBuilder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

DEFAULT_READONLY

DEFAULT_COMPACTION_ENABLED

DEFAULT_SPLIT_ENABLED

DEFAULT_MERGE_ENABLED

DEFAULT_MEMSTORE_FLUSH_SIZE

DEFAULT_REGION_REPLICATION

DEFAULT_REGION_MEMSTORE_REPLICATION

NAMESPACE_TABLEDESC

Method Detail

getUnit

toByteArray

parseFrom

newBuilder

copy

copy

newBuilder

addCoprocessor

addCoprocessor

addCoprocessorWithSpec

addColumnFamily

setCoprocessor

setCoprocessor

setCoprocessors

setColumnFamily

setColumnFamilies

modifyColumnFamily

removeValue

removeValue

removeValue

removeColumnFamily

removeCoprocessor

setCompactionEnabled

setSplitEnabled

setMergeEnabled

setDurability

setFlushPolicyClassName

setMaxFileSize

setMaxFileSize

setMemStoreFlushSize

setMemStoreFlushSize

setNormalizerTargetRegionCount

setNormalizerTargetRegionSize

setNormalizationEnabled

setOwner

setOwnerString

setPriority

setReadOnly

setRegionMemStoreReplication

setRegionReplication

setRegionSplitPolicyClassName

setValue

setValue

setValue

getValue

setReplicationScope

setRegionServerGroup

build