@capgo/capacitor-data-storage-sqlite

从您的 Capacitor app 存储 SQLite 中的密钥和值字符串, 其中有多个商店和表格, 以及 iOS 和 Android 的可选加密 。 一个简单的,持久的替代 本地Storage.

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-data-storage-sqlite 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 加上@capgo/capor-data-storage-sqlite到我的Capacitor应用上并把它接上 代理设置指南 • 妇女 主机磁共振

主要特点

• 密钥值 API数字 : set(), (中文(简体) ), get(), (中文(简体) ), remove(), (中文(简体) ), clear(), (中文(简体) ), iskey(), (中文(简体) ), keys(), (中文(简体) ), values() 财务报告和审定财务报表 keysvalues()。 。 。 .
• 库存和表格数字 : openStore(), (中文(简体) ), setTable(), (中文(简体) ), tables(), (中文(简体) ), deleteTable() 财务报告和审定财务报表 deleteStore()。 。 。 .
• 加密:通过SQLCipher在iOS和Android上的可选加密商店.
• JSON 进出口数字 : importFromJson(), (中文(简体) ), isJsonValid() 财务报告和审定财务报表 exportToJson()。 。 。 .
• 过滤数字 : filtervalues() 返回匹配过滤器的密钥的值.
• 平台: iOS,Android和Web. 互联网档案馆的存檔,存档日期2013-12-02. Web在浏览器中存储数据,其密钥值与API相同.

数据存储集

@capgo/capacitor-data-storage-sqlite

第6条

业主的说明

此插件已转移至 Capgo 或 @ jepiqueau (英语) 决定退休.
我们将永远感谢他所做的工作.

Capacitor 数据存储 SQlite 插件是一个自定义的本地 Capacitor 插件,为简单数据提供密钥值永久存储 仅类型字符串 至IOS,Android和Electron平台上的SQLite并至Web平台的IndexDB.

为什么数据存储 SQLite?

一个维护的由社区驱动的插件,提供由SQLite支持的简单的密钥值存储. 最初由@jepiqueau创建,现由Capgo维护:

• 简单 API - 用于字符串数据的简单密钥值存储接口
• 跨平台 - iOS、Android、Electron和Web(IndexedDB)方面的工作
• SQL 备份 - 在本地平台上可靠、加密地存储
• 进出口 - JSON数据传输进出口
• 多表支助 - 组织多个表格的数据

对于需要简单,可靠的本地存储而不需要复杂的SQL查询的应用程序来说,是完美的.

维护者

浏览器支持

插件遵循来自 Capacitor Team, (中文(简体) ),

• Capacitor 浏览器支持

意思是,如果没有额外的 JavaScript 转换, 它将无法在 IE11 中工作, 例如: 宝贝。 。 。 .

文档

这里有最完整的医生: https://capgo.app/docs/plugins/data-storage-sqlite/ 页面存档备份,存于互联网档案馆

兼容性

说明: 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的 Capacitor 安装的版本( 如 Capacitor 8 的插件 v8) 。 只有最新的主要版本得到积极维护.

安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-data-storage-sqlite` plugin in my project.

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install --save @capgo/capacitor-data-storage-sqlite
npx cap sync

• 在iOS方面,无需采取进一步措施.

• 在Android上,不需要进一步的步骤.

• 网上,

npm install --save localforage

• 在电上

npm install --save @capacitor-community/electron
npx cap add @capacitor-community/electron

转到您的应用程序的电子文件夹

cd electron
npm install --save sqlite3
npm install --save-dev @types/sqlite3
npm run build
cd ..
npx cap sync @capacitor-community/electron

然后构建您的属性( A)

npm run build
npx cap copy
npx cap copy @capacitor-community/electron
npx cap open ios
npx cap open android
npx cap open @capacitor-community/electron
ionic serve

配置

此插件不需要配置

支持的方法

文档

• API 文档

• 使用文件( U)

显示插件用途的应用程序

离子/角

• 角-数据存储-sqlite-app启动器

音效/反应

• 反应-数据存储-sqlite-app启动器

反应

• 反应- 数据库qlite- app

音响/声调

• vue-data-sklite-app启动程序

阴道

• vue-datatoragesqlite-app 数据存储器

使用量

• 参见电容器文档

• 参见 USAGE 文档

依赖关系

IOS & Android代码使用SQLCipher允许数据库加密. 安卓代码现在基于 androidx.sqlite。每次交易后,为了改进业绩,数据库不再关闭. 你必须管理 close 在打开新数据库之前先输入数据库. 网络代码使用 localforage 在浏览器中存储数据存储的软件包. 电码使用 sqlite3软件包

数据库加密密码句

打开 iOS系统 财务报告和审定财务报表 机器人,加密仓库使用插件中的 SQLCipher 密码句 Global 缺省数(test secret 编号 : test new secret) 除非你自己配置.

建议 (CLI APs): 设置密码句 capacitor.config.ts 以免内出血 node_modules数字 :

import type { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapgoCapacitorDataStorageSqlite: {
      encryptionSecret: 'my-production-passphrase',
      encryptionNewSecret: 'my-next-passphrase',
    },
  },
};

export default config;

然后使用 openStore 与 encrypted: true 财务报告和审定财务报表 mode 设置为 secret, (中文(简体) ), encryption,或 newsecret 如API文件所描述.

高级 : 内置默认值存在于插件包中(不是在您的 android/ 应用树 :

• 机器人: node_modules/@capgo/capacitor-data-storage-sqlite/android/src/main/java/com/jeep/plugin/capacitor/capgocapacitordatastoragesqlite/cdssUtils/Global.java
• iOS: (英语) node_modules/@capgo/capacitor-data-storage-sqlite/ios/Sources/CapgoCapacitorDataStorageSqlitePlugin/Global.swift

避免直接编辑这些文件;它们安装时被覆盖。 偏爱 capacitor.config 或插件的分叉.

要打开加密的 .db 在桌面 SQLCipher 工具中,使用您配置的相同的密码句 encryptionSecret (或现后的秘密) newsecret (原始内容存档于2013-10-12). rekey.

贡献者

感谢这些伟大的人emoji 密钥:

让·皮埃尔·克约 💻

马修·伯克 📖

凯文·范沙伊克 💻

安迪・加贝特 📖

• openStore(...)
• closeStore(...)
• isStoreOpen(...)
• isStoreExists(...)
• deleteStore(...)
• setTable(...)
• set(...)
• get(...)
• remove(...)
• clear()
• iskey(...)
• keys()
• values()
• filtervalues(...)
• keysvalues()
• isTable(...)
• tables()
• deleteTable(...)
• importFromJson(...)
• isJsonValid(...)
• exportToJson()
• vacuum()
• getPluginVersion()
• 接口
• 类型异名

打开Store(...)

openStore(options: capOpenStorageOptions) => Promise<void>

打开商店

自: 0.0.1 资源

关闭Store(...)

closeStore(options: capStorageOptions) => Promise<void>

关闭存储

自: 3.0.0 (单位:千美元)

是 Store 打开(...)

isStoreOpen(options: capStorageOptions) => Promise<capDataStorageResult>

检查仓库是否打开

回返情况: Promise<capDataStorageResult>

自: 3.0.0 (单位:千美元)

属于 StoreExists (...)

isStoreExists(options: capStorageOptions) => Promise<capDataStorageResult>

检查仓库是否存在

回返情况: Promise<capDataStorageResult>

自: 3.0.0 (单位:千美元)

删除Store(...)

deleteStore(options: capOpenStorageOptions) => Promise<void>

删除存储

自: 0.0.1 资源

设置表格(...)

setTable(options: capTableStorageOptions) => Promise<void>

设置或添加表格到已有的存储中

自: 0.0.1 资源

设置(...)

set(options: capDataStorageOptions) => Promise<void>

用给定的密钥和值存储数据

自: 0.0.1 资源

获取(...)

get(options: capDataStorageOptions) => Promise<capValueResult>

获取给定数据密钥的数据值

回返情况: Promise<capValueResult>

自: 0.0.1 资源

删除(...)

remove(options: capDataStorageOptions) => Promise<void>

用给定的密钥删除数据

自: 0.0.1 资源

清除( c)

clear() => Promise<void>

清除数据存储( 删除全部密钥)

自: 0.0.1 资源

异键(...)

iskey(options: capDataStorageOptions) => Promise<capDataStorageResult>

检查数据密钥是否存在

回返情况: Promise<capDataStorageResult>

自: 0.0.1 资源

键( )

keys() => Promise<capKeysResult>

获取数据密钥列表

回返情况: Promise<capKeysResult>

自: 0.0.1 资源

数值()

values() => Promise<capValuesResult>

获取数据值列表

回返情况: Promise<capValuesResult>

自: 0.0.1 资源

过滤值(...)

filtervalues(options: capFilterStorageOptions) => Promise<capValuesResult>

获取过滤密钥的数据值列表

回返情况: Promise<capValuesResult>

自: 2.4.2

键值( )

keysvalues() => Promise<capKeysValuesResult>

获取数据密钥/ 值对列表

回返情况: Promise<capKeysValuesResult>

自: 0.0.1 资源

istable (...) (中文(简体) )

isTable(options: capTableStorageOptions) => Promise<capDataStorageResult>

检查是否有表格

回返情况: Promise<capDataStorageResult>

自: 3.0.0 (单位:千美元)

表格( )

tables() => Promise<capTablesResult>

获取当前存储的表格列表

回返情况: Promise<capTablesResult>

自: 3.0.0 (单位:千美元)

删除表格(...)

deleteTable(options: capTableStorageOptions) => Promise<void>

删除表格

自: 3.0.0 (单位:千美元)

从 Json (...) 导入

importFromJson(options: capStoreImportOptions) => Promise<capDataStorageChanges>

从 JSON 从数据库导入

回返情况: Promise<capDataStorageChanges>

自: 3.2.0 (中文(简体) )

是 JsonValid (...) 语句

isJsonValid(options: capStoreImportOptions) => Promise<capDataStorageResult>

检查 JSON 对象的有效性

回返情况: Promise<capDataStorageResult>

自: 3.2.0 (中文(简体) )

导出 ToJson ()

exportToJson() => Promise<capStoreJson>

导出给定的数据库到 JSON 对象

回返情况: Promise<capStoreJson>

自: 3.2.0 (中文(简体) )

真空( )

vacuum() => Promise<void>

重建目前的 SQLite 商店以回收未使用的磁盘空间 .

自: 8.032 电话

获取 PluginVersion ()

getPluginVersion() => Promise<{ version: string; }>

获取本地 Capacitor 插件版本

回返情况: Promise<{ version: string; }>

接口

封顶

笼盖

capDataStorage 结果

封面表组合选项

capDataStorage 选项

上限

capeKeys 结果

上限

笼盖

capeKeysValues 结果

封顶表

capDataStorage 变化

封口导入选项

盖斯多尔杰森

杰森斯托尔

Json表单

类型异名

capSQLite 奥托沃库姆

'none' | 'full' | 'incremental' | 0 | 1 | 2

本项目遵循 全部贡献者 规格。 任何捐款都欢迎!

@jepiqueau的退休信息 -- >

自从Ionic Capacitor创立以来,我多年来一直致力于开发和维护这个插件. 现在,73+岁, 随着我的MacBook Pro因运行iOS的Capacitor 6而变得过时, 我决定停止对插件的维护。 如果有人希望拥有这个插件,欢迎他们这样做.

与开发者社区一道参与这一发展旅程,是一个极大的荣誉。 我很高兴看到你们中许多人跟随我走这条路,并将插件纳入你们的应用程序。 你的意见和建议促使我不断加以改进.

我之所以作出这一决定,是因为与家庭有关的一些问题需要我充分注意和时间。 因此,我不会退缩。 感谢大家的支持.

结束 < -