Getting Started

Installieren

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

Importieren

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

API Übersicht

connect

Die Datenbankverbindung initialisieren und den HTTP-Server starten.

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

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

disconnect

Datenbankverbindung schließen und HTTP-Server beenden.

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

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

getServerInfo

Den HTTP-Server-Port und den Token für direkte Kommunikation abrufen.

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

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

execute

Ausführen Sie eine SQL-Anfrage über die Capacitor-Brücke (für einfache Abfragen). Für bessere Leistung bei großen Datensätzen verwenden Sie das HTTP-Protokoll direkt über die SQLConnection-Klasse.

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

Eine Datenbanktransaktion beginnen.

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

await CapgoCapacitorFastSql.beginTransaction({ database: 'myapp' });
// Execute multiple operations
await CapgoCapacitorFastSql.commitTransaction({ database: 'myapp' });

commitTransaction

Die aktuelle Transaktion bestätigen.

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

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

rollbackTransaction

Die aktuelle Transaktion rückgängig machen.

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

Konfigurieren Sie web-spezifische Optionen für das sql.js WASM-Modul.

Rufen Sie diesen vor dem ersten connect() Aufruf zum Laden von sql.js aus einem lokal verpackten Pfad anstatt der Standard-CDN auf. Diese Methode ist ein no-op auf iOS und 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' });

Typenverweis

SQLConnectionOptions

Datenbankverbindungsoptionen.

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-Typen, die vom Plugin unterstützt werden.

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

SQLResult

Ausführungsergebnis einer SQL-Anfrage.

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

Transaktionsisolationsebenen.

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

WebConfig

Web-Plattform-Konfiguration für das sql.js-WASM-Modul. Verwenden Sie es mit configureWeb() um sql.js von einem lokal verpackten Pfad zu laden anstatt der Standard-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-Datensatz-Ergebnis - Werte indiziert durch Spaltenname.

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API sich im Hintergrund ändert.

Fortsetzen von Getting Started

Wenn Sie " Getting Started " verwenden, um das Dashboard und die API-Operationen zu planen, verbinden Sie es mit Mit @capgo/capacitor-fast-sql für die native Fähigkeit in Mit @capgo/capacitor-fast-sql, API Übersicht für die Implementierungsdetails in API Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.