Iniziare

1. Installa il pacchetto

   npm

   npm i @capgo/capacitor-data-storage-sqlite

   pnpm

   pnpm add @capgo/capacitor-data-storage-sqlite

   yarn

   yarn add @capgo/capacitor-data-storage-sqlite

   bun

   bun add @capgo/capacitor-data-storage-sqlite

2. Sincronizza con i progetti nativi

   npm

   npx cap sync

   pnpm

   pnpm cap sync

   yarn

   yarn cap sync

   bun

   bunx cap sync

3. Configura il plugin

   Esempio di Archiviazione Base:

   import { CapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
   
   // Apri un database di archiviazione
   await CapacitorDataStorageSqlite.openStore({
     database: 'myapp_storage'
   });
   
   // Memorizza dati
   await CapacitorDataStorageSqlite.set({
     key: 'user_preferences',
     value: JSON.stringify({ theme: 'dark' })
   });

   Esempio di Archiviazione Crittografata:

   // Apri archiviazione crittografata
   await CapacitorDataStorageSqlite.openStore({
     database: 'secure_storage',
     encrypted: true,
     mode: 'encryption'
   });
   
   // Memorizza dati sensibili
   await CapacitorDataStorageSqlite.set({
     key: 'api_token',
     value: 'secret_token_value'
   });

   iOS

   Nessuna configurazione aggiuntiva richiesta per iOS.

   Android

   Nessuna configurazione aggiuntiva richiesta per Android.

4. Operazioni base

   import { CapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
   
   // Imposta un valore
   await CapacitorDataStorageSqlite.set({
     key: 'username',
     value: 'john_doe'
   });
   
   // Ottieni un valore
   const { value } = await CapacitorDataStorageSqlite.get({
     key: 'username'
   });
   console.log('Username:', value); // "john_doe"
   
   // Rimuovi un valore
   await CapacitorDataStorageSqlite.remove({
     key: 'username'
   });
   
   // Cancella tutti i dati
   await CapacitorDataStorageSqlite.clear();
   
   // Verifica se la chiave esiste
   const { result } = await CapacitorDataStorageSqlite.iskey({
     key: 'username'
   });
   console.log('La chiave esiste:', result); // true o false
   
   // Ottieni tutte le chiavi
   const { keys } = await CapacitorDataStorageSqlite.keys();
   console.log('Tutte le chiavi:', keys);
   
   // Ottieni tutti i valori
   const { values } = await CapacitorDataStorageSqlite.values();
   console.log('Tutti i valori:', values);

5. Utilizzo avanzato

   import { CapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
   
   export class StorageService {
     private dbName = 'app_storage';
     private isEncrypted = false;
   
     async initialize(encrypted = false) {
       this.isEncrypted = encrypted;
   
       // Apri archiviazione con opzioni
       await CapacitorDataStorageSqlite.openStore({
         database: this.dbName,
         encrypted: encrypted,
         mode: encrypted ? 'encryption' : 'no-encryption',
         version: 1
       });
     }
   
     // Metodi di archiviazione generici
     async setObject<T>(key: string, data: T): Promise<void> {
       const value = JSON.stringify(data);
       await CapacitorDataStorageSqlite.set({ key, value });
     }
   
     async getObject<T>(key: string): Promise<T | null> {
       try {
         const { value } = await CapacitorDataStorageSqlite.get({ key });
         return value ? JSON.parse(value) : null;
       } catch (error) {
         console.error('Errore nel recupero dell\'oggetto:', error);
         return null;
       }
     }
   
     // Operazioni batch
     async setMultiple(items: Record<string, any>): Promise<void> {
       for (const [key, value] of Object.entries(items)) {
         await CapacitorDataStorageSqlite.set({
           key,
           value: typeof value === 'string' ? value : JSON.stringify(value)
         });
       }
     }
   
     async getMultiple(keys: string[]): Promise<Record<string, any>> {
       const results: Record<string, any> = {};
   
       for (const key of keys) {
         try {
           const { value } = await CapacitorDataStorageSqlite.get({ key });
           results[key] = value;
         } catch (error) {
           results[key] = null;
         }
       }
   
       return results;
     }
   
     // Gestione tabelle
     async getTables(): Promise<string[]> {
       const { tables } = await CapacitorDataStorageSqlite.tables();
       return tables;
     }
   
     async deleteTable(table: string): Promise<void> {
       await CapacitorDataStorageSqlite.deleteTable({ table });
     }
   
     // Funzionalità Import/Export
     async exportToJson(): Promise<any[]> {
       const { keys } = await CapacitorDataStorageSqlite.keys();
       const { values } = await CapacitorDataStorageSqlite.values();
   
       return keys.map((key, index) => ({
         key,
         value: values[index]
       }));
     }
   
     async importFromJson(data: Array<{ key: string; value: string }>): Promise<void> {
       // Cancella dati esistenti
       await CapacitorDataStorageSqlite.clear();
   
       // Importa nuovi dati
       for (const item of data) {
         await CapacitorDataStorageSqlite.set({
           key: item.key,
           value: item.value
         });
       }
     }
   
     // Filtraggio e ricerca
     async keysStartingWith(prefix: string): Promise<string[]> {
       const { keys } = await CapacitorDataStorageSqlite.keys();
       return keys.filter(key => key.startsWith(prefix));
     }
   
     async filterByPrefix(prefix: string): Promise<Array<{ key: string; value: string }>> {
       const { keys } = await CapacitorDataStorageSqlite.keys();
       const { values } = await CapacitorDataStorageSqlite.values();
   
       const filtered: Array<{ key: string; value: string }> = [];
   
       keys.forEach((key, index) => {
         if (key.startsWith(prefix)) {
           filtered.push({ key, value: values[index] });
         }
       });
   
       return filtered;
     }
   
     // Chiudi il database quando hai finito
     async close(): Promise<void> {
       await CapacitorDataStorageSqlite.closeStore({
         database: this.dbName
       });
     }
   }
   
   // Esempio di utilizzo
   const storage = new StorageService();
   await storage.initialize(true); // Usa crittografia
   
   // Memorizza dati utente
   await storage.setObject('user_profile', {
     id: 123,
     name: 'John Doe',
     email: 'john@example.com'
   });
   
   // Recupera dati utente
   const profile = await storage.getObject<any>('user_profile');
   console.log('Profilo utente:', profile);

Riferimento API

Metodi

openStore(options: OpenStoreOptions)

Apre un database di archiviazione.

Parametri:

• options.database: string - Nome del database
• options.encrypted: boolean - Abilita crittografia
• options.mode: string - ‘encryption’ o ‘no-encryption’
• options.version: number - Versione del database

closeStore(options: CloseStoreOptions)

Chiude il database di archiviazione.

set(options: SetOptions)

Memorizza una coppia chiave-valore.

Parametri:

• options.key: string - Chiave di archiviazione
• options.value: string - Valore da memorizzare

get(options: GetOptions)

Recupera un valore per chiave.

Restituisce: Promise<{ value: string }>

remove(options: RemoveOptions)

Rimuove una coppia chiave-valore.

clear()

Cancella tutti i dati dall’archiviazione.

iskey(options: IskeyOptions)

Verifica se una chiave esiste.

Restituisce: Promise<{ result: boolean }>

keys()

Ottiene tutte le chiavi di archiviazione.

Restituisce: Promise<{ keys: string[] }>

values()

Ottiene tutti i valori di archiviazione.

Restituisce: Promise<{ values: string[] }>

tables()

Ottiene tutti i nomi delle tabelle.

Restituisce: Promise<{ tables: string[] }>

deleteTable(options: DeleteTableOptions)

Elimina una tabella specifica.

Interfacce

interface OpenStoreOptions {
  database: string;
  encrypted?: boolean;
  mode?: string;
  version?: number;
}

interface SetOptions {
  key: string;
  value: string;
}

interface GetOptions {
  key: string;
}

interface RemoveOptions {
  key: string;
}

Note sulle Piattaforme

iOS

• Utilizza SQLite3 con SQLCipher opzionale per la crittografia
• I dati persistono attraverso gli aggiornamenti dell’app
• Supporta iOS 11.0+

Android

• Utilizza SQLite con SQLCipher opzionale
• I dati persistono attraverso gli aggiornamenti dell’app
• Supporta Android 5.0 (API 21)+

Casi d’Uso Comuni

1. Preferenze Utente: Memorizza impostazioni e preferenze dell’app
2. Gestione Cache: Cache risposte API e dati
3. Archiviazione Offline: Memorizza dati per accesso offline
4. Gestione Sessioni: Gestisci sessioni utente in modo sicuro
5. Archiviazione Token: Memorizza token di autenticazione in modo sicuro

Best Practice

1. Usa la Crittografia per Dati Sensibili

   // Per dati sensibili come token
   await openStore({
     database: 'secure_db',
     encrypted: true,
     mode: 'encryption'
   });

2. Organizza le Chiavi con Prefissi

   // Usa prefissi per l'organizzazione
   await set({ key: 'user:123:profile', value: userData });
   await set({ key: 'cache:api:users', value: apiData });

3. Gestisci con Attenzione i Dati Grandi

   // Per oggetti grandi, considera la compressione
   const compressed = compress(largeData);
   await set({ key: 'large_data', value: compressed });

4. Pulizia Regolare

   // Rimuovi voci cache scadute
   const keys = await keys();
   for (const key of keys.keys) {
     if (key.startsWith('cache:') && isExpired(key)) {
       await remove({ key });
     }
   }

Risoluzione Problemi

Il database non si apre:

• Verifica che il nome del database sia valido (alfanumerico, trattini bassi)
• Assicurati che non ci siano caratteri speciali nel nome del database
• Verifica che la modalità di crittografia corrisponda al database esistente

I dati non persistono:

• Assicurati che openStore sia chiamato prima delle operazioni
• Verifica eventuali errori nella console
• Verifica che i nomi delle chiavi siano stringhe

Problemi di prestazioni:

• Evita di memorizzare valori molto grandi
• Usa operazioni batch quando possibile
• Considera l’uso di più database per diversi tipi di dati