adding-persistent-event

Create persistent event classes and integrate with EventLogPayloadTransformer.

13|1|Updated Dec 22, 2020

Search Tags:#software development #database migration #system integration #event logging #persistent events

Ready to run

npx skills add https://github.com/terraware/terraware-server --skill adding-persistent-event

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: adding-persistent-event
Source: https://github.com/terraware/terraware-server/tree/main/.claude/skills/adding-persistent-event
Command: npx skills add https://github.com/terraware/terraware-server --skill adding-persistent-event

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of adding new types of events that need to be permanently recorded in the system's event log, ensuring all significant write operations and event occurrences are tracked.

Core Features & Use Cases

Event Definition: Guides the creation of new event classes and associated type aliases.
System Integration: Ensures new events are correctly handled by the EventLogPayloadTransformer and can be backfilled in the database if necessary.
Use Case: When introducing a new feature that modifies user data, use this Skill to define the corresponding persistent event, ensuring the change is logged for auditing and debugging.

Quick Start

Follow the checklist in the SKILL.md file to add a new persistent event.

Frequently Asked Questions about adding-persistent-event

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I add a new persistent event to an event logging system?▼

To add a new persistent event, you create the event class, define type aliases, and integrate it with EventLogPayloadTransformer for payload transformation. This ensures the new write operation is properly logged and available for database backfilling if necessary.

Why do I need to persist events in a database event log?▼

Persisting events in a database event log ensures all significant write operations and system changes are permanently tracked. You need persistent events for reliable auditing, debugging, and maintaining an accurate historical record of user data modifications.

What's the best way to integrate a new event class with EventLogPayloadTransformer?▼

The best way to integrate a new event class with EventLogPayloadTransformer is to follow a structured checklist that guides payload transformation setup and database backfilling. This ensures proper event publishing and consistent logging for new write operations.

Can I backfill existing database records when introducing a new event type?▼

Yes, you can backfill existing database records when adding a new persistent event. The process involves integrating the new event class with EventLogPayloadTransformer, which supports potential database backfilling to update historical logs with the new event type.

How do I test new event logging logic for write operations?▼

To test new event logging logic, you verify the event class definition, type aliases, and EventLogPayloadTransformer integration. The process includes ensuring proper event publishing and validating that the new persistent event logic accurately records write operations.