@capacitor-community/sqlite

SQLITE DATABASE

@capacitor-community/sqlite

CAPACITOR 4

Capacitor community plugin for Native and Electron SQLite Databases. In Native databases could be encrypted with SQLCipher

Maintainers

Maintainer	GitHub	Social
Quéau Jean Pierre	jepiqueau

To install:

npm install --save @capacitor-community/sqlite
npx cap sync

yarn add @capacitor-community/sqlite
npx cap sync

pnpm install --save @capacitor-community/sqlite
pnpm install --save @jeep-sqlite
pnpm install --save sql.js
npx cap sync

More Reading:

• Releases
• Changelog
• Issues
• Capacitor documentation
• Datatypes In SQLite Version 3
• IncrementalUpgradeDatabaseVersion

Web Quirks

The plugin follows the guidelines from the Capacitor Team,

• Capacitor Browser Support

Meaning that it will not work in IE11 without additional JavaScript transformations, e.g. with Babel. You'll need the usual capacitor/android/react npm script to build and copy the assets folder.

For Angular framework

• Copy manually the file sql-wasm.wasm from node_modules/sql.js/dist/sql-wasm.wasm to the src/assets folder of YOUR_APP

For Vue & React frameworks

• Copy manually the file sql-wasm.wasm from node_modules/sql.js/dist/sql-wasm.wasm to the public/assets folder of YOUR_APP

Android Quirks

In case you get the following error when building your app in Android Studio: x files found with path 'build-data.properties'. You can you add the following code to app/build.gradle:

    packagingOptions {
        exclude 'build-data.properties'
    }

See #301 and SO question for more information.

Electron Quirks

• On Electron, go to the Electron folder of YOUR_APPLICATION

cd electron
npm install --save sqlite3
npm install --save jszip
npm install --save node-fetch@2.6.7
npm install --save-dev @types/sqlite3

• Important: node-fetch version must be <=2.6.7; otherwise you'll get an error running the app.

IOS Quirks

• on iOS, no further steps needed.

Supported Methods by Platform

Name	Android	iOS	Electron	Web
createConnection (ReadWrite)	✅	✅	✅	✅
createConnection (ReadOnly)	✅	✅	✅	❌
closeConnection (ReadWrite)	✅	✅	✅	✅
closeConnection (ReadOnly)	✅	✅	✅	❌
isConnection (ReadWrite)	✅	✅	✅	✅
isConnection (ReadOnly)	✅	✅	✅	❌
open (non-encrypted DB)	✅	✅	✅	✅
open (encrypted DB)	✅	✅	❌	❌
close	✅	✅	✅	✅
getUrl	✅	✅	❌	❌
getVersion	✅	✅	✅	✅
execute	✅	✅	✅	✅
executeSet	✅	✅	✅	✅
run	✅	✅	✅	✅
query	✅	✅	✅	✅
deleteDatabase	✅	✅	✅	✅
importFromJson	✅	✅	✅	✅
exportToJson	✅	✅	✅	✅
deleteExportedRows	✅	✅	✅	✅
createSyncTable	✅	✅	✅	✅
setSyncDate	✅	✅	✅	✅
getSyncDate	✅	✅	✅	✅
isJsonValid	✅	✅	✅	✅
isDBExists	✅	✅	✅	✅
addUpgradeStatement	✅	✅	✅	✅
copyFromAssets	✅	✅	✅	✅
isDBOpen	✅	✅	✅	✅
isDatabase	✅	✅	✅	✅
isTableExists	✅	✅	✅	✅
getTableList	✅	✅	✅	✅
getDatabaseList	✅	✅	✅	✅
getMigratableDbList	✅	✅	❌	❌
addSQLiteSuffix	✅	✅	❌	❌
deleteOldDatabases	✅	✅	❌	❌
moveDatabasesAndAddSuffix	✅	✅	❌	❌
checkConnectionsConsistency	✅	✅	✅	✅
isSecretStored	✅	✅	❌	❌
setEncryptionSecret	✅	✅	❌	❌
changeEncryptionSecret	✅	✅	❌	❌
clearEncryptionSecret	✅	✅	❌	❌
checkEncryptionSecret	✅	✅	❌	❌
initWebStore	❌	❌	❌	✅
saveToStore	❌	❌	❌	✅
getNCDatabasePath	✅	✅	❌	❌
createNCConnection	✅	✅	❌	❌
closeNCConnection	✅	✅	❌	❌
isNCDatabase	✅	✅	❌	❌
transaction	✅	✅	✅	✅
getFromHTTPRequest	✅	✅	✅	✅
isDatabaseEncrypted	✅	✅	❌	❌
isInConfigEncryption	✅	✅	❌	❌
isInConfigBiometricAuth	✅	✅	❌	❌

Documentation & APIs

• API

• API Connection Wrapper

• API DB Connection Wrapper

• Import-Export Json

• Upgrade Database Version

• Migrating Cordova Databases

• Type ORM

• Web Usage

• Non Conformed Databases

• Biometric Authentication

Applications demonstrating the use of the plugin and related documentation

Ionic/Angular

• Ionic/Angular Usage Documentation

• ionic-angular-sqlite-starter Ionic 6 Angular SQLite CRUD operations.

• angular-sqlite-app-starter This one is now more for testing the issues.

• angular-sqlite-synchronize-app

Ionic/Angular TypeORM app

• ionic-sqlite-typeorm-app

Ionic/React

• Ionic/React Usage Documentation

• react-sqlite-app-starter

React+Vite

• react-vite-sqlite-app

Ionic/Vue

• Ionic/Vue Usage Documentation

• vue-sqlite-app-starter

Vue

• vue-sqlite-app

Vue+Vite

• vue-vite-sqlite-app

Vue TypeORM app

• vue-typeorm-app

SolidJS+Vite

• solidjs-vite-sqlite-app

Dependencies

The iOS and Android codes are using SQLCipher allowing for database encryption. The iOS codes is using ZIPFoundation for unzipping assets files. The Electron code is using sqlite3 and node-fetch from 4.2.0. The Web code is using the Stencil component jeep-sqlite based on sql.js, localforage, and jszip.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Changelog

4.6.2 (2023-02-24)

Chore

• Update to jeep-sqlite@2.0.0 with @stencil/core@3.00
• Update SQLCipher to 4.5.0 (iOS & Android only)
• Update to androidx.security:security-crypto:1.1.0-alpha05 (should fix issue#321)