org.apache.gravitino

Interface SupportsMetalakes

All Known Implementing Classes:

GravitinoAdminClient

@Evolving
public interface SupportsMetalakes

Client interface for supporting metalakes. It includes methods for listing, loading, creating, altering and dropping metalakes.

Method Summary

Modifier and Type	Method and Description
Metalake	alterMetalake(java.lang.String name, MetalakeChange... changes) Alter a metalake with specified metalake name and changes.
Metalake	createMetalake(java.lang.String name, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Create a metalake with specified name, comment and properties.
void	disableMetalake(java.lang.String name) Disable a metalake.
default boolean	dropMetalake(java.lang.String name) Drop a metalake with specified name.
boolean	dropMetalake(java.lang.String name, boolean force) Drop a metalake with specified name.
void	enableMetalake(java.lang.String name) Enable a metalake.
Metalake[]	listMetalakes() List all metalakes.
Metalake	loadMetalake(java.lang.String name) Load a metalake by its name.
default boolean	metalakeExists(java.lang.String name) Check if a metalake exists.

Method Detail

listMetalakes

Metalake[] listMetalakes()

List all metalakes.

Returns:

The list of metalakes.

loadMetalake

Metalake loadMetalake(java.lang.String name)
               throws NoSuchMetalakeException

Load a metalake by its name.

Parameters:

name - the name of the metalake.

Returns:

The metalake.

Throws:

NoSuchMetalakeException - If the metalake does not exist.

metalakeExists

default boolean metalakeExists(java.lang.String name)

Check if a metalake exists.

Parameters:

name - The name of the metalake.

Returns:

True if the metalake exists, false otherwise.

createMetalake

Metalake createMetalake(java.lang.String name,
                        java.lang.String comment,
                        java.util.Map<java.lang.String,java.lang.String> properties)
                 throws MetalakeAlreadyExistsException

Create a metalake with specified name, comment and properties.

Parameters:

name - The name of the metalake.

comment - The comment of the metalake.

properties - The properties of the metalake.

Returns:

The created metalake.

Throws:

MetalakeAlreadyExistsException - If the metalake already exists.

alterMetalake

Metalake alterMetalake(java.lang.String name,
                       MetalakeChange... changes)
                throws NoSuchMetalakeException,
                       java.lang.IllegalArgumentException

Alter a metalake with specified metalake name and changes.

Parameters:

name - The name of the metalake.

changes - The changes to apply.

Returns:

The altered metalake.

Throws:

NoSuchMetalakeException - If the metalake does not exist.

java.lang.IllegalArgumentException - If the changes cannot be applied to the metalake.

dropMetalake

default boolean dropMetalake(java.lang.String name)
                      throws NonEmptyEntityException,
                             MetalakeInUseException

Drop a metalake with specified name. Please make sure:

• There is no catalog in the metalake. Otherwise, a NonEmptyEntityException will be thrown.
• The method disableMetalake(String) has been called before dropping the metalake. Otherwise, a MetalakeInUseException will be thrown.

It is equivalent to calling dropMetalake(name, false).

Parameters:

name - The name of the metalake.

Returns:

True if the metalake was dropped, false if the metalake does not exist.

Throws:

NonEmptyEntityException - If the metalake is not empty.

MetalakeInUseException - If the metalake is in use.

dropMetalake

boolean dropMetalake(java.lang.String name,
                     boolean force)
              throws NonEmptyEntityException,
                     MetalakeInUseException

Drop a metalake with specified name. If the force flag is true, it will:

• Cascade drop all sub-entities (tags, catalogs, schemas, tables, etc.) of the metalake in Gravitino store.
• Drop the metalake even if it is in use.
• External resources (e.g. database, table, etc.) associated with sub-entities will not be deleted unless it is managed (such as managed fileset).

If the force flag is false, it is equivalent to calling dropMetalake(String).

Parameters:

name - The name of the metalake.

force - Whether to force the drop.

Returns:

True if the metalake was dropped, false if the metalake does not exist.

Throws:

NonEmptyEntityException - If the metalake is not empty and force is false.

MetalakeInUseException - If the metalake is in use and force is false.

enableMetalake

void enableMetalake(java.lang.String name)
             throws NoSuchMetalakeException

Enable a metalake. If the metalake is already in use, this method does nothing.

Parameters:

name - The name of the metalake.

Throws:

NoSuchMetalakeException - If the metalake does not exist.

disableMetalake

void disableMetalake(java.lang.String name)
              throws NoSuchMetalakeException

Disable a metalake. If the metalake is already disabled, this method does nothing. Once a metalake is disable:

• It can only be listed, loaded, dropped, or enable.
• Any other operations on the metalake will throw an MetalakeNotInUseException.
• Any operation on the sub-entities (catalogs, schemas, tables, etc.) will throw an MetalakeNotInUseException.

Parameters:

name - The name of the metalake.

Throws:

NoSuchMetalakeException - If the metalake does not exist.