@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

REFACTOR 🚀

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
• 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@refactor
npm run build
npx cap sync
npx cap add android
npx cap add ios
npx cap add @capacitor-community/electron

IOS

• on iOS no further steps needed.

Android

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

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

public class MainActivity extends BridgeActivity {

  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // Initializes the Bridge
    this.init(
        savedInstanceState,
        new ArrayList<Class<? extends Plugin>>() {
          {
            // Additional plugins you've installed go here
            // Ex: add(TotallyAwesomePlugin.class);
            add(CapacitorSQLite.class);
          }
        }
      );
  }
}

Electron

• 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

npx cap open @capacitor-community/electron

Configuration

No configuration required for this plugin

Supported methods

Name	Android	iOS	Electron	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_Documentation

API_Connection_Wrapper_Documentation

API_DB_Connection_Wrapper_Documentation

ImportExportJson_Documentation

UpgradeDatabaseVersion_Documentation

Ionic/Angular_Usage_Documentation

Ionic/React_Usage_Documentation

Ionic/Vue_Usage_Documentation

Applications demonstrating the use of the plugin

Ionic/Angular

• angular-sqlite-app-refactor

Ionic/React

• react-sqlite-app-refactor

Ionic/Vue

• vue-sqlite-app-refactor

Vue (to come later)

Usage

• see capacitor documentation

• In your Ionic/Angular App

• In your Ionic/React App

• In your Ionic/Vue App

Dependencies

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

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

2.9.0 (2021-01-14) REFACTOR

Chore

• update to @capacitor/core@2.4.6

Bug Fixes

• remove Android permissions issue#60
• update usage docs
• update README and CHANGELOG