ElectricSQL Real-Time Postgres Sync Engine

ElectricSQL Real-Time Postgres Sync Engine

ElectricSQL is a read-path sync engine for PostgreSQL that handles partial replication, data delivery, and fan-out. It syncs data out of Postgres in real time using an HTTP API that integrates with CDNs, with Shapes for managing partial replication and client libraries for React and TypeScript.

Installation

Use the upstream install or setup path that matches your environment:

• docker compose -f .support/docker-compose.yml up
• brew install asdf
• pnpm install
• pnpm test

Requirements and caveats from upstream:

• For example, using Docker Compose from the root of this repo:
• We use asdf to install Elixir, Erlang, and Node.js. Versions are defined in .tool-versions.
• This starts a Docker Compose setup with Postgres configured for logical replication on port 54321.

Basic usage or getting-started notes:

• Getting Started

• See the Quickstart guide to get up and running. In short, you need to:

• have a Postgres database with logical replication enabled; and then to

• Source: https://github.com/electric-sql/electric

• Extracted from upstream docs: https://raw.githubusercontent.com/electric-sql/electric/HEAD/README.md

Source

• Agent Skill Exchange