Database¶

{
  "$id": "https://open-metadata.org/schema/entity/data/database.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Database",
  "$comment": "@om-entity-type",
  "description": "This schema defines the Database entity. A database also referred to as Database Catalog is a collection of schemas.",
  "type": "object",
  "javaType": "org.openmetadata.schema.entity.data.Database",
  "javaInterfaces": ["org.openmetadata.schema.EntityInterface"],

  "definitions": {},

  "properties": {
    "id": {
      "description": "Unique identifier that identifies this database instance.",
      "$ref": "../../type/basic.json#/definitions/uuid"
    },
    "name": {
      "description": "Name that identifies the database.",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "fullyQualifiedName": {
      "description": "Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.",
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
    },
    "displayName": {
      "description": "Display Name that identifies this database.",
      "type": "string"
    },
    "description": {
      "description": "Description of the database instance.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "dataProducts": {
      "description": "List of data products this entity is part of.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "tags": {
      "description": "Tags for this Database.",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": []
    },
    "version": {
      "description": "Metadata version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/entityVersion"
    },
    "updatedAt": {
      "description": "Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.",
      "$ref": "../../type/basic.json#/definitions/timestamp"
    },
    "updatedBy": {
      "description": "User who made the update.",
      "type": "string"
    },
    "impersonatedBy": {
      "description": "Bot user that performed the action on behalf of the actual user.",
      "$ref": "../../type/basic.json#/definitions/impersonatedBy"
    },
    "href": {
      "description": "Link to the resource corresponding to this entity.",
      "$ref": "../../type/basic.json#/definitions/href"
    },
    "owners": {
      "description": "Owners of this database.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "service": {
      "description": "Link to the database cluster/service where this database is hosted in.",
      "$ref": "../../type/entityReference.json"
    },
    "serviceType": {
      "description": "Service type where this database is hosted in.",
      "$ref": "../services/databaseService.json#/definitions/databaseServiceType"
    },
    "location": {
      "description": "Reference to the Location that contains this database.",
      "$ref": "../../type/entityReference.json"
    },
    "usageSummary": {
      "description": "Latest usage information for this database.",
      "$ref": "../../type/usageDetails.json",
      "default": null
    },
    "databaseSchemas": {
      "description": "References to schemas in the database.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "changeDescription": {
      "description": "Change that lead to this version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/changeDescription"
    },
    "incrementalChangeDescription": {
      "description": "Change that lead to this version of the entity.",
      "$ref": "../../type/entityHistory.json#/definitions/changeDescription"
    },
    "default": {
      "description": "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.",
      "type": "boolean",
      "default": false
    },
    "deleted": {
      "description": "When `true` indicates the entity has been soft deleted.",
      "type": "boolean",
      "default": false
    },
    "retentionPeriod": {
      "description": "Retention period of the data in the database. Period is expressed as duration in ISO 8601 format in UTC. Example - `P23DT23H`.",
      "$ref": "../../type/basic.json#/definitions/duration"
    },
    "extension": {
      "description": "Entity extension data with custom attributes added to the entity.",
      "$ref": "../../type/basic.json#/definitions/entityExtension"
    },
    "sourceUrl": {
      "description": "Source URL of database.",
      "$ref": "../../type/basic.json#/definitions/sourceUrl"
    },
    "domains": {
      "description": "Domains the Database belongs to. When not set, the Database inherits the domain from the database service it belongs to.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "votes": {
      "description": "Votes on the entity.",
      "$ref": "../../type/votes.json"
    },
    "lifeCycle": {
      "description": "Life Cycle properties of the entity",
      "$ref": "../../type/lifeCycle.json"
    },
    "certification": {
      "$ref": "../../type/assetCertification.json"
    },
    "followers": {
      "description": "Followers of this entity.",
      "$ref": "../../type/entityReferenceList.json"
    },
    "sourceHash": {
      "description": "Source hash of the entity",
      "type": "string",
      "minLength": 1,
      "maxLength": 32
    },
    "databaseProfilerConfig": {
      "type": "object",
      "javaType": "org.openmetadata.schema.type.DatabaseProfilerConfig",
      "description": "This schema defines the type for Database profile config.",
      "properties": {
        "profileSample": {
          "description": "Percentage of data or no. of rows we want to execute the profiler and tests on",
          "type": "number",
          "default": null
        },
        "profileSampleType": {
          "$ref": "./table.json#/definitions/profileSampleType"
        },
        "sampleDataCount": {
          "description": "Number of row of sample data to be generated",
          "type": "integer",
          "default": 50,
          "title": "Sample Data Rows Count"
        },
        "samplingMethodType": {
          "$ref": "./table.json#/definitions/samplingMethodType"
        },
        "sampleDataStorageConfig": {
          "title": "Storage Config for Sample Data",
          "$ref": "../services/connections/connectionBasicType.json#/definitions/sampleDataStorageConfig"
        },
        "randomizedSample": {
          "description": "Whether to randomize the sample data or not.",
          "type": "boolean",
          "default": true
        }
      }
    },
    "entityStatus": {
      "description": "Status of the Database.",
      "$ref": "../../type/status.json"
    }
  },

  "required": ["id", "name", "service"],
  "additionalProperties": false
}

{
  "@context": {
    "@vocab": "https://open-metadata.org/schema/",
    "om": "https://open-metadata.org/schema/",
    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcat": "http://www.w3.org/ns/dcat#",

    "Database": {
      "@id": "om:Database",
      "@type": ["om:DataAsset", "dcat:Catalog"]
    },
    "id": {
      "@id": "om:id",
      "@type": "xsd:string"
    },
    "name": {
      "@id": "om:name",
      "@type": "xsd:string"
    },
    "fullyQualifiedName": {
      "@id": "om:fullyQualifiedName",
      "@type": "xsd:string"
    },
    "displayName": {
      "@id": "om:displayName",
      "@type": "xsd:string"
    },
    "description": {
      "@id": "om:description",
      "@type": "xsd:string"
    },
    "service": {
      "@id": "om:belongsToService",
      "@type": "@id"
    },
    "serviceType": {
      "@id": "om:hasServiceType",
      "@type": "xsd:string"
    },
    "databaseSchemas": {
      "@id": "om:hasSchema",
      "@type": "@id",
      "@container": "@set"
    },
    "location": {
      "@id": "om:hasLocation",
      "@type": "@id"
    },
    "owners": {
      "@id": "om:hasOwners",
      "@type": "@id",
      "@container": "@set"
    },
    "domains": {
      "@id": "om:hasDomains",
      "@type": "@id",
      "@container": "@set"
    },
    "tags": {
      "@id": "om:hasTag",
      "@type": "@id",
      "@container": "@set"
    },
    "dataProducts": {
      "@id": "om:hasDataProducts",
      "@type": "@id",
      "@container": "@set"
    },
    "followers": {
      "@id": "om:hasFollowers",
      "@type": "@id",
      "@container": "@set"
    },
    "default": {
      "@id": "om:isDefault",
      "@type": "xsd:boolean"
    },
    "deleted": {
      "@id": "om:isDeleted",
      "@type": "xsd:boolean"
    },
    "retentionPeriod": {
      "@id": "om:retentionPeriod",
      "@type": "xsd:duration"
    },
    "usageSummary": {
      "@id": "om:hasUsageSummary",
      "@type": "@json"
    },
    "databaseProfilerConfig": {
      "@id": "om:hasProfilerConfig",
      "@type": "@json"
    },
    "version": {
      "@id": "om:version",
      "@type": "xsd:decimal"
    },
    "updatedAt": {
      "@id": "om:updatedAt",
      "@type": "xsd:long"
    },
    "updatedBy": {
      "@id": "om:updatedBy",
      "@type": "xsd:string"
    },
    "impersonatedBy": {
      "@id": "om:impersonatedBy",
      "@type": "xsd:string"
    },
    "changeDescription": {
      "@id": "om:hasChangeDescription",
      "@type": "@json"
    },
    "incrementalChangeDescription": {
      "@id": "om:hasIncrementalChangeDescription",
      "@type": "@json"
    },
    "sourceUrl": {
      "@id": "om:sourceUrl",
      "@type": "xsd:anyURI"
    },
    "sourceHash": {
      "@id": "om:sourceHash",
      "@type": "xsd:string"
    },
    "votes": {
      "@id": "om:hasVotes",
      "@type": "@json"
    },
    "lifeCycle": {
      "@id": "om:hasLifeCycle",
      "@type": "@json"
    },
    "certification": {
      "@id": "om:hasCertification",
      "@type": "@json"
    },
    "entityStatus": {
      "@id": "om:hasEntityStatus",
      "@type": "@json"
    },
    "extension": {
      "@id": "om:hasExtension",
      "@type": "@json"
    },
    "href": {
      "@id": "om:href",
      "@type": "xsd:anyURI"
    }
  }
}

{
  "@context": "https://open-metadata.org/context/dataAsset.jsonld",
  "@type": "Database",
  "@id": "https://example.com/data/databases/ecommerce",

  "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
  "name": "ecommerce",
  "fullyQualifiedName": "postgres_prod.ecommerce",
  "displayName": "E-commerce Database",
  "description": "Main database for e-commerce application containing customer, order, and product data",
  "default": false,
  "deleted": false,
  "retentionPeriod": "P365D",

  "service": {
    "@id": "https://example.com/services/postgres_prod",
    "@type": "DatabaseService",
    "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "name": "postgres_prod",
    "type": "databaseService"
  },
  "serviceType": "Postgres",

  "databaseSchemas": [
    {
      "@id": "https://example.com/data/schemas/public",
      "@type": "DatabaseSchema",
      "id": "c3d4e5f6-a7b8-4c9d-0e1f-2a3b4c5d6e7f",
      "name": "public",
      "type": "databaseSchema"
    },
    {
      "@id": "https://example.com/data/schemas/analytics",
      "@type": "DatabaseSchema",
      "id": "d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f8a",
      "name": "analytics",
      "type": "databaseSchema"
    }
  ],

  "owners": [
    {
      "@id": "https://example.com/teams/ecommerce",
      "@type": "Team",
      "id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
      "name": "ecommerce",
      "displayName": "E-commerce Team",
      "type": "team"
    }
  ],

  "domains": [
    {
      "@id": "https://example.com/domains/sales",
      "@type": "Domain",
      "id": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b0c",
      "name": "Sales",
      "type": "domain"
    }
  ],

  "tags": [
    {
      "tagFQN": "Tier.Gold",
      "source": "Classification",
      "labelType": "Manual",
      "state": "Confirmed"
    },
    {
      "tagFQN": "Environment.Production",
      "source": "Classification",
      "labelType": "Manual",
      "state": "Confirmed"
    }
  ],

  "followers": [],
  "dataProducts": [],

  "usageSummary": {
    "dailyStats": {
      "count": 150,
      "percentileRank": 85.0
    },
    "weeklyStats": {
      "count": 1050,
      "percentileRank": 82.0
    },
    "monthlyStats": {
      "count": 4500,
      "percentileRank": 80.0
    },
    "date": "2024-01-03"
  },

  "databaseProfilerConfig": {
    "profileSample": 50,
    "profileSampleType": "PERCENTAGE",
    "sampleDataCount": 50,
    "randomizedSample": true
  },

  "votes": {
    "upVotes": 12,
    "downVotes": 1,
    "upVoters": [],
    "downVoters": []
  },

  "lifeCycle": {
    "created": {
      "timestamp": 1704067200000,
      "accessedBy": "admin"
    }
  },

  "version": 1.5,
  "updatedAt": 1704240000000,
  "updatedBy": "jane.doe",
  "sourceUrl": "https://postgres-prod.example.com/ecommerce",
  "href": "https://openmetadata.example.com/api/v1/databases/b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e"
}