Getting Started
Einen Einrichtungsprompt mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen Plugin kopieren.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-data-storage-sqlite`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/data-storage-sqlite/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Installieren
EinrichtenSie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihrer AI-Anwendung mit folgendem Befehl hinzu:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsDann verwenden Sie folgende Anfrage:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-data-storage-sqlite` plugin in my project.Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den unten angegebenen Plattform-spezifischen Anweisungen:
bun add @capgo/capacitor-data-storage-sqlitebunx cap syncImportieren
Abschnitt mit dem Titel „Importieren“import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';API-Übersicht
Abschnitt mit dem Titel „API Übersicht“openStore
Abschnitt mit dem Titel „openStore“Ein Laden öffnen
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.openStore({} as capOpenStorageOptions);closeStore
Abschnitt mit dem Titel „closeStore“Den Laden schließen
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.closeStore({} as capStorageOptions);isStoreOpen
Überprüfen, ob der Laden geöffnet istIn die Zwischenablage kopieren
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.isStoreOpen({} as capStorageOptions);isStoreExists
In die Zwischenablage kopierenAbschnitt mit dem Titel „isStoreExists“
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.isStoreExists({} as capStorageOptions);deleteStore
Abschnitt mit dem Titel „Löschen des Stores“Ein Store löschen
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.deleteStore({} as capOpenStorageOptions);Eine Tabelle zu einem bestehenden Store hinzufügen oder bearbeiten
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.setTable({} as capTableStorageOptions);Ein Datenpaar mit gegebener Schlüssel und Wert speichern
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.set({} as capDataStorageOptions);Ein Datenwert für einen gegebenen Daten-Schlüssel abrufen
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.get({} as capDataStorageOptions);Entferne eine Daten mit der gegebenen Schlüssel
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.remove({} as capDataStorageOptions);Daten Speicher löschen (alle Schlüssel entfernen)
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.clear();Überprüfe, ob eine Daten Schlüssel existiert
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.iskey({} as capDataStorageOptions);Daten Schlüssel Liste abrufen
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.keys();Liste der Datenwerte abrufen
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.values();filtervalues
Abschnitt mit dem Titel „Filterwerte“Liste der Datenwerte für Filter-Schlüssel abrufen
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.filtervalues({} as capFilterStorageOptions);Liste der Daten-Schlüssel/Wert-Paare abrufen
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.keysvalues();Überprüfen, ob eine Tabelle existiert
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.isTable({} as capTableStorageOptions);Liefere die Liste der Tabelle für den aktuellen Store
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.tables();deleteTable
Abschnitt mit dem Titel „deleteTable“Eine Tabelle löschen
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.deleteTable({} as capTableStorageOptions);importFromJson
Abschnitt mit dem Titel „importFromJson“Eine Datenbank aus einem JSON importieren
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.importFromJson({} as capStoreImportOptions);isJsonValid
Abschnitt mit dem Titel „isJsonValid“Überprüfe die Gültigkeit eines JSON-Objekts
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.isJsonValid({} as capStoreImportOptions);exportToJson
Abschnitt mit dem Titel „exportToJson“Die gegebene Datenbank in ein JSON-Objekt exportieren
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.exportToJson();Typenverweis
Abschnitt mit dem Titel „Typenverweis“capOpenStorageOptions
Abschnitt mit dem Titel „capOpenStorageOptions“export interface capOpenStorageOptions { /** * The storage database name */ database?: string; // default: // ios, android: storageSQLite // web : storageIDB /** * The storage table name */ table?: string; // default: // ios, android: storage_table // web: storage_store /** * Set to true for database encryption */ encrypted?: boolean; // only for ios and android /*** * Set the mode for database encryption * ["encryption", "secret","newsecret"] */ mode?: string; // only for ios and android}capStorageOptions
Abschnitt mit dem Titel „capStorageOptions“export interface capStorageOptions { /** * The storage name */ database: string;}capDataStorageResult
Abschnitt mit dem Titel „capDataStorageResult“export interface capDataStorageResult { /** * result set to true when successful else false */ result?: boolean; /** * a returned message */ message?: string;}capTableStorageOptions
Abschnitt mit dem Titel "capTableStorageOptions"export interface capTableStorageOptions { /** * The storage table name */ table: string;}capDataStorageOptions
Abschnitt mit dem Titel "capDataStorageOptions"export interface capDataStorageOptions { /** * The data name */ key: string; /** * The data value when required */ value?: string;}capValueResult
Abschnitt mit dem Titel "capValueResult"export interface capValueResult { /** * the data value for a given data key */ value: string;}capKeysResult
Abschnitt mit dem Titel "capKeysResult"export interface capKeysResult { /** * the data key list as an Array */ keys: string[];}capValuesResult
Abschnitt mit dem Titel "capValuesResult"export interface capValuesResult { /** * the data values list as an Array */ values: string[];}capFilterStorageOptions
Abschnitt mit dem Titel "capFilterStorageOptions"export interface capFilterStorageOptions { /** * The filter data for filtering keys * * ['%filter', 'filter', 'filter%'] for * [starts with filter, contains filter, ends with filter] */ filter: string;}capKeysValuesResult
Abschnitt mit dem Titel “capKeysValuesResult”export interface capKeysValuesResult { /** * the data keys/values list as an Array of {key:string,value:string} */ keysvalues: any[];}capTablesResult
Abschnitt mit dem Titel “capTablesResult”export interface capTablesResult { /** * the tables list as an Array */ tables: string[];}capStoreImportOptions
Abschnitt mit dem Titel “capStoreImportOptions”export interface capStoreImportOptions { /** * Set the JSON object to import * */ jsonstring?: string;}Quellwahrheit
Abschnitt mit dem Titel “Quellwahrheit”Diese Seite wurde aus dem Plugin generiert. src/definitions.tsRe-run the sync when the public API changes upstream.
Weitermachen von Getting Started
Abschnitt mit dem Titel “Weitermachen von Getting Started”If Sie Storage und Datei-Handling planen, verbinden Sie es mit Zur Einführung um Storage und Datei-Handling zu planen, verbinden Sie es mit Verwenden Sie @capgo/capacitor-data-storage-sqlite Verwenden Sie @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-data-storage-sqlite Verwenden Sie @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file Verwenden Sie @capgo/capacitor-file, Verwenden Sie @capgo/capacitor-file um Storage und Datei-Handling zu planen, verbinden Sie es mit @capgo/capacitor-file, und @capgo/capacitor-uploader für die Implementierungsdetails in @capgo/capacitor-Uploader.