SpDtoGen 1.0.0

<div align="center">

🌐 Language / Ngôn ngữ / 言語

🇬🇧 English  |  🇻🇳 Tiếng Việt  |  🇯🇵 日本語

</div>

sp-dto-gen

A .NET CLI tool that automatically generates C# DTOs from SQL Server Stored Procedures using sp_describe_first_result_set — no SP execution required.

Installation

dotnet tool install -g SpDtoGen

Usage

Generate DTO for a single SP

sp-dto-gen dto \
  --connection "Server=localhost;Database=MyDb;Trusted_Connection=true;" \
  --sp usp_Order_GetById \
  --output ./DTOs \
  --namespace MyApp.Application.DTOs

Generate DTOs matching a wildcard pattern

sp-dto-gen dto --connection "..." --sp "usp_Order*" --output ./DTOs

Generate DTOs for all SPs in the database

sp-dto-gen dto --connection "..." --output ./DTOs

Preview without writing files

sp-dto-gen dto --connection "..." --sp usp_Order_GetById --dry-run

Generate record instead of class

sp-dto-gen dto --connection "..." --sp usp_Order_GetById --record

Options

Example output

Given this stored procedure:

CREATE PROCEDURE usp_Order_GetById @Id INT
AS
SELECT
    o.OrderId,
    o.CustomerName,
    o.TotalAmount,     -- decimal(18,2)
    o.CreatedAt,       -- datetime2
    o.IsDeleted,       -- bit
    o.AssignedUserId   -- int NULL
FROM Orders o
WHERE o.OrderId = @Id

Generated OrderGetByIdDto.cs:

// <auto-generated>
//   Generated by SpDtoGen on 2024-01-15 08:30:00 UTC
//   Source SP: [dbo].[usp_Order_GetById]
// </auto-generated>

using System.CodeDom.Compiler;

namespace MyApp.Application.DTOs;

[GeneratedCode("SpDtoGen", "1.0.0")]
/// <summary>DTO for stored procedure [dbo].[usp_Order_GetById]</summary>
public class OrderGetByIdDto
{
    public int OrderId { get; set; }
    public string CustomerName { get; set; } = string.Empty;
    /// <remarks>SQL: decimal(18,2) — precision=18, scale=2</remarks>
    public decimal TotalAmount { get; set; }
    public DateTime CreatedAt { get; set; }
    public bool IsDeleted { get; set; }
    public int? AssignedUserId { get; set; }
}

Naming convention

Known limitations

⚠️ SP using temp tables (#tempTable) — sp_describe_first_result_set cannot statically analyze SPs that use temp tables. The tool will generate an empty skeleton with a warning comment. You will need to add properties manually.

Workaround: Consider rewriting the SP to use table variables (@tableVar) instead of temp tables — they are fully supported.

• Dynamic SQL (EXEC(@sql)) cannot be statically analyzed — same behavior as above.
• IF/ELSE branches returning different result sets — only the first resolvable branch is used.
• Multiple result sets — only the first result set is generated.

License

MIT