Saltar al contenido principal
@capgo/capacitor-data-storage-sqlite Archivos y almacenamiento Código abierto

Almacenamiento de datos plugin Capacitor

Almacena datos localmente con SQLite usando API de clave-valor y soporte para cifrado

Instalar

bun add @capgo/capacitor-data-storage-sqlite bunx cap sync
npm, pnpm o yarn
  • npm install @capgo/capacitor-data-storage-sqlite
  • pnpm add @capgo/capacitor-data-storage-sqlite
  • yarn add @capgo/capacitor-data-storage-sqlite

Guía

Cómo usar Data Storage en Capacitor

Probar en el dispositivo

Descarga la app Capgo y escanea el QR code.

Vista previa QR del plugin Data Storage code

Uso de @capgo/capacitor-data-storage-sqlite

Almacenamiento SQLite de pares clave/valor (strings).

Instalar

bun add @capgo/capacitor-data-storage-sqlite
bunx cap sync

bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.

Importar

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

API de un vistazo

Método Descripción
openStore Abrir un store.
closeStore Cerrar el store.
isStoreOpen Comprobar si el store está abierto.
isStoreExists Comprobar si el store existe.
deleteStore Eliminar un store.
setTable Configurar o añadir una tabla a un store existente.
set Guardar un dato con una clave y un valor dados.
get Recuperar el valor de un dato para una clave de datos dada.
remove Eliminar un dato con una clave dada.
clear Limpiar el Data Store (borrar todas las claves).
iskey Comprobar si existe una clave de datos.
keys Obtener la lista de claves de datos.
values Obtener la lista de valores de datos.
filtervalues Obtener la lista de valores de datos para claves de filtro.
keysvalues Obtener la lista de pares clave/valor.
isTable Comprobar si existe una tabla.
tables Obtener la lista de tablas del store actual.
deleteTable Eliminar una tabla.
importFromJson Importar una base de datos desde un JSON.
isJsonValid Comprobar la validez de un objeto JSON.
exportToJson Exportar la base de datos indicada a un objeto JSON.
vacuum Reconstruir el store SQLite actual para recuperar el espacio en disco no utilizado.

Ejemplos

openStore()

Abrir un store.

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

await CapgoCapacitorDataStorageSqlite.openStore({
  database: 'database',
  table: 'table',
  encrypted: false,
  mode: 'encryption',
  autoVacuum: 'none',
});

closeStore()

Cerrar el store.

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

await CapgoCapacitorDataStorageSqlite.closeStore({ database: 'database' });

isStoreOpen()

Comprobar si el store está abierto.

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

const result = await CapgoCapacitorDataStorageSqlite.isStoreOpen({ database: 'database' });
console.log(result);

isStoreExists()

Comprobar si el store existe.

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

const result = await CapgoCapacitorDataStorageSqlite.isStoreExists({ database: 'database' });
console.log(result);

deleteStore()

Eliminar un store.

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

await CapgoCapacitorDataStorageSqlite.deleteStore({
  database: 'database',
  table: 'table',
  encrypted: false,
  mode: 'encryption',
  autoVacuum: 'none',
});

setTable()

Configurar o añadir una tabla a un store existente.

import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';

await CapgoCapacitorDataStorageSqlite.setTable({ table: 'table' });

La tabla anterior enumera los 22 métodos principales. Los helpers de Listener, de versión y el contrato completo de cada método están documentados en la repositorio GitHub.

Referencia completa

Continúa desde Uso de @capgo/capacitor-data-storage-sqlite

Si estás usando Uso de @capgo/capacitor-data-storage-sqlite para planificar el almacenamiento y la gestión de archivos, conéctalo con @capgo/capacitor-data-storage-sqlite para el detalle de implementación en @capgo/capacitor-data-storage-sqlite, Primeros pasos para los detalles de implementación en Primeros pasos, @capgo/capacitor-file para el detalle de implementación en @capgo/capacitor-file, Uso de @capgo/capacitor-file para la funcionalidad nativa en Uso de @capgo/capacitor-file, y @capgo/capacitor-uploader para el detalle de implementación en @capgo/capacitor-uploader.

FAQ

FAQ del plugin Data Storage

¿Cómo instalo el plugin Data Storage en una app Capacitor?

Ejecuta "bun add @capgo/capacitor-data-storage-sqlite" (o "npm install @capgo/capacitor-data-storage-sqlite"), luego ejecuta "bunx cap sync" para que los proyectos de iOS y Android detecten el code nativo. Impórtalo desde "@capgo/capacitor-data-storage-sqlite" en el code de tu app.

¿Funciona @capgo/capacitor-data-storage-sqlite con React, Vue y Angular?

Sí. Data Storage es un paquete Capacitor, por lo que funciona con cualquier framework web que corra dentro de Capacitor, incluyendo Ionic, React, Vue, Angular, Svelte y JavaScript puro.

¿Qué versión de Capacitor soporta @capgo/capacitor-data-storage-sqlite?

Los plugins de Capgo siguen la versión mayor de Capacitor: usa la versión mayor del plugin que coincida con la versión mayor de tu Capacitor (por ejemplo, el plugin v8 con Capacitor 8). La tabla de compatibilidad del README de GitHub lista las versiones mantenidas.

¿Es @capgo/capacitor-data-storage-sqlite gratuito y open source?

Sí. El código fuente de code es público en GitHub en https://github.com/Cap-go/capacitor-data-storage-sqlite/ y el paquete es gratuito en npm. Los reportes de bugs y pull requests son bienvenidos.

¿Puedo actualizar code que usa Data Storage sin pasar por la revisión de la App Store?

Instalar o actualizar el plugin cambia el code nativo, así que requiere un nuevo build para la tienda. Después, los cambios de JavaScript, HTML y CSS que llamen al plugin se pueden publicar al instante con las live updates de Capgo.

Lanza cambios en Data Storage sin esperar la revisión de la app

Una vez que el plugin esté en tu store build, Capgo live updates envía tus cambios de JavaScript, HTML y CSS a los usuarios en minutos.

Empieza con Capgo