Einstieg

Installieren

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

Importieren

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

API Übersicht

openStore

Ein Laden öffnen

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

await CapgoCapacitorDataStorageSqlite.openStore({} as capOpenStorageOptions);

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 ist

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

await CapgoCapacitorDataStorageSqlite.isStoreOpen({} as capStorageOptions);

isStoreExists

Überprüfen, ob der Laden existiert

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

await CapgoCapacitorDataStorageSqlite.isStoreExists({} as capStorageOptions);

deleteStore

Ein Laden löschen

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

await CapgoCapacitorDataStorageSqlite.deleteStore({} as capOpenStorageOptions);

setTable

Eine Tabelle in einem bestehenden Laden setzen oder hinzufügen

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

await CapgoCapacitorDataStorageSqlite.setTable({} as capTableStorageOptions);

set

Speichern Sie Daten mit der angegebenen Schlüssel-Wert-Kombination

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

await CapgoCapacitorDataStorageSqlite.set({} as capDataStorageOptions);

get

Abrufen Sie den Wert einer Datenkennung für eine gegebene Datenkennung

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

await CapgoCapacitorDataStorageSqlite.get({} as capDataStorageOptions);

remove

Löschen Sie Daten mit der angegebenen Schlüssel

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

await CapgoCapacitorDataStorageSqlite.remove({} as capDataStorageOptions);

clear

Löschen Sie alle Schlüssel im Data Store

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

await CapgoCapacitorDataStorageSqlite.clear();

iskey

Überprüfen, ob eine Daten-Schlüssel existiert

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

await CapgoCapacitorDataStorageSqlite.iskey({} as capDataStorageOptions);

keys

Liste der Daten-Schlüssel abrufen

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

await CapgoCapacitorDataStorageSqlite.keys();

values

Liste der Daten-Werte abrufen

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

await CapgoCapacitorDataStorageSqlite.values();

filtervalues

Liste der Daten-Werte für Filter-Schlüssel abrufen

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

await CapgoCapacitorDataStorageSqlite.filtervalues({} as capFilterStorageOptions);

keysvalues

Holen Sie sich die Liste der Schlüssel/Werte

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

await CapgoCapacitorDataStorageSqlite.keysvalues();

isTable

Überprüfen Sie, ob eine Tabelle existiert

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

await CapgoCapacitorDataStorageSqlite.isTable({} as capTableStorageOptions);

tables

Holen Sie sich die Liste der Tabelle für den aktuellen Speicherort

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

await CapgoCapacitorDataStorageSqlite.tables();

deleteTable

Löschen Sie eine Tabelle

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

await CapgoCapacitorDataStorageSqlite.deleteTable({} as capTableStorageOptions);

importFromJson

Ein Datenbank-Import aus einem JSON-File

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

await CapgoCapacitorDataStorageSqlite.importFromJson({} as capStoreImportOptions);

isJsonValid

Überprüfen Sie die Gültigkeit eines JSON-Objekts

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

await CapgoCapacitorDataStorageSqlite.isJsonValid({} as capStoreImportOptions);

exportToJson

Exportieren Sie die gegebene Datenbank als JSON-Objekt

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

await CapgoCapacitorDataStorageSqlite.exportToJson();

Typenreferenz

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

export interface capStorageOptions {
  /**
   * The storage name
   */
  database: string;
}

capDataStorageResult

export interface capDataStorageResult {
  /**
   * result set to true when successful else false
   */
  result?: boolean;
  /**
   * a returned message
   */
  message?: string;
}

capTableStorageOptions

export interface capTableStorageOptions {
  /**
   * The storage table name
   */
  table: string;
}

capDataStorageOptions

export interface capDataStorageOptions {
  /**
   * The data name
   */
  key: string;
  /**
   * The data value when required
   */
  value?: string;
}

capValueResult

export interface capValueResult {
  /**
   * the data value for a given data key
   */
  value: string;
}

capKeysResult

export interface capKeysResult {
  /**
   * the data key list as an Array
   */
  keys: string[];
}

capValuesResult

export interface capValuesResult {
  /**
   * the data values list as an Array
   */
  values: string[];
}

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

export interface capKeysValuesResult {
  /**
   * the data keys/values list as an Array of {key:string,value:string}
   */
  keysvalues: any[];
}

capTablesResult

export interface capTablesResult {
  /**
   * the tables list as an Array
   */
  tables: string[];
}

capStoreImportOptions

export interface capStoreImportOptions {
  /**
   * Set the JSON object to import
   *
   */
  jsonstring?: string;
}

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API upstream ändert.

Weiter von Getting Started

Wenn Sie Getting Started zur Planung von Speicher und Dateimanagement verwenden, verbinden Sie es mit Mit @capgo/capacitor-data-storage-sqlite für die native Fähigkeit in Mit @capgo/capacitor-data-storage-sqlite @capgo/capacitor-data-storage-sqlite für die Implementierungsdetails in @capgo/capacitor-datenspeicher-sqlite, @capgo/capacitor-datei für die Implementierungsdetails in @capgo/capacitor-datei, Mit @capgo/capacitor-datei für die native Fähigkeit in Mit @capgo/capacitor-datei, und @capgo/capacitor-hochloader für die Implementierungsdetails in @capgo/capacitor-hochloader.