使用 @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.