NetEvolve.Pulse.MySql 0.84.106

Prefix Reserved
dotnet add package NetEvolve.Pulse.MySql --version 0.84.106
                    
NuGet\Install-Package NetEvolve.Pulse.MySql -Version 0.84.106
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NetEvolve.Pulse.MySql" Version="0.84.106" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="NetEvolve.Pulse.MySql" Version="0.84.106" />
                    
Directory.Packages.props
<PackageReference Include="NetEvolve.Pulse.MySql" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add NetEvolve.Pulse.MySql --version 0.84.106
                    
#r "nuget: NetEvolve.Pulse.MySql, 0.84.106"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package NetEvolve.Pulse.MySql@0.84.106
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=NetEvolve.Pulse.MySql&version=0.84.106
                    
Install as a Cake Addin
#tool nuget:?package=NetEvolve.Pulse.MySql&version=0.84.106
                    
Install as a Cake Tool

NetEvolve.Pulse.MySql

MySQL persistence provider for the Pulse outbox and idempotency patterns using plain ADO.NET.

Overview

NetEvolve.Pulse.MySql provides MySQL-backed implementations of the outbox and idempotency patterns:

  • MySqlOutboxRepository — Implements IOutboxRepository with optimized MySQL queries and schema scripts for table creation.
  • MySqlOutboxManagement — Implements IOutboxManagement for dead-letter inspection, replay, and statistics.
  • MySqlIdempotencyKeyRepository — Implements IIdempotencyKeyRepository for at-most-once command processing.

Requirements

  • MySQL 8.0 or later — Required for SELECT … FOR UPDATE SKIP LOCKED support (concurrent polling safety).
  • MySql.Data — Oracle MySQL Connector/NET.

Getting Started

1. Create the database schema

Run the SQL scripts from the Scripts/ folder against your MySQL database:

mysql -u <user> -p <database> < OutboxMessage.sql
mysql -u <user> -p <database> < IdempotencyKey.sql

Upgrading an existing schema

The scripts are safe to re-run. Every index is guarded by an information_schema.statistics check, because MySQL 8.0 has no CREATE INDEX IF NOT EXISTS. Re-running a script after upgrading the package is the supported way to apply indexes added in later releases. Existing tables and indexes are left unchanged.

For example, deployments created before IX_OutboxMessage_Status_UpdatedAt existed can re-run OutboxMessage.sql. They can also apply the index on its own:

SET @pulse_sql := IF(
    (SELECT COUNT(*) FROM information_schema.statistics
        WHERE TABLE_SCHEMA = DATABASE() AND TABLE_NAME = 'OutboxMessage' AND INDEX_NAME = 'IX_OutboxMessage_Status_UpdatedAt') = 0,
    'CREATE INDEX `IX_OutboxMessage_Status_UpdatedAt` ON `OutboxMessage` (`Status`, `UpdatedAt`)',
    'DO 0'
);
PREPARE pulse_stmt FROM @pulse_sql;
EXECUTE pulse_stmt;
DEALLOCATE PREPARE pulse_stmt;

The scripts use a session user variable (@pulse_sql). To execute them through MySql.Data instead of the mysql client, set AllowUserVariables=True in the connection string.

Idempotency key length and case sensitivity

  • Keys can be up to 450 characters long (IdempotencyKeySchema.MaxLengths.IdempotencyKey). ExistsAsync, StoreAsync and TryReserveAsync reject a longer key with an ArgumentOutOfRangeException. Keys are never truncated. The column stays VARCHAR(500), so existing rows need no change.
  • The key column uses the binary collation utf8mb4_bin, so keys are case-sensitive and accent-sensitive: aBc123 and ABC123 are two different keys. utf8mb4_bin is a PAD SPACE collation, so trailing spaces are not significant.
  • Keys are stored with a plain INSERT, and a duplicate key (ER_DUP_ENTRY, 1062) counts as an existing key. INSERT IGNORE is no longer used, because it turned data errors into warnings.

Tables created by earlier releases use utf8mb4_unicode_ci. Re-running IdempotencyKey.sql switches the key column to utf8mb4_bin. To apply the change on its own:

ALTER TABLE `IdempotencyKey`
    MODIFY `IdempotencyKey` VARCHAR(500) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NOT NULL;

2. Register services

Outbox:

services.AddPulse(config => config
    .AddOutbox()
    .AddMySqlOutbox("Server=localhost;Database=mydb;User Id=root;Password=secret;")
);

Idempotency:

services.AddPulse(config => config
    .AddMySqlIdempotencyStore("Server=localhost;Database=mydb;User Id=root;Password=secret;")
);

Data Types

C# type MySQL column type Encoding
Guid BINARY(16) Guid.ToByteArray() / new Guid(byte[])
DateTimeOffset BIGINT UTC ticks

This encoding is interchangeable with the NetEvolve.Pulse.EntityFramework MySQL provider.

Notes

MySQL does not use schema namespaces in the same way as SQL Server or PostgreSQL. The OutboxOptions.Schema and IdempotencyKeyOptions.Schema properties are not used; tables are always created in the active database specified by the connection string.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.84.106 88 11/8/2026
0.70.75 152 7/28/2026
0.70.16 132 7/27/2026
0.70.0 153 7/24/2026
0.67.140 133 7/23/2026
0.67.36 144 5/10/2026