pengdows.poco.mint.cli 2.0.1

pengdows.poco.mint

A .NET global tool that generates strongly-typed C# POCO classes from database schemas for use with the pengdows.crud framework. Point it at any supported database and receive ready-to-use entity classes with audit tracking, concurrency tokens, and all pengdows.crud attributes already applied.

Installation

dotnet tool install --global pengdows.poco.mint.cli

Quick Start

pengdows.poco.mint \
  -c "Host=localhost;Database=mydb;Username=postgres;Password=secret" \
  -p PostgreSql \
  -o ./Entities \
  -n MyApp.Data.Entities

Supported Databases

Options

Required

Optional

Examples

SQL Server

pengdows.poco.mint \
  -c "Server=localhost;Database=MyDatabase;Trusted_Connection=True;TrustServerCertificate=True" \
  -p SqlServer \
  -o ./Entities \
  -n MyApp.Data.Entities

PostgreSQL

pengdows.poco.mint \
  -c "Host=localhost;Database=mydb;Username=postgres;Password=secret" \
  -p PostgreSql \
  -o ./Entities \
  -n MyApp.Data.Entities

MySQL / MariaDB

pengdows.poco.mint \
  -c "Server=localhost;Database=mydb;Uid=root;Pwd=secret;" \
  -p MySql \
  -o ./Entities \
  -n MyApp.Data.Entities

Oracle

pengdows.poco.mint \
  -c "Data Source=localhost:1521/XEPDB1;User Id=myuser;Password=secret;" \
  -p Oracle \
  -o ./Entities \
  -n MyApp.Data.Entities

SQLite

pengdows.poco.mint \
  -c "Data Source=./mydb.sqlite" \
  -p Sqlite \
  -o ./Entities \
  -n MyApp.Data.Entities

DuckDB

pengdows.poco.mint \
  -c "Data Source=./mydb.duckdb" \
  -p DuckDB \
  -o ./Entities \
  -n MyApp.Data.Entities

Firebird

pengdows.poco.mint \
  -c "DataSource=localhost;Database=mydb.fdb;User=SYSDBA;Password=masterkey" \
  -p Firebird \
  -o ./Entities \
  -n MyApp.Data.Entities

CockroachDB

pengdows.poco.mint \
  -c "Host=localhost;Port=26257;Database=mydb;Username=root;SslMode=Disable" \
  -p CockroachDb \
  -o ./Entities \
  -n MyApp.Data.Entities

Filter to Specific Schemas and Tables

pengdows.poco.mint \
  -c "Server=localhost;Database=MyDatabase;Trusted_Connection=True;TrustServerCertificate=True" \
  -p SqlServer \
  -s dbo sales \
  -t customers orders order_items \
  -o ./Entities

Include Views

pengdows.poco.mint \
  -c "Server=localhost;Database=MyDatabase;Trusted_Connection=True;TrustServerCertificate=True" \
  -p SqlServer \
  --include-views \
  -o ./Entities

Using a Config File

pengdows.poco.mint -f myconfig.json

Config file format:

{
  "connectionString": "Server=localhost;Database=MyDatabase;Trusted_Connection=True;TrustServerCertificate=True",
  "provider": "SqlServer",
  "output": "./Entities",
  "namespace": "MyApp.Data.Entities",
  "schemas": ["dbo"],
  "tables": ["customers", "orders"],
  "includeViews": false
}

Generated Output

The tool generates one .generated.cs file per table or view. Each class is decorated with pengdows.crud attributes derived from the database schema:

using System;
using System.Data;
using System.Text.Json;
using pengdows.crud.attributes;

namespace MyApp.Data.Entities;

[Table("orders", "dbo")]
public class Order
{
    [Column("order_id", DbType.Int32, 1)]
    [Id(writable: false)]
    [NonInsertable]
    public int OrderID { get; set; }

    [Column("customer_id", DbType.Int32, 2)]
    public int CustomerID { get; set; }

    [Column("order_date", DbType.DateTime, 3)]
    public DateTime OrderDate { get; set; }

    [Column("total", DbType.Decimal, 4)]
    public decimal Total { get; set; }

    [Column("created_on", DbType.DateTime, 5)]
    [CreatedOn]
    public DateTime CreatedOn { get; set; }

    [Column("row_version", DbType.Binary, 6)]
    [Version]
    public byte[] RowVersion { get; set; }
}

Regeneration overwrites *.generated.cs. Add customizations in a separate partial class file alongside the generated file.

Automatic Attribute Detection

Design Constraints

• The database schema is the source of truth; the generator never mutates the schema.
• Generated POCOs are mapping contracts for deterministic SQL generation.
• Surrogate [Id] takes precedence. A unique constraint becomes [PrimaryKey] only when the table already has a surrogate [Id].
• [Version] represents an optimistic concurrency token, not a "last updated" timestamp.
• Identifier normalization may produce collisions. Collisions are resolved with numeric suffixes (e.g., Name, Name1, Name2) and a warning is issued. The CLI prompts for confirmation unless -y is passed.
• Composite key sequences must be contiguous and start at 1; invalid sequences stop generation.
• If a table has no surrogate [Id], the generator emits [PrimaryKey] only. Some pengdows.crud helpers expect a surrogate [Id], so consider adding one if you need full helper support.

Web UI

A browser-based UI and REST API are available as a Docker image for interactive schema exploration and POCO generation. See README.docker.md for details.

Requirements

• .NET 8.0 or later
• pengdows.crud v2.0+ (pulled automatically as a dependency)