Overview
Couchbase Lite for React Native enables developers to build fast, responsive mobile apps with local data storage, powerful querying, and secure data sync with Capella App Services or Sync Gateway, all with a modern TypeScript/JavaScript developer experience. It provides local data storage, SQL++ querying, and bi-directional data sync with Capella App Services or Sync Gateway.
| Couchbase Lite for React Native has graduated from a community project to a fully enterprise-supported offering. You must have a Couchbase Lite Enterprise license to use this plugin. |
The plugin uses React Native’s Turbo Module architecture. Developers write in TypeScript/JavaScript while the plugin runs the underlying database operations natively on device.
Platform Support
| Environment | Support Status |
|---|---|
iOS |
Supported |
Android |
Supported |
Web |
Not supported |
Windows |
Not supported |
Capabilities
Couchbase Lite for React Native has near-complete feature parity with other Couchbase Lite platform implementations.
- SQL++ Query Language
-
Write expressive queries using SQL++, with support for indexes, built-in functions, and Full-Text Search (FTS).
- Data Sync
-
Sync data bi-directionally with Capella App Services or {sgw}.
- Blob Handling
-
Store and sync binary data, including images and PDFs.
- Real-time Change Notifications
-
Listen for changes to documents, collections, queries, and replication status.
- Database Encryption
-
Encrypt local databases at rest.
- Pre-built Databases
-
Bundle a pre-populated database with your app to reduce initial sync time and bandwidth on first launch.
Limitations
The following Couchbase Lite features are not currently supported in this plugin:
-
Vector Search — not yet available on this platform.
-
Peer-to-Peer Sync — the plugin does not include a platform-specific peer discovery mechanism.
Get Started
Use the following resources to get started with Couchbase Lite for React Native:
-
Prerequisites and Installation — environment requirements and initial setup.
-
Migration Guide — upgrade instructions for projects moving from version 1.0.x.
-
Full Plugin Documentation — API reference, guides, and examples.
-
Example App — a hands-on Expo demonstration project.
| Couchbase recommends Expo for React Native development. Expo reduces setup complexity and provides a managed workflow that’s compatible with this plugin. |