DotEventOutbox 1.0.2

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package DotEventOutbox --version 1.0.2
NuGet\Install-Package DotEventOutbox -Version 1.0.2
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="DotEventOutbox" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add DotEventOutbox --version 1.0.2
#r "nuget: DotEventOutbox, 1.0.2"
#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. 
// Install DotEventOutbox as a Cake Addin
#addin nuget:?package=DotEventOutbox&version=1.0.2

// Install DotEventOutbox as a Cake Tool
#tool nuget:?package=DotEventOutbox&version=1.0.2

DotEventOutbox Library

Overview

DotEventOutbox is a .NET library designed to facilitate robust and efficient handling of domain events using the Outbox Pattern. It provides a suite of tools and services to ensure reliable and scalable event processing, particularly in distributed systems or microservices architectures.

Features

  • Domain Event Handling: Define and handle domain events in your application.
  • Outbox Pattern Implementation: Reliably handle event dispatch to ensure consistency and fault tolerance.
  • Idempotent Processing: Ensure each event is processed only once.
  • Configurable and Extendable: Tailor the library to fit the specific needs of your application.

Getting Started

Installation

You can install the DotEventOutbox library via NuGet package manager. Run the following command:

dotnet add package DotEventOutbox

Basic Setup

  1. Configure Services: Add DotEventOutbox to your service collection in the Startup.cs or wherever you configure services.

    string schemaName = "Outbox";
     services.AddOutbox(configuration,
     options => options.UseNpgsql(configuration.GetConnectionString("AppDb"),
             o => o.MigrationsHistoryTable(HistoryRepository.DefaultTableName, schemaName)),
             schemaName);

  2. Applying Migrations: Apply migrations to set up the necessary database tables.

    • For development, you can apply migrations automatically during application startup.
    • For production, it's recommended to apply migrations manually or as part of your CI/CD pipeline.

Usage

  • Define domain events implementing IEvent.
  • Implement IDomainEventEmitter in your entities.
  • Use OutboxMessageProcessingJob for processing and dispatching events.

Advanced Configuration

  • Customize the OutboxMessage entity configurations as needed.
  • Configure Quartz jobs for event processing schedules.

Contributing

Contributions are welcome! If you have a feature request, bug report, or pull request, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.

Acknowledgements

Special thanks to the contributors and users of DotEventOutbox. Your feedback and support are greatly appreciated!

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. 
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
1.1.1 76 5/20/2024
1.1.0 210 12/26/2023
1.0.5 116 12/26/2023
1.0.4 128 12/25/2023
1.0.3 108 12/24/2023
1.0.2 112 12/22/2023
1.0.1 115 12/22/2023
1.0.0 110 12/21/2023