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](https://github.com/jepiqueau) | | 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 ``` ## More Reading: - [Releases](https://github.com/capacitor-community/sqlite/blob/master/info_releases.md) - [Changelog](https://github.com/capacitor-community/sqlite/blob/master/CHANGELOG.md) - [Issues](https://github.com/capacitor-community/sqlite/issues) - [Capacitor documentation](https://capacitorjs.com/docs/) - [Datatypes In SQLite Version 3](https://www.sqlite.org/datatype3.html) - [IncrementalUpgradeDatabaseVersion](https://capacitorjs.com/docs/IncrementalUpgradeDatabaseVersion.md) ## Web Quirks The plugin follows the guidelines from the `Capacitor Team`, - [Capacitor Browser Support](https://capacitorjs.com/docs/v3/web#browser-support) Meaning that it will not work in IE11 without additional JavaScript transformations, e.g. with [Babel](https://babeljs.io/). 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](https://github.com/capacitor-community/sqlite/issues/301) and [SO question](https://stackoverflow.com/questions/63291529/how-to-fix-more-than-one-file-was-found-with-os-independent-path-build-data-pro) for more information. ## Electron Quirks - On Electron, go to the Electron folder of YOUR_APPLICATION ```bash cd electron npm install --save sqlite3 npm install --save jszip npm install --save node-fetch npm install --save-dev @types/sqlite3 ``` - **Important**: `node-fetch` version must be `<=2.6.7`; otherwise [you'll get an error](https://github.com/capacitor-community/sqlite/issues/349 "you'll get an error ERR_REQUIRE_ESM") running the app. ## IOS Quirks - on iOS, no further steps needed. ## Supported Methods by Platform | Name | Android | iOS | Electron | Web | | :-------------------------- | :------ | :-- | :------- | :-- | | createConnection (ReadWrite)| ✅ | ✅ | ✅ | ✅ | | createConnection (ReadOnly) | ✅ | ✅ | ✅ | ❌ | since 4.1.0-7 | closeConnection (ReadWrite) | ✅ | ✅ | ✅ | ✅ | | closeConnection (ReadOnly) | ✅ | ✅ | ✅ | ❌ | since 4.1.0-7 | isConnection (ReadWrite) | ✅ | ✅ | ✅ | ✅ | | isConnection (ReadOnly) | ✅ | ✅ | ✅ | ❌ | since 4.1.0-7 | open (non-encrypted DB) | ✅ | ✅ | ✅ | ✅ | | open (encrypted DB) | ✅ | ✅ | ❌ | ❌ | | close | ✅ | ✅ | ✅ | ✅ | | getUrl | ✅ | ✅ | ❌ | ❌ | | getVersion | ✅ | ✅ | ✅ | ✅ | | execute | ✅ | ✅ | ✅ | ✅ | | executeSet | ✅ | ✅ | ✅ | ✅ | | run | ✅ | ✅ | ✅ | ✅ | | query | ✅ | ✅ | ✅ | ✅ | | deleteDatabase | ✅ | ✅ | ✅ | ✅ | | importFromJson | ✅ | ✅ | ✅ | ✅ | | exportToJson | ✅ | ✅ | ✅ | ✅ | | deleteExportedRows | ✅ | ✅ | ✅ | ✅ | | createSyncTable | ✅ | ✅ | ✅ | ✅ | | setSyncDate | ✅ | ✅ | ✅ | ✅ | | getSyncDate | ✅ | ✅ | ✅ | ✅ | | isJsonValid | ✅ | ✅ | ✅ | ✅ | | isDBExists | ✅ | ✅ | ✅ | ✅ | | addUpgradeStatement | ✅ | ✅ | ✅ | ✅ | Modified 4.1.0-6 | copyFromAssets | ✅ | ✅ | ✅ | ✅ | | isDBOpen | ✅ | ✅ | ✅ | ✅ | | isDatabase | ✅ | ✅ | ✅ | ✅ | | isTableExists | ✅ | ✅ | ✅ | ✅ | | getTableList | ✅ | ✅ | ✅ | ✅ | | getDatabaseList | ✅ | ✅ | ✅ | ✅ | | getMigratableDbList | ✅ | ✅ | ❌ | ❌ | | addSQLiteSuffix | ✅ | ✅ | ❌ | ❌ | | deleteOldDatabases | ✅ | ✅ | ❌ | ❌ | | moveDatabasesAndAddSuffix | ✅ | ✅ | ❌ | ❌ | | checkConnectionsConsistency | ✅ | ✅ | ✅ | ✅ | | isSecretStored | ✅ | ✅ | ❌ | ❌ | | setEncryptionSecret | ✅ | ✅ | ❌ | ❌ | | changeEncryptionSecret | ✅ | ✅ | ❌ | ❌ | | clearEncryptionSecret | ✅ | ✅ | ❌ | ❌ | | initWebStore | ❌ | ❌ | ❌ | ✅ | | saveToStore | ❌ | ❌ | ❌ | ✅ | | getNCDatabasePath | ✅ | ✅ | ❌ | ❌ | | createNCConnection | ✅ | ✅ | ❌ | ❌ | | closeNCConnection | ✅ | ✅ | ❌ | ❌ | | isNCDatabase | ✅ | ✅ | ❌ | ❌ | | transaction | ✅ | ✅ | ✅ | ✅ | | getFromHTTPRequest | ✅ | ✅ | ✅ | ✅ | since 4.2.0 ## Documentation & APIs - [API](https://github.com/capacitor-community/sqlite/blob/master/docs/API.md) - [API Connection Wrapper](https://github.com/capacitor-community/sqlite/blob/master/docs/APIConnection.md) - [API DB Connection Wrapper](https://github.com/capacitor-community/sqlite/blob/master/docs/APIDBConnection.md) - [Import-Export Json](https://github.com/capacitor-community/sqlite/blob/master/docs/ImportExportJson.md) - [Upgrade Database Version](https://github.com/capacitor-community/sqlite/blob/master/docs/UpgradeDatabaseVersion.md) - [Migrating Cordova Databases](https://github.com/capacitor-community/sqlite/blob/master/docs/MigratingCordovaDatabases.md) - [Type ORM](https://github.com/capacitor-community/sqlite/blob/master/docs/TypeORM-Usage.md) - [Web Usage](https://github.com/capacitor-community/sqlite/blob/master/docs/Web-Usage.md) - [Non Conformed Databases](https://github.com/capacitor-community/sqlite/blob/master/docs/NonConformedDatabases.md) - [Biometric Authentication](https://github.com/capacitor-community/sqlite/blob/master/docs/Biometric-Authentication.md) ## Applications demonstrating the use of the plugin and related documentation ### Ionic/Angular - [Ionic/Angular Usage Documentation](https://github.com/capacitor-community/sqlite/blob/master/docs/Ionic-Angular-Usage.md) - [angular-sqlite-app-starter](https://github.com/jepiqueau/angular-sqlite-app-starter) - [angular-sqlite-synchronize-app](https://github.com/jepiqueau/angular-sqlite-synchronize-app) ### Ionic/React - [Ionic/React Usage Documentation](https://github.com/capacitor-community/sqlite/blob/master/docs/Ionic-React-Usage.md) - [react-sqlite-app-starter](https://github.com/jepiqueau/react-sqlite-app-starter) ### React+Vite - [react-vite-sqlite-app](https://github.com/jepiqueau/react-vite-sqlite-app) ### Ionic/Vue - [Ionic/Vue Usage Documentation](https://github.com/capacitor-community/sqlite/blob/master/docs/Ionic-Vue-Usage.md) - [vue-sqlite-app-starter](https://github.com/jepiqueau/vue-sqlite-app-starter) ### Vue - [vue-sqlite-app](https://github.com/jepiqueau/vue-sqlite-app) ### Vue+Vite - [vue-vite-sqlite-app](https://github.com/jepiqueau/vuevite-app) ### SolidJS+Vite - [solidjs-vite-sqlite-app](https://github.com/jepiqueau/capacitor-solid-sqlite) ### Vue TypeORM app - [vue-typeorm-app](https://github.com/jepiqueau/vue-typeorm-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](https://allcontributors.org/docs/en/emoji-key)):

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!