2021-08-11 17:17:55 +00:00
|
|
|
# Database
|
|
|
|
|
|
|
|
This schema defines the Database entity. A database also referred to as Database Catalog is a collection tables.
|
|
|
|
|
2021-08-13 08:26:20 -07:00
|
|
|
<b id="httpsopen-metadata.orgschemaentitydatadatabase.json">$id: https://open-metadata.org/schema/entity/data/database.json</b>
|
2021-08-11 17:17:55 +00:00
|
|
|
|
|
|
|
Type: `object`
|
|
|
|
|
|
|
|
## Properties
|
2021-08-13 08:26:20 -07:00
|
|
|
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/id">id</b>
|
|
|
|
- Unique identifier that identifies this database instance.
|
|
|
|
- $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.
|
|
|
|
- $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.
|
|
|
|
- $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.
|
|
|
|
- $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.
|
|
|
|
- $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.
|
|
|
|
- $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.
|
|
|
|
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
2021-08-11 17:17:55 +00:00
|
|
|
|
|
|
|
|
|
|
|
## Types definitions in this schema
|
|
|
|
**databaseName**
|
|
|
|
|
2021-08-13 08:26:20 -07:00
|
|
|
- Name that identifies the database.
|
|
|
|
- Type: `string`
|
|
|
|
- The value must match this pattern: `^[^.]*$`
|
|
|
|
- Length: between 1 and 64
|
|
|
|
|
2021-08-11 17:17:55 +00:00
|
|
|
|