List catalogs

GET 
/metalakes/:metalake/catalogs

Returns the identifiers of the catalogs in the metalake, or the full catalogs when details is true. When authorization is enabled, only the catalogs the caller can load are returned.

Sign in with a bearer token or a local user's password; see Authentication.

Request

Path Parameters

metalake stringrequired

The name of the metalake

Query Parameters

details boolean

When true, returns the full catalog objects instead of their identifiers

Responses

200

The identifiers of the catalogs in the metalake, or the full catalogs with their type, provider, comment, properties and audit information when details is true.

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, model]

The type of the catalog

provider stringrequired

Possible values: [hive, lakehouse-iceberg, lakehouse-paimon, lakehouse-hudi, lakehouse-generic, glue, jdbc-mysql, jdbc-postgresql, jdbc-doris, jdbc-starrocks, jdbc-oracle, jdbc-sqlserver, jdbc-bigquery, jdbc-maxcompute, jdbc-oceanbase, jdbc-clickhouse, jdbc-hologres, fileset, kafka, model]

The provider of the catalog. Each provider serves one catalog type: fileset serves fileset, kafka serves messaging, model serves model, and every other provider serves relational.

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": "fileset",
      "comment": "This is my hadoop catalog",
      "properties": {
        "key2": "value2"
      },
      "audit": {
        "creator": "gravitino",
        "createTime": "2023-12-08T06:41:25.595Z"
      }
    }
  ]
}

400

The request is malformed or fails validation, for example because of invalid JSON, a missing required field or an invalid parameter value. The body is normally an error model, although the server's middleware can return plain text instead.

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[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

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

5xx

The server hit an internal error that the client usually cannot fix by changing the request.

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[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

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

Loading...