跳转到正文

@capgo/capacitor-data-storage-sqlite

基于 SQLite (原生端) 和 IndexedDB (Web 端) 的加密友好型键值存储。

无需手动编写 SQL,即可打开具名存储、设置键值并查询数据。支持在存储内切换表、迁移 JSON 负载,并能在需要超越 OS 沙盒的静态数据保护时,在 iOS 和 Android 上启用加密。

典型场景:离线设置、表单草稿、缓存的 API 数据负载,以及在进程重启后仍需保留的功能开关。

平台支持备注
iOS是通过社区存储层使用 SQLite
Android是支持可选加密的 SQLite
Web 端是基于 IndexedDB 的实现方案
  • openStore - 打开一个 Store。
  • closeStore - 关闭 Store。
  • isStoreOpen - 检查 Store 是否已打开。
  • isStoreExists - 检查 Store 是否存在。
方法描述
openStore打开 Store。
closeStore关闭 Store。
isStoreOpen检查 Store 是否已打开。
isStoreExists检查 Store 是否存在。
deleteStore删除 Store。
setTable为现有 Store 设置或添加表。
set使用指定的 key 和 value 存储数据。
get根据指定的 key 获取数据值。
remove移除指定 key 的数据。
clear清空 Data Store(删除所有 key)。
iskey检查数据 key 是否存在。
keys获取数据键列表。
values获取数据值列表。
filtervalues获取筛选键的数据值列表。
keysvalues获取数据键值对列表。
isTable检查表是否存在。
tables获取当前 store 的表列表。
deleteTable删除表。
importFromJson从 JSON 导入数据库。
isJsonValid校验 JSON 对象是否有效。
exportToJson将指定的数据库导出为 JSON 对象。
getPluginVersion获取原生 Capacitor 插件版本。

此参考文档同步自 src/definitions.ts 中的 capacitor-data-storage-sqlite.

继续探索 @capgo/capacitor-data-storage-sqlite

标题为“继续探索 @capgo/capacitor-data-storage-sqlite”的部分

如果你正在使用 @capgo/capacitor-data-storage-sqlite 要规划存储和文件处理,请将其与 使用 @capgo/capacitor-data-storage-sqlite 关于使用 @capgo/capacitor-data-storage-sqlite 的原生能力, @capgo/capacitor-file 关于 @capgo/capacitor-file 中的实现细节, 使用 @capgo/capacitor-file 原生能力请参阅《使用 @capgo/capacitor-file》, @capgo/capacitor-uploader 关于 @capgo/capacitor-uploader 中的实现细节,以及 使用 @capgo/capacitor-uploader 关于使用 @capgo/capacitor-uploader. 的原生能力