Get catalog

GET 
/metalakes/:metalake/catalogs/:catalog

Returns the catalog with the given name, including its type, provider, comment, properties and audit information.

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

Request

Path Parameters

metalake stringrequired

The name of the metalake

catalog stringrequired

The name of the catalog

Responses

200

The catalog, with its type, provider, comment, properties and audit information.

application/vnd.gravitino.v1+json

Schema

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, 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)

{
  "code": 0,
  "catalog": {
    "name": "string",
    "type": "relational",
    "provider": "hive",
    "comment": "string",
    "audit": {
      "creator": "string",
      "createTime": "2024-07-29T15:51:28.071Z",
      "lastModifier": "string",
      "lastModifiedTime": "2024-07-29T15:51:28.071Z"
    },
    "properties": {}
  }
}

CatalogResponse

{
  "code": 0,
  "catalog": {
    "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"
    }
  }
}

404

The metalake or catalog 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[]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"
}

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

NoSuchCatalogException

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

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...