Documentation

Welcome to the ElectricSQL developer documentation!

ElectricSQL is a Postgres sync engine. Use it to sync little subsets of your Postgres data into local apps, services and environments.

You don't need to be an expert in database replication or distributed systems to use Electric. You do need to be familiar with basic web development.

New to ElectricSQL?

Start with the Quickstart to get up-and-running. The guides on Shapes and Auth are also good entrypoints and helpful to understand how Electric works.

The HTTP API and TypeScript Client docs show how to sync data. The React page illustrates how to bind these into a reactivity framework.

The easiest way to use Electric in production is the Electric Cloud. Alternatively, the Deployment guide covers how to self host.

Looking for PGlite docs?

If you're interested in using PGlite, it has it's own docs site at pglite.dev/docs

Examples

There are lots of examples in the main repo on GitHub.

The integration docs also illustrate common patterns, e.g. using Electric with frameworks like TanStack and Phoenix and platforms like Supabase and Cloudflare.

Source code

ElectricSQL is an open source project developed at github.com/electric-sql. Check out the source code, issues and development in progress there.

Support

See the Community page for information on support and events, including our community Discord where you can ask questions and get support.