DataHub · Schema

Relationship

A named edge connecting two entities in the metadata graph.

Data CatalogData DiscoveryData GovernanceData LineageMetadata

Properties

Name Type Description
type string The relationship type name, such as OwnedBy, Contains, DownstreamOf, or Produces.
entity string The URN of the related entity.
direction string The traversal direction of this relationship.
View JSON Schema on GitHub

JSON Schema

datahub-relationship-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Relationship",
  "title": "Relationship",
  "type": "object",
  "description": "A named edge connecting two entities in the metadata graph.",
  "properties": {
    "type": {
      "type": "string",
      "description": "The relationship type name, such as OwnedBy, Contains, DownstreamOf, or Produces.",
      "example": "DownstreamOf"
    },
    "entity": {
      "type": "string",
      "description": "The URN of the related entity.",
      "example": "urn:li:dataset:(urn:li:dataPlatform:hive,OtherDataset,PROD)"
    },
    "direction": {
      "type": "string",
      "description": "The traversal direction of this relationship.",
      "enum": [
        "INCOMING",
        "OUTGOING"
      ]
    }
  }
}