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

Database

Database

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

$id:https://open-metadata.org/schema/entity/data/database.json

Type: object

This schema does not accept additional properties.

Properties

<<<<<<< HEAD

• id
  • Unique identifier that identifies this database instance.
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • Name that identifies the database.
  • $ref: #/definitions/databaseName
• fullyQualifiedName
  • Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
  • Type: string
• displayName
  • Display Name that identifies this database.
  • Type: string
• description
  • Description of the database instance.
  • Type: string
• version
  • Metadata version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/entityVersion
• updatedAt
  • Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
  • $ref: ../../type/basic.json#/definitions/timestamp
• updatedBy
  • User who made the update.
  • Type: string
• href
  • Link to the resource corresponding to this entity.
  • $ref: ../../type/basic.json#/definitions/href
• owner
  • Owner of this database.
  • $ref: ../../type/entityReference.json
• service required
  • Link to the database cluster/service where this database is hosted in.
  • $ref: ../../type/entityReference.json
• serviceType
  • Service type where this database is hosted in.
  • $ref: ../services/databaseService.json#/definitions/databaseServiceType
• location
  • Reference to the Location that contains this database.
  • $ref: ../../type/entityReference.json
• usageSummary
  • Latest usage information for this database.
  • $ref: ../../type/usageDetails.json
• tables
  • References to tables in the database.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• changeDescription
  • Change that lead to this version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/changeDescription
• deleted
  • When true indicates the entity has been soft deleted.
  • Type: boolean
  • Default: false

a07bc411 (updated json schema and schema docs (#3219))

• id
  • Unique identifier that identifies this database instance.
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • Name that identifies the database.
  • $ref: #/definitions/databaseName
• fullyQualifiedName
  • Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
  • Type: string
• displayName
  • Display Name that identifies this database.
  • Type: string
• description
  • Description of the database instance.
  • Type: string
• version
  • Metadata version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/entityVersion
• updatedAt
  • Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
  • $ref: ../../type/basic.json#/definitions/timestamp
• updatedBy
  • User who made the update.
  • Type: string
• href
  • Link to the resource corresponding to this entity.
  • $ref: ../../type/basic.json#/definitions/href
• owner
  • Owner of this database.
  • $ref: ../../type/entityReference.json
• service required
  • Link to the database cluster/service where this database is hosted in.
  • $ref: ../../type/entityReference.json
• serviceType
  • Service type where this database is hosted in.
  • $ref: ../services/databaseService.json#/definitions/databaseServiceType
• location
  • Reference to the Location that contains this database.
  • $ref: ../../type/entityReference.json
• usageSummary
  • Latest usage information for this database.
  • $ref: ../../type/usageDetails.json
• tables
  • References to tables in the database.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• changeDescription
  • Change that lead to this version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/changeDescription
• deleted
  • When true indicates the entity has been soft deleted.
  • Type: boolean
  • Default: false

Type definitions in this schema

<<<<<<< HEAD

databaseName

• Name that identifies the database.
• Type: string
• Length: between 1 and 128

a07bc411 (updated json schema and schema docs (#3219))

databaseName

• Name that identifies the database.
• Type: string
• The value must match this pattern: ^[^.]*$
• Length: between 1 and 128

<<<<<<< HEAD This document was updated on: Tuesday, January 25, 2022

This document was updated on: Monday, March 7, 2022

a07bc411 (updated json schema and schema docs (#3219))