Add SQL Comments
Enable this option to include user-defined metadata as SQL comments in your CREATE TABLE scripts.
When enabled, the table create scripts add a COMMENT ON TABLE statement carrying the object's description (the Business Entity description when one exists, otherwise the object description), and matching column-level comments from the column descriptions. Comments are only emitted where a description exists.
When to Change This Setting
Keep the default N when descriptions are not maintained in the metadata. Enable it when you maintain object and column descriptions in BimlFlex and want them surfaced in the Databricks catalog for discovery.
Related Settings
| Setting | Interaction |
|---|---|
| Add SQL Tags | The equivalent option for business metadata as tags |
Notes
- This setting is part of the Databricks settings category.
- The default value for this setting is
N.