https://github.com/powersync-ja/react-native-database-benchmarks
https://github.com/powersync-ja/react-native-database-benchmarks
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/powersync-ja/react-native-database-benchmarks
- Owner: powersync-ja
- Created: 2024-03-06T15:47:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T12:27:32.000Z (almost 2 years ago)
- Last Synced: 2025-12-19T13:46:37.888Z (6 months ago)
- Language: TypeScript
- Size: 1.54 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React Native Database Benchmarks
A project to compare performance between various databases on React Native.
## Install dependencies
You can install dependencies using yarn
- `yarn install`
## Generate Android and iOS native bindings
- npx expo run:android
- npx expo run:ios
## Running the project
Please ensure you have generated the native bindings before running the app.
## Android
1. Open the `android` directory in Android Studio.
2. It will take some time to sync and build gradle dependencies.
3. Select `Build` in the top menu > Select `Build Variant`.
4. Change the `:app` active build variant to `release`.
5. Run the app using the default configuration.
6. Click on the `Logcat` option in the bottom tool window (under the Run button).
7. You can use the `package:mine` filter in the filter bar to filter the results.
8. Once all the benchmarks are done running, it will print out the results in the log for all the tests in a CSV format.
## iOS
1. Open the `ios/reactnativedatabasebenchmarks.xcworkspace` in xcode.
2. Edit the scheme and choose the `Release` build configuration for the run.
3. Click the play button to run the app.
## Benchmark limitations
1. Does not measure UI performance during database operations yet.
2. Only a single run of each test is recorded.
3. No UI yet - all results are logged to the console.
4. Does not test concurrent operations.
### OP SQLite
OP SQLite can be run using a performance mode fla set in the `package.json` file. Using the following commands to set this up for the project. This must be done before the project is built.
`1` is thread unsafe, you should only use transactions but will be the fastest option for single operations. `2` is thread-safe and marginally slower.
```
"op-sqlite": {
"performanceMode": "2"
}
```
### Expo-sqlite
Expo sqlite does not support batching of queries out the box. Prepared statements are used to achieve functionality simillar to batching.
## Running the original react-native-quick-sqlite tests
#### Steps to setup the library:
- `yarn remove @powersync/react-native-quick-sqlite`
- `yarn add react-native-quick-sqlite`
- From Expo 51 onwards a patch is required to compile RNQS `yarn patch-package`
- Comment out the code in the file referencing PowersyncSqliteAdapter which includes `adapters/powersync-sqlite-adapter.ts`. Also comment out lines 6, 23 and 27 in `App.tsx`.
- Uncomment out the code referencing react-native-quick-sqlite (line 6 onwards) in `adapters/rn-quick-sqlite-adapter.ts` and lines 13, 24 and 29 in `App.tsx`.
- You can follow the inverse of the above steps to test the powersync fork of react-native-quick-sqlite