DataHubRetention

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

dataHubRetentionKey

Key for a DataHub Retention

Fields

Field	Type	Required	Description	Annotations
entityName	string	✓	Entity name to apply retention to. * (or empty) for applying defaults.
aspectName	string	✓	Aspect name to apply retention to. * (or empty) for applying defaults.

Raw Schema

{
  "type": "record",
  "Aspect": {
    "name": "dataHubRetentionKey"
  },
  "name": "DataHubRetentionKey",
  "namespace": "com.linkedin.metadata.key",
  "fields": [
    {
      "type": "string",
      "name": "entityName",
      "doc": "Entity name to apply retention to. * (or empty) for applying defaults."
    },
    {
      "type": "string",
      "name": "aspectName",
      "doc": "Aspect name to apply retention to. * (or empty) for applying defaults."
    }
  ],
  "doc": "Key for a DataHub Retention"
}

dataHubRetentionConfig

None

Fields

Field	Type	Required	Description	Annotations
retention	Retention	✓

Raw Schema

{
  "type": "record",
  "Aspect": {
    "name": "dataHubRetentionConfig"
  },
  "name": "DataHubRetentionConfig",
  "namespace": "com.linkedin.retention",
  "fields": [
    {
      "type": {
        "type": "record",
        "name": "Retention",
        "namespace": "com.linkedin.retention",
        "fields": [
          {
            "type": [
              "null",
              {
                "type": "record",
                "name": "VersionBasedRetention",
                "namespace": "com.linkedin.retention",
                "fields": [
                  {
                    "type": "int",
                    "name": "maxVersions"
                  }
                ],
                "doc": "Keep max N latest records"
              }
            ],
            "name": "version",
            "default": null
          },
          {
            "type": [
              "null",
              {
                "type": "record",
                "name": "TimeBasedRetention",
                "namespace": "com.linkedin.retention",
                "fields": [
                  {
                    "type": "int",
                    "name": "maxAgeInSeconds"
                  }
                ],
                "doc": "Keep records that are less than X seconds old"
              }
            ],
            "name": "time",
            "default": null
          }
        ],
        "doc": "Base class that encapsulates different retention policies.\nOnly one of the fields should be set"
      },
      "name": "retention"
    }
  ]
}

Relationships

Global Metadata Model