MSBuild.Sdk.PostgreSql 1.0.0-preview2

MSBuild.Sdk.PostgreSql

MSBuild SDK for PostgreSQL Database Projects

Build SQL Server-style database projects for PostgreSQL! This SDK enables you to organize your PostgreSQL schema as code in a .csproj file, and automatically compile it to a deployable .pgpac package during build.

Features

✅ Convention over Configuration - Auto-discovers SQL files
✅ MSBuild Integration - Works with dotnet build and Visual Studio
✅ Incremental Builds - Only rebuilds when SQL files change
✅ Validation - Checks dependencies and circular references
✅ Portable Packages - Generates .pgpac files (PostgreSQL Data-tier Application Package)
✅ CI/CD Ready - Perfect for DevOps pipelines

Quick Start

Before You Start

• There is no separate Visual Studio project template installer for preview1.
• Create the .csproj manually or generate one with pgpac extract.
• To open the project in Visual Studio, make sure the solution can restore MSBuild.Sdk.PostgreSql from nuget.org or a local package feed.

1. Create a Database Project

<Project Sdk="Microsoft.NET.Sdk">

  <Sdk Name="MSBuild.Sdk.PostgreSql" Version="1.0.0-preview1" />

  <PropertyGroup>
    <TargetFramework>net10.0</TargetFramework>
    <DatabaseName>MyDatabase</DatabaseName>
  </PropertyGroup>

</Project>

2. Organize SQL Files

MyDatabase/
├── MyDatabase.csproj
├── Tables/
│   ├── Users.sql
│   └── Orders.sql
├── Views/
│   └── ActiveOrders.sql
└── Functions/
    └── CalculateTotal.sql

3. Build

dotnet build

Output:

bin/Debug/net10.0/MyDatabase.pgpac

Project Structure

Automatic SQL Discovery

All .sql files are automatically included! Organize them however you want:

MyDatabase/
├── Tables/          ✅ Discovered
├── Views/           ✅ Discovered  
├── Functions/       ✅ Discovered
├── Types/           ✅ Discovered
├── Sequences/       ✅ Discovered
├── Triggers/        ✅ Discovered
└── YourFolder/      ✅ Discovered

Pre/Post Deployment Scripts

Only these need explicit configuration:

<ItemGroup>
  <PreDeploy Include="Scripts\PreDeployment\*.sql" />
  <PostDeploy Include="Scripts\PostDeployment\*.sql" />
</ItemGroup>

Configuration

Properties

Example

<Project Sdk="Microsoft.NET.Sdk">

  <Sdk Name="MSBuild.Sdk.PostgreSql" Version="1.0.0-preview1" />

  <PropertyGroup>
    <TargetFramework>net10.0</TargetFramework>
    <DatabaseName>ProductionDB</DatabaseName>
    <OutputFormat>pgpac</OutputFormat>
    <ValidateOnBuild>true</ValidateOnBuild>
  </PropertyGroup>

  
  <ItemGroup>
    <PreDeploy Include="Scripts\PreDeployment\BackupData.sql" />
    <PostDeploy Include="Scripts\PostDeployment\SeedData.sql" />
  </ItemGroup>

</Project>

Build Integration

dotnet CLI

# Build
dotnet build

# Clean
dotnet clean

# Rebuild
dotnet rebuild

Visual Studio

• Open the .csproj directly or add it to an existing solution
• If you are testing a local packed SDK, add a nuget.config with your local feed before opening the project
• Run dotnet restore if Visual Studio reports the SDK cannot be resolved
• Press Ctrl+Shift+B to build
• Output appears in bin\Debug\net10.0\

CI/CD

# GitHub Actions
- name: Build Database
  run: dotnet build MyDatabase/MyDatabase.csproj
  
- name: Upload Package
  uses: actions/upload-artifact@v3
  with:
    name: database
    path: MyDatabase/bin/Debug/net10.0/*.pgpac

What is .pgpac?

A .pgpac (PostgreSQL Data-tier Application Package) is:

• 📦 ZIP file containing your database schema
• 📄 Single content.json file inside
• 🚀 Deployable with postgresPacTools publish
• ✅ Version controllable artifact

Deployment

After building, deploy with:

postgresPacTools publish \
  -sf bin/Debug/net10.0/MyDatabase.pgpac \
  -tcs "Host=server;Database=mydb;Username=user;Password=pass"

Comparison with MSBuild.Sdk.SqlProj

If you're familiar with SQL Server database projects:

Advanced Usage

Custom Output Path

<PropertyGroup>
  <PgPacFilePath>$(MSBuildProjectDirectory)\dist\$(DatabaseName).pgpac</PgPacFilePath>
</PropertyGroup>

Use PgPacFilePath to control the generated database package location. The SDK intentionally does not override TargetPath, so Visual Studio and the .NET project system can continue to treat the project like a normal SDK-style .NET project.

JSON Output

<PropertyGroup>
  <OutputFormat>json</OutputFormat>
  <PgPacFileName>$(DatabaseName).pgproj.json</PgPacFileName>
</PropertyGroup>

Disable Validation

<PropertyGroup>
  <ValidateOnBuild>false</ValidateOnBuild>
</PropertyGroup>

Requirements

• .NET 10 SDK or later
• PostgreSQL database for deployment

Links

• GitHub: https://github.com/mbulava-org/pgPacTool
• NuGet: https://www.nuget.org/packages/MSBuild.Sdk.PostgreSql
• Documentation: https://github.com/mbulava-org/pgPacTool/tree/main/docs

License

MIT License - see LICENSE file

Contributing

Contributions welcome! See CONTRIBUTING.md

Build PostgreSQL databases like a pro! 🐘🚀