名前付きストアを開き、キーを設定して値をクエリできます。SQLを手書きする必要はありません。ストア内でテーブルを切り替え、JSONペイロードをマイグレーションし、OSサンドボックスを超える静止状態の保護が必要な場合にiOSとAndroidで暗号化を有効にできます。
典型的な使用例: オフライン設定、下書きフォーム、キャッシュされた API ペイロード、プロセス再起動後も維持される必要がある機能フラグ。
プラットフォーム対応
「プラットフォーム対応」という見出しのセクション| プラットフォーム | サポート | 備考 |
|---|---|---|
| iOSと | はい | コミュニティストレージレイヤー経由のSQLite |
| Androidでは | はい | 任意の暗号化付き SQLite |
| Web | はい | IndexedDBベースの実装 |
コア機能
「コア機能」セクションopenStore- ストアを開くcloseStore- ストアを閉じるisStoreOpen- ストアが開いているか確認するisStoreExists- ストアが存在するか確認する
公開 API
「Public 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オブジェクトにエクスポートします。 |
getPluginVersion | ネイティブの Capacitor プラグインのバージョンを取得します。 |
Source of Truth
「Source Of Truth」セクションこのリファレンスは以下から同期されています： src/definitions.ts における capacitor-data-storage-sqlite.
@capgo/capacitor-data-storage-sqliteから続ける
セクション「@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 を、 @capgo/capacitor-uploader の使用方法 ネイティブ機能は「@capgo/capacitor-uploader. の使用」を参照してください
