Feat/421 wipe events table script#450
Open
Priyanshubhartistm wants to merge 5 commits intocameri:mainfrom
Open
Feat/421 wipe events table script#450Priyanshubhartistm wants to merge 5 commits intocameri:mainfrom
Priyanshubhartistm wants to merge 5 commits intocameri:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new administrative CLI (npm run clean-db) to safely wipe or selectively prune relay event data, aimed at helping operators maintain/test relays without manual SQL.
Changes:
- Introduces
src/clean-db.tsCLI with confirmation/--force,--dry-run, and filter options (--all,--older-than,--kinds), plus Postgres optimizations (TRUNCATE / VACUUM ANALYZE). - Adds unit tests for option parsing/validation.
- Documents relay maintenance usage in README and exposes the CLI via a new npm script.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/clean-db.ts | Implements the clean-db CLI, option parsing, confirmation flow, and DB operations (TRUNCATE / DELETE + VACUUM). |
| test/unit/clean-db.spec.ts | Adds unit tests for option parsing/validation behavior and error messaging. |
| README.md | Adds “Relay Maintenance” section with clean-db usage examples. |
| package.json | Adds clean-db npm script entry point. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Author
|
@cameri |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
npm run clean-db.Type DELETEto confirm.--forceoption to skip prompt.NODE_ENVis production.--allfor full wipe.--older-than=daysfor timestamp-based cleanup.--kinds=1,7,4for kind-specific cleanup.--dry-runto show affected row count without deleting.TRUNCATE TABLE events, event_tags RESTART IDENTITY CASCADE.VACUUM ANALYZE eventsafterward.Related Issue
Closes #421
#421
Motivation and Context
Relay operators need a safe and repeatable way to reset or prune heavy event data during testing and maintenance without running manual SQL commands.
This change improves:
How Has This Been Tested?
npm run lintnpm run buildnpm run test:unitevents=0andevent_tags=0.Screenshots (if appropriate):
N/A (CLI and database maintenance change)
Types of changes
Checklist: