React Hook for @capacitor-community/sqlite@latest plugin
react-sqlite-hook@latest
Capacitor 4
A React Hook to help Capacitor developpers to use @capacitor-community/sqlite@latest plugin in React or Ionic/React applications
## @LATEST For Capacitor 4 (Master)
The `Capacitor4`react-sqlite-hook interfacing the `@capacitor-community/sqlite@latest`
## For Capacitor 3 (v2.1.12)
The `Capacitor3`react-sqlite-hook interfacing the `@capacitor-community/sqlite@3.7.0`
## @REFACTOR REFACTOR 🚀 (Move to branch 2.9.x)
The `refactor` react-sqlite-hook interfacing the `@capacitor-community/sqlite@refactor`
## @INITIAL 🛑 (Move to branch 2.4.x)
The `initial` react-sqlite-hook interfacing the `@capacitor-community/sqlite@initial`. !!! The MAINTAINANCE is now STOPPED !!!
## Maintainers
| Maintainer | GitHub | Social |
| ----------------- | ----------------------------------------- | ------ |
| Quéau Jean Pierre | [jepiqueau](https://github.com/jepiqueau) | |
## Installation
```bash
npm install --save @capacitor-community/sqlite@next
npm install --save-dev react-sqlite-hook@next
```
## Supported methods
| Name | Android | iOS | Electron | Web |
| :-------------------------- | :------ | :-- | :------- | :-- |
| echo | ✅ | ✅ | ✅ | ✅ |
| getPlatform | ✅ | ✅ | ✅ | ✅ |
| getCapacitorSQLite | ✅ | ✅ | ✅ | ✅ |
| addUpgradeStatement | ✅ | ✅ | ✅ | ✅ |
| createConnection | ✅ | ✅ | ✅ | ✅ |
| retrieveConnection | ✅ | ✅ | ✅ | ✅ |
| retrieveAllConnections | ✅ | ✅ | ✅ | ✅ |
| closeConnection | ✅ | ✅ | ✅ | ✅ |
| closeAllConnections | ✅ | ✅ | ✅ | ✅ |
| isConnection | ✅ | ✅ | ✅ | ✅ |
| isDatabase | ✅ | ✅ | ✅ | ✅ |
| getDatabaseList | ✅ | ✅ | ✅ | ✅ |
| getMigratableDbList | ✅ | ✅ | ❌ | ❌ |
| addSQLiteSuffix | ✅ | ✅ | ❌ | ❌ |
| deleteOldDatabases | ✅ | ✅ | ❌ | ❌ |
| importFromJson | ✅ | ✅ | ✅ | ✅ |
| isJsonValid | ✅ | ✅ | ✅ | ✅ |
| copyFromAssets | ✅ | ✅ | ✅ | ✅ |
| checkConnectionsConsistency | ✅ | ✅ | ✅ | ✅ |
| isSecretStored | ✅ | ✅ | ❌ | ❌ |
| setEncryptionSecret | ✅ | ✅ | ❌ | ❌ |
| changeEncryptionSecret | ✅ | ✅ | ❌ | ❌ |
| clearEncryptionSecret | ✅ | ✅ | ❌ | ❌ |
| removeListeners | ✅ | ✅ | ✅ | ✅ |
| initWebStore | ❌ | ❌ | ❌ | ✅ |
| saveToStore | ❌ | ❌ | ❌ | ✅ |
| getNCDatabasePath | ✅ | ✅ | ❌ | ❌ |
| createNCConnection | ✅ | ✅ | ❌ | ❌ |
| closeNCConnection | ✅ | ✅ | ❌ | ❌ |
| retrieveNCConnection | ✅ | ✅ | ❌ | ❌ |
| isNCConnection | ✅ | ✅ | ❌ | ❌ |
| isNCDatabase | ✅ | ✅ | ❌ | ❌ |
| getFromHTTPRequest | ✅ | ✅ | ✅ | ✅ |
## Supported listeners
| Name | Android | iOS | Electron | Web |
| :--------------- | :------ | :-- | :------- | :-- |
| onProgressImport | ✅ | ✅ | 🚧 | ✅ |
| onProgressExport | ✅ | ✅ | 🚧 | ✅ |
## Documentation
- [API Hook](https://github.com/jepiqueau/react-sqlite-hook/tree/master/docs/APIHook.md)
## Applications demonstrating the use of the plugin and the react hook
- [react-sqlite-app-starter](https://github.com/jepiqueau/react-sqlite-app-starter)
## Usage
The usage of `react-sqlite-hook`is demonstrated in
- [Ionic/React_Usage_Documentation](https://github.com/capacitor-community/sqlite/blob/master/docs/Ionic-React-Usage.md)
## 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!