DataHub OwnershipType 实体详解:自定义数据资产所有权类型的建模、API 与实战
2026/9/20 12:00:21 网站建设 项目流程
  • 数据目录
  • 数据治理
  • 数据血缘
  • 后端
  • 前端
  • 数据工程
  • 数据集成

【免费下载链接】datahub

The Context Platform for your Data and AI Stack

项目地址:https://gitcode.com/GitHub_Trending/da/datahub
点击查看免费下载

本文以 DataHub 元数据模型文档《OwnershipType》为核心,系统讲解ownershipType实体如何定义数据资产所有者的角色与职责(如技术负责人、业务负责人、数据管家等),并深入仓库源码(PDL 模型、OwnershipTypeService、GraphQL Resolver、Python SDK 示例)剖析其 URN 标识、aspect 结构、内置与自定义类型的差异、增删改查全流程及向后兼容策略。读完本文,你将能够在自己的 DataHub 实例中创建自定义所有权类型、将其分配给数据集并正确管理其生命周期。

一、什么是 OwnershipType

在 DataHub 中,ownershipType实体代表一种自定义的所有权类别(custom ownership category)。所有权类型定义了用户或用户组对数据资产可以承担的角色与职责。DataHub 内置了Technical Owner(技术负责人)、Business Owner(业务负责人)、Data Steward(数据管家)等所有权类型,同时允许组织根据自身的治理模型和组织结构创建自定义的所有权类型,从而将"谁拥有这份数据"这一元数据从固定枚举升级为可扩展的一等实体。

从代码结构上看,该实体由三部分构成:

  • 实体 Key aspect:OwnershipTypeKey.pdl(aspect 名ownershipTypeKey
  • 实体信息 aspect:OwnershipTypeInfo.pdl(aspect 名ownershipTypeInfo
  • 历史遗留的枚举定义:OwnershipType.pdl

二、Identity:如何唯一标识一个所有权类型

OwnershipType实体由单一字段唯一标识:

  • id:所有权类型的唯一标识字符串。对于自定义类型,通常是一个 UUID;对于内置类型,则是带系统前缀的标识符。

URN 结构遵循模式:urn:li:ownershipType:<id>

典型示例:

  • 内置类型:urn:li:ownershipType:__system__technical_owner
  • 自定义类型:urn:li:ownershipType:8b3d78d1-a9d9-4f79-a948-10c52e3e8f9e(系统自动生成的 UUID)
  • 具名自定义类型:urn:li:ownershipType:data_quality_lead(组织自定义的人类可读 id)

在模型层,OwnershipTypeKey记录了 id 与显示名的设计区别:id 是用于数据所有权类型名的唯一标识(如 Business Owner、Data Steward、Technical Owner),应当与用于显示的 name 字段区分开,见 OwnershipTypeKey.pdl。而实体 URN 由EntityKeyUtils.convertEntityKeyToUrn(key, Constants.OWNERSHIP_TYPE_ENTITY_NAME)根据 Key 生成,见 OwnershipTypeService.java。

三、核心能力:ownershipTypeInfo 与 Status 管理

3.1 核心信息(ownershipTypeInfo)

ownershipTypeInfoaspect 承载所有权类型的关键元数据,字段定义见 OwnershipTypeInfo.pdl:

字段类型说明
namestring(必填)所有权类型的显示名称(如 "Data Quality Lead"、"Compliance Officer")
descriptionoptional string该所有权类型职责与范围的详细说明
createdAuditStamp记录创建时间与创建者的审计戳
lastModifiedAuditStamp记录最近一次修改时间与操作者的审计戳

值得注意的是,name和审计字段在 PDL 中都带有@Searchable注解:

  • name使用WORD_GRAM字段类型,enableAutocomplete: trueboostScore: 10.0,即支持搜索与自动补全,且权重较高;
  • created.time被索引为createdAt(DATETIME),created.actor被索引为createdBy(URN);
  • lastModified.time被索引为lastModifiedAt(DATETIME),lastModified.actor被索引为lastModifiedBy(URN)。

这意味着所有权类型天然具备可搜索、可排序、可按创建人过滤的索引能力,无需额外配置。

3.2 内置类型 vs 自定义类型

DataHub 随系统自动创建四个内置所有权类型:

类型 id说明
__system__technical_owner参与资产的生产、维护或分发
__system__business_owner与资产相关的主要利益相关者或领域专家
__system__data_steward参与资产的治理
__system__none未指定所有权类型

内置类型具有以下约束(这些规则在 OwnershipTypeService.java 中以isSystemOwnershipType方法硬编码判定,即URN 的 id 以__system__前缀开头):

  • 内置类型 id 以__system__前缀开头,不能硬删除(hard-delete),只能通过statusaspect 软删除;
  • 自定义类型没有此前缀限制,可以被彻底删除。

3.3 在所有权分配中的使用

所有权类型通过数据资产ownershipaspect 中Owner记录的typeUrn字段被引用,从而在资产所有者与其具体角色之间建立关联:

Owner { owner: urn:li:corpuser:jdoe typeUrn: urn:li:ownershipType:data_quality_lead type: CUSTOM // deprecated field, maintained for backwards compatibility }

Ownershipaspect(见 Ownership.pdl)还维护了一个ownerTypes映射,该映射将所有者按其所有权类型 URN 分组,通过 mutation hook 自动填充

ownerTypes: optional map[string, array[Urn]] = {}

该字段在 PDL 中以MAP_ARRAY类型建立搜索索引(queryByDefault: false),可用于按所有权类型聚合与检索资产的所有者。此外Ownership还包含lastModified审计戳,默认值为time: 0actor: urn:li:corpuser:unknown,其中 time 为 0 表示缺失数据。

3.4 Status 管理

statusaspect 控制所有权类型是激活还是软删除状态:

  • removed:当设为 true 时,该所有权类型被视为已删除,但其引用被保留。

内置所有权类型只能软删除(status.removed = true),而自定义类型可以从系统中完全移除。

四、代码实战:创建、分配与查询自定义所有权类型

4.1 使用 Python SDK 创建自定义所有权类型

示例脚本 ownership_type_create_custom.py 演示了完整的创建流程:它依次发送两条 MCP(MetadataChangeProposal),先发送 Key aspect,再发送 Info aspect。

import os import time from datahub.emitter.mce_builder import make_user_urn from datahub.emitter.mcp import MetadataChangeProposalWrapper from datahub.emitter.rest_emitter import DatahubRestEmitter from datahub.metadata.schema_classes import ( AuditStampClass, OwnershipTypeInfoClass, OwnershipTypeKeyClass, ) emitter = DatahubRestEmitter( gms_server=os.getenv("DATAHUB_GMS_URL", "http://localhost:8080"), token=os.getenv("DATAHUB_GMS_TOKEN"), ) ownership_type_id = "data_quality_lead" ownership_type_urn = f"urn:li:ownershipType:{ownership_type_id}" current_timestamp = int(time.time() * 1000) actor_urn = make_user_urn("datahub") # Emit the key aspect ownership_type_key = OwnershipTypeKeyClass(id=ownership_type_id) emitter.emit_mcp( MetadataChangeProposalWrapper( entityUrn=ownership_type_urn, aspect=ownership_type_key, ) ) # Emit the info aspect ownership_type_info = OwnershipTypeInfoClass( name="Data Quality Lead", description="Responsible for ensuring data quality standards and monitoring data quality metrics", created=AuditStampClass(time=current_timestamp, actor=actor_urn), lastModified=AuditStampClass(time=current_timestamp, actor=actor_urn), ) emitter.emit_mcp( MetadataChangeProposalWrapper( entityUrn=ownership_type_urn, aspect=ownership_type_info, ) ) print(f"Created custom ownership type: {ownership_type_urn}")

关键点解读:

  • Emitter 配置DatahubRestEmitter默认指向http://localhost:8080(GMS),可通过环境变量DATAHUB_GMS_URLDATAHUB_GMS_TOKEN覆盖,便于接入带认证的部署环境;
  • 两步写入:先写 Key aspect 确立实体身份,再写ownershipTypeInfoaspect 补充展示信息;两步都基于同一 URNurn:li:ownershipType:data_quality_lead
  • 审计戳AuditStamptime为毫秒级时间戳(int(time.time() * 1000)),actor使用make_user_urn("datahub")构造。

4.2 为数据集分配带自定义所有权类型的所有者

示例脚本 dataset_add_owner_custom_type.py 演示了如何为数据集添加带自定义所有权类型的所有者:

from datahub.emitter.mce_builder import ( make_dataset_urn, make_ownership_type_urn, make_user_urn, ) from datahub.emitter.mcp import MetadataChangeProposalWrapper from datahub.emitter.rest_emitter import DatahubRestEmitter from datahub.ingestion.graph.client import DataHubGraph, DataHubGraphConfig from datahub.metadata.schema_classes import ( OwnerClass, OwnershipClass, OwnershipTypeClass, ) # Create DataHub client graph = DataHubGraph(DataHubGraphConfig(server="http://localhost:8080")) emitter = DatahubRestEmitter("http://localhost:8080") # Create dataset URN dataset_urn = make_dataset_urn(platform="snowflake", name="analytics.users", env="PROD") # Create custom ownership type URN # This should reference a previously created custom ownership type custom_ownership_type_urn = make_ownership_type_urn("data_quality_lead") # Create an owner with the custom ownership type owner = OwnerClass( owner=make_user_urn("jdoe"), type=OwnershipTypeClass.CUSTOM, # Use CUSTOM enum for custom types typeUrn=custom_ownership_type_urn, # Reference the custom ownership type entity ) # Get existing ownership or create new try: existing_ownership = graph.get_aspect(dataset_urn, OwnershipClass) if existing_ownership: # Add to existing owners existing_ownership.owners.append(owner) ownership = existing_ownership else: # Create new ownership aspect ownership = OwnershipClass(owners=[owner]) except Exception: # Create new ownership aspect if retrieval fails ownership = OwnershipClass(owners=[owner]) # Emit the ownership aspect mcp = MetadataChangeProposalWrapper( entityUrn=str(dataset_urn), aspect=ownership, ) emitter.emit_mcp(mcp) print( f"Added owner {owner.owner} with custom ownership type {custom_ownership_type_urn}" ) print(f"to dataset {dataset_urn}")

要点解读:

  • make_ownership_type_urn("data_quality_lead")构造urn:li:ownershipType:data_quality_lead该自定义类型必须已提前创建
  • OwnerClasstype字段使用OwnershipTypeClass.CUSTOM(对应枚举中的CUSTOM值),typeUrn指向自定义所有权类型实体;
  • 脚本同时演示了DataHubGraph.get_aspect读取已有Ownershipaspect 并追加 owner 的"读-改-写"模式,避免覆盖原有所有者列表。

4.3 列出所有所有权类型(GraphQL)

示例脚本 ownership_type_list.py 通过 GraphQL 查询列出全部所有权类型:

from datahub.ingestion.graph.client import DataHubGraph, DataHubGraphConfig # Create DataHub client graph = DataHubGraph(DataHubGraphConfig(server="http://localhost:8080")) # Search for all ownership type entities # Note: The GraphQL API provides a listOwnershipTypes query, but we can also # use the search API to find all ownership types search_query = """ query listOwnershipTypes($input: ListOwnershipTypesInput!) { listOwnershipTypes(input: $input) { start count total ownershipTypes { urn type info { name description } } } } """ variables = { "input": { "start": 0, "count": 100, # Adjust as needed } } # Execute the GraphQL query result = graph.execute_graphql(query=search_query, variables=variables) # Process and display the results if result and "listOwnershipTypes" in result: ownership_types = result["listOwnershipTypes"]["ownershipTypes"] total = result["listOwnershipTypes"]["total"] print(f"Found {total} ownership types:") print("-" * 80) for ownership_type in ownership_types: urn = ownership_type["urn"] name = ownership_type["info"]["name"] description = ownership_type["info"].get("description", "No description") print(f"URN: {urn}") print(f"Name: {name}") print(f"Description: {description}") print("-" * 80) else: print("No ownership types found or query failed")

listOwnershipTypes查询支持start/count分页参数,返回total总数与ownershipTypes列表,每条包含urntypeinfo { name, description }

4.4 通过 REST API 查询所有权类型

使用entitiesV2接口按 URN 获取某个所有权类型的完整信息:

curl 'http://localhost:8080/entitiesV2/urn%3Ali%3AownershipType%3A__system__technical_owner'

响应包含ownershipTypeInfostatus两个 aspect:

{ "urn": "urn:li:ownershipType:__system__technical_owner", "aspects": { "ownershipTypeInfo": { "value": { "name": "Technical Owner", "description": "Involved in the production, maintenance, or distribution of the asset(s).", "created": { "time": 1234567890000, "actor": "urn:li:corpuser:datahub" }, "lastModified": { "time": 1234567890000, "actor": "urn:li:corpuser:datahub" } } } } }

注意 URN 中的:需要 URL 编码为%3A。后端读取时通过getOwnershipTypeEntityResponse同时拉取ownershipTypeInfostatus两个 aspect,见 OwnershipTypeService.java。

五、集成点:Owner Aspect、GraphQL 与鉴权

5.1 与 Owner aspect 的关系

ownershipType实体与绝大多数数据资产(数据集、仪表盘、图表等)上的ownershipaspect 存在主关联关系。Owner记录中的typeUrn字段引用一个 ownershipType 实体,对应的@Relationship声明如下:

@Relationship = { "name": "ownershipType", "entityTypes": [ "ownershipType" ] } typeUrn: optional Urn

该关系使得系统可以:

  • 在搜索与发现(search and discovery)中按所有权类型过滤资产
  • 在整个组织中按角色对所有者进行分组
  • 追踪每个资产上谁承担了什么职责

5.2 GraphQL API 集成

GraphQL API 通过以下 Resolver 暴露所有权类型的完整 CRUD 能力,全部位于 datahub-graphql-core/.../resolvers/ownership/:

Resolver功能
CreateOwnershipTypeResolver.java创建新的自定义所有权类型
UpdateOwnershipTypeResolver.java修改已有所有权类型
DeleteOwnershipTypeResolver.java删除所有权类型(对系统类型执行软删除)
ListOwnershipTypesResolver.java返回所有可用所有权类型

GraphQL 实体类型为CUSTOM_OWNERSHIP_TYPE,映射到OwnershipTypeEntityGraphQL 类型。从 CreateOwnershipTypeResolver.java 可以看到,创建成功后 Resolver 会构建OwnershipTypeEntity.builder().setType(EntityType.CUSTOM_OWNERSHIP_TYPE)返回给前端。前端侧,数据资产侧边栏的 OwnershipTypesSelect.tsx 与权限策略表单中的 OwnershipTypesSelect.tsx 均消费这些 GraphQL 查询。

5.3 鉴权(Authorization)

管理所有权类型需要特定权限:

  • 创建、更新或删除所有权类型需要canManageOwnershipTypes权限;
  • 该权限通常仅授予平台管理员与治理团队。

这一点在 Resolver 层有强制校验:CreateOwnershipTypeResolver在执行业务逻辑前先调用AuthorizationUtils.canManageOwnershipTypes(context),不满足时直接抛出AuthorizationException("Unauthorized to perform this action. Please contact your DataHub administrator."),见 CreateOwnershipTypeResolver.java。值得注意的是,OwnershipTypeService本身不做鉴权(其 Javadoc 明确说明 "no Authorization is performed within the service",见 OwnershipTypeService.java),鉴权职责完全由上层调用方(GraphQL Resolver 等)承担。

六、常见使用模式

根据文档与源码,以下场景最适合引入自定义所有权类型:

  1. 组织特定角色:定义与你的组织结构匹配的所有权类型(如 "Product Manager"、"Data Engineer"、"Analytics Lead");
  2. 合规角色:为监管合规创建类型(如 "Privacy Officer"、"Compliance Reviewer"、"Audit Contact");
  3. 生命周期角色:在数据生命周期各阶段追踪不同职责(如 "Data Producer"、"Data Consumer"、"Data Custodian");
  4. 领域特定角色:为特定领域建立所有权类型(如 "Marketing Data Owner"、"Finance Data Steward")。

七、注意事项与异常行为

7.1 向后兼容:type 与 typeUrn 并存

Owner记录同时包含已弃用的type字段(OwnershipType枚举)与较新的typeUrn字段(指向 ownershipType 实体的 URN)。枚举字段仅为向后兼容而保留,新实现不应再使用。当使用自定义所有权类型时,枚举字段被设置为CUSTOM。枚举定义见 OwnershipType.pdl。

7.2 系统类型删除限制

内置所有权类型(id 以__system__开头的类型)无法被完全删除。OwnershipTypeService.deleteOwnershipType()的行为如下(见 OwnershipTypeService.java):

  • 系统类型:软删除,即写入statusaspect 并设置removed = true
  • 自定义类型:硬删除,即调用entityClient.deleteEntity整体移除实体;若deleteReferences为 true,还会进一步调用deleteEntityReferences清理引用。

这保证了即使系统类型被停用,对其的引用依然有效。对应的测试覆盖见 OwnershipTypeServiceTest.java。

7.3 从枚举到实体的迁移

历史上,所有权类型被定义为一个固定枚举(OwnershipType.pdl)。ownershipType实体的引入在保持兼容性的同时带来了可扩展性。已弃用的枚举值(DEVELOPERDATAOWNERDELEGATEPRODUCERCONSUMERSTAKEHOLDER)应迁移到对应的系统所有权类型(TECHNICAL_OWNERBUSINESS_OWNERDATA_STEWARD)。从 PDL 注释中可以确认映射关系:DEVELOPER/DATAOWNER/DELEGATE/PRODUCER应使用TECHNICAL_OWNERCONSUMER使用TECHNICAL_OWNERBUSINESS_OWNERSTAKEHOLDER使用TECHNICAL_OWNERBUSINESS_OWNERDATA_STEWARD

7.4 ID 生成规则

创建自定义所有权类型时,注意以下 ID 约束:

  • 系统会自动为id字段生成 UUID(OwnershipTypeService.createOwnershipType中使用UUID.randomUUID().toString(),见 OwnershipTypeService.java);
  • 组织也可以使用人类可读的 ID(如data_quality_lead)以便管理;
  • ID 不得包含保留字符,且必须是 URL 安全的;
  • __system__前缀为内置类型保留,自定义类型不得使用。

八、源码延伸:测试与前端消费

如果你想进一步深入该实体的实现细节,以下仓库路径可作为继续探索的入口:

  • 后端服务与 CRUD 实现:OwnershipTypeService.java、OwnershipTypeServiceFactory.java;
  • GraphQL 类型映射:OwnershipType.java、OwnershipTypeMapper.java;
  • Resolver 单元测试:CreateOwnershipTypeResolverTest.java、DeleteOwnershipTypeResolverTest.java、ListOwnershipTypesResolverTest.java、UpdateOwnershipTypeResolverTest.java;
  • 前端消费:所有权类型选择器 OwnershipTypesSelect.tsx、useOwnershipTypes.ts 及其测试 useOwnershipTypes.test.ts。

九、总结

ownershipType实体是 DataHub 所有权模型从固定枚举迈向可扩展实体体系的关键一步。通过urn:li:ownershipType:<id>的唯一标识、ownershipTypeInfostatus两个核心 aspect、以及 Python SDK / REST / GraphQL 三类 API 的完整支持,组织可以灵活地构建贴合自身治理结构的角色体系,同时保持对历史枚举数据的向后兼容。建议新项目一律使用typeUrn引用所有权类型,并将内置的__system__类型视为只读治理基础,仅在必要时通过软删除停用。

  • 数据目录
  • 数据治理
  • 数据血缘
  • 后端
  • 前端
  • 数据工程
  • 数据集成

【免费下载链接】datahub

The Context Platform for your Data and AI Stack

项目地址:https://gitcode.com/GitHub_Trending/da/datahub
点击查看免费下载

相关推荐

上一篇:如何快速掌握正则表达式?Regulex可视化工具让学习效率提升300%
下一篇:终极指南:如何使用 qrcode.react 在 React 中轻松生成二维码

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

需要专业的网站建设服务?

联系我们获取免费的网站建设咨询和方案报价,让我们帮助您实现业务目标

立即咨询