lakeFS icon indicating copy to clipboard operation
lakeFS copied to clipboard

Unity catalog exporter: Exported tables should retain original table field documentation

Open talSofer opened this issue 1 year ago • 2 comments

databricks users can add comments to tables in Unity Catalog and to their columns for documentation purposes. Table-level comments can be added after table creation, but column-level comments can be added on table creation.

Currently, table and column comments don't survive the export process to Unity Catalog.

Requirements

  • Retain Delta Lake tables comments on their export to Unity
  • Retain Delta Lake columns comments on their export to Unity

talSofer avatar Jan 18 '24 10:01 talSofer

Why is this a bug for exported tables only? AFAICT @kesarwam opened the issue before we exported the tables

itaiad200 avatar Feb 19 '24 14:02 itaiad200

@itaiad200 this is not a bug, this is an enhancement request. The way I see this, we should not support this for Unity delta sharing solution (against which #6322 was opened) but include it in our recommended delta + unity solution which is the exporter. Makes sense?

talSofer avatar Feb 19 '24 14:02 talSofer

Column comments are already supported: Image

Jonathan-Rosenberg avatar Feb 29 '24 14:02 Jonathan-Rosenberg

So currently Delta table comments (both on table and column) are exported. When running:

  1. DESCRIBE DETAIL <catalog>.<schema>.<table>; you'll get the table comment (although you can't see it in the Unity GUI).
  2. DESCRIBE TABLE <catalog>.<schema>.<table>; you'll get the column comments (you can also see it in the Unity GUI).

LMK if you wish me to keep working on that @talSofer @ozkatz

Jonathan-Rosenberg avatar Feb 29 '24 15:02 Jonathan-Rosenberg

Great news @Jonathan-Rosenberg! Do you know what effort does it take to make table documentation appear in the Unity catalog UI?

talSofer avatar Mar 03 '24 06:03 talSofer

not much... Just wanted to know that it's indeed necessary

Jonathan-Rosenberg avatar Mar 03 '24 14:03 Jonathan-Rosenberg