跳过主要内容
返回插件
@capgo/capacitor-fast-sql
教程
由 github.com/Cap-go

高性能本地SQLite

高性能本地SQLite提供自定义协议进行高效的同步操作和IndexedDB替代

指南

快速 SQL 教程

使用 @capgo/capacitor-fast-sql

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

安装

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

此插件暴露的内容

  • connect - 初始化数据库连接并启动 HTTP 服务器。
  • disconnect - 关闭数据库连接并停止 HTTP 服务器。
  • getServerInfo - 获取 HTTP 服务器端口和令牌以进行直接通信。
  • execute - 通过 Capacitor 桥执行 SQL 查询 (适用于简单查询)。对于大型数据集的更好性能,使用 HTTP 协议直接通过 SQLConnection 类。

示例用法

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

执行 SQL 查询通过 Capacitor 桥 (适用于简单查询)。对于大型数据集的更好性能,使用 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);

全局参考