metabase/metabase

Read SQL Server `MS_Description` extended properties to auto-populate table and column descriptions

Open

#18,500 创建于 2021年10月15日

在 GitHub 查看
 (1 评论) (3 反应) (0 负责人)Clojure (47,314 star) (6,465 fork)batch import
.BackendAdministration/Metadata & SyncDatabase/SQLServerDrainable:YesType:New Featuregood first issue

描述

Microsoft SQL Server provides an "extended properties" feature which enables self-documenting tables and columns. Developers can set descriptions for tables and columns easily with SQL.

In my organization, we've been setting descriptions on every table and column for years and years. Several tools we've used over the years that automatically generate documentation from Microsoft SQL Databases query this metadata.

I was sad to see that metabase did not read any of the descriptions stored within my tables.

I propose a feature request that metabase take advantage of these easily gettable properties to automatically document the tables and columns that it models for Microsoft SQL Server.

See references:

贡献者指南

技术栈
sql
领域
backenddatabase
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
4
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
3-5 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Understanding of SQL Server extended propertiesFamiliarity with Metabase's database sync code
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
30
研究方向
Start by examining Metabase's SQL Server driver implementation, specifically the sync process that retrieves table and column metadata. Look at how other databases (e.g., PostgreSQL) auto populate descriptions for reference. The key is to query SQL Server's `sys.extended properties` or use `fn listextendedproperty` to fetch descriptions associated with tables and columns. Then integrate this into the sync flow so that descriptions are set automatically. See the existing sync code in `metabase/driver/sqlserver.clj` and the sync namespace.