composoftware / sqlite Goto Github PK

@capacitor-community/sqlite

CAPACITOR 4

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

🚨 Release 4.2.2-1 ->> 🚨

Please do not use it. it was a trial to implement BEGIN CONCURRENCY in Electron Platform to fix issue #258. It seems that sqlite3 does not offer this feature as well as PRAGMA journal_mode= wal2

If someone got some ideas on this, he is welcome.

🚨 Release 4.2.2-1 <<- 🚨

To install:

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

yarn install --save @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

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

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.

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

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

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.

• 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
npm install --save-dev @types/sqlite3

• on iOS, no further steps needed.

• 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

• Ionic/Angular Usage Documentation

• angular-sqlite-app-starter

• angular-sqlite-synchronize-app

• Ionic/React Usage Documentation

• react-sqlite-app-starter

• react-vite-sqlite-app

• Ionic/Vue Usage Documentation

• vue-sqlite-app-starter

• vue-sqlite-app

• vue-vite-sqlite-app

• solidjs-vite-sqlite-app

• vue-typeorm-app

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

Thanks goes to these wonderful people (emoji key):

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