Skip to main content

​
Database Schemas

A Database Schema is a container within a Database. It holds Tables and sits between Database and Table in the hierarchy.
Entity schema follows the OpenMetadata Standard.

​
Entity Hierarchy

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

​
Inheritance

When you set an owner or domain on a Database Schema, it is inherited by all child tables. Schemas also inherit from their parent database.

​
API Endpoints

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