Breeze is a library from IdeaBlade that helps you manage data in rich client applications. Breeze clients communicate with any remote service that speaks HTTP and JSON.
This repo contains the .NET server-side libraries. It is the successor to breeze.server.net; see Relationship to the old repo.
| Package | Purpose |
|---|---|
| Breeze.AspNetCore.NetCore | ASP.NET Core integration - [BreezeQueryFilter] and friends |
| Breeze.Persistence.EFCore | Entity Framework Core support |
| Breeze.Persistence.NH | NHibernate support |
| Breeze.Persistence | Shared persistence layer (pulled in automatically) |
| Breeze.Core | Query and serialization core (pulled in automatically) |
A typical EF Core application installs the first two.
Version 8.0 targets .NET 8, 9 and 10. For .NET 5, 6 or 7 - all out of support - use 7.5.2 from the old repo.
| docs/guide/ | Using Breeze on the server - getting started, querying, saving, metadata, errors |
| UPGRADE.md | Upgrading an app from 7.x - every consumer-facing change |
| CHANGES-DEV.md | Structural changes, for people working on Breeze itself |
| STATUS.md | What is done, what is in flight, what is next |
| DOCS.md | Building and viewing the docs - the guide (VitePress) and the .NET API reference (DocFX) |
The user documentation is at breeze.github.io/breeze-server-v3. The 7.x and ASP.NET 4.x documentation is still at breeze.github.io/doc-net.
src/ the five shipping packages
tests/ test server, EF/NHibernate models, and the test database script
tools/ DbScripter - regenerates tests/Databases/BreezeTestDb.sql
Shared package metadata, signing and target frameworks live in src/Directory.Build.props;
each .csproj carries only what differs.
dotnet build Breeze.sln
dotnet pack src/Breeze.Core/Breeze.Core.csproj -c Release
The suite is driven from the client repo, breeze-client-v3; this repo provides the server and the database it runs against.
Full instructions, verified end to end, are in breeze-client-v3/TESTING.md. The short version:
# 1. create the single test database (note -f 65001; see below)
sqlcmd -S . -E -Q "CREATE DATABASE BreezeTestDb"
sqlcmd -S . -E -d BreezeTestDb -f 65001 -i tests/Databases/BreezeTestDb.sql
# 2. start the server and leave it running
dotnet run --project tests/Test.AspNetCore.EFCore/Test.AspNetCore.EFCore.csproj \
--no-launch-profile --urls http://localhost:34377
# 3. from the breeze-client-v3 checkout
npm test-f 65001 is required. The script is UTF-8 and the Northwind data contains accented
characters; without it sqlcmd decodes the file as the system ANSI codepage and silently
corrupts every one of them. See tests/Databases/README.md.
--no-launch-profile is also required - the default profile is IIS Express.
This repo starts fresh. The old repo carried four dead source trees (AspNet, AspNetCore, AspNetCore-v3, Old),
per-.NET-version duplicates of every project file (93 .csproj files, against 13 here), a gulp build, and 40MB of
SQL Server 2008-era .mdf binaries. None of that is here. The old repo remains available for history and for
7.x maintenance.
If you have discovered a bug or missing feature, please create an issue.
If you have questions about using Breeze, please ask on Stack Overflow.
If you need help developing your application, please contact us at IdeaBlade.