Getting Started

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-fast-sql` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

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

インポート

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

API オーバービュー

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' });

rollbackTransaction

ロールバック

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

try {
  await CapgoCapacitorFastSql.beginTransaction({ database: 'myapp' });
  // Operations...
  await CapgoCapacitorFastSql.commitTransaction({ database: 'myapp' });
} catch (error) {
  await CapgoCapacitorFastSql.rollbackTransaction({ database: 'myapp' });
}

configureWeb

SQL.js WASM モジュールの Web 特有のオプションを設定

呼び出す 前 最初の connect() ローカルにバンドルされたパスから sql.js を読み込む代わりに、デフォルトの CDN を呼び出す。このメソッドは iOS と Android で何もしない。

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

// Configure once at app startup (web only)
await CapgoCapacitorFastSql.configureWeb({
  sqlJsUrl: '/assets/sql-wasm.js',
  wasmUrl: '/assets/sql-wasm.wasm',
});
const db = await FastSQL.connect({ database: 'myapp' });

型

SQLConnectionOptions

データベース接続オプション。

export interface SQLConnectionOptions {
  /**
   * Database name (file will be created in app data directory)
   */
  database: string;

  /**
   * Enable encryption (iOS/Android only)
   */
  encrypted?: boolean;

  /**
   * Encryption key (required if encrypted is true)
   */
  encryptionKey?: string;

  /**
   * Read-only mode
   */
  readOnly?: boolean;
}

SQLValue

プラグインがサポートするSQL値の種類。

export type SQLValue = string | number | boolean | null | Uint8Array;

SQLResult

SQLクエリの実行結果。

export interface SQLResult {
  /**
   * Rows returned by the query (for SELECT statements)
   */
  rows: SQLRow[];

  /**
   * Number of rows affected by the query (for INSERT/UPDATE/DELETE)
   */
  rowsAffected: number;

  /**
   * ID of the last inserted row (for INSERT statements with auto-increment)
   */
  insertId?: number;
}

IsolationLevel

トランザクションの隔離レベル。

export enum IsolationLevel {
  ReadUncommitted = 'READ UNCOMMITTED',
  ReadCommitted = 'READ COMMITTED',
  RepeatableRead = 'REPEATABLE READ',
  Serializable = 'SERIALIZABLE',
}

WebConfig

Webプラットフォームの設定ファイルは、sql.js WASMモジュールのために使用します。 configureWeb() を使用して、sql.jsをデフォルトのCDNからローカルにバンドルされたパスから読み込む代わりに。

export interface WebConfig {
  /**
   * URL to the sql.js JavaScript file (`sql-wasm.js`).
   * When omitted, the plugin loads from the cdnjs CDN.
   * @example '/assets/sql-wasm.js'
   */
  sqlJsUrl?: string;

  /**
   * URL to the sql.js WebAssembly binary (`sql-wasm.wasm`).
   * When omitted, the plugin loads from the cdnjs CDN.
   * @example '/assets/sql-wasm.wasm'
   */
  wasmUrl?: string;
}

SQLRow

SQL行結果 - 列名でインデックスされた値。

export interface SQLRow {
  [column: string]: SQLValue;
}

真実の源

このページはプラグインの src/definitions.ts. Re-run the sync when the public API changes upstream.

パブリック__CAPGO_KEEP_0__がアップストリームで変更されたときに、再度Syncを実行してください。

Capgoを使用している場合 はじめに ダッシュボードとAPIの作業を計画するには、 Capgoの@capgo/capacitor-fast-sqlを使用します Capgoの@capgo/capacitor-fast-sqlのネイティブ機能について APIの概要 APIの概要の実装詳細について 導入 導入の実装詳細について APIのキー APIのキーに関する実装詳細 デバイス デバイスの実装詳細について。