Database Services

A Database Service represents a connection to a database platform (e.g., Snowflake, BigQuery, PostgreSQL). It is the root of the database hierarchy and contains Databases.

Entity schema follows the OpenMetadata Standard.

Entity Hierarchy

Database Services are at the top of the hierarchy:

DatabaseService (this page)
└── Database
    └── DatabaseSchema
        └── Table

API Endpoints

Method	Endpoint	Description
`PUT`	`/v1/services/databaseServices`	Create or update
`POST`	`/v1/services/databaseServices`	Create (POST variant)
`GET`	`/v1/services/databaseServices`	List services
`GET`	`/v1/services/databaseServices/{id}`	Get by ID
`GET`	`/v1/services/databaseServices/name/{fqn}`	Get by name
`PATCH`	`/v1/services/databaseServices/{id}`	Update by ID
`PATCH`	`/v1/services/databaseServices/name/{fqn}`	Update by name
`DELETE`	`/v1/services/databaseServices/{id}`	Delete by ID
`DELETE`	`/v1/services/databaseServices/name/{fqn}`	Delete by name
`PUT`	`/v1/services/databaseServices/restore`	Restore
`GET`	`/v1/services/databaseServices/{id}/versions`	List versions
`GET`	`/v1/services/databaseServices/{id}/versions/{version}`	Get version
`GET`	`/v1/services/databaseServices/name/{fqn}/export`	Export CSV
`PUT`	`/v1/services/databaseServices/name/{fqn}/import`	Import CSV
`GET`	`/v1/services/databaseServices/name/{fqn}/exportAsync`	Export CSV async
`PUT`	`/v1/services/databaseServices/name/{fqn}/importAsync`	Import CSV async
`POST`	`/v1/services/databaseServices/{id}/testConnectionResult`	Add test connection result

Databases

List Database Services

⌘I

​Database Services

​Entity Hierarchy

​API Endpoints

Database Services

Entity Hierarchy

API Endpoints