Skip to main content

Databases

A Database is a container within a Database Service. It holds Database Schemas, which in turn contain Tables.
Entity schema follows the OpenMetadata Standard.

Entity Hierarchy

Databases sit between Services and Schemas in the hierarchy:
DatabaseService
└── Database (this page)
    └── DatabaseSchema
        └── Table

Inheritance

When you set an owner or domain on a Database, it is inherited by all child schemas and tables.

API Endpoints

MethodEndpointDescription
PUT/v1/databasesCreate or update a database
POST/v1/databasesCreate a database (POST variant)
GET/v1/databasesList databases
GET/v1/databases/{id}Get by ID
GET/v1/databases/name/{fqn}Get by FQN
PATCH/v1/databases/{id}Update by ID
PATCH/v1/databases/name/{fqn}Update by name
DELETE/v1/databases/{id}Delete by ID
DELETE/v1/databases/name/{fqn}Delete by name
PUT/v1/databases/restoreRestore soft-deleted database
GET/v1/databases/{id}/versionsList versions
GET/v1/databases/{id}/versions/{version}Get specific version
GET/v1/databases/name/{fqn}/exportExport to CSV
GET/v1/databases/name/{fqn}/exportAsyncExport to CSV (async)
PUT/v1/databases/name/{fqn}/importImport from CSV
PUT/v1/databases/name/{fqn}/importAsyncImport from CSV (async)
PUT/v1/databases/{id}/followersAdd follower
DELETE/v1/databases/{id}/followers/{userId}Remove follower
PUT/v1/databases/{id}/voteAdd/update vote
GET/v1/databases/{id}/profilerConfigGet profiler config
PUT/v1/databases/{id}/profilerConfigSet profiler config
DELETE/v1/databases/{id}/profilerConfigDelete profiler config