fix(android): migrate from `android-database-sqlcipher` to `sqlcipher-android` by dragermrb · Pull Request #607 · capacitor-community/sqlite

dragermrb · 2024-12-11T18:27:39Z

Pull request to migrate from net.zetetic:android-database-sqlcipher to net.zetetic:sqlcipher-android
to allow using an Android 15 (API Level 35) with 16 KB page size supports.

Related issue: #594

DGeoWils · 2025-03-19T15:00:57Z

@robingenz Can we get this merged?

robingenz · 2025-03-19T17:29:14Z

Unfortunately, I don't have the capacity to test it at the moment. So this PR will have to wait or someone else from the Capacitor community takes over.

DGeoWils · 2025-03-19T17:32:45Z

Thank you!

shiv19 · 2025-05-17T11:31:01Z

I tried these change on this version of the plugin
"@capacitor-community/sqlite": "6.0.1",

And the changes seem to be working fine when deployed on a 16kb page size device.
However, I did not perform extensive testing.
I'll report back if it passes QA and we end up shipping this to prod.

Without the changes in this PR, the app does crash on launch on a 16kb page size device.
cc @robingenz

If merged, we also need to patch this on the 6.x version of the plugin for capacitor 6 users.

Copilot

Pull Request Overview

Migrate from net.zetetic:android-database-sqlcipher to net.zetetic:sqlcipher-android to support Android 15's 16 KB page size.

Swapped imports, casts, and method calls to use net.zetetic.database.sqlcipher types and overloads.
Replaced SQLiteDatabase.loadLibs(context) with System.loadLibrary("sqlcipher") and updated openDatabase and openOrCreateDatabase signatures.
Changed conversion of passwords to bytes and updated exception handling in changePassword.

Reviewed Changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.

File	Description
UtilsSQLite.java	Replaced `net.sqlcipher.Cursor` with `SQLiteCursor` and adjusted casts.
UtilsSQLCipher.java	Swapped native library loading, updated database open calls with new overloads, and tweaked exception.
UtilsDrop.java	Updated imports and casts to use `SQLiteCursor` for table/view/index/trigger queries.
Database.java	Swapped library init, adjusted password byte conversion, open/creation calls, and cursor usage.

Files not reviewed (1)

android/build.gradle: Language not supported

Comments suppressed due to low confidence (3)

android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/UtilsSQLCipher.java:207

[nitpick] The parameter name nwpassword is unclear; rename it to newPassword for readability and consistency.

public void changePassword(Context ctxt, File file, String password, String nwpassword) throws Exception {

android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/UtilsSQLCipher.java:214

Throwing a generic Exception loses error specificity; consider using SQLiteException or a custom exception type to preserve context.

throw new Exception("database " + file.getAbsolutePath() + " open failed");

android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/Database.java:117

Calling System.loadLibrary directly may miss other native dependencies; verify that all required native libraries are loaded or use the library’s recommended initialization method.

System.loadLibrary("sqlcipher");

shiv19 · 2025-05-20T11:27:59Z

                    try {
                        if (globVar.secret.length() > 0) {
-                            db = SQLiteDatabase.openDatabase(dbPath.getAbsolutePath(), globVar.secret, null, SQLiteDatabase.OPEN_READONLY);
+                            db =


The linting error might be coming from this section of UtilsSQLCipher.java
Once the linting error is fixed, I can approve and merge this.

Hi!

This PR is for @capacitor-community/sqlite@6.0.2 and linter works.

npm run prettier -- --check > @capacitor-community/sqlite@6.0.2 prettier > prettier "**/*.{css,html,ts,js,java}" --check Checking formatting... [warn] jsxBracketSameLine is deprecated. All matched files use Prettier code style!

Error on CI tries to use version 7.x (I don't know why)

Run npm run lint > @capacitor-community/sqlite@[7](https://github.com/capacitor-community/sqlite/actions/runs/15118907452/job/42548687676?pr=607#step:5:8).0.0 lint > npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint > @capacitor-community/sqlite@7.0.0 eslint > eslint . --ext ts > @capacitor-community/sqlite@7.0.0 prettier > prettier "**/*.{css,html,ts,js,java}" --plugin=prettier-plugin-java --check Checking formatting... [warn] android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/UtilsSQLCipher.java [warn] Code style issues found in the above file. Run Prettier with --write to fix. Error: Process completed with exit code 1.

There must be a 6.x branch in the repo, you'll need to make the 6.x PR to that branch.

robingenz · 2025-05-21T05:38:57Z

@shiv19 Thank you for helping out!

However, I did not perform extensive testing.

Please do that and let me know how it goes. Then we can merge it. This change is pretty central. So I want to be sure.

If merged, we also need to patch this on the 6.x version of the plugin for capacitor 6 users.

I always publish updates only for the latest Capacitor version supported to keep the maintenance effort as low as possible. Otherwise we would also have to test both versions intensively.

dragermrb · 2025-05-21T06:54:37Z

@robingenz

I always publish updates only for the latest Capacitor version supported to keep the maintenance effort as low as possible. Otherwise we would also have to test both versions intensively.

Should I update the PR to version 7 of the plugin?

robingenz · 2025-05-21T06:58:34Z

@dragermrb Isn't it already Capacitor 7? Your PR goes against the master branch. What do you need to change?

dragermrb · 2025-05-21T07:02:08Z

I created the PR for version 6.0.2 (master branch at the time). Therefore, the fork used to develop the PR is based on version 6.0.2 and does not include the changes introduced in version 7.x.

Linter, for example, differs between versions 6 and 7.

robingenz · 2025-05-21T07:31:47Z

@dragermrb So yes, please update to Capacitor 7.

dragermrb · 2025-05-21T14:50:49Z

@dragermrb So yes, please update to Capacitor 7.

Fixed

robingenz · 2025-05-21T17:06:23Z

Here is a dev release for testing:

npm i @capacitor-community/sqlite@7.0.0-dev.bf54d28.1747847115

If no bugs are reported in the next few days, I'll merge it.

shiv19 · 2025-05-21T21:17:11Z

@robingenz, we've shipped this fix to prod (minus the last commit with the UTF-8 encoding param). Our QA didn't find any issues, and it also passed the google app review. We're monitoring crash analytics closely. If you don't hear back from me here, it means it's all good ✅️.

davinderclerisy · 2025-07-01T06:20:20Z

@robingenz Just checking in - any updates on when this fix will be released?

MonicaExplan · 2025-07-09T11:07:21Z

I tried these change on this version of the plugin "@capacitor-community/sqlite": "6.0.1",

And the changes seem to be working fine when deployed on a 16kb page size device. However, I did not perform extensive testing. I'll report back if it passes QA and we end up shipping this to prod.

Without the changes in this PR, the app does crash on launch on a 16kb page size device. cc @robingenz

If merged, we also need to patch this on the 6.x version of the plugin for capacitor 6 users.

Hello

I need to install this patch on my "@capacitor-community/sqlite": "6.0.1",

I try npm i @capacitor-community/sqlite@6.0.1#pull/607 but fails.
How can I install?

Thanks

robingenz · 2025-08-08T06:14:03Z

@dragermrb Multiple users reported this issue that occurred as a result of this change. Can you take a look at it?

(android) Migrate from android-database-sqlcipher to sqlcipher-android

c769b3f

dragermrb mentioned this pull request Dec 11, 2024

feat: Add support for Android devices with 16 KB page size #594

Closed

code style

3a1cdc4

shiv19 requested a review from Copilot May 18, 2025 22:07

Copilot AI reviewed May 18, 2025

View reviewed changes

Comment thread android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/Database.java Outdated

Comment thread android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/Database.java

Explicitly specify password charset

d33cd23

shiv19 reviewed May 20, 2025

View reviewed changes

dragermrb added 2 commits May 21, 2025 16:40

Merge remote-tracking branch 'upstream/master' into fix-16kb-pagesize

6cd52fc

style: format

bf54d28

robingenz changed the title ~~(android) Migrate from android-database-sqlcipher to sqlcipher-android~~ fix(android): migrate from android-database-sqlcipher to sqlcipher-android May 21, 2025

robingenz merged commit 43c689b into capacitor-community:master Jul 2, 2025

MonicaExplan mentioned this pull request Jul 9, 2025

feat: Android 16KB for ver "6.0.1" #650

Closed

github-actions Bot locked as resolved and limited conversation to collaborators Aug 8, 2026

Uh oh!

Conversation

dragermrb commented Dec 11, 2024

Uh oh!

DGeoWils commented Mar 19, 2025

Uh oh!

robingenz commented Mar 19, 2025

Uh oh!

DGeoWils commented Mar 19, 2025

Uh oh!

shiv19 commented May 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

shiv19 May 20, 2025

Choose a reason for hiding this comment

Uh oh!

dragermrb May 20, 2025

Choose a reason for hiding this comment

Uh oh!

shiv19 May 21, 2025

Choose a reason for hiding this comment

Uh oh!

robingenz commented May 21, 2025

Uh oh!

dragermrb commented May 21, 2025

Uh oh!

robingenz commented May 21, 2025

Uh oh!

dragermrb commented May 21, 2025

Uh oh!

robingenz commented May 21, 2025

Uh oh!

dragermrb commented May 21, 2025

Uh oh!

robingenz commented May 21, 2025

Uh oh!

shiv19 commented May 21, 2025

Uh oh!

davinderclerisy commented Jul 1, 2025

Uh oh!

MonicaExplan commented Jul 9, 2025

Uh oh!

robingenz commented Aug 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

shiv19 commented May 17, 2025 •

edited

Loading