Skip to main content
Version: 0.5.1

Update catalog

PUT 

/metalakes/:metalake/catalogs/:catalog

Alters the specified catalog information in the specified metalake

Request

Path Parameters

    metalake stringrequired

    The name of the metalake

    catalog stringrequired

    The name of the catalog

Body

    updates

    object[]

    required

  • Array [

  • oneOf

    @type stringrequired

    Possible values: [rename]

    newName stringrequired

    The new name of the catalog

  • ]

Responses

Returns included catalog object

Schema

    code int32

    Possible values: [0]

    Status code of the response

    catalog

    object

    A catalog

    name stringrequired

    The name of the catalog

    type stringrequired

    Possible values: [relational, fileset, messaging]

    The type of the catalog

    provider stringrequired

    Possible values: [hive, lakehouse-iceberg, jdbc-mysql, jdbc-postgresql, hadoop]

    The provider of the catalog

    comment stringnullable

    A comment about the catalog

    audit

    object

    required

    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 catalog

    property name* string
Loading...