Skip to main content

​
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

MethodEndpointDescription
PUT/v1/services/databaseServicesCreate or update
POST/v1/services/databaseServicesCreate (POST variant)
GET/v1/services/databaseServicesList 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/restoreRestore
GET/v1/services/databaseServices/{id}/versionsList versions
GET/v1/services/databaseServices/{id}/versions/{version}Get version
GET/v1/services/databaseServices/name/{fqn}/exportExport CSV
PUT/v1/services/databaseServices/name/{fqn}/importImport CSV
GET/v1/services/databaseServices/name/{fqn}/exportAsyncExport CSV async
PUT/v1/services/databaseServices/name/{fqn}/importAsyncImport CSV async
POST/v1/services/databaseServices/{id}/testConnectionResultAdd test connection result