Various Pro Tips
Database viewer
Android - you can use the new App Inspector in modern versions of Android Studio.
Via Flipper You can also use Facebook Flipper with a plugin. See discussion.
iOS - check open database path in iOS System Log (via Console for plugged-in device, or Xcode logs, or by using find
), then open it via sqlite3
in the console, or an external tool like sqlitebrowser
Which SQLite version am I using?
This usually only matters if you use raw SQL to use new SQLite versions:
- On iOS, we use whatever SQLite version is bundled with the OS. Here's a table of iOS version - SQLite version matches
- On Android in JSI mode, we use SQLite bundled with WatermelonDB. See
@nozbe/sqlite
NPM dependency version to see which SQLite version is bundled. - On Android NOT in JSI mode, we use the SQLite bundled with the OS
BTW: We're happy to accept contributions so that you can choose custom version or build of SQLite in all modes and on all platforms, but it needs to be opt-in (this adds to build time and binary size and most people don't need this)
Prepopulating database on native
There's no built-in support for this. One way is to generate a SQLite DB (you can use the the Node SQLite support in 0.19.0-2 pre-release or extract it from an ios/android app), bundle it with the app, and then use a bit of code to check if the DB you're expecting it available, and if not, making a copy of the default DB — before you attempt loading DB from JS side. See discussion
Override entity ID generator
You can optionally overide WatermelonDB's id generator with your own custom id generator in order to create specific random id formats (e.g. if UUIDs are used in the backend). In your database index file, pass a function with your custom ID generator to setGenerator
:
// Define a custom ID generator.
function randomString(): string {
return 'RANDOM STRING';
}
setGenerator(randomString);
// or as anonymous function:
setGenerator(() => 'RANDOM STRING');
To get UUIDs specifically, install uuid and then pass their id generator to setGenerator
:
import { v4 as uuidv4 } from 'uuid';
setGenerator(() => uuidv4());