ガイド
Capacitor で Fast SQL を使う方法
@capgo/capacitor-fast-sql の使い方
高速な SQLite データベースアクセスを実現する Fast SQL プラグイン。
インストール
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クエリを実行します（簡易的なクエリ用）。大規模なデータセットで高いパフォーマンスが必要な場合は、SQLConnectionクラスを使用してHTTPプロトコルで直接通信してください。 |
beginTransaction |
データベーストランザクションを開始します。 |
commitTransaction |
現在のトランザクションをコミットします。 |
rollbackTransaction |
現在のトランザクションをロールバックします。 |
configureWeb |
公式のSQLite Wasmモジュール向けに、Web専用のオプションを設定します。 |
実装例
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クエリを実行します（簡易的なクエリ用）。大規模なデータセットで高いパフォーマンスが必要な場合は、SQLConnectionクラスを使用してHTTPプロトコルで直接通信してください。
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つのコアメソッドが記載されています。Listenerやversionヘルパー、および各メソッドの詳細な仕様については、以下に記載されています。 GitHub リポジトリ.
リファレンス全文
@capgo/capacitor-fast-sql の使い方から続ける
以下を使用している場合： @capgo/capacitor-fast-sql の使い方 ストレージとファイル処理を計画するには、次と連携させます @capgo/capacitor-fast-sql @capgo/capacitor-fast-sql の実装の詳細については、 はじめに Getting Started の実装の詳細については、 @capgo/capacitor-data-storage-sqlite @capgo/capacitor-data-storage-sqlite の実装の詳細については、 @capgo/capacitor-data-storage-sqlite の使い方 「@capgo/capacitor-data-storage-sqlite の使い方」のネイティブ機能については、また @capgo/capacitor-file @capgo/capacitor-file. の実装の詳細については