List schemas

GET 
/metalakes/:metalake/catalogs/:catalog/schemas

Returns the identifiers of the schemas in the catalog, or of the child schemas of parentSchema when it is set. When authorization is enabled, only the schemas the caller owns or holds USE_SCHEMA on 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

catalog stringrequired

The name of the catalog

Query Parameters

parentSchema string

The parent schema whose direct child schemas are listed. Only meaningful for catalogs that support hierarchical (multi-level) schemas, such as an Iceberg catalog accessed through the Gravitino REST server with a configured schema separator (gravitino.schema.separator, default :). For example, when the schemas a, a:b and a:b:c exist, listing with parentSchema=a:b returns [a:b:c]. When omitted, only the top-level schemas under the catalog are returned (the direct children of the catalog root, e.g. a), not the nested ones.

Responses

200

The identifiers of the entities in the requested namespace, each with its namespace and name.

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

identifiers

object[]

A list of NameIdentifier objects

Array [

namespace string[]required

The namespace of the entity may be with multiple levels

name stringrequired

The name of the entity

]

Example (from schema)

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

CatalogListResponse

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

SchemaListResponse

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

TableListResponse

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

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