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 identifier.
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 identifier.
boolean	dropMetalake(java.lang.String name) Drop a metalake with specified identifier.
Metalake[]	listMetalakes() List all metalakes.
Metalake	loadMetalake(java.lang.String name) Load a metalake by its identifier.
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 identifier.

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 identifier.

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 identifier.

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

boolean dropMetalake(java.lang.String name)

Drop a metalake with specified identifier.

Parameters:

name - The identifier of the metalake.

Returns:

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