Programmatically Update Table / Columns Descriptions in Unity Catalog Without Altering Table

[wallfacer]

Currently, we must re-run our DLT pipelines anytime we want to add/modify a table or column description to unity catalog.

• Is this the only way to add/modify unity catalog descriptions?
• Is there functionality within databricks cli / sdk that we can leverage to programmatically update table or column descriptions?
• Is there an api like StatementExecutionAPI?

Is this feature on the product roadmap?

[Kaniz_Fatma]

Hi @wallfacer, Let’s explore some options for programmatically updating table or column descriptions in Unity Catalog within Databricks:

1. Databricks CLI and SDK:

   • You can leverage the Databricks Command-Line Interface (CLI) and the Databricks SDK to programmatically update table or column descriptions.
   • The Databricks CLI provides a set of commands that allow you to interact with Databricks workspaces, clusters, and other resources from the command line.
   • The Databricks SDK (Python-based) allows you to programmatically manage Databricks resources using Python scripts.
   • You can use these tools to update table or column descriptions without altering the table itself¹.

2. SQL Syntax:

   • If you prefer SQL, you can use the UPDATE statement to modify table or column descriptions.
   • Here’s the syntax for the UPDATE statement:

     UPDATE table_name [table_alias]
     SET { { column_name | field_name } = [ expr | DEFAULT } ...]
     [WHERE clause]
     

   • Note that the table must be a Delta Lake table for this approach².

3. REST API:

   • While there isn’t a direct REST API specifically for updating table or column descriptions, you can use the REST API to execute SQL statements.
   • You can follow this tutorial to learn how to use the REST API to alter table or column comments³.

4. Product Roadmap:

   • As for whether this feature is on the product roadmap, I will get back to you.

Remember to choose the approach that best fits your requirements and workflow. If you have any further questions or need additional assistance, feel free to ask! 😊⁴³¹