メインコンテンツへスキップ
@capgo/capacitor-data-storage-sqlite ファイルとストレージ オープンソース

データストレージ Capacitor プラグイン

シンプルな key-value API と暗号化サポートを備えた SQLite データベースでデータをローカルに保存

インストール

bun add @capgo/capacitor-data-storage-sqlite bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-data-storage-sqlite
  • pnpm add @capgo/capacitor-data-storage-sqlite
  • yarn add @capgo/capacitor-data-storage-sqlite

ガイド

Capacitor で Data Storage を使う方法

実機でテストする

Capgo アプリをダウンロードして、QR code をスキャンしてください。

Data StorageプラグインのプレビューQR code

@capgo/capacitor-data-storage-sqlite の使い方

キー/値の文字列ペアをSQLiteに保存します。

インストール

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

bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。

インポート

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

API の概要

メソッド 説明
openStore ストアを開きます。
closeStore ストアを閉じます。
isStoreOpen ストアが開いているか確認します。
isStoreExists ストアが存在するか確認します。
deleteStore ストアを削除します。
setTable 既存のストアにテーブルを設定または追加します。
set 指定したキーと値でデータを保存します。
get 指定したデータキーの値を取得します。
remove 指定したキーのデータを削除します。
clear Data Storeをクリアします(すべてのキーを削除)。
iskey データキーが存在するか確認します。
keys データキーのリストを取得します。
values データ値のリストを取得します。
filtervalues フィルタキーのデータ値リストを取得します。
keysvalues データキー/値ペアのリストを取得します。
isTable テーブルが存在するか確認します。
tables 現在のストアのテーブルリストを取得します。
deleteTable テーブルを削除します。
importFromJson JSONからデータベースをインポートします。
isJsonValid JSONオブジェクトの妥当性を確認します。
exportToJson 指定されたデータベースをJSONオブジェクトにエクスポートします。
vacuum 現在のSQLiteストアを再構築して、未使用のディスク領域を回収します。

例

openStore()

ストアを開きます。

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

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

closeStore()

ストアを閉じます。

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

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

isStoreOpen()

ストアが開いているか確認します。

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

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

isStoreExists()

ストアが存在するか確認します。

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

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

deleteStore()

ストアを削除します。

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

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

setTable()

既存のストアにテーブルを設定または追加します。

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

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

上記の表には22個のコアメソッドが記載されています。Listenerとversionヘルパー、および各メソッドの完全な仕様は、以下に記載されています。 GitHub リポジトリ.

完全なリファレンス

「@capgo/capacitor-data-storage-sqlite の使用」から続ける

使用している場合 @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. の実装の詳細については

よくある質問

Data Storage プラグイン FAQ

Capacitor アプリに Data Storage プラグインをインストールするには?

"bun add @capgo/capacitor-data-storage-sqlite"(または "npm install @capgo/capacitor-data-storage-sqlite")を実行し、次に "bunx cap sync" を実行して、iOS と Android プロジェクトがネイティブ code を認識するようにします。アプリの code から "@capgo/capacitor-data-storage-sqlite" をインポートします。

@capgo/capacitor-data-storage-sqlite は React、Vue、Angular で動作しますか?

はい。Data Storage は Capacitor パッケージなので、Ionic、React、Vue、Angular、Svelte、プレーン JavaScript を含む、Capacitor 内で動作するすべての Web フレームワークで利用できます。

@capgo/capacitor-data-storage-sqlite はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-data-storage-sqlite は無料かつオープンソースですか?

はい。ソース code は https://github.com/Cap-go/capacitor-data-storage-sqlite/ の GitHub で公開されており、npm から無料でインストールできます。バグレポートやプルリクエストをお待ちしています。

Data Storage を使用している code を、App Store のレビューなしで更新できますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリの審査を待たずに、Data Storageの変更をリリース

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める