跳过主要内容
@capgo/capacitor-快速SQL 文件 & 存储 开源

快速 SQL Capacitor 插件

高性能本地SQLite,自定义协议,高效同步操作和 IndexedDB 替代

安装

bun add @capgo/capacitor-fast-sql bunx cap sync
npm,pnpm 或 yarn
  • npm install @capgo/capacitor-fast-sql
  • pnpm add @capgo/capacitor-fast-sql
  • yarn add @capgo/capacitor-fast-sql

指南

如何使用 Capacitor 快速 SQL

在设备上测试

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

快速 SQL 插件预览二维码 code

使用 @capgo/capacitor-fast-sql

快速 SQL 插件,高性能 SQLite 数据库访问

安装

bun add @capgo/capacitor-fast-sql
bunx cap sync

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

导入

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

API概览

方法 描述
connect 初始化数据库连接并启动HTTP服务器。
disconnect 关闭数据库连接并停止HTTP服务器。
getServerInfo 获取HTTP服务器端口和令牌以进行直接通信。
execute 通过Capacitor桥执行SQL查询(适用于简单查询)。对于大数据集的更好性能,请直接使用HTTP协议通过SQLConnection类。
beginTransaction 开始数据库事务。
commitTransaction 提交当前事务。
rollbackTransaction 回滚当前事务。
configureWeb Configure web-specific 选项以便于使用官方 SQLite Wasm 模块。

示例

connect()

初始化数据库连接并启动 HTTP 服务器。

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

const conn = await CapgoCapacitorFastSql.connect({ database: 'myapp' });
console.log('Connected on port:', conn.port);

disconnect()

关闭数据库连接并停止 HTTP 服务器。

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

await CapgoCapacitorFastSql.disconnect({ database: 'myapp' });

getServerInfo()

获取 HTTP 服务器端口和令牌以便于直接通信。

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

const info = await CapgoCapacitorFastSql.getServerInfo({ database: 'myapp' });
console.log('Server port:', info.port);

execute()

通过 Capacitor 桥执行 SQL 查询(适用于简单查询)。对于大型数据集的更好性能,请直接使用 HTTP 协议通过 SQLConnection 类。

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

const result = await CapgoCapacitorFastSql.execute({
  database: 'myapp',
  statement: 'SELECT * FROM users WHERE age > ?',
  params: [18]
});
console.log('Rows:', result.rows);

beginTransaction()

开始数据库事务。

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

await CapgoCapacitorFastSql.beginTransaction({ database: 'myapp' });
// Execute multiple operations
await CapgoCapacitorFastSql.commitTransaction({ database: 'myapp' });

commitTransaction()

提交当前事务。

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

await CapgoCapacitorFastSql.commitTransaction({ database: 'myapp' });

上表列出了 8 个核心方法。监听器和版本辅助函数,以及每个方法的完整契约,均在 GitHub 仓库.

全局参考

继续使用@capgo/capacitor-fast-sql

如果您正在使用 使用@capgo/capacitor-fast-sql 来规划存储和文件处理,连接它与 @capgo/capacitor-快速 SQL 以获取@capgo/capacitor-fast-sql 的实现细节 开始 获取@capgo/capacitor-data-storage-sqlite 关于@capgo/capacitor-data-storage-sqlite的实现细节。 使用@capgo/capacitor-data-storage-sqlite 为本地能力在使用@capgo/capacitor-data-storage-sqlite, 和 @capgo/capacitor文件 为实现细节在@capgo/capacitor-file.

常见问题

Fast SQL 插件常见问题

如何在 Capacitor 应用中安装 Fast SQL 插件?

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

@capgo/capacitor-fast-sql 与 React、Vue 和 Angular 是否兼容?

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

哪个 Capacitor 版本支持 @capgo/capacitor-fast-sql?

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

@capgo/capacitor-fast-sql 是否免费和开源?

是的。code 的源代码在 GitHub 上公开,网址为 https://github.com/Cap-go/capacitor-fast-sql/,并且该包可以从 npm 免费安装。欢迎 bug 报告和 pull 请求。

是否可以在不经过 App Store 审核的情况下更新使用 Fast SQL 的 code?

安装或升级插件会改变本机 code, 因此需要重新构建存储。 之后,JavaScript、HTML 和 CSS 的更改,调用插件的更改,可以立即与 Capgo 实时更新一起发布。

不必等待应用程序审查即可将快速 SQL 更改部署

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

开始使用 Capgo