org.apache.hadoop.hbase.master

Interface ClusterSchema

All Known Subinterfaces:

ClusterSchemaService

All Known Implementing Classes:

ClusterSchemaServiceImpl

@InterfaceAudience.Private
public interface ClusterSchema

View and edit the current cluster schema. Use this API making any modification to namespaces, tables, etc.

Implementation Notes

Nonces are for when operation is non-idempotent to ensure once-only semantic, even across process failures.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HBASE_MASTER_CLUSTER_SCHEMA_OPERATION_TIMEOUT Default operation timeout in milliseconds.
static String	HBASE_MASTER_CLUSTER_SCHEMA_OPERATION_TIMEOUT_KEY Timeout for cluster operations in milliseconds.

Method Summary

Modifier and Type	Method and Description
long	createNamespace(NamespaceDescriptor namespaceDescriptor, NonceKey nonceKey, ProcedurePrepareLatch latch) Create a new Namespace.
long	deleteNamespace(String name, NonceKey nonceKey, ProcedurePrepareLatch latch) Delete an existing Namespace.
NamespaceDescriptor	getNamespace(String name) Get a Namespace
List<NamespaceDescriptor>	getNamespaces() Get all Namespaces
TableNamespaceManager	getTableNamespaceManager() For internals use only.
long	modifyNamespace(NamespaceDescriptor descriptor, NonceKey nonceKey, ProcedurePrepareLatch latch) Modify an existing Namespace.

Field Detail

HBASE_MASTER_CLUSTER_SCHEMA_OPERATION_TIMEOUT_KEY

static final String HBASE_MASTER_CLUSTER_SCHEMA_OPERATION_TIMEOUT_KEY

Timeout for cluster operations in milliseconds.

See Also:

Constant Field Values

DEFAULT_HBASE_MASTER_CLUSTER_SCHEMA_OPERATION_TIMEOUT

static final int DEFAULT_HBASE_MASTER_CLUSTER_SCHEMA_OPERATION_TIMEOUT

Default operation timeout in milliseconds.

See Also:

Constant Field Values

Method Detail

getTableNamespaceManager

TableNamespaceManager getTableNamespaceManager()

For internals use only. Do not use! Provisionally part of this Interface. Prefer the high-level APIs available elsewhere in this API.

Returns:

Instance of TableNamespaceManager

createNamespace

long createNamespace(NamespaceDescriptor namespaceDescriptor,
                     NonceKey nonceKey,
                     ProcedurePrepareLatch latch)
              throws IOException

Create a new Namespace.

Parameters:

namespaceDescriptor - descriptor for new Namespace

nonceKey - A unique identifier for this operation from the client or process.

latch - A latch to block on for precondition validation

Returns:

procedure id

Throws:

IOException - Throws ClusterSchemaException and InterruptedIOException as well as IOException

modifyNamespace

long modifyNamespace(NamespaceDescriptor descriptor,
                     NonceKey nonceKey,
                     ProcedurePrepareLatch latch)
              throws IOException

Modify an existing Namespace.

Parameters:

nonceKey - A unique identifier for this operation from the client or process.

latch - A latch to block on for precondition validation

Returns:

procedure id

Throws:

IOException - Throws ClusterSchemaException and InterruptedIOException as well as IOException

deleteNamespace

long deleteNamespace(String name,
                     NonceKey nonceKey,
                     ProcedurePrepareLatch latch)
              throws IOException

Delete an existing Namespace. Only empty Namespaces (no tables) can be removed.

Parameters:

nonceKey - A unique identifier for this operation from the client or process.

latch - A latch to block on for precondition validation

Returns:

procedure id

Throws:

IOException - Throws ClusterSchemaException and InterruptedIOException as well as IOException

getNamespace

NamespaceDescriptor getNamespace(String name)
                          throws IOException

Get a Namespace

Parameters:

name - Name of the Namespace

Returns:

Namespace descriptor for name

Throws:

IOException - Throws ClusterSchemaException and InterruptedIOException as well as IOException

getNamespaces

List<NamespaceDescriptor> getNamespaces()
                                 throws IOException

Get all Namespaces

Returns:

All Namespace descriptors

Throws:

IOException