Test catalog connection

POST 
http://localhost:8090/api/metalakes/:metalake/catalogs/testConnection

Test catalog connection

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

The type of the catalog

provider stringrequired

Possible values: [hive, lakehouse-iceberg, jdbc-mysql, jdbc-postgresql]

The provider of the catalog

comment stringnullable

A comment for the catalog

properties

object

nullable

A map of properties for the catalog

property name* string

Responses

200

Test connection completed

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

Example (from schema)

{
  "code": 0,
  "type": "string",
  "message": "string",
  "stack": [
    "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

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'http://localhost:8090/api/metalakes/:metalake/catalogs/testConnection' \
-H 'Content-Type: application/json' \
-H 'Accept: application/vnd.gravitino.v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "type": "relational",
  "provider": "hive",
  "comment": "string",
  "properties": {}
}'

Request Collapse all

Base URL

http://localhost:8090/api

Auth

Security Scheme

OAuth2WithJWTBasicAuth

Bearer Token

Parameters

metalake — pathrequired

Body

• Example (from schema)
• CatalogCreate

{
  "name": "string",
  "type": "relational",
  "provider": "hive",
  "comment": "string",
  "properties": {}
}

ResponseClear

Click the Send API Request button above and see the response here!