# @capgo/capacitor-data-storage-sqlite 中文文档

规范地址：https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/

版本：8\.0\.60
npm 元数据更新时间：2026-11-09T07:18:38.054Z
中文译文更新时间：2026-11-09T03:42:40.517Z
软件包许可：MPL-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capgo/capacitor-data-storage-sqlite
原文对照：https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/?lang=original
项目主页：https://capgo.app/docs/plugins/data-storage-sqlite/
源码仓库：https://github.com/Cap-go/capacitor-data-storage-sqlite

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：479 kB，56 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：localforage ^1\.10\.0，@capacitor/core \>=8\.0\.0
- 首次发布：2024-08-14T18:54:54.076Z
- 最新版本发布：2026-11-09T07:18:37.703Z
- 近 30 天下载量：43798（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：138（近 12 个月 65 个）

## 中文简介

SQLite 密钥/ 值字符串对的存储

## 安装

```sh
npm install @capgo/capacitor-data-storage-sqlite
```

也可以使用：`pnpm add @capgo/capacitor-data-storage-sqlite`、`yarn add @capgo/capacitor-data-storage-sqlite`、`bun add @capgo/capacitor-data-storage-sqlite`

## README

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

[![Capgo - Build Capacitor apps with AI, ship updates instantly](https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-data-storage-sqlite)](https://capgo.app/?ref=plugin_data_storage_sqlite)

**队长**:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

## [\*免费开始\*](https://capgo.app/register/?ref=plugin_data_storage_sqlite)

14天无限自由审判. 不需要信用卡

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

![@capgo/capacitor-data-storage-sqlite for Capacitor apps](https://raw.githubusercontent.com/Cap-go/capacitor-data-storage-sqlite/main/assets/github-social-preview.png)

## 主要特点

-   **密钥值 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相同.

  
![](https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png)

### 数据存储集

**`@capgo/capacitor-data-storage-sqlite`**

  

**第6条**

  
  

**业主的说明**

  

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

  

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

## 为什么数据存储 SQLite?

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

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

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

![](https://img.shields.io/maintenance/yes/2024?style=flat-square) [![](https://img.shields.io/github/workflow/status/Cap-go/capacitor-data-storage-sqlite/CI?style=flat-square)](https://github.com/Cap-go/capacitor-data-storage-sqlite/actions?query=workflow%3A%22CI%22) [![](https://img.shields.io/npm/l/capacitor-data-storage-sqlite.svg?style=flat-square)](https://www.npmjs.com/package/Cap-go/capacitor-data-storage-sqlite)  
[![](https://img.shields.io/npm/dw/capacitor-data-storage-sqlite?style=flat-square)](https://www.npmjs.com/package/Cap-go/capacitor-data-storage-sqlite) [![](https://img.shields.io/npm/v/capacitor-data-storage-sqlite?style=flat-square)](https://www.npmjs.com/package/Cap-go/capacitor-data-storage-sqlite) [![](https://img.shields.io/badge/all%20contributors-4-orange?style=flat-square)](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-contributors-)

## 维护者

| 维护者 | GitHub 图像 | 社会 |
| --- | --- | --- |
| 马丁·多纳迪厄 | [骑师x](https://github.com/riderx) |  |
| 让·皮埃尔 | [耶稣会](https://github.com/jepiqueau) |  |

## 浏览器支持

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

-   [Capacitor 浏览器支持](https://capacitorjs.com/docs/v3/web#browser-support)

意思是,如果没有额外的 JavaScript 转换, 它将无法在 IE11 中工作, 例如: [宝贝](https://babeljs.io/)。 。 。 .

## 文档

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

## 兼容性

| 插件版本 | 电容兼容性 | 维护 |
| --- | --- | --- |
| 联合国 | 联合国 | ✅ |
| 页:1 | 页:1 | 应要求 |
| 页:1 | 页:1 | ❌ |
| 页:1 | 页:1 | ❌ |

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

## 安装

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

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

然后使用下列提示:

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

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

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

-   在iOS方面,无需采取进一步措施.
    
-   在Android上,不需要进一步的步骤.
    
-   网上,
    

```bash
npm install --save localforage
```

-   在电上

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

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

```bash
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
```

## 配置

此插件不需要配置

## 支持的方法

| 名称 | 机器人 | iOS系统 | 电子 | 网页 |
| --- | --- | --- | :-- | :-- |
| 打开Store( 非加密 DB) | ✅ | ✅ | ✅ | ✅ |
| 打开 Store (加密 DB) | ✅ | ✅ | ❌ | ❌ |
| 关闭 Store | ✅ | ✅ | ✅ | ❌ |
| 是 Store 打开 | ✅ | ✅ | ✅ | ❌ |
| 已存在 | ✅ | ✅ | ✅ | ❌ |
| 删除Store | ✅ | ✅ | ✅ | ❌ |
| 设置表格 | ✅ | ✅ | ✅ | ✅ |
| 设定 | ✅ | ✅ | ✅ | ✅ |
| 起来 | ✅ | ✅ | ✅ | ✅ |
| 键 | ✅ | ✅ | ✅ | ✅ |
| 密钥 | ✅ | ✅ | ✅ | ✅ |
| 数值 | ✅ | ✅ | ✅ | ✅ |
| 过滤值 | ✅ | ✅ | ✅ | ✅ |
| 键值 | ✅ | ✅ | ✅ | ✅ |
| 删除 | ✅ | ✅ | ✅ | ✅ |
| 清除 | ✅ | ✅ | ✅ | ✅ |
| 列表 | ✅ | ✅ | ✅ | ✅ |
| 图表 | ✅ | ✅ | ✅ | ✅ |
| 删除表格 | ✅ | ✅ | ✅ | ❌ |
| 这是杰森瓦利德 | ✅ | ✅ | ✅ | ✅ |
| 从 Json 导入 | ✅ | ✅ | ✅ | ✅ |
| 导出 ToJson | ✅ | ✅ | ✅ | ✅ |

## 文档

-   [API 文档](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/docs/API.md)
    
-   [使用文件( U)](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/docs/USAGE.md)
    

## 显示插件用途的应用程序

### 离子/角

-   [角-数据存储-sqlite-app启动器](https://github.com/Cap-go/angular-data-storage-sqlite-app-starter)

### 音效/反应

-   [反应-数据存储-sqlite-app启动器](https://github.com/Cap-go/react-data-storage-sqlite-app-starter)

### 反应

-   [反应- 数据库qlite- app](https://github.com/Cap-go/react-datastoragesqlite-app)

### 音响/声调

-   [vue-data-sklite-app启动程序](https://github.com/Cap-go/vue-data-storage-sqlite-app-starter)

### 阴道

-   [vue-datatoragesqlite-app 数据存储器](https://github.com/Cap-go/vue-datastoragesqlite-app)

## 使用量

-   [参见电容器文档](https://capacitor.ionicframework.com/docs/getting-started/with-ionic)
    
-   [参见 USAGE 文档](https://github.com/Cap-go/capacitor-data-storage-sqlite/blob/master/docs/USAGE.md)
    

## 依赖关系

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

## 数据库加密密码句

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

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

```ts
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 密钥](https://allcontributors.org/docs/en/emoji-key):

<table><tbody><tr><td align="center"><a href="https://github.com/jepiqueau" rel="nofollow noopener noreferrer"><img alt="" src="https://avatars3.githubusercontent.com/u/16580653?v=4" width="100px;" loading="lazy" decoding="async" referrerpolicy="no-referrer"><br><sub><b>让·皮埃尔·克约</b></sub></a><br><a href="https://github.com/capacitor-data-storage-sqlite/commits?author=jepiqueau" title="Code" rel="nofollow noopener noreferrer">💻</a></td><td align="center"><a href="https://github.com/mwpb" rel="nofollow noopener noreferrer"><img alt="" src="https://avatars.githubusercontent.com/u/12957941?v=4" width="100px;" loading="lazy" decoding="async" referrerpolicy="no-referrer"><br><sub><b>马修·伯克</b></sub></a><br><a href="https://github.com/capacitor-data-storage-sqlite/commits?author=jepiqueau" title="Documentation" rel="nofollow noopener noreferrer">📖</a></td><td align="center"><a href="https://github.com/mwpb" rel="nofollow noopener noreferrer"><img alt="" src="https://avatars.githubusercontent.com/u/1745820?v=4" width="100px;" loading="lazy" decoding="async" referrerpolicy="no-referrer"><br><sub><b>凯文·范沙伊克</b></sub></a><br><a href="https://github.com/capacitor-data-storage-sqlite/commits?author=jepiqueau" title="Code" rel="nofollow noopener noreferrer">💻</a></td><td align="center"><a href="https://github.com/garbit" rel="nofollow noopener noreferrer"><img alt="" src="https://avatars.githubusercontent.com/u/555396?v=4" width="100px;" loading="lazy" decoding="async" referrerpolicy="no-referrer"><br><sub><b>安迪・加贝特</b></sub></a><br><a href="https://github.com/capacitor-data-storage-sqlite/commits?author=jepiqueau" title="Documentation" rel="nofollow noopener noreferrer">📖</a></td></tr></tbody></table>

-   [`openStore(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-openstore)
-   [`closeStore(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-closestore)
-   [`isStoreOpen(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-isstoreopen)
-   [`isStoreExists(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-isstoreexists)
-   [`deleteStore(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-deletestore)
-   [`setTable(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-settable)
-   [`set(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-set)
-   [`get(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-get)
-   [`remove(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-remove)
-   [`clear()`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-clear)
-   [`iskey(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-iskey)
-   [`keys()`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-keys)
-   [`values()`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-values)
-   [`filtervalues(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-filtervalues)
-   [`keysvalues()`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-keysvalues)
-   [`isTable(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-istable)
-   [`tables()`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-tables)
-   [`deleteTable(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-deletetable)
-   [`importFromJson(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-importfromjson)
-   [`isJsonValid(...)`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-isjsonvalid)
-   [`exportToJson()`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-exporttojson)
-   [`vacuum()`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-vacuum)
-   [`getPluginVersion()`](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-getpluginversion)
-   [接口](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-type-aliases)

### 打开Store(...)

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

打开商店

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[capOpenStorageOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capopenstorageoptions)` | 数字 : [封顶](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capopenstorageoptions) |

**自:** 0.0.1 资源

* * *

### 关闭Store(...)

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

关闭存储

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[capStorageOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capstorageoptions)` | 数字 : [笼盖](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capstorageoptions) |

**自:** 3.0.0 (单位:千美元)

* * *

### 是 Store 打开(...)

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

检查仓库是否打开

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[capStorageOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capstorageoptions)` | 数字 : [笼盖](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capstorageoptions) |

**回返情况:** `Promise<[capDataStorageResult](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageresult)>`

**自:** 3.0.0 (单位:千美元)

* * *

### 属于 StoreExists (...)

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

检查仓库是否存在

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[capStorageOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capstorageoptions)` | 数字 : [笼盖](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capstorageoptions) |

**回返情况:** `Promise<[capDataStorageResult](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageresult)>`

**自:** 3.0.0 (单位:千美元)

* * *

### 删除Store(...)

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

删除存储

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[capOpenStorageOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capopenstorageoptions)` | 数字 : [封顶](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capopenstorageoptions) |

**自:** 0.0.1 资源

* * *

### 设置表格(...)

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

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

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[capTableStorageOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-captablestorageoptions)` | 数字 : [封面表组合选项](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-captablestorageoptions) |

**自:** 0.0.1 资源

* * *

### 设置(...)

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

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

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[capDataStorageOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageoptions)` | 数字 : [capDataStorage 选项](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageoptions) |

**自:** 0.0.1 资源

* * *

### 获取(...)

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

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

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[capDataStorageOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageoptions)` | 数字 : [capDataStorage 选项](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageoptions) |

**回返情况:** `Promise<[capValueResult](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capvalueresult)>`

**自:** 0.0.1 资源

* * *

### 删除(...)

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

用给定的密钥删除数据

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[capDataStorageOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageoptions)` | 数字 : [capDataStorage 选项](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageoptions) |

**自:** 0.0.1 资源

* * *

### 清除( c)

```typescript
clear() => Promise<void>
```

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

**自:** 0.0.1 资源

* * *

### 异键(...)

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

检查数据密钥是否存在

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[capDataStorageOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageoptions)` | 数字 : [capDataStorage 选项](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageoptions) |

**回返情况:** `Promise<[capDataStorageResult](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageresult)>`

**自:** 0.0.1 资源

* * *

### 键( )

```typescript
keys() => Promise<capKeysResult>
```

获取数据密钥列表

**回返情况:** `Promise<[capKeysResult](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capkeysresult)>`

**自:** 0.0.1 资源

* * *

### 数值()

```typescript
values() => Promise<capValuesResult>
```

获取数据值列表

**回返情况:** `Promise<[capValuesResult](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capvaluesresult)>`

**自:** 0.0.1 资源

* * *

### 过滤值(...)

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

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

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[capFilterStorageOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capfilterstorageoptions)` | 数字 : [笼盖](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capfilterstorageoptions) |

**回返情况:** `Promise<[capValuesResult](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capvaluesresult)>`

**自:** 2.4.2

* * *

### 键值( )

```typescript
keysvalues() => Promise<capKeysValuesResult>
```

获取数据密钥/ 值对列表

**回返情况:** `Promise<[capKeysValuesResult](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capkeysvaluesresult)>`

**自:** 0.0.1 资源

* * *

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

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

检查是否有表格

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[capTableStorageOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-captablestorageoptions)` | 数字 : [封面表组合选项](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-captablestorageoptions) |

**回返情况:** `Promise<[capDataStorageResult](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageresult)>`

**自:** 3.0.0 (单位:千美元)

* * *

### 表格( )

```typescript
tables() => Promise<capTablesResult>
```

获取当前存储的表格列表

**回返情况:** `Promise<[capTablesResult](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-captablesresult)>`

**自:** 3.0.0 (单位:千美元)

* * *

### 删除表格(...)

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

删除表格

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[capTableStorageOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-captablestorageoptions)` | 数字 : [封面表组合选项](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-captablestorageoptions) |

**自:** 3.0.0 (单位:千美元)

* * *

### 从 Json (...) 导入

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

从 JSON 从数据库导入

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[capStoreImportOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capstoreimportoptions)` |

**回返情况:** `Promise<[capDataStorageChanges](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastoragechanges)>`

**自:** 3.2.0 (中文(简体) )

* * *

### 是 JsonValid (...) 语句

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

检查 JSON 对象的有效性

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[capStoreImportOptions](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capstoreimportoptions)` |

**回返情况:** `Promise<[capDataStorageResult](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageresult)>`

**自:** 3.2.0 (中文(简体) )

* * *

### 导出 ToJson ()

```typescript
exportToJson() => Promise<capStoreJson>
```

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

**回返情况:** `Promise<[capStoreJson](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capstorejson)>`

**自:** 3.2.0 (中文(简体) )

* * *

### 真空( )

```typescript
vacuum() => Promise<void>
```

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

**自:** 8.032 电话

* * *

### 获取 PluginVersion ()

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

获取本地 Capacitor 插件版本

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

* * *

### 接口

#### 封顶

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`database`** | `string` | 存储数据库名称 |
| **`table`** | `string` | 存储表名称 |
| **`encrypted`** | `boolean` | 数据库加密设置为正 |
| **`mode`** | `string` | 在iOS和Android上设置数据库加密模式。 - `encryption` - 用已配置的密码句加密一个已存在的纯文本数据库 - `secret` ——打开或创建带有所配置的密码句的加密数据库 - `newsecret` ——重接加密数据库 `encryptionSecret` 改为 `encryptionNewSecret` 密码句设置在 `capacitor.config` 下级 `plugins.CapgoCapacitorDataStorageSqlite` (见QQLink Capgo CapacitorDataStorageSqlite Config}). 默认在插件中定义 `Global` 源,如果您不配置它们. |
| **`autoVacuum`** | `[capSQLiteAutoVacuum](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capsqliteautovacuum)` | 为商店设置 SQLite 自动 vacuum 模式 。 使用 `none`编号 :`0`, (中文(简体) ), `full`编号 :`1`,或 `incremental`编号 :`2`iOS,Android,以及只有电能. Web 忽略此选项 . |

#### 笼盖

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`database`** | `string` | 存储名称 |

#### capDataStorage 结果

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`result`** | `boolean` | 当成功时结果被设定为真实 |
| **`message`** | `string` | 返回的消息 |

#### 封面表组合选项

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`table`** | `string` | 存储表名称 |

#### capDataStorage 选项

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`key`** | `string` | 数据名称 |
| **`value`** | `string` | 所需数据值 |

#### 上限

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`value`** | `string` | 给定数据密钥的数据值 |

#### capeKeys 结果

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`keys`** | `string[]` | 作为矩阵的数据密钥列表 |

#### 上限

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`values`** | `string[]` | 作为矩阵的数据值列表 |

#### 笼盖

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`filter`** | `string` | 用于过滤密钥的过滤数据 \['% filter',"filter","filter%"\],用于\[从过滤器开始,包含过滤器,以过滤器结束\] |

#### capeKeysValues 结果

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`keysvalues`** | `any[]` | 数据密钥/ 值列表为 { key: string, value: string} 的矩阵 |

#### 封顶表

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`tables`** | `string[]` | 表格列表为矩阵 |

#### capDataStorage 变化

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`changes`** | `number` | 导入的 FromJson 命令的更改数 |

#### 封口导入选项

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`jsonstring`** | `string` | 设定要导入的 JSON 对象 |

#### 盖斯多尔杰森

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`export`** | `[JsonStore](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-jsonstore)` | 导出 JSON 对象 |

#### 杰森斯托尔

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`database`** | `string` | 数据库名称 |
| **`encrypted`** | `boolean` | 设定为真( 数据库加密) / 假的 iOS & Android |
| **`tables`** | `JsonTable[]` | \* 表数组([Json表单](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-jsontable)(中文(简体) ) |

#### Json表单

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`name`** | `string` | 数据库名称 |
| **`values`** | `capDataStorageOptions[]` | \* 数值矩阵([capDataStorage 选项](https://npmcn.com/package/%40capgo/capacitor-data-storage-sqlite/#readme-capdatastorageoptions)(中文(简体) ) |

### 类型异名

#### capSQLite 奥托沃库姆

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

本项目遵循 [全部贡献者](https://github.com/all-contributors/all-contributors) 规格。 任何捐款都欢迎!

@jepiqueau的退休信息 -- >

  

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

  

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

  

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

  

结束 < -

## 常见问题

### @capgo/capacitor-data-storage-sqlite 是什么？

SQLite 密钥/ 值字符串对的存储

### 如何安装 @capgo/capacitor-data-storage-sqlite？

在项目目录运行 npm install @capgo/capacitor-data-storage-sqlite，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：localforage（^1\.10\.0）、@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capgo/capacitor-data-storage-sqlite 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capgo/capacitor-data-storage-sqlite 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capgo/capacitor-data-storage-sqlite 可以商用吗？

@capgo/capacitor-data-storage-sqlite 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @capgo/capacitor-data-storage-sqlite 的下载量有多少？

根据 npm 官方下载统计，@capgo/capacitor-data-storage-sqlite 在 2026/10/09 – 2026/11/07 这 30 天内被下载 43,798 次，日均约 1,460 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capgo/capacitor-data-storage-sqlite 还在维护吗？

最新版本 8\.0\.60 发布于 2026/11/09（今天）；至今共发布 138 个版本，其中过去 12 个月发布了 65 个；首次发布于 2024/08/15。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

