@capacitor-community/sqlite

SQLITE DATABASE

@capacitor-community/sqlite

REFACTOR 🚀

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

NEXT FOR CAPACITOR 3 🚧 (Master)

The refactor release has been upgraded to @capacitor/core@3.0.0-beta.1. !!! ONLY iOS and Android plugins have been upgraded !!!

The test has been achieved on:

• a Ionic/Angular app

REFACTOR 🚀 (Move to branch 2.9.x)

The refactor offers now (since 2.9.0-beta.1) all the features that the previous was offering. It has been a quite heavy process, hoping that the developpers will take benefit from it.

The main reasons for it:

• multiple database connections
• db connector allowing for easy commands db.open(), db.close, ...
• improve the response time of the encrypted database by removing the internal open and close database for each sqlite query
• moving to the latest androidx.sqlite.db.xxx
• offering encryption for Electron platform by using @journeyapps/sqlcipher on MacOs, !!! NOT ON WINDOWS !!!
• cleaning and aligning the code between platforms
• allowing developers to develop typeorm or spatialite drivers.

This was discussed lengthly in issue#1 and issue#52

Refactor available for Android, iOS and Electron platforms.

The test has been achieved on:

• a Ionic/Angular app

• a Ionic/React app

• a Ionic/Vue app

Other frameworks will be tested later

• Stencil

Browser Support

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.

Installation

npm install @capacitor-community/sqlite@next
npm run build
npx cap sync
npx cap add android
npx cap add ios
// npx cap add @capacitor-community/electron not working

IOS

• on iOS no further steps needed.

Android

• On Android, register the plugin in your main activity:

import com.getcapacitor.community.database.sqlite.CapacitorSQLitePlugin;

public class MainActivity extends BridgeActivity {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        registerPlugin(CapacitorSQLitePlugin.class);

    }

Electron (NOT WORKING YET)

• On Electron, go to the Electron folder of YOUR_APPLICATION

npm install --save @journeyapps/sqlcipher

Build & Run

npm run build
npx cap copy
npx cap copy @capacitor-community/electron

IOS

npx cap open ios

Android

npx cap open android

Electron (NOT WORKING YET)

npx cap open @capacitor-community/electron

Issues

When you will find issues, please report them with the NEXT word at the start of the issue title.

issues

Configuration

No configuration required for this plugin

Supported methods

Name	Android	iOS	Electron Mac	Electron Windows	Web
createConnection	✅	✅	✅	✅	❌
closeConnection	✅	✅	✅	✅	❌
open (non-encrypted DB)	✅	✅	✅	✅	❌
open (encrypted DB)	✅	✅	✅	❌	❌
close	✅	✅	✅	✅	❌
execute	✅	✅	✅	✅	❌
executeSet	✅	✅	✅	✅	❌
run	✅	✅	✅	✅	❌
query	✅	✅	✅	✅	❌
deleteDatabase	✅	✅	✅	✅	❌
importFromJson	✅	✅	✅	✅	❌
exportToJson	✅	✅	✅	✅	❌
createSyncTable	✅	✅	✅	✅	❌
setSyncDate	✅	✅	✅	✅	❌
getSyncDate	✅	✅	✅	✅	❌
isJsonValid	✅	✅	✅	✅	❌
isDBExists	✅	✅	✅	✅	❌
addUpgradeStatement	✅	✅	✅	✅	❌
copyFromAssets	✅	✅	✅	✅	❌

Documentation

API

API_Documentation

API_Connection_Wrapper_Documentation

API_DB_Connection_Wrapper_Documentation

ImportExportJson_Documentation

UpgradeDatabaseVersion_Documentation

Framework's Usage

Ionic/Angular_Usage_Documentation

Applications demonstrating the use of the plugin

Ionic/Angular

• angular-sqlite-app-refactor

Ionic/React (to come later)

Ionic/Vue (to come later)

Vue (to come later)

Usage

• see capacitor documentation

• In your Ionic/Angular App

Dependencies

The IOS and Android codes are using SQLCipher allowing for database encryption The Electron code use @journeyapps/sqlcipher allowing for database encryption for MacOS !!! NOT for Windows !!!

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jean Pierre Quéau 💻

Paul Antoine 💻

Karyfars 💻

Chriswep 📖

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

Changelog

3.0.0-beta.1 (2021-01-23)

Bug Fixes

• update API Docs
• update README, CHANGELOG

Chore

• update to @capacitor/core@3.0.0-beta.1

Added Features

• better Error handling throught try...catch