Usage

This guide explains how to use ElectricSQL. It's broken down into four main sections.

Installation

Instuctions on how to install and setup ElectricSQL.

• Overview
• Prerequisites
• Postgres
• Sync service
• TypeScript client

Data modelling

How to expose and manage your database schema.

• Overview
• Migrations
• Electrification
• Types
• Constraints
• Permissions
• Validation

Authentication

How to authenticate the client with the replication protocol.

• Overview
• Token format
• Secure mode
• Insecure mode

Data access

How to sync and work with local data in your client app.

• Overview
• Client
• Shapes
• Queries
• Writes

See also

See the Integrations guide and the API docs. You might also be interested in some of the Reference docs, such as the Architecture and Roadmap pages.

Integrations

Integrate ElectricSQL with your stack.

API docs

Normative API docs.

Reference

About the ElectricSQL system.