Add SQL Code Comments

Enable to add descriptive comments to the SQL ELT code.

When enabled, the generated load code carries a placeholder comment at each position where an Extension Point can add custom code, such as before and after the source query and before and after the target load. Each comment names the Extension Point and the target, in the form Placeholder for extensionpoint="<Extension Point>" target="<Object>". The comments are added to generated stored procedures and to generated Databricks and Fabric notebooks. When disabled, no placeholder comments are added.

This setting covers the ELT code only. Comments on table definitions are controlled by the platform settings listed below.

When to Change This Setting

Enable it while developing or reviewing the generated code, to see where each Extension Point can add custom logic. Keep the default N to keep the generated code free of placeholder comments.

Related Settings

Setting	Interaction
Add SQL Comments (Snowflake)	Adds object and column descriptions as comments to Snowflake table scripts
Add SQL Comments (Databricks)	Adds object and column descriptions as comments to Databricks table scripts

Notes

• This setting is part of the Core settings category.
• The default value for this setting is N.