OpenMetadata/docs/openmetadata-apis/schemas/entities/database.md

Database Entity

database

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json

Entity that represents a database

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	Yes	Unknown status	No	Forbidden	Allowed	none	database.json

Database entity Type

object [Database entity](database.md)

Database entity Properties

Property	Type	Required	Nullable	Defined by
id	string	Optional	cannot be null	Basic type
name	string	Required	cannot be null	Database entity
fullyQualifiedName	string	Optional	cannot be null	Database entity
description	string	Optional	cannot be null	Database entity
href	string	Optional	cannot be null	Basic type
owner	object	Optional	cannot be null	Entity Reference type
service	object	Required	cannot be null	Entity Reference type
usageSummary	object	Optional	cannot be null	Usage Details type
tables	array	Optional	cannot be null	Entity Reference type

id

Unique id used to identify an entity

id

• is optional
• Type: string
• cannot be null
• defined in: Basic type

id Type

string

id Constraints

UUID: the string must be a UUID, according to RFC 4122

name

Name that identifies the database

name

• is required
• Type: string
• cannot be null
• defined in: Database entity

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1

pattern: the string must match the following regular expression:

^[^.]*$

try pattern

fullyQualifiedName

Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'

fullyQualifiedName

• is optional
• Type: string
• cannot be null
• defined in: Database entity

fullyQualifiedName Type

string

description

Description of the database instance. What it has and how to use it.

description

• is optional
• Type: string
• cannot be null
• defined in: Database entity

description Type

string

href

Link to the resource corresponding to this entity

Link to the resource

href

• is optional
• Type: string
• cannot be null
• defined in: Basic type

href Type

string

href Constraints

URI: the string must be a URI, according to RFC 3986

owner

Entity reference that includes entity ID and entity type

owner

• is optional
• Type: object [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)
• cannot be null
• defined in: Entity Reference type

owner Type

object [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)

service

Entity reference that includes entity ID and entity type

service

• is required
• Type: object [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)
• cannot be null
• defined in: Entity Reference type

service Type

object [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)

usageSummary

Type used to return usage details of an entity

usageSummary

• is optional
• Type: object [Type used to return usage details of an entity](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/usagedetails.md)
• cannot be null
• defined in: Usage Details type

usageSummary Type

object [Type used to return usage details of an entity](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/usagedetails.md)

tables

References to tables in the database

tables

• is optional
• Type: object[] [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)
• cannot be null
• defined in: Entity Reference type

tables Type

object[] [Entity Reference](https://github.com/open-metadata/OpenMetadata/tree/88ab3784a5a9e2cfcf56bbb144522498eb33184c/docs/openmetadata-apis/schemas/entities/entityreference.md)

Database entity Definitions

Definitions group databaseName

Reference this group by using

{"$ref":"https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json#/definitions/databaseName"}

Property	Type	Required	Nullable	Defined by

database-definitions-databasename

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/api/data/createDatabase.json#/properties/name

Name that identifies the database

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	createDatabase.json*

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1

pattern: the string must match the following regular expression:

^[^.]*$

try pattern

database-definitions

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json#/definitions

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	database.json*

definitions Type

unknown

database-properties-description

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json#/properties/description

Description of the database instance. What it has and how to use it.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	database.json*

description Type

string

database-properties-fullyqualifiedname

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json#/properties/fullyQualifiedName

Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	database.json*

fullyQualifiedName Type

string

database-properties-name

https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json#/properties/name

Name that identifies the database

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	database.json*

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 64

minimum length: the minimum number of characters for this string is: 1

pattern: the string must match the following regular expression:

^[^.]*$

try pattern