List catalogs (names)

GET 
/metalakes/:metalake/catalogs

List catalogs (names)

Request

Path Parameters

metalake stringrequired

The name of the metalake

Query Parameters

details boolean

Include detailed information about the catalogs

Responses

200

Returns the list of catalog objects if {details} is true, otherwise returns the list of catalog identifiers

application/vnd.gravitino.v1+json

Schema

Schema

oneOf

CatalogListResponse

code int32

Possible values: [0]

Status code of the response

identifiers

object[]

Array [

namespace string[]required

The namespace of the entity may be with multiple levels

name stringrequired

The name of the entity

]

CatalogInfoListResponse

code int32

Possible values: [0]

Status code of the response

catalogs

object[]

A list of catalog objects

Array [

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, lakehouse-paimon, jdbc-mysql, jdbc-postgresql, jdbc-doris, hadoop, kafka]

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

]

Example (from schema)

{}

CatalogListResponse

{
  "code": 0,
  "identifiers": [
    {
      "namespace": [
        "my_metalake"
      ],
      "name": "my_hive_catalog"
    }
  ]
}

CatalogInfoListResponse

{
  "code": 0,
  "catalogs": [
    {
      "name": "my_hive_catalog",
      "type": "relational",
      "provider": "hive",
      "comment": "This is my hive catalog",
      "properties": {
        "key1": "value1",
        "gravitino.bypass.hive.metastore.client.capability.check": "false",
        "metastore.uris": "thrift://127.0.0.1:9083"
      },
      "audit": {
        "creator": "gravitino",
        "createTime": "2023-12-08T03:41:25.595Z"
      }
    },
    {
      "name": "my_hadoop_catalog",
      "type": "fileset",
      "provider": "hadoop",
      "comment": "This is my hadoop catalog",
      "properties": {
        "key2": "value2"
      },
      "audit": {
        "creator": "gravitino",
        "createTime": "2023-12-08T06:41:25.595Z"
      }
    }
  ]
}

400

Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.

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"
  ]
}

Example

{
  "code": 1003,
  "type": "BadRequestException",
  "message": "Malformed request"
}

5xx

A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.

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"
  ]
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...