Inizia

Installazione

Puoi utilizzare la nostra configurazione assistita da AI per installare il plugin. Aggiungi le Capgo competenze al tuo strumento AI utilizzando il seguente comando:

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

Poi utilizza il seguente prompt:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche del tuo sistema operativo qui sotto:

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 port 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 ponte (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 contexto: HTML frammento di testo da una stringa di Capgo UI più lunga (chiave genitrice `create_an_issue_and_discuss_before_working_on_a_new_feature`). Pagina/area: Sito web di marketing di Capgo. Ruolo: Paragrafo di marketing o legale lungo. Visto in: pagina contributing.astro. Chiave messaggio `create_an_issue_and_discuss_before_working_on_a_new_feature` (Crea un Issue e discuti prima di lavorare su una nuova funzionalità). | HTML frammento di testo da una stringa di Capgo UI più lunga (chiave genitrice `mention_issue_before_working`). Pagina/area: Sito web di marketing di Capgo. Ruolo: Frase di copia del sito web. Visto in: pagina contributing.astro. Chiave messaggio `mention_issue_before_working` (Menziona l'Issue prima di lavorare). connect() la prima

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

Copia nell'area di trasferimento

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

I tipi di valori SQL supportati dal plugin.

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

SQLResult

I risultati di un'execuzione di 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

I livelli di isolamento delle transazioni.

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. Utilizza 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 di una riga SQL - valori indicizzati dal nome della colonna.

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

Punto di verità

Questa pagina è generata dal plugin’s src/definitions.ts. Riavvia la sincronizzazione quando le modifiche pubbliche API si verificano su upstream.

Continua da qui: Getting Started

Se stai utilizzando Iniziare per pianificare il pannello di controllo e le operazioni API, connettilo con Utilizzare @capgo/capacitor-fast-sql per la capacità nativa in Utilizzare @capgo/capacitor-fast-sql, API Overview per i dettagli di implementazione in API Overview, Introduzione per i dettagli di implementazione in Introduzione, API Keys per i dettagli di implementazione in API Keys, e Dispositivi per i dettagli di implementazione nei dispositivi.