跳过主要内容
@capgo/capacitor-sqlite数据存储 文件 & 存储 开源

数据存储 Capacitor 插件

使用SQLite数据库,简单的键值API和加密支持来在本地存储数据

安装

bun add @capgo/capacitor-data-storage-sqlite bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-data-storage-sqlite
  • pnpm add @capgo/capacitor-data-storage-sqlite
  • yarn add @capgo/capacitor-data-storage-sqlite

指南

如何在 Capacitor 中使用数据存储

在设备上测试

下载 Capgo 应用,然后扫描二维码 code

数据存储插件预览二维码 code

使用 @capgo/capacitor-data-storage-sqlite

SQLite 存储键值对字符串。

安装

bun add @capgo/capacitor-data-storage-sqlite
bunx cap sync

bunx cap sync 将插件的本机 code 复制到您的本机项目中。每次升级插件后,请重新运行它。

导入

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

快速浏览 API

方法 描述
openStore 打开一个数据存储。
closeStore 关闭数据存储。
isStoreOpen 检查数据存储是否已打开。
isStoreExists 检查数据存储是否存在。
deleteStore 删除一个数据存储。
setTable 设置或添加一个表格到一个已有的数据存储。
set 将数据存储到一个指定的键和值。
get 根据给定的数据键获取一个数据值。
remove 根据给定的键删除一个数据。
clear 清除数据存储(删除所有键)。
iskey 检查一个数据键是否存在。
keys 获取数据键列表。
values 获取数据值列表。
filtervalues 获取数据值列表(用于过滤键)。
keysvalues 获取数据键/值对列表。
isTable 检查表是否存在。
tables 获取当前存储的表列表。
deleteTable 删除表。
importFromJson 从 JSON 导入数据库。
isJsonValid 检查 JSON 对象的有效性。
exportToJson 将给定的数据库导出为 JSON 对象。
vacuum 重建当前 SQLite 存储以回收未使用的磁盘空间。

示例

openStore()

打开一个存储。

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

await CapgoCapacitorDataStorageSqlite.openStore({
  database: 'database',
  table: 'table',
  encrypted: false,
  mode: 'encryption',
  autoVacuum: 'none',
});

closeStore()

关闭存储。

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

await CapgoCapacitorDataStorageSqlite.closeStore({ database: 'database' });

isStoreOpen()

检查是否已打开存储。

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

const result = await CapgoCapacitorDataStorageSqlite.isStoreOpen({ database: 'database' });
console.log(result);

isStoreExists()

检查是否存在存储。

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

const result = await CapgoCapacitorDataStorageSqlite.isStoreExists({ database: 'database' });
console.log(result);

deleteStore()

删除存储。

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

await CapgoCapacitorDataStorageSqlite.deleteStore({
  database: 'database',
  table: 'table',
  encrypted: false,
  mode: 'encryption',
  autoVacuum: 'none',
});

setTable()

将或添加一个表格到一个已有的存储。

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

await CapgoCapacitorDataStorageSqlite.setTable({ table: 'table' });

上面的表格列出了 22 个核心方法。监听器和版本帮助,以及每个方法的完整契约,都在__CAPGO_KEEP_0__仓库中文档化。 GitHub参考文档.

完整参考

继续使用@capgo/capacitor-data-storage-sqlite

如果您正在使用 使用 @capgo/capacitor-data-storage-sqlite 用于规划存储和文件处理,连接它与 @capgo/capacitor-数据存储-SQLite 查看 @capgo/capacitor-data-storage-sqlite 的实现细节 开始 查看开始的实现细节 @capgo/capacitor文件 查看 @capgo/capacitor-file 的实现细节 使用 @capgo/capacitor-file 查看使用 @capgo/capacitor-file 的原生能力,并 @capgo/capacitor-uploader 为 @capgo/capacitor-uploader 的实现细节。

常见问题

数据存储插件常见问题

如何在Capacitor应用中安装数据存储插件?

Run "bun add @capgo/capacitor-data-storage-sqlite" (or "npm install @capgo/capacitor-data-storage-sqlite"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-data-storage-sqlite" in your app code.

@capgo/capacitor-data-storage-sqlite works with React, Vue and Angular?

是的。数据存储是一个 Capacitor 包,因此它与任何运行在 Capacitor 内的 Web 框架都兼容,包括 Ionic、React、Vue、Angular、Svelte 和普通 JavaScript。

哪个 Capacitor 版本支持 @capgo/capacitor-data-storage-sqlite?

Capgo 插件遵循 Capacitor 的主要版本:使用与 Capacitor 主要版本匹配的插件主要版本(例如插件 v8 与 Capacitor 8)。兼容性表格在 GitHub README 中列出。

@capgo/capacitor-data-storage-sqlite 是否免费和开源?

是的。源代码 code 公开在 GitHub 上,https://github.com/Cap-go/capacitor-data-storage-sqlite/,并且该包从 npm 免费安装。bug 报告和 pull 请求都欢迎。

我可以在不经过 App Store 审核的情况下更新使用 Data Storage 的 code?

安装或升级插件会更改本机 code,需要一个新的商店构建。之后,JavaScript、HTML 和 CSS 调用插件的更改可以立即通过 Capgo 实时更新发布。

无需等待应用程序审查即可将数据存储更改推送

一旦插件添加到您的商店构建中,Capgo即刻将您的JavaScript、HTML和CSS更改推送给用户。

开始使用Capgo