50 lines
1.7 KiB
Markdown
Raw Normal View History

# Database
2021-08-16 16:28:10 +00:00
This schema defines the Database entity. A database also referred to as Database Catalog is a collection of tables.
2021-08-29 21:24:50 +00:00
**$id:** [**https://open-metadata.org/schema/entity/data/database.json**](https://open-metadata.org/schema/entity/data/database.json)
Type: `object`
## Properties
2021-08-29 21:24:50 +00:00
* **id**
* Unique identifier that identifies this database instance.
* $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* Name that identifies the database.
* $ref: [\#/definitions/databaseName](database.md#databasename)
* **fullyQualifiedName**
* Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
* Type: `string`
* **description**
* Description of the database instance.
* Type: `string`
* **href**
* Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#href)
* **owner**
* Owner of this database.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **service** `required`
* Link to the database cluster/service where this database is hosted in.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **usageSummary**
* Latest usage information for this database.
* $ref: [../../type/usageDetails.json](../types/usagedetails.md)
* **tables**
* References to tables in the database.
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
## Type definitions in this schema
2021-08-29 21:24:50 +00:00
### databaseName
2021-08-29 21:24:50 +00:00
* Name that identifies the database.
* Type: `string`
* The value must match this pattern: `^[^.]*$`
* Length: between 1 and 64
2021-08-29 21:24:50 +00:00
_This document was updated on: Thursday, August 26, 2021_