Polecat

SQL Server-Backed Event Store inside the Critter Stack.

Polecat is live and ready for real usage! See Jeremy's announcement on the 1.0 release.

Support Plans

While Polecat is open source, JasperFx Software offers paid support and consulting contracts for Marten.

Help us keep working on this project 💚

Become a Sponsor on GitHub by sponsoring monthly or one time.

Working with the Code

Before getting started you will need the following in your environment:

1. .NET SDK 10.0+

Available here

2. SQL Server 2025 or above database

The fastest possible way to develop with Polecat is to run SQL Server in a Docker container. Assuming that you have Docker running on your local box, type: docker-compose up -d. This will run SQL Server with native JSON support required for full Polecat functionality (JSON_OBJECT, GENERATE_SERIES, etc.).

On Apple Silicon Macs, SQL Server 2025 under Rosetta may crash due to memory constraints. SQL Server 2022 can be used as a fallback for basic development with docker compose -f docker-compose.edge.yml up -d (port 11435; point POLECAT_TESTING_DATABASE at it, or pass --storage edge to the Nuke test targets). Be aware about limited functionality in this case: 2022 has no native json or vector type.

Documentation

All the documentation is expected to mimic how other JasperFx projects are handled, which is written in Markdown and the docs are published as a static site.

License

Copyright © Jeremy D. Miller and contributors.

Polecat is provided as-is under the MIT license. For more information see LICENSE.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.