Getting Started

安装

您可以使用我们的 AI 助手设置来安装插件。使用以下命令将 Capgo 技能添加到您的 AI 工具中：

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

然后使用以下提示：

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

如果您prefer手动设置，请按照以下命令安装插件并遵循以下平台特定的说明：

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

导入

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

API概述

openStore

打开商店

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

await CapgoCapacitorDataStorageSqlite.openStore({} as capOpenStorageOptions);

closeStore

关闭商店

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

await CapgoCapacitorDataStorageSqlite.closeStore({} as capStorageOptions);

isStoreOpen

检查商店是否打开

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

await CapgoCapacitorDataStorageSqlite.isStoreOpen({} as capStorageOptions);

isStoreExists

检查是否存在商店

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

await CapgoCapacitorDataStorageSqlite.isStoreExists({} as capStorageOptions);

deleteStore

删除商店

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

await CapgoCapacitorDataStorageSqlite.deleteStore({} as capOpenStorageOptions);

setTable

将表格添加到现有的商店

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

await CapgoCapacitorDataStorageSqlite.setTable({} as capTableStorageOptions);

set

使用给定键和值存储数据

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

await CapgoCapacitorDataStorageSqlite.set({} as capDataStorageOptions);

get

根据给定的数据键获取数据值

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

await CapgoCapacitorDataStorageSqlite.get({} as capDataStorageOptions);

remove

根据给定的键删除数据

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

await CapgoCapacitorDataStorageSqlite.remove({} as capDataStorageOptions);

clear

清除数据存储（删除所有键）

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

await CapgoCapacitorDataStorageSqlite.clear();

iskey

检查数据键是否存在

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

await CapgoCapacitorDataStorageSqlite.iskey({} as capDataStorageOptions);

keys

获取数据键列表

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

await CapgoCapacitorDataStorageSqlite.keys();

values

获取数据值列表

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

await CapgoCapacitorDataStorageSqlite.values();

filtervalues

获取数据值列表（用于过滤键）

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

await CapgoCapacitorDataStorageSqlite.filtervalues({} as capFilterStorageOptions);

keysvalues

获取数据键值对列表

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

await CapgoCapacitorDataStorageSqlite.keysvalues();

isTable

检查当前商店是否存在表格

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

await CapgoCapacitorDataStorageSqlite.isTable({} as capTableStorageOptions);

tables

获取当前商店的表格列表

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

await CapgoCapacitorDataStorageSqlite.tables();

deleteTable

删除表格

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

await CapgoCapacitorDataStorageSqlite.deleteTable({} as capTableStorageOptions);

importFromJson

从 JSON 导入数据库

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

await CapgoCapacitorDataStorageSqlite.importFromJson({} as capStoreImportOptions);

isJsonValid

检查 JSON 对象的有效性

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

await CapgoCapacitorDataStorageSqlite.isJsonValid({} as capStoreImportOptions);

exportToJson

将给定的数据库导出为 JSON 对象

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

await CapgoCapacitorDataStorageSqlite.exportToJson();

类型参考

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

真实数据来源

本页面由插件生成 src/definitions.ts. 当公共 API 上游发生变化时，请重新同步。

继续从 Getting Started

如果您正在使用 Getting Started 来规划存储和文件处理，连接它到 使用 @capgo/capacitor-data-storage-sqlite 为 Using @capgo/capacitor-data-storage-sqlite 原生能力 @capgo/capacitor-data-storage-sqlite 为 @capgo/capacitor-data-storage-sqlite 实现细节 @capgo/capacitor-file 为 @capgo/capacitor-file 实现细节 使用 @capgo/capacitor-file 为原生能力在使用 @capgo/capacitor-file, 和 @capgo/capacitor-uploader 为实现细节在 @capgo/capacitor-uploader。