uc-deploy-comments

Deploy column and table comments to Unity Catalog with ANSI SQL.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/guyman-tr/Databricks_Knowledge --skill uc-deploy-comments
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: uc-deploy-comments
Source: https://github.com/guyman-tr/Databricks_Knowledge/tree/main/.cursor/skills/uc-deploy-comments
Command: npx skills add https://github.com/guyman-tr/Databricks_Knowledge --skill uc-deploy-comments

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires deploy_alter_batch.py, deploy_ddr_enrichment.py, apply_tvf_col_comments.py, propagate_upstream_cols.py, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Manages the deployment of column and table comments/descriptions in Unity Catalog, enhancing data documentation and discoverability.

Core Features & Use Cases

  • Deploy Column and Table Comments: Pushes comments to tables and views in Unity Catalog.
  • Batch and One-off Deployment: Supports batch deployment from a deploy-index and one-off deployment of specific alter files.
  • TVF Views: Applies comments to Temp View Functions (TVFs) in a structured manner.
  • Views vs. Tables: Offers clear syntax for altering views and tables with ANSI SQL compliance.

Quick Start

Run 'deploy_alter_batch.py --schema DWH_dbo --batch-size 25 --deploy-batch 2 -v' to deploy column and table comments in batch mode for schema DWH_dbo.

Frequently Asked Questions about uc-deploy-comments

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I batch deploy comments to Unity Catalog tables and views?

Batch deploy comments to Unity Catalog by running deploy_alter_batch.py with parameters like --schema and --batch-size to push column and table descriptions in structured groups. You can target specific deploy batches for controlled execution across schemas.

Can I apply column comments to TVFs in Unity Catalog?

Yes, you can apply column comments to TVFs in Unity Catalog using the apply_tvf_col_comments.py script. This handles Temp View Functions in a structured manner, ensuring descriptions are pushed correctly to function-based views.

What is the difference between deploying comments to views versus tables in Unity Catalog?

Deploying comments to views versus tables in Unity Catalog requires different ANSI SQL syntax for the alter statements. The Skill handles both object types, applying the correct SQL syntax to ensure compliance when pushing descriptions to tables or views.

Do I need deployment tools and Unity Catalog access to deploy table documentation?

Yes, you need existing deployment tools and Unity Catalog access to deploy table documentation. The Skill automates the comment deployment process using predefined scripts, but requires proper environment access and permissions to alter table and view metadata.

Can I deploy a single specific alter file instead of running a batch deployment?

Yes, you can deploy a single specific alter file instead of running a batch deployment. The Skill supports one-off deployment of individual alter files alongside batch deployments from a deploy-index, giving you flexibility for targeted updates.

Why use a scripted approach for Unity Catalog table documentation instead of manual comments?

Using a scripted approach for Unity Catalog table documentation automates the deployment of column and table comments, ensuring consistency across schemas. It handles batch deployments, TVFs, and ANSI SQL syntax compliance that manual commenting cannot efficiently manage at scale.