Manage Metalakes

Introduction

This page covers the Gravitino API for metalakes. For what a metalake is, what it isolates, the in-use behavior, deletion semantics, and permissions, see Metalakes.

Metalakes sit above any single metalake, so these operations use the admin client rather than the client used for everything inside one. Creating a metalake is reserved for service admins, configured with gravitino.authorization.serviceAdmins.

Metalake Operations

Create a Metalake

REST

curl -X POST -H "Accept: application/vnd.gravitino.v1+json" \
  -H "Content-Type: application/json" -d '{
  "name": "production",
  "comment": "Production estate",
  "properties": {}
}' http://localhost:8090/api/metalakes

Java

GravitinoAdminClient adminClient = GravitinoAdminClient
    .builder("http://localhost:8090")
    .build();

GravitinoMetalake metalake = adminClient.createMetalake(
    "production", "Production estate", new HashMap<>());

Python

admin_client = GravitinoAdminClient(uri="http://localhost:8090")
admin_client.create_metalake(
    name="production", comment="Production estate", properties={})

Load a Metalake

REST

curl -X GET -H "Accept: application/vnd.gravitino.v1+json" \
  http://localhost:8090/api/metalakes/production

Java

GravitinoMetalake metalake = adminClient.loadMetalake("production");

Python

metalake = admin_client.load_metalake("production")

Alter a Metalake

Changes are applied as a list in one request.

Change	JSON	Java	Python
Rename	{"@type":"rename","newName":"metalake_renamed"}	MetalakeChange.rename("metalake_renamed")	MetalakeChange.rename("metalake_renamed")
Update the comment	{"@type":"updateComment","newComment":"new_comment"}	MetalakeChange.updateComment("new_comment")	MetalakeChange.update_comment("new_comment")
Set a property	{"@type":"setProperty","property":"key1","value":"value1"}	MetalakeChange.setProperty("key1", "value1")	MetalakeChange.set_property("key1", "value1")
Remove a property	{"@type":"removeProperty","property":"key1"}	MetalakeChange.removeProperty("key1")	MetalakeChange.remove_property("key1")

REST

curl -X PUT -H "Accept: application/vnd.gravitino.v1+json" \
  -H "Content-Type: application/json" -d '{
  "updates": [
    {"@type": "updateComment", "newComment": "Production estate, EMEA"}
  ]
}' http://localhost:8090/api/metalakes/production

Java

GravitinoMetalake metalake = adminClient.alterMetalake(
    "production", MetalakeChange.updateComment("Production estate, EMEA"));

Python

metalake = admin_client.alter_metalake(
    "production", MetalakeChange.update_comment("Production estate, EMEA"))

Enable or Disable a Metalake

A metalake that is not in use can only be listed, loaded, enabled, or dropped. Enabling one that is already in use does nothing, and the same is true of disabling one already out of use.

REST

curl -X PATCH -H "Accept: application/vnd.gravitino.v1+json" \
  -H "Content-Type: application/json" -d '{"inUse": false}' \
  http://localhost:8090/api/metalakes/production

Java

adminClient.disableMetalake("production");
adminClient.enableMetalake("production");

Python

admin_client.disable_metalake("production")
admin_client.enable_metalake("production")

Drop a Metalake

Without force, the metalake must have no catalogs and must not be in use. With force, Gravitino removes the metalake and everything registered under it, whether or not it is in use. External systems are left alone; managed objects are removed with their data.

REST

curl -X DELETE -H "Accept: application/vnd.gravitino.v1+json" \
  "http://localhost:8090/api/metalakes/production?force=false"

Java

boolean dropped = adminClient.dropMetalake("production", false);

Python

dropped = admin_client.drop_metalake("production", force=False)

List Metalakes

REST

curl -X GET -H "Accept: application/vnd.gravitino.v1+json" \
  http://localhost:8090/api/metalakes

Java

GravitinoMetalake[] metalakes = adminClient.listMetalakes();

Python

metalakes = admin_client.list_metalakes()