Inizia

Sezione intitolata “Installa”

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

Importa

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

API Panoramica

connect

Inizializza la connessione al database e avvia il server HTTP.

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

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

disconnect

Chiudi la connessione al database e fermi il server HTTP.

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

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

getServerInfo

Ottieni il numero di porta del server HTTP e il token per la comunicazione diretta.

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

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

execute

Esegui una query SQL tramite Capacitor bridge (per query semplici). Per una maggiore prestazione con grandi set di dati, utilizza il protocollo HTTP direttamente tramite la classe 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

Inizia una transazione di database.

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

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

commitTransaction

Conferma la transazione corrente.

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

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

rollbackTransaction

Annulla la transazione corrente.

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

Configura le opzioni specifiche per il modulo sql.js WASM.

Chiamalo prima della prima connect() chiamata per caricare sql.js da un percorso bundle locale anziché dal CDN predefinito. Questo metodo è un no-op su iOS e 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' });

Riferimento ai tipi

SQLConnectionOptions

Opzioni di connessione al database.

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

Tipi di valori SQL supportati dal plugin.

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

SQLResult

Risultato dell'esecuzione di una query 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

Livelli di isolamento della transazione.

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

WebConfig

Configurazione della piattaforma web per il modulo sql.js WASM. Utilizzare con configureWeb() per caricare sql.js da un percorso localmente bundle invece del CDN predefinito.

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

Risultato della riga SQL - valori indicizzati dal nome della colonna.

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

Fonte di Verità

Questa pagina è generata dalla plugin’s. Ri-eseguire la sincronizzazione quando le modifiche pubbliche __CAPGO_KEEP_0__ sono aggiornate in alto. src/definitions.ts. Re-run the sync when the public API changes upstream.