Skills
.Work. You
Rest

malky-outbox-pattern

Community

Implement transactional outbox pattern for APIs.

Software Engineering#idempotent#kafka#outbox#cdc#schema-registry#debezium#avro
Authormmacphail
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Ensures reliable, end-to-end event publication by implementing the Transactional Outbox Pattern across API projects. Generates the outbox migration, Debezium connector configuration with field-by-field annotations, Avro schemas for the Schema Registry, and comprehensive Kafka topic naming guidance to ensure correct routing and ordering.

Core Features & Use Cases

  • Outbox table migration for each aggregate to guarantee atomic emission of events within a database transaction.
  • Debezium connector configuration with explicit field-level annotations, topic routing, and error handling to publish events to Kafka.
  • Avro schemas for event envelopes and aggregate state stored in a schema registry with forward-transitive compatibility.
  • Kafka topic naming documentation that clearly separates event history topic from compacted current-state topic and ensures per-aggregate ordering.

Quick Start

Generate the outbox artifacts for an aggregate by creating the migration, Debezium config, Avro schemas, and Kafka topic naming documentation.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: malky-outbox-pattern
Download link: https://github.com/mmacphail/my-claude-rules/archive/main.zip#malky-outbox-pattern

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.