スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください：

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

次に、以下のプロンプトを使用します：

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

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

npm install @capgo/capacitor-fast-sql
npx cap sync

インポート

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

クイックスタート

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

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

例: disconnect

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

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

例: getServerInfo

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

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

よくある落とし穴

• ネイティブ同期: 実行 npx cap sync プラグインのアップグレード後。
• 信頼できる情報源: 信頼 src/definitions.ts GitHub リポジトリ内。

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クエリを実行します（シンプルなクエリ向け）。 大規模なデータセットで高いパフォーマンスが必要な場合は、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' });

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() 呼び出すと、デフォルトのCDNではなくローカルにバンドルされたパスから sql.js を読み込みます。このメソッドは iOS と Android では no-op です。

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 platform configuration for the sql.js WASM module. Use with configureWeb() デフォルトのCDNではなく、ローカルにバンドルされたパスからsql.jsを読み込むには。

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

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-fast-sql の使用 @capgo/capacitor-fast-sql を使う際のネイティブ機能について、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。