Test catalog connection

POST 
/metalakes/:metalake/catalogs/testConnection

Tests whether a catalog with the supplied configuration can connect to its source, by running a read-only catalog-level operation without creating the catalog. A failed test is reported as an error code in an HTTP 200 response, and a passing test does not guarantee that every object-level or write operation will succeed.

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

Request

Path Parameters

metalake stringrequired

The name of the metalake

application/json

Body

name stringrequired

The name of the catalog

type stringrequired

Possible values: [relational, fileset, messaging, model]

The type of the catalog

provider string

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. The provider is optional for fileset and model catalogs, where the server uses the catalog type as the provider. The legacy value hadoop is still accepted and is replaced by the catalog type, so a fileset catalog created with hadoop is stored with provider fileset.

comment stringnullable

A comment for the catalog

properties

object

nullable

A map of properties for the catalog

property name* string

Responses

200

The result of the connection test. code is 0 when the test passed; a failed test, including a missing metalake or an existing catalog of the same name, is reported with its error code, exception type and message.

application/vnd.gravitino.v1+json

Schema

Schema

code int32required

Status code of the response

type string

Internal type definition of the exception

message string

The message of the exception

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": 0,
  "type": "string",
  "message": "string"
}

TestConnectionSuccess

{
  "code": 0
}

TestConnectionFailed

{
  "code": 1007,
  "type": "ConnectionFailedException",
  "message": "Failed to run getAllDatabases in Hive Metastore: Failed to connect to Hive Metastore",
  "stack": [
    "org.apache.gravitino.exceptions.ConnectionFailedException: Failed to run getAllDatabases in Hive Metastore: Failed to connect to Hive Metastore",
    "..."
  ]
}

CatalogAlreadyExists

{
  "code": 1004,
  "type": "CatalogAlreadyExistsException",
  "message": "Failed to operate catalog(s) [my_catalog] operation [CREATE], reason [CatalogAlreadyExistsException]",
  "stack": [
    "org.apache.gravitino.exceptions.CatalogAlreadyExistsException: Catalog my_catalog already exists",
    "..."
  ]
}

MetalakeNotFound

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

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