feat: add postgres replication plugin for external data sync#133
Open
Lumantis wants to merge 1 commit intoouterbase:mainfrom
Open
feat: add postgres replication plugin for external data sync#133Lumantis wants to merge 1 commit intoouterbase:mainfrom
Lumantis wants to merge 1 commit intoouterbase:mainfrom
Conversation
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.
Add PostgreSQL Replication Plugin for External Data Sync
Summary
Adds a new
postgres-replicationplugin that enables one-way data synchronization from an external PostgreSQL database into StarbaseDB's local SQLite storage. This is useful for read-heavy workloads where data originates in PostgreSQL but needs to be served from the edge with low latency.What it does
/replicationto add, list, pause, resume, and delete replication configs.onEvent(), following the same pattern as the CDC plugin.API Endpoints
GET/replicationPOST/replicationPOST/replication/:id/syncPATCH/replication/:idDELETE/replication/:idGET/replication/logsFiles changed
plugins/postgres-replication/index.ts-- Main plugin implementationplugins/postgres-replication/index.test.ts-- Unit tests (vitest)plugins/postgres-replication/meta.json-- Plugin metadatadist/plugins.ts-- Added export for the new pluginUsage example
Design decisions
StarbasePlugin, usesregister()for routes,onEvent()for callbacks).INSERT OR REPLACEfor upserts to handle both new and updated rows.role: 'admin'for all endpoints, consistent with the CDC plugin.tmp_prefixed tables following the project convention (see cron plugin).Testing
All tests use vitest with mocked
dataSource.rpc.executeQuery. Coverage includes config CRUD, full sync, incremental sync, error handling, event callbacks, and edge cases (empty tables, missing configs, wrong dialect).