Getting Started

インストール

AI-Assisted セットアップを使用してプラグインをインストールすることができます。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.

Manual セットアップを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

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

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

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

Web環境のsql.js WASMモジュールのためのオプションを設定します。

このメソッドを呼び出してください 最初の ローカルにバンドルされたパスからデフォルトのCDNではなくsql.jsを読み込む前に connect() 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

sql.js WASMモジュールのWebプラットフォーム設定。 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パブリック API がアップストリームで変更された場合に再度同期を実行してください。

Getting Started から続けて

Capacitor を使用している場合 Getting Started API ダッシュボードと運用計画の作成に役立つプラットフォームに接続します。 @capgo/capacitor-fast-sql を使用します。 @capgo/capacitor-fast-sql を使用して、ネイティブ機能を実装します。 API の概要 API の実装詳細については、以下を参照してください。 導入 __CAPGO_KEEP_0__ の実装詳細については、以下を参照してください。 API のキー API の実装詳細については、以下を参照してください。 デバイス デバイスの実装詳細については、以下を参照してください。