Enhance support for CLR stored procedures and table-valued functions

- Updated SqlChangeTracker to include CLR stored procedures (type 'PC') and table-valued functions (type 'FT') in the introspection and scripting processes.
- Added functionality to script CLR stored procedures and table-valued functions, including their parameters and return types.
- Enhanced the normalization process for CLR table-valued functions to suppress differences related to NULL tokens and formatting.
- Implemented tests to verify the inclusion and correct scripting of CLR objects.
- Updated the SyncCommandService to handle differences in CLR functions and queues more effectively.

Author: zacateras

CHANGELOG.md

@@ -10,13 +10,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ### Fixed
 - Script schema-level permissions after schema creation and before schema extended properties.
 - Match legacy non-canonical schema-less object filenames to the scripted object name when the canonical name requires percent escaping.
+- Treat equivalent queue option formatting, explicit default `ON [PRIMARY]`, and disabled default activation as compatible during comparison.
+- Treat legacy explicit `NULL` tokens on CLR table-valued function return columns as compatible during comparison and preserve them during compatibility reconciliation when the rest of the definition matches.
 - Trailing semicolon differences on `INSERT` statement lines in data scripts are now suppressed during comparison normalization; scripts emitted with and without statement terminators compare as compatible (#47).
 - Legacy `TableData` scripts now compare as compatible when they differ from canonical output only by `SET IDENTITY_INSERT` semicolons or top-level `N'...'` string literal prefixes, including inside multi-line `INSERT ... VALUES (...)` statements.
 - Whitespace-only separator lines now compare as compatible with empty blank lines during `status` and `diff`.
 - Preserve reference banner-comment formatting and module-declaration identifier quoting during programmable-object compatibility reconciliation.
 - Preserve compatible computed-column arithmetic grouping parentheses during table compatibility reconciliation.
 
 ### Added
+- Discover and script SQL CLR scalar functions as `Function` objects.
+- Discover and script SQL CLR table-valued functions as `Function` objects.
+- Discover and script SQL CLR stored procedures as `StoredProcedure` objects.
 - `sqlct init` now prompts interactively for connection details (server, database, auth, credentials, trust-server-certificate) when run without flags in a new project directory (#36).
 - Connection flags (`--server`, `--database`, `--auth`, `--user`, `--password`, `--trust-server-certificate`) for non-interactive/scripted `init` use (#36).
 - `--skip-connection-test` flag for `sqlct init` to bypass the connection test step (#36).

README.md

@@ -52,8 +52,12 @@ Current runtime scope for `status`, `diff`, and `pull` covers:
 - `FullTextStoplist`
 - `SearchPropertyList`
 
+Stored procedure scripting covers T-SQL procedures and SQL CLR stored procedures (`sys.objects.type = 'P'` and `PC`).
+
 Table scripting also includes standalone user-created table statistics (`CREATE STATISTICS`) as post-create table statements. Current statistics option coverage includes effective sampling (`FULLSCAN` or `SAMPLE <n> PERCENT`), `PERSIST_SAMPLE_PERCENT = ON`, `NORECOMPUTE`, `INCREMENTAL=ON`, and `AUTO_DROP = ON|OFF` when the source server exposes the required metadata. `MAXDOP`, `STATS_STREAM`, `ROWCOUNT`, and `PAGECOUNT` remain deferred.
 
+Function scripting covers T-SQL scalar/table functions and SQL CLR scalar/table-valued functions (`sys.objects.type = 'FS'` and `FT`), including `EXTERNAL NAME` assembly bindings.
+
 When `data.trackedTables` is configured, `status`, `diff`, and `pull` also process `TableData` artifacts for those explicit tracked tables.
 
 `--object` selectors support:

specs/01-cli.md

@@ -195,9 +195,10 @@ Behavior:
   - Deleted: object exists only in target.
   - Changed: normalized script content differs.
   - Suppress changes when scripts are identical after normalization.
-- Normalization in v1 is limited to line-ending/trailing-newline stability for deterministic comparison.
+- Normalization includes line-ending/trailing-newline stability plus explicitly listed compatibility rules for deterministic comparison.
 - Whitespace-only lines are normalized to empty lines during comparison so blank separators with spaces or tabs compare as compatible.
 - Trailing semicolons on `INSERT` statement lines are stripped during normalization; scripts emitted with and without statement terminators compare as compatible.
+- Equivalent `Queue` option spacing, line wrapping, explicit default `ON [PRIMARY]`, and disabled default activation compare as compatible.
 - When `data.trackedTables` is configured, `status` also reports data-script differences for tracked tables.
 - Status output MUST report schema and data summaries separately.
 - Exit codes:
@@ -217,9 +218,10 @@ Behavior:
 - Without `--object`, output concatenated per-object diffs in stable order.
 - Changed objects use DB-vs-folder unified diff.
 - Added/deleted objects use empty-side vs script-side unified diff.
-- Normalization in v1 is limited to line-ending/trailing-newline stability for deterministic comparison.
+- Normalization includes line-ending/trailing-newline stability plus explicitly listed compatibility rules for deterministic comparison.
 - Whitespace-only lines are normalized to empty lines during comparison so blank separators with spaces or tabs compare as compatible.
 - Trailing semicolons on `INSERT` statement lines are stripped during normalization; scripts emitted with and without statement terminators compare as compatible.
+- Equivalent `Queue` option spacing, line wrapping, explicit default `ON [PRIMARY]`, and disabled default activation compare as compatible.
 - Diff output uses a chunked format: only changed lines and their surrounding context are shown, not the entire file.
 - `--context <N>` controls the number of unchanged context lines shown before and after each changed segment (default: 3). Negative values are treated as 0.
 - When two change segments are close enough that their context regions overlap, they are merged into a single hunk.

specs/04-scripting.md

@@ -66,7 +66,7 @@ This specification defines normative scripting rules for `sqlct`.
 - Assemblies
 - Views
 - Stored Procedures
-- Functions (`FN`, `TF`, `IF`)
+- Functions (`FN`, `TF`, `IF`, `FS`, `FT`)
 - Sequences
 - Schema
 - Role
@@ -373,8 +373,13 @@ Each emitted statement MUST be followed by `GO`.
   2. index-level (by index name, then property name).
 
 ### 8.3 Stored Procedures
-- Stored procedures are scripted through programmable-object framing rules with object type `P` and level type `PROCEDURE`.
-- Definition text MUST come from `OBJECT_DEFINITION`.
+- Stored procedures are scripted through programmable-object framing rules with object types `P`, `PC` and level type `PROCEDURE`.
+- T-SQL stored procedure definition text for `P` MUST come from `OBJECT_DEFINITION`.
+- CLR stored procedure (`PC`) metadata MUST be sourced from `sys.assembly_modules`, `sys.assemblies`, and `sys.parameters`.
+- CLR stored procedure (`PC`) output MUST emit:
+  - `CREATE PROCEDURE [schema].[name] (<parameters>)`
+  - optional `WITH EXECUTE AS <CALLER|OWNER|'principal'>`
+  - `AS EXTERNAL NAME [assembly].[class].[method]`
 - Regex replacements from overrides MUST be applied before compatibility line-map reconciliation.
 - Compatibility definition line-map reconciliation MUST be applied when reference file exists.
 - When no compatible reference spacing is preserved, procedure emission MUST use the canonical programmable-object whitespace rules from Section 6.1.
@@ -388,8 +393,24 @@ Each emitted statement MUST be followed by `GO`.
   2. parameter-level (by parameter name, then property name).
 
 ### 8.4 Functions
-- Functions are scripted through programmable-object framing rules with object types `FN`, `TF`, `IF` and level type `FUNCTION`.
-- Definition text MUST come from `OBJECT_DEFINITION`.
+- Functions are scripted through programmable-object framing rules with object types `FN`, `TF`, `IF`, `FS`, `FT` and level type `FUNCTION`.
+- T-SQL function definition text for `FN`, `TF`, and `IF` MUST come from `OBJECT_DEFINITION`.
+- CLR function metadata for `FS` and `FT` MUST be sourced from `sys.assembly_modules`, `sys.assemblies`, and `sys.parameters`.
+- CLR scalar function (`FS`) output MUST emit:
+  - `CREATE FUNCTION [schema].[name] (<parameters>)`
+  - `RETURNS <return_type>`
+  - `WITH EXECUTE AS <CALLER|OWNER|'principal'>`
+  - `EXTERNAL NAME [assembly].[class].[method]`
+- CLR table-valued function (`FT`) return-column metadata MUST be sourced from `sys.columns`, `sys.types`, and type-schema metadata for the function object.
+- CLR table-valued function (`FT`) order metadata MUST be sourced from `sys.function_order_columns` when available.
+- CLR table-valued function (`FT`) output MUST emit:
+  - `CREATE FUNCTION [schema].[name] (<parameters>)`
+  - `RETURNS TABLE (`
+  - one return column per line in `column_id` order using `[name] <type>`
+  - `)`
+  - `WITH EXECUTE AS <CALLER|OWNER|'principal'>`
+  - optional `ORDER ([column_1] <ASC|DESC>, [column_2] <ASC|DESC>, ...)` ordered by `order_column_id`
+  - `EXTERNAL NAME [assembly].[class].[method]`
 - Regex replacements from overrides MUST be applied before final emission.
 - When no compatible reference spacing is preserved, function emission MUST use the canonical programmable-object whitespace rules from Section 6.1.
 - Grants and extended properties MUST follow module body.
@@ -781,6 +802,8 @@ When compatibility reference files are available, `sqlct` MAY apply reconciliati
 - Trailing semicolons on `INSERT` statement lines MUST be stripped by comparison normalization so that scripts emitted with and without statement terminators compare as compatible.
 - For `TableData`, trailing semicolons on `SET IDENTITY_INSERT` lines MUST also be stripped by comparison normalization.
 - For `TableData`, comparison normalization MUST treat legacy top-level `N'...'` string literals inside single-line or multi-line `INSERT ... VALUES (...)` statements as compatible with canonical `'...'` literals; canonical script generation remains governed by Section 8.26.
+- For `Queue`, comparison normalization MUST treat equivalent single-line and multi-line queue option formatting as compatible, MAY treat explicit `ON [PRIMARY]` as equivalent to an omitted default primary filegroup, and MAY treat disabled activation containing only default owner execution context as equivalent to omitted activation.
+- For CLR table-valued `Function` scripts, comparison normalization MAY treat legacy explicit `NULL` tokens on return-column lines as compatible with canonical return-column lines that omit nullability, including legacy cases where the final return-column line also carries the closing `)` token.
 
 ## 11. Error and Unsupported Behavior
 - Missing SQL object metadata for requested object MUST fail with an error.

src/SqlChangeTracker/PACKAGE_README.md

@@ -53,8 +53,12 @@ Current runtime scope for `status`, `diff`, and `pull` covers:
 - `FullTextStoplist`
 - `SearchPropertyList`
 
+Stored procedure scripting covers T-SQL procedures and SQL CLR stored procedures (`sys.objects.type = 'P'` and `PC`).
+
 Table scripting also includes standalone user-created table statistics (`CREATE STATISTICS`) as post-create table statements. Current statistics option coverage includes effective sampling (`FULLSCAN` or `SAMPLE <n> PERCENT`), `PERSIST_SAMPLE_PERCENT = ON`, `NORECOMPUTE`, `INCREMENTAL=ON`, and `AUTO_DROP = ON|OFF` when the source server exposes the required metadata. `MAXDOP`, `STATS_STREAM`, `ROWCOUNT`, and `PAGECOUNT` remain deferred.
 
+Function scripting covers T-SQL scalar/table functions and SQL CLR scalar/table-valued functions (`sys.objects.type = 'FS'` and `FT`), including `EXTERNAL NAME` assembly bindings.
+
 When `data.trackedTables` is configured, `status`, `diff`, and `pull` also process `TableData` artifacts for those explicit tracked tables.
 
 Feature-backed object types are included when the target database exposes them, such as `FullTextCatalog`, `FullTextStoplist`, and `SearchPropertyList`.

src/SqlChangeTracker/Sql/SqlServerIntrospector.cs

@@ -23,7 +23,7 @@ FROM sys.assemblies a
 SELECT s.name AS schema_name, o.name AS object_name, o.type
 FROM sys.objects o
 JOIN sys.schemas s ON s.schema_id = o.schema_id
-WHERE o.is_ms_shipped = 0 AND o.type IN ('U','V','P','FN','TF','IF')
+WHERE o.is_ms_shipped = 0 AND o.type IN ('U','V','P','PC','FN','TF','IF','FS','FT')
 ORDER BY s.name, o.name;", MapObjectType),
 
             () => RunQuery(options, @"
@@ -401,7 +401,7 @@ FROM sys.objects o
 FROM sys.objects o
 JOIN sys.schemas s ON s.schema_id = o.schema_id
 WHERE o.is_ms_shipped = 0
-  AND o.type = 'P'
+  AND o.type IN ('P','PC')
   AND s.name = @schema
   AND o.name = @name
 ORDER BY s.name, o.name;
@@ -416,7 +416,7 @@ FROM sys.objects o
 FROM sys.objects o
 JOIN sys.schemas s ON s.schema_id = o.schema_id
 WHERE o.is_ms_shipped = 0
-  AND o.type IN ('FN','TF','IF')
+  AND o.type IN ('FN','TF','IF','FS','FT')
   AND s.name = @schema
   AND o.name = @name
 ORDER BY s.name, o.name;
@@ -715,8 +715,8 @@ private static string MapObjectType(string type)
             "ASSEMBLY" => "Assembly",
             "U" => "Table",
             "V" => "View",
-            "P" => "StoredProcedure",
-            "FN" or "TF" or "IF" => "Function",
+            "P" or "PC" => "StoredProcedure",
+            "FN" or "TF" or "IF" or "FS" or "FT" => "Function",
             "SQ" => "Sequence",
             "SC" => "Schema",
             "SY" => "Synonym",