OpenMetadata · Schema

Database

Data CatalogMetadataData GovernanceData LineageData QualityOpen SourceData DiscoveryData Observability

Properties

Name Type Description
id string
name string
fullyQualifiedName string
displayName string
description string
dataProducts array
dataContract object
tags array
version number
updatedAt integer
updatedBy string
impersonatedBy string
href string
owners array
service object
serviceType string
location object
usageSummary object
databaseSchemas array
changeDescription object
incrementalChangeDescription object
default boolean
deleted boolean
retentionPeriod string
extension object
sourceUrl string
domains array
votes object
lifeCycle object
certification object
followers array
sourceHash string
databaseProfilerConfig object
entityStatus string
provider string
children array
style object
experts array
reviewers array
View JSON Schema on GitHub

JSON Schema

database.json Raw ↑ 
{
  "required": [
    "id",
    "name",
    "service"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "pattern": "^((?!::).)*$",
      "type": "string"
    },
    "fullyQualifiedName": {
      "maxLength": 3072,
      "minLength": 1,
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "dataProducts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "dataContract": {
      "$ref": "#/components/schemas/EntityReference"
    },
    "tags": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TagLabel"
      }
    },
    "version": {
      "type": "number",
      "format": "double"
    },
    "updatedAt": {
      "type": "integer",
      "format": "int64"
    },
    "updatedBy": {
      "type": "string"
    },
    "impersonatedBy": {
      "type": "string"
    },
    "href": {
      "type": "string",
      "format": "uri"
    },
    "owners": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "service": {
      "$ref": "#/components/schemas/EntityReference"
    },
    "serviceType": {
      "type": "string",
      "enum": [
        "BigQuery",
        "BigTable",
        "Mysql",
        "Redshift",
        "Snowflake",
        "Postgres",
        "Timescale",
        "Mssql",
        "MicrosoftAccess",
        "Oracle",
        "Athena",
        "Hive",
        "Impala",
        "Presto",
        "Trino",
        "Vertica",
        "Glue",
        "MariaDB",
        "Druid",
        "Db2",
        "Clickhouse",
        "Databricks",
        "AzureSQL",
        "DynamoDB",
        "SingleStore",
        "SQLite",
        "DeltaLake",
        "Salesforce",
        "PinotDB",
        "Datalake",
        "DomoDatabase",
        "QueryLog",
        "CustomDatabase",
        "Dbt",
        "SapHana",
        "SapSuccessFactors",
        "MongoDB",
        "Cassandra",
        "Couchbase",
        "Greenplum",
        "Doris",
        "StarRocks",
        "UnityCatalog",
        "SAS",
        "Teradata",
        "SapErp",
        "Synapse",
        "Exasol",
        "Cockroach",
        "SSAS",
        "Epic",
        "ServiceNow",
        "Dremio",
        "MicrosoftFabric",
        "BurstIQ",
        "Informix",
        "Iomete",
        "QuestDB"
      ]
    },
    "location": {
      "$ref": "#/components/schemas/EntityReference"
    },
    "usageSummary": {
      "$ref": "#/components/schemas/UsageDetails"
    },
    "databaseSchemas": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "changeDescription": {
      "$ref": "#/components/schemas/ChangeDescription"
    },
    "incrementalChangeDescription": {
      "$ref": "#/components/schemas/ChangeDescription"
    },
    "default": {
      "type": "boolean"
    },
    "deleted": {
      "type": "boolean"
    },
    "retentionPeriod": {
      "type": "string"
    },
    "extension": {
      "type": "object"
    },
    "sourceUrl": {
      "type": "string"
    },
    "domains": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "votes": {
      "$ref": "#/components/schemas/Votes"
    },
    "lifeCycle": {
      "$ref": "#/components/schemas/LifeCycle"
    },
    "certification": {
      "$ref": "#/components/schemas/AssetCertification"
    },
    "followers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "sourceHash": {
      "maxLength": 32,
      "minLength": 1,
      "type": "string"
    },
    "databaseProfilerConfig": {
      "$ref": "#/components/schemas/DatabaseProfilerConfig"
    },
    "entityStatus": {
      "type": "string",
      "enum": [
        "Draft",
        "In Review",
        "Approved",
        "Archived",
        "Deprecated",
        "Rejected",
        "Unprocessed"
      ]
    },
    "provider": {
      "type": "string",
      "enum": [
        "system",
        "user",
        "automation"
      ]
    },
    "children": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "style": {
      "$ref": "#/components/schemas/Style"
    },
    "experts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "reviewers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/openmetadata/main/json-schema/database.json"
}