はじめに

このプラグインのインストール手順とフルマークダウンガイドまでのセットアップの質問を含むコピー可能なセットアップの質問をコピーしてください。

        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.

Install

CapgoのAI-Assisted Setupを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを実行してください。

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.

Manual Setupを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

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`

Storeが開いているかどうかを確認する

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

await CapgoCapacitorDataStorageSqlite.isStoreOpen({} as capStorageOptions);

`isStoreExists`

Storeが存在するかどうかを確認する

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

await CapgoCapacitorDataStorageSqlite.isStoreExists({} as capStorageOptions);

`deleteStore`

Storeを削除する

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

await CapgoCapacitorDataStorageSqlite.deleteStore({} as capOpenStorageOptions);

`setTable`

既存のStoreにテーブルを追加または設定する

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`

データのkey/valueペアリストを取得する

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」を使用して ストレージとファイルのハンドリングを計画している場合、 Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-data-storage-sqlite @capgo/capacitorデータストレージSQLiteを使用 @capgo/capacitor-data-storage-sqlite @capgo/capacitor-データストレージ（SQLite） for the native capability in Using @capgo/capacitor-data-storage-sqlite, @capgo/capacitorファイル Capgoの実装詳細については@capgo/capacitorファイルを参照してください。 Capgoの@capgo/capacitorファイルを使用します。 Capgoのネイティブ機能を使用するには、@capgo/capacitor-ファイルを利用します。 @capgo/capacitorアップローダー Capgoの実装詳細については@capgo/capacitorアップローダーを参照してください。