PowerSync SDK on NPM
This SDK is distributed via NPM
Source Code
Refer to packages/react-native in the powersync-js repo on GitHub
API Reference
Full API reference for the PowerSync SDK
Example Projects
Gallery of example projects/demo apps built with React Native and PowerSync.
Changelog
Changelog for the SDK
SDK Features
- Real-time streaming of database changes: Changes made by one user are instantly streamed to all other users with access to that data. This keeps clients automatically in sync without manual polling or refresh logic.
- Direct access to a local SQLite database: Data is stored locally, so apps can read and write instantly without network calls. This enables offline support and faster user interactions.
- Asynchronous background execution: The SDK performs database operations in the background to avoid blocking the application’s main thread. This means that apps stay responsive, even during heavy data activity.
- Query subscriptions for live updates: The SDK supports query subscriptions that automatically push real-time updates to client applications as data changes, keeping your UI reactive and up to date.
- Automatic schema management: PowerSync syncs schemaless data and applies a client-defined schema using SQLite views. This architecture means that PowerSync SDKs can handle schema changes gracefully without requiring explicit migrations on the client-side.
Using Hooks
A separatepowersync-react package is available containing React hooks for PowerSync. See its README for example code.
npm: @powersync/react
Installation
Add the PowerSync React Native NPM package to your project:- npm
- yarn
- pnpm
- OP-SQLite (Recommended)
- React Native Quick SQLite
PowerSync OP-SQLite offers:
- Built-in encryption support via SQLCipher
- Smoother transition to React Native’s New Architecture
- npm
- yarn
- pnpm
Polyfills and additional notes:
- For async iterator support with watched queries, additional polyfills are required. See the Babel plugins section in the README.
- When using the OP-SQLite package, we recommend adding this metro config to avoid build issues.
Getting Started
Prerequisites: To sync data between your client-side app and your backend source database, you must have completed the necessary setup for PowerSync, which includes connecting your source database to the PowerSync Service and deploying Sync Streams (or legacy Sync Rules) (steps 1-4 in the Setup Guide).1. Define the Client-Side Schema
The first step is to define the client-side schema, which refers to the schema for the managed SQLite database exposed by the PowerSync Client SDKs, that your app can read from and write to. The client-side schema is typically mainly derived from your backend source database schema and your Sync Streams (or legacy Sync Rules), but can also include other tables such as local-only tables. Note that schema migrations are not required on the SQLite database due to the schemaless nature of the PowerSync protocol: schemaless data is synced to the client-side SQLite database, and the client-side schema is then applied to that data using SQLite views to allow for structured querying of the data. The schema is applied when the local PowerSync database is constructed (as we’ll show in the next step). The types available aretext, integer and real. These should map directly to the values produced by your Sync Streams (or legacy Sync Rules). If a value doesn’t match, it is cast automatically. For details on how backend source database types are mapped to the SQLite types, see Types.
Example:
Note: No need to declare a primary key
id column - as PowerSync will automatically create this.powersync/AppSchema.ts
2. Instantiate the PowerSync Database
Next, you need to instantiate the PowerSync database. PowerSync streams changes from your backend source database into the client-side SQLite database, based on your Sync Streams (or legacy Sync Rules). In your client-side app, you can read from and write to the local SQLite database, whether the user is online or offline. Example:- React Native Quick SQLite
- OP-SQLite
For getting started and testing PowerSync use the @journeyapps/react-native-quick-sqlite package.
By default, this SDK requires @journeyapps/react-native-quick-sqlite as a peer dependency.
powersync/system.ts
SDK versions lower than 1.8.0In SDK versions lower than 1.8.0, you will need to use the deprecated RNQSPowerSyncDatabaseOpenFactory syntax to instantiate the database.
powersync/system.ts
3. Integrate with your Backend
The PowerSync backend connector provides the connection between your application backend and the PowerSync client-slide managed SQLite database. It is used to:- Retrieve an auth token to connect to the PowerSync instance.
- Upload client-side writes to your backend API. Any writes that are made to the SQLite database are placed into an upload queue by the PowerSync Client SDK and automatically uploaded to your app backend (where you apply those changes to the backend source database) when the user is connected.
- PowerSyncBackendConnector.fetchCredentials - This is called every couple of minutes and is used to obtain credentials for your app backend API. -> See Authentication Setup for instructions on how the credentials should be generated.
- PowerSyncBackendConnector.uploadData - Use this to upload client-side changes to your app backend. -> See Writing Client Changes for considerations on the app backend implementation.
powersync/Connector.ts
Using PowerSync: CRUD functions
Once the PowerSync instance is configured you can start using the SQLite DB functions. The most commonly used CRUD functions to interact with your SQLite data are:- PowerSyncDatabase.get - get (
SELECT) a single row from a table. - PowerSyncDatabase.getAll - get (
SELECT) a set of rows from a table. - PowerSyncDatabase.watch - execute a read query every time source tables are modified.
- PowerSyncDatabase.execute - execute a write (
INSERT/UPDATE/DELETE) query.
Fetching a Single Item
The get method executes a read-only (SELECT) query and returns a single result. It throws an exception if no result is found. Use getOptional to return a single optional result (returns null if no result is found).
TodoItemWidget.jsx
Querying Items (PowerSync.getAll)
The getAll method returns a set of rows from a table.
ListsWidget.jsx
Watching Queries (PowerSync.watch)
The watch method executes a read query whenever a change to a dependent table is made. It can be used with an AsyncGenerator, or with a callback.
- AsyncIterator approach
- Callback approach
Mutations (PowerSync.execute)
The execute method can be used for executing single SQLite write statements.
ListsWidget.jsx
When using the default client-side JSON-based view system, writes are applied to a view, with triggers writing to the underlying table. Because of this, If you need direct table writes, use raw tables.
result.rowsAffected from db.execute() can be 0 even when an UPDATE or DELETE succeeds.When you need to confirm whether a mutation changed any rows, add a RETURNING clause and check the returned rows:Configure Logging
Additional Usage Examples
For more usage examples including accessing connection status, monitoring sync progress, and waiting for initial sync, see the Usage Examples page.ORM Support
See JavaScript ORM Support for details.Troubleshooting
See Troubleshooting for pointers to debug common issues.Supported Platforms
See Supported Platforms -> React Native SDK.Upgrading the SDK
Run the below command in your project folder:- npm
- yarn
- pnpm
Developer Notes
Connection Methods
This SDK supports two methods for streaming sync commands:-
WebSocket (Default)
- The implementation leverages RSocket for handling reactive socket streams.
- Back-pressure is effectively managed through client-controlled command requests.
- Sync commands are transmitted efficiently as BSON (binary) documents.
- This method is recommended since it will support the future BLOB column support feature.
-
HTTP Streaming (Legacy)
- This is the original implementation method.
- This method will not support the future BLOB column feature.
PowerSyncDatabase.connect() method uses WebSocket. You can optionally specify the connectionMethod to override this:
Android: Flipper Network Plugin for HTTP Streams
Not needed when using websockets, which is the default since@powersync/react-native@1.11.0.
If you are connecting to PowerSync using HTTP streams, you require additional configuration on Android. React Native does not support streams out of the box, so we use the polyfills mentioned. There is currently an open issue where the Flipper network plugin does not allow Stream events to fire. This plugin needs to be disabled in order for HTTP streams to work.
If you are using Java (Expo < 50):
Uncomment the following from android/app/src/debug/java/com/<ProjectName>/ReactNativeFlipper.java
android/gradle.properties
onCreate in android/app/src/main/java/com/<ProjectName>/example/MainApplication.kt