Update metalake

PUT 
http://localhost:8090/api/metalakes/:name

Alters a specified metalake

Request

Path Parameters

name stringrequired

The name of the metalake to retrieve

application/json

Body

updates

object[]

required

Array [

oneOf

RenameMetalakeRequest

@type stringrequired

Possible values: [rename]

newName stringrequired

The new name of the metalake

UpdateMetalakeCommentRequest

@type stringrequired

Possible values: [updateComment]

newComment stringrequired

The new comment of the metalake

SetMetalakePropertyRequest

@type stringrequired

Possible values: [setProperty]

property stringrequired

The property to set

value stringrequired

The value to set

RemoveMetalakePropertyRequest

@type stringrequired

Possible values: [removeProperty]

property stringrequired

The property to remove

]

Responses

200

Returns included metalake object.

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

metalake

object

Gravitino Metalake is the top-level metadata repository for users. It contains a list of catalogs as sub-level metadata collections. With GravitinoMetaLake, users can list, create, load, alter and drop a catalog with specified identifier.

name stringrequired

The name of the Metalake

comment stringnullable

A comment about the Metalake

audit

object

Audit information for a Gravitino resource.

creator string

The user who created the resource

createTime date-time

The time the resource was created

lastModifier string

The user who last modified the resource

lastModifiedTime date-time

The time the resource was last modified

properties

object

Configured string to string map of properties for the Metalake

property name* string

Example (from schema)

{
  "code": 0,
  "metalake": {
    "name": "my_metalake",
    "comment": "This is my metalake",
    "properties": {
      "key1": "value1",
      "key2": "value2",
      "gravitino.identifier": "gravitino.v1.uid4516733622157792920"
    },
    "audit": {
      "creator": "gravitino",
      "createTime": "2023-12-07T14:04:17.349Z"
    }
  }
}

MetalakeResponse

{
  "code": 0,
  "metalake": {
    "name": "my_metalake",
    "comment": "This is my metalake",
    "properties": {
      "key1": "value1",
      "key2": "value2",
      "gravitino.identifier": "gravitino.v1.uid2062071866014250017"
    },
    "audit": {
      "creator": "gravitino",
      "createTime": "2023-12-06T14:21:24.982Z"
    }
  }
}

404

Not Found - The metalake does not exist

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

NoSuchMetalakeException

{
  "code": 1003,
  "type": "NoSuchMetalakeException",
  "message": "Failed to operate metalake(s) [test] operation [LOAD], reason [NoSuchMetalakeException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchMetalakeException: Metalake test does not exist",
    "..."
  ]
}

409

Conflict - The target (metalake)name already exists

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

MetalakeAlreadyExistsException

{
  "code": 1004,
  "type": "MetalakeAlreadyExistsException",
  "message": "Failed to operate metalake(s) [my_metalake] operation [CREATE], reason [MetalakeAlreadyExistsException]",
  "stack": [
    "org.apache.gravitino.exceptions.MetalakeAlreadyExistsException: Metalake my_metalake already exists",
    "..."
  ]
}

500

Internal server error. It is possible that the server encountered a storage issue.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT 'http://localhost:8090/api/metalakes/:name' \
-H 'Content-Type: application/json' \
-H 'Accept: application/vnd.gravitino.v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "updates": [
    {
      "@type": "rename",
      "newName": "my_metalake_new"
    },
    {
      "@type": "updateComment",
      "newComment": "This is my new metalake comment"
    },
    {
      "@type": "setProperty",
      "property": "key1",
      "value": "value1_new"
    },
    {
      "@type": "removeProperty",
      "property": "key2"
    }
  ]
}'

Request Collapse all

Base URL

http://localhost:8090/api

Auth

Security Scheme

OAuth2WithJWTBasicAuth

Bearer Token

Parameters

name — pathrequired

Body

{
  "updates": [
    {
      "@type": "rename",
      "newName": "my_metalake_new"
    },
    {
      "@type": "updateComment",
      "newComment": "This is my new metalake comment"
    },
    {
      "@type": "setProperty",
      "property": "key1",
      "value": "value1_new"
    },
    {
      "@type": "removeProperty",
      "property": "key2"
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!