{"id":14139983,"url":"https://github.com/Cap-go/capacitor-data-storage-sqlite","last_synced_at":"2025-08-05T05:32:01.626Z","repository":{"id":32152568,"uuid":"131804089","full_name":"Cap-go/capacitor-data-storage-sqlite","owner":"Cap-go","description":"Capacitor Data Storage SQLite Plugin for IOS and Android ","archived":false,"fork":false,"pushed_at":"2024-12-02T06:48:51.000Z","size":26100,"stargazers_count":81,"open_issues_count":10,"forks_count":18,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-12-07T15:29:21.366Z","etag":null,"topics":["capacitor","capacitor-plugin","ionic"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cap-go.png","metadata":{"files":{"readme":"readme.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"Cap-go","patreon":null,"open_collective":"capgo","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-05-02T05:49:24.000Z","updated_at":"2024-12-02T06:48:55.000Z","dependencies_parsed_at":"2024-01-02T23:09:39.989Z","dependency_job_id":"adf2fd0b-5a0e-40dd-8b3e-2275ecb9bfe5","html_url":"https://github.com/Cap-go/capacitor-data-storage-sqlite","commit_stats":{"total_commits":214,"total_committers":11,"mean_commits":"19.454545454545453","dds":0.4579439252336449,"last_synced_commit":"dd21d90e75cab4cae03e2b619c6cba1287dfd02a"},"previous_names":["cap-go/capacitor-data-storage-sqlite"],"tags_count":97,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-data-storage-sqlite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-data-storage-sqlite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-data-storage-sqlite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-data-storage-sqlite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cap-go","download_url":"https://codeload.github.com/Cap-go/capacitor-data-storage-sqlite/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228708659,"owners_count":17960494,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["capacitor","capacitor-plugin","ionic"],"created_at":"2024-08-16T18:01:32.302Z","updated_at":"2024-12-08T08:31:10.263Z","avatar_url":"https://github.com/Cap-go.png","language":"Swift","readme":" \u003ca href=\"https://capgo.app/\"\u003e\u003cimg src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/?ref=plugin\"\u003e ➡️ Get Instant updates for your App with Capgo 🚀\u003c/a\u003e\u003c/h2\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/consulting/?ref=plugin\"\u003e Fix your annoying bug now, Hire a Capacitor expert 💪\u003c/a\u003e\u003c/h2\u003e\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\u003cbr\u003e\u003cimg src=\"https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png\" width=\"128\" height=\"128\" /\u003e\u003c/p\u003e\n\u003ch3 align=\"center\"\u003eDATA STORAGE SQLITE\u003c/h3\u003e\n\u003cp align=\"center\"\u003e\u003cstrong\u003e\u003ccode\u003e@capgo/capacitor-data-storage-sqlite\u003c/code\u003e\u003c/strong\u003e\u003c/p\u003e\n\u003cbr\u003e\n\u003cp align=\"center\" style=\"font-size:50px;color:red\"\u003e\u003cstrong\u003eCAPACITOR 6\u003c/strong\u003e\u003c/p\u003e\u003cbr\u003e\n\u003cbr\u003e\n\u003c!-- Note from the Owner - Start --\u003e\n\u003cp align=\"center\" style=\"font-size:50px;color:red\"\u003e\u003cstrong\u003eNote from the Owner\u003c/strong\u003e\u003c/p\u003e\n\u003c!-- Note from the Owner - End --\u003e\n\u003cbr\u003e\n\u003c!-- Message below Note from the Owner - Start --\u003e\n\u003cp align=\"left\" style=\"font-size:47px\"\u003eThis Plugin has been transfered to Capgo org after his original creator \u003ca href=\"https://github.com/jepiqueau\"\u003e@jepiqueau\u003c/a\u003e decide to retire. \n\u003cbr\u003eWe will forever be thankful for the work he did.\u003c/p\u003e\n\u003cbr\u003e\n\u003cp align=\"center\"\u003e\n  Capacitor Data Storage SQlite Plugin is a custom Native Capacitor plugin providing a key-value permanent store for simple data of \u003cstrong\u003etype string only\u003c/strong\u003e to SQLite on IOS, Android and Electron platforms and to IndexDB for the Web platform.\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/maintenance/yes/2024?style=flat-square\" /\u003e\n  \u003ca href=\"https://github.com/Cap-go/capacitor-data-storage-sqlite/actions?query=workflow%3A%22CI%22\"\u003e\u003cimg src=\"https://img.shields.io/github/workflow/status/Cap-go/capacitor-data-storage-sqlite/CI?style=flat-square\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/Cap-go/capacitor-data-storage-sqlite\"\u003e\u003cimg src=\"https://img.shields.io/npm/l/capacitor-data-storage-sqlite.svg?style=flat-square\" /\u003e\u003c/a\u003e\n\u003cbr\u003e\n  \u003ca href=\"https://www.npmjs.com/package/Cap-go/capacitor-data-storage-sqlite\"\u003e\u003cimg src=\"https://img.shields.io/npm/dw/capacitor-data-storage-sqlite?style=flat-square\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/Cap-go/capacitor-data-storage-sqlite\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/capacitor-data-storage-sqlite?style=flat-square\" /\u003e\u003c/a\u003e\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n\u003ca href=\"#contributors-\"\u003e\u003cimg src=\"https://img.shields.io/badge/all%20contributors-4-orange?style=flat-square\" /\u003e\u003c/a\u003e\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\u003c/p\u003e\n\n## Maintainers\n\n| Maintainer        | GitHub                                    | Social |\n| ----------------- | ----------------------------------------- | ------ |\n| Martin Donadieu   | [riderx](https://github.com/riderx)       |        |\n| Quéau Jean Pierre | [jepiqueau](https://github.com/jepiqueau) |        |\n\n## Browser Support\n\nThe plugin follows the guidelines from the `Capacitor Team`,\n\n- [Capacitor Browser Support](https://capacitorjs.com/docs/v3/web#browser-support)\n\nmeaning that it will not work in IE11 without additional JavaScript transformations, e.g. with [Babel](https://babeljs.io/).\n\n## Installation\n\n```bash\nnpm install --save @capgo/capacitor-data-storage-sqlite\nnpx cap sync\n```\n\n- On iOS, no further steps are needed.\n\n- On Android, no further steps are needed.\n\n- On Web, \n```bash\nnpm install --save localforage\n```\n\n- On Electron\n```bash\nnpm install --save @capacitor-community/electron\nnpx cap add @capacitor-community/electron\n```\nGo to the Electron folder of your application\n\n```bash\ncd electron\nnpm install --save sqlite3\nnpm install --save-dev @types/sqlite3\nnpm run build\ncd ..\nnpx cap sync @capacitor-community/electron\n```\n\nThen build YOUR_APPLICATION\n\n```\nnpm run build\nnpx cap copy\nnpx cap copy @capacitor-community/electron\nnpx cap open ios\nnpx cap open android\nnpx cap open @capacitor-community/electron\nionic serve\n```\n\n## Configuration\n\nNo configuration required for this plugin\n\n## Supported methods\n\n| Name                         | Android | iOS | Electron | Web |\n| :--------------------------- | :------ | :-- | :------- | :-- |\n| openStore (non-encrypted DB) | ✅      | ✅  | ✅       | ✅  |\n| openStore (encrypted DB)     | ✅      | ✅  | ❌       | ❌  |\n| closeStore                   | ✅      | ✅  | ✅       | ❌  |\n| isStoreOpen                  | ✅      | ✅  | ✅       | ❌  |\n| isStoreExists                | ✅      | ✅  | ✅       | ❌  |\n| deleteStore                  | ✅      | ✅  | ✅       | ❌  |\n| setTable                     | ✅      | ✅  | ✅       | ✅  |\n| set                          | ✅      | ✅  | ✅       | ✅  |\n| get                          | ✅      | ✅  | ✅       | ✅  |\n| iskey                        | ✅      | ✅  | ✅       | ✅  |\n| keys                         | ✅      | ✅  | ✅       | ✅  |\n| values                       | ✅      | ✅  | ✅       | ✅  |\n| filtervalues                 | ✅      | ✅  | ✅       | ✅  |\n| keysvalues                   | ✅      | ✅  | ✅       | ✅  |\n| remove                       | ✅      | ✅  | ✅       | ✅  |\n| clear                        | ✅      | ✅  | ✅       | ✅  |\n| isTable                      | ✅      | ✅  | ✅       | ✅  |\n| tables                       | ✅      | ✅  | ✅       | ✅  |\n| deleteTable                  | ✅      | ✅  | ✅       | ❌  |\n| isJsonValid                  | ✅      | ✅  | ✅       | ✅  |\n| importFromJson               | ✅      | ✅  | ✅       | ✅  |\n| exportToJson                 | ✅      | ✅  | ✅       | ✅  |\n\n## Documentation\n\n- [API_Documentation](docs/API.md)\n\n- [USAGE_Documentation](docs/USAGE.md)\n\n## Applications demonstrating the use of the plugin\n\n### Ionic/Angular\n\n- [angular-data-storage-sqlite-app-starter](https://github.com/Cap-go/angular-data-storage-sqlite-app-starter)\n\n### Ionic/React\n\n- [react-data-storage-sqlite-app-starter](https://github.com/Cap-go/react-data-storage-sqlite-app-starter)\n\n### React\n\n- [react-datastoragesqlite-app](https://github.com/Cap-go/react-datastoragesqlite-app)\n\n### Ionic/Vue\n\n- [vue-data-storage-sqlite-app-starter](https://github.com/Cap-go/vue-data-storage-sqlite-app-starter)\n\n### Vue\n\n- [vue-datastoragesqlite-app](https://github.com/Cap-go/vue-datastoragesqlite-app)\n\n## Usage\n\n- [see capacitor documentation](https://capacitor.ionicframework.com/docs/getting-started/with-ionic)\n\n- [see USAGE_Documentation](https://github.com/Cap-go/capacitor-data-storage-sqlite/blob/master/docs/USAGE.md)\n\n## Dependencies\n\nThe IOS \u0026 Android code use SQLCipher allowing for database encryption. \nThe Android code is now based on `androidx.sqlite`. The database is not closed anymore after each transaction for performance improvement.\nYou must manage the `close` of the database before opening a new database.\nThe Web code use `localforage` package to store the datastore in the Browser.\nThe Electron code use `sqlite3`package\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/jepiqueau\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/16580653?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eJean Pierre Quéau\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/capacitor-data-storage-sqlite/commits?author=jepiqueau\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/mwpb\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/12957941?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMatthew Burke\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/capacitor-data-storage-sqlite/commits?author=jepiqueau\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e    \n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/mwpb\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1745820?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eKevin van Schaijk\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/capacitor-data-storage-sqlite/commits?author=jepiqueau\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e  \n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/garbit\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/555396?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eAndy Garbett\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/capacitor-data-storage-sqlite/commits?author=jepiqueau\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e    \n     \n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n\u003cp align=\"left\" style=\"font-size:47px\"\u003eRetirement message of @jepiqueau --\u003e\u003c/p\u003e\n\u003cbr\u003e\n\u003cp align=\"left\"\u003e\nI have been dedicated to developing and maintaining this plugin for many years since the inception of Ionic Capacitor. Now, at 73+ years old, and with my MacBook Pro becoming obsolete for running Capacitor 6 for iOS, I have made the decision to cease maintenance of the plugin. If anyone wishes to take ownership of this plugin, they are welcome to do so.  \n\u003c/p\u003e\n\u003cbr\u003e\n\u003cp align=\"left\"\u003e\nIt has been a great honor to be part of this development journey alongside the developer community. I am grateful to see many of you following me on this path and incorporating the plugin into your applications. Your comments and suggestions have motivated me to continuously improve it.  \n\u003c/p\u003e\n\u003cbr\u003e\n\u003cp align=\"left\"\u003e\nI have made this decision due to several family-related troubles that require my full attention and time. Therefore, I will not be stepping back. Thank you to all of you for your support.\n\u003c/p\u003e\n\u003cbr\u003e\n\u003cp align=\"left\" style=\"font-size:47px\"\u003eEnd \u003c--\u003c/p\u003e\n\u003c!-- Message below Note from the Owner - End --\u003e\n\u003cbr\u003e\n\n","funding_links":["https://github.com/sponsors/Cap-go","https://opencollective.com/capgo"],"categories":["Capgo Capacitor Plugins","Swift","[Capgo plugins](https://capgo.app/)"],"sub_categories":["Storage \u0026 Files"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCap-go%2Fcapacitor-data-storage-sqlite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCap-go%2Fcapacitor-data-storage-sqlite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCap-go%2Fcapacitor-data-storage-sqlite/lists"}