electric-sql/pglite
Pglite
Pglite is a client-side relational database engine that runs a full-featured PostgreSQL instance directly within browser and Node.js environments. By leveraging WebAssembly, it provides a persistent SQL storage solution that enables complex data management and querying without requiring an external database server.
The project distinguishes itself through a reactive SQL data layer that automatically synchronizes user interface components with live query results. It manages database operations using worker threads to prevent main-thread blocking and coordinates access across multiple browser tabs to ensure consistent data views. For performance, it supports binary-snapshot-based initialization, allowing applications to load pre-built database states instantly.
The platform includes a comprehensive suite of tools for local-first development, such as virtual file system persistence, transaction management, and support for custom engine extensions. It also provides developer-focused utilities including an interactive SQL terminal, schema inspection, and automated database lifecycle management for testing and development workflows.
The project integrates with modern build tools to resolve binary dependencies and provides type-safe query builders and ORM support to bridge application logic with the database.
Features
- Browser Databases - Runs a full-featured Postgres engine directly in the browser to enable local data persistence and complex querying.
- Client-Side Databases - Provides a persistent SQL storage solution that enables complex data management without an external database server.
- SQL Query Execution - Runs standard SQL commands and parameterized queries directly within browser or server environments.
- In-Browser Database Engines - Runs a full-featured relational database engine compiled to WebAssembly directly within browser and Node.js environments.
- WebAssembly Engines - Runs a full-featured relational database engine compiled to WebAssembly for client-side SQL execution.
- Database Execution Engines - Provides a full-featured relational database runtime environment for browser and Node.js applications.
- Reactive Data Queries - Triggers automatic interface updates whenever the underlying database state changes by subscribing to live query results.
- Reactive Data Bindings - Automatically updates user interface components in real time whenever underlying database query results change.
- Multi-Tab Database Coordinators - Manages leader election across multiple browser tabs to ensure consistent database access and state.
- Object-Relational Mapping - Provides ORM integration to map application objects to relational database records and manage complex data models.
- WebAssembly - Provides a high-performance execution environment for relational data using binary compilation for native-speed SQL operations.
- Databases and Data Tools - Embeddable Postgres with reactive bindings.
- Browser Storage Managers - Manages database persistence using browser storage and virtual file systems to ensure data availability.
- Atomic Transactions - Groups multiple operations into atomic units that commit upon success or automatically roll back on failure.
- Type-Safe Query Builders - Offers type-safe query builders that translate application logic into SQL, ensuring compile-time validation.
- Local-First Architectures - Enables building applications that store and process data locally while maintaining full relational database capabilities.
- Leader Election - Coordinates database access and leader election across multiple browser tabs using messaging protocols.
- Shared Worker Storage - Coordinates shared database access across multiple browser tabs using background workers.
- Database Change Subscriptions - Subscribes to asynchronous database events to trigger application updates when data changes occur.
- Virtualized Filesystem Layers - Interacts with internal storage layers to import or export data using standard file operations and streaming protocols.
- Virtual File Systems - Maps database storage to virtual file systems to ensure persistence across browser sessions.
- Database Initialization - Initializes persistent or in-memory database instances, supporting snapshot loading for faster startup.
- Cross-Thread Database Dispatchers - Offloads database operations to background worker threads to maintain main-thread responsiveness.
- Binary Snapshots - Loads pre-built database snapshots directly into memory to bypass standard initialization and reduce startup time.
- Incremental Syncing - Tracks changes to query results using keyed diff algorithms to efficiently update component state as data evolves.
- Database Export Utilities - Generates SQL scripts and compressed archives for database backups, restoration, and migration.
- Database Extensions - Supports custom engine extensions and plugins to add specialized features to the database system.
- Database Migrations - Facilitates database migrations by exporting and importing data between instances for version transitions.
- Database Context Providers - Injects database instances into the component tree for accessible data management across the application lifecycle.
