48 lines
2.5 KiB
Markdown
Raw Normal View History

# Database
This schema defines the Database entity. A database also referred to as Database Catalog is a collection tables.
<b id="httpsopen-metadata.orgschemaentitydatadatabase.json">&#36;id: https://open-metadata.org/schema/entity/data/database.json</b>
Type: `object`
## Properties
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/id">id</b>
- Unique identifier that identifies this database instance.
- &#36;ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/name">name</b> `required`
- Name that identifies the database.
- &#36;ref: [#/definitions/databaseName](#/definitions/databaseName)
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/fullyQualifiedName">fullyQualifiedName</b>
- Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
- Type: `string`
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/description">description</b>
- Description of the database instance.
- Type: `string`
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/href">href</b>
- Link to the resource corresponding to this entity.
- &#36;ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/owner">owner</b>
- Owner of this database.
- &#36;ref: [../../type/entityReference.json](#....typeentityreference.json)
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/service">service</b> `required`
- Link to the database cluster/service where this database is hosted in.
- &#36;ref: [../../type/entityReference.json](#....typeentityreference.json)
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/usageSummary">usageSummary</b>
- Latest usage information for this database.
- &#36;ref: [../../type/usageDetails.json](#....typeusagedetails.json)
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/tables">tables</b>
- References to tables in the database.
- &#36;ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
## Types definitions in this schema
**databaseName**
- Name that identifies the database.
- Type: `string`
- The value must match this pattern: `^[^.]*$`
- Length: between 1 and 64