@powersync/op-sqlite

OP-SQLite Factory for the PowerSync React Native SDK

Overview

This package (packages/powersync-op-sqlite) enables using OP-SQLite with PowerSync alongside the React Native SDK.

If you are not yet familiar with PowerSync, please see the PowerSync React Native SDK README for more information.

Installation

Follow the installation instructions for the React Native SDK if you haven't yet set up PowerSync in your project. However, note that this package cannot be installed alongside @journeyapps/react-native-quick-sqlite. Skip the step about installing it as a peer dependency, or uninstall it if it is already installed.

Install Package

npx expo install @powersync/op-sqlite

When using this package without a frameowrk like Expo, we recommend adding this metro config to avoid issues related to bundling PowerSync. Without it, you may be getting TypeError: Cannot read property 'PowerSyncDatabase' of undefined or similar errors.

Install Peer Dependency:

This SDK currently requires @op-engineering/op-sqlite as a peer dependency.

Install it in your app with:

npx expo install @op-engineering/op-sqlite

Usage

import { OPSqliteOpenFactory } from '@powersync/op-sqlite';
import { PowerSyncDatabase } from '@powersync/react-native';

const factory = new OPSqliteOpenFactory({
  dbFilename: 'sqlite.db'
});

this.powersync = new PowerSyncDatabase({ database: factory, schema: AppSchema });

Encryption with SQLCipher

To enable SQLCipher you need to add the following configuration option to your application's package.json. Note that for monorepos you may have to add this configuration to the monorepo root package.json instead, this depends on where your package manager tool hoists modules.

{
  // your normal package.json
  // ...
  "op-sqlite": {
    "sqlcipher": true
  }
}

Additionally you will need to add an encryption key to the OPSQLite factory constructor

const factory = new OPSqliteOpenFactory({
  dbFilename: 'sqlite.db',
  sqliteOptions: {
    encryptionKey: 'your-encryption-key'
  }
});

Loading SQLite extensions

To load additional SQLite extensions include the extensions option in sqliteOptions which expects an array of objects with a path and an entryPoint:

sqliteOptions: {
  extensions: [{ path: libPath, entryPoint: 'sqlite3_powersync_init' }];
}

More info can be found in the OP-SQLite docs.

Example usage:

import { getDylibPath } from '@op-engineering/op-sqlite';

let libPath: string;
if (Platform.OS === 'ios') {
  libPath = getDylibPath('co.powersync.sqlitecore', 'powersync-sqlite-core');
} else {
  libPath = 'libpowersync';
}

const factory = new OPSqliteOpenFactory({
  dbFilename: 'sqlite.db',
  sqliteOptions: {
    extensions: [{ path: libPath, entryPoint: 'sqlite3_powersync_init' }]
  }
});

Native Projects

This package uses native libraries. Create native Android and iOS projects (if not created already) by running:

npx expo run:android
# OR
npx expo run:ios