複数の保存先を使う

複数ストレージへの書き込みと読み取り時の書き戻しを設定する手順です。

高速な保存先と永続的な保存先を組み合わせる場合などに、複数のストレージを登録します。

複数ストレージを登録する

persist() を複数回呼ぶと、すべての保存先に並列で書き込みます。読み取りは登録順に確認し、最初に見つかった保存先の値を返します。

import { Memory } from "@unikvs/memory";
import { NodeFs } from "@unikvs/fs.node";
import * as unikvs from "unikvs";

const kvs = new unikvs.Builder<{
  profile: unikvs.PlainValue<Uint8Array>;
}>()
  .persist(new Memory())
  .persist(new NodeFs(".unikvs"))
  .build();

上記の例では、書き込みはメモリーとファイルの両方に行い、読み取りはメモリーを先に確認します。

copy() と move() も、コピー元・移動元が存在するすべての保存先に適用されます。一部の保存先にだけコピー元・移動元がある場合は、存在する保存先だけが更新されます。どの保存先にも存在しない場合は KeyNotFoundError になります。

読み取り時に書き戻す

get() と stream() は repair: true を指定すると、後段で見つかった値を前段へ書き戻します。既定値は false です。

const bytes = await kvs.get("profile", { repair: true });

書き戻しを制御したい場合は、@unikvs/allow-repair を使います。書き戻しを許可しない分岐では、読み取り自体は成功し、警告ログに残ります。拒否時に読み取りも失敗させたい場合は throwOnRepairDenied: true を指定します。

import { AllowRepair } from "@unikvs/allow-repair";

const noRepair = new AllowRepair();
noRepair.disable();

const kvs = new unikvs.Builder<{
  profile: unikvs.PlainValue<Uint8Array>;
}>()
  .persist(new Memory())
  .fork(new unikvs.Branch().use(noRepair).persist(new NodeFs(".unikvs")))
  .build();

保存先ごとに変換を変える

fork() は分岐ごとに異なるミドルウェアの組み合わせを使いたい場合に使います。各保存先は、persist() 呼び出し時点のパイプラインのスナップショットを使います。そのため、分岐後に追加したミドルウェアは、すでに登録済みの保存先には影響しません。

import { Json } from "@unikvs/json";
import { Memory } from "@unikvs/memory";
import { NodeFs } from "@unikvs/fs.node";
import * as unikvs from "unikvs";

const kvs = new unikvs.Builder<{
  settings: unikvs.PlainValue<Uint8Array>;
}>()
  .fork(new unikvs.Branch().use(new Json()).persist(new Memory()))
  .persist(new NodeFs(".unikvs"))
  .build();

上記の例では、メモリー側だけ JSON 変換を適用し、ファイル側はバイト列のまま保存します。

動作の背景はアーキテクチャーを参照してください。
保存先の選び方はストレージ比較を参照してください。
パッケージ固有の注意は各パッケージリファレンスを参照してください。