DataHubConnection

Technical Reference Guide

The sections above provide an overview of how to use this entity. The following sections provide detailed technical information about how metadata is stored and represented in DataHub.

Aspects are the individual pieces of metadata that can be attached to an entity. Each aspect contains specific information (like ownership, tags, or properties) and is stored as a separate record, allowing for flexible and incremental metadata updates.

Relationships show how this entity connects to other entities in the metadata graph. These connections are derived from the fields within each aspect and form the foundation of DataHub's knowledge graph.

Reading the Field Tables

Each aspect's field table includes an Annotations column that provides additional metadata about how fields are used:

• ⚠️ Deprecated: This field is deprecated and may be removed in a future version. Check the description for the recommended alternative
• Searchable: This field is indexed and can be searched in DataHub's search interface
• Searchable (fieldname): When the field name in parentheses is shown, it indicates the field is indexed under a different name in the search index. For example, dashboardTool is indexed as tool
• → RelationshipName: This field creates a relationship to another entity. The arrow indicates this field contains a reference (URN) to another entity, and the name indicates the type of relationship (e.g., → Contains, → OwnedBy)

Fields with complex types (like Edge, AuditStamp) link to their definitions in the Common Types section below.

Aspects

dataHubConnectionDetails

Information about a connection to an external platform.

Fields

Field	Type	Required	Description	Annotations
type	DataHubConnectionDetailsType	✓	The type of the connection. This defines the schema / encoding of the connection details.	Searchable
name	string		Display name of the connection	Searchable
json	DataHubJsonConnection		An JSON payload containing raw connection details. This will be present if the type is JSON.

Raw Schema

{
  "type": "record",
  "Aspect": {
    "name": "dataHubConnectionDetails"
  },
  "name": "DataHubConnectionDetails",
  "namespace": "com.linkedin.connection",
  "fields": [
    {
      "Searchable": {},
      "type": {
        "type": "enum",
        "symbolDocs": {
          "JSON": "A json-encoded set of connection details"
        },
        "name": "DataHubConnectionDetailsType",
        "namespace": "com.linkedin.connection",
        "symbols": [
          "JSON"
        ]
      },
      "name": "type",
      "doc": "The type of the connection. This defines the schema / encoding of the connection details."
    },
    {
      "Searchable": {
        "boostScore": 10.0,
        "enableAutocomplete": true,
        "fieldType": "TEXT_PARTIAL"
      },
      "type": [
        "null",
        "string"
      ],
      "name": "name",
      "default": null,
      "doc": "Display name of the connection"
    },
    {
      "type": [
        "null",
        {
          "type": "record",
          "name": "DataHubJsonConnection",
          "namespace": "com.linkedin.connection",
          "fields": [
            {
              "type": "string",
              "name": "encryptedBlob",
              "doc": "The encrypted JSON connection details."
            }
          ],
          "doc": "A set of connection details consisting of an encrypted JSON blob."
        }
      ],
      "name": "json",
      "default": null,
      "doc": "An JSON payload containing raw connection details.\nThis will be present if the type is JSON."
    }
  ],
  "doc": "Information about a connection to an external platform."
}

dataPlatformInstance

The specific instance of the data platform that this entity belongs to

Fields

Field	Type	Required	Description	Annotations
platform	string	✓	Data Platform	Searchable
instance	string		Instance of the data platform (e.g. db instance)	Searchable (platformInstance)

Raw Schema

{
  "type": "record",
  "Aspect": {
    "name": "dataPlatformInstance"
  },
  "name": "DataPlatformInstance",
  "namespace": "com.linkedin.common",
  "fields": [
    {
      "Searchable": {
        "addToFilters": true,
        "fieldType": "URN",
        "filterNameOverride": "Platform"
      },
      "java": {
        "class": "com.linkedin.common.urn.Urn"
      },
      "type": "string",
      "name": "platform",
      "doc": "Data Platform"
    },
    {
      "Searchable": {
        "addToFilters": true,
        "fieldName": "platformInstance",
        "fieldType": "URN",
        "filterNameOverride": "Platform Instance"
      },
      "java": {
        "class": "com.linkedin.common.urn.Urn"
      },
      "type": [
        "null",
        "string"
      ],
      "name": "instance",
      "default": null,
      "doc": "Instance of the data platform (e.g. db instance)"
    }
  ],
  "doc": "The specific instance of the data platform that this entity belongs to"
}

Relationships

Global Metadata Model