Conversation
…e README for dependency installation
| 2. **Install dependencies:** | ||
| ``` | ||
| npx mintlify install | ||
| pnpm install |
There was a problem hiding this comment.
I would love not having to install mintlify as a global tool 👍 To ensure this works, maybe we should also update the workflow in .github/workflows/check.yaml (we can even cache pnpm dependencies automatically after upgrading actions/setup-node).
| }, | ||
| "devDependencies": { | ||
| "mintlify": "^4.2.520" | ||
| } |
There was a problem hiding this comment.
We should probably enable corepack as well, to ensure pnpm is used consistently.
| } | ||
| ``` | ||
|
|
||
| Depending on your target platform, pass an `AndroidEncryptedDatabaseFactory`, `JavaEncryptedDatabaseFactory`, or `NativeEncryptedDatabaseFactory` to the wrapper. The factory automatically installs the SQLite3MultipleCiphers extension — no manual setup required. |
There was a problem hiding this comment.
sqlite3mc is a fork, not an extension. But we should mention that the PowerSync extension gets loaded automatically, since it's a manual step with the default Room setup.
| Depending on your target platform, pass an `AndroidEncryptedDatabaseFactory`, `JavaEncryptedDatabaseFactory`, or `NativeEncryptedDatabaseFactory` to the wrapper. The factory automatically installs the SQLite3MultipleCiphers extension — no manual setup required. | |
| Depending on your target platform, pass an `AndroidEncryptedDatabaseFactory`, `JavaEncryptedDatabaseFactory`, or `NativeEncryptedDatabaseFactory` to the wrapper. The factory automatically installs the PowerSync SQLite extension, so you can skip the `loadPowerSyncExtension()` step. |
|
|
||
| For more details, see the [`sqlite3multipleciphers` README](https://github.com/powersync-ja/powersync-kotlin/tree/main/sqlite3multipleciphers) in the PowerSync Kotlin SDK repository. | ||
|
|
||
| **Using encryption with Room:** |
There was a problem hiding this comment.
This looks good to me. But I wonder if we should put this as a section in the guide on using Room, since:
- this takes up way more space here in a collapsible with large paddings.
- it's not relevant for everyone using encryption.
So I think it might be better to move this to the page on Room, and add a link from here to that section perhaps.
There was a problem hiding this comment.
That makes sense. Will do that
@khawarizmus could you please move this to a separate PR? |
Changes
data-encryption.mdx: Added instructions for using encryption with Room in the Kotlin section. UsesPowerSyncConnectionFactoryAsSqliteDriverto wrap an encryptedPersistentConnectionFactoryand pass it toRoomDatabase.Builder.setDriver.The last two points are just for easier use. We can now simply do
pnpm devto spin the docs