yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-18 22:53:09 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/main-concepts/metadata-standard/schemas/entity/data/database.md
Pere Miquel Brull 0793e69752
Fix automated schema generation & Add Docs CI (#6084) 
Fix automated schema generation & Add Docs CI (#6084)
2022-07-14 14:13:00 +02:00

2.6 KiB
Raw Blame History

title slug
database /main-concepts/metadata-standard/schemas/entity/data/database

Database

This schema defines the Database entity. A database also referred to as Database Catalog is a collection of schemas.

Properties

  • id: Unique identifier that identifies this database instance. Refer to ../../type/basic.json#/definitions/uuid.
  • name: Name that identifies the database. Refer to ../../type/basic.json#/definitions/entityName.
  • fullyQualifiedName: Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • displayName (string): Display Name that identifies this database.
  • description: Description of the database instance. Refer to ../../type/basic.json#/definitions/markdown.
  • version: Metadata version of the entity. Refer to ../../type/entityHistory.json#/definitions/entityVersion.
  • updatedAt: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to ../../type/basic.json#/definitions/timestamp.
  • updatedBy (string): User who made the update.
  • href: Link to the resource corresponding to this entity. Refer to ../../type/basic.json#/definitions/href.
  • owner: Owner of this database. Refer to ../../type/entityReference.json.
  • service: Link to the database cluster/service where this database is hosted in. Refer to ../../type/entityReference.json.
  • serviceType: Service type where this database is hosted in. Refer to ../services/databaseService.json#/definitions/databaseServiceType.
  • location: Reference to the Location that contains this database. Refer to ../../type/entityReference.json.
  • usageSummary: Latest usage information for this database. Refer to ../../type/usageDetails.json. Default: None.
  • databaseSchemas: References to schemas in the database. Refer to ../../type/entityReference.json#/definitions/entityReferenceList.
  • changeDescription: Change that lead to this version of the entity. Refer to ../../type/entityHistory.json#/definitions/changeDescription.
  • default (boolean): Some databases don't support a database/catalog in the hierarchy and use default database. For example, MySql. For such databases, set this flag to true to indicate that this is a default database. Default: False.
  • deleted (boolean): When true indicates the entity has been soft deleted. Default: False.

Documentation file automatically generated at 2022-07-14 10:51:34.749986.