DynamoDB のシングルトンアイテム
シングルトンアイテムとは、固定でハードコードされたキーを持つ単一の行で、アプリケーション全体の状態を保持します。ユーザーごとやドキュメントごとに 1 レコードではなく、1 つのレコードです。リレーショナルアプリなら 1 行の設定テーブルに保持するようなものです。
SQL から来ると、id = 1 を持つ config テーブルと SELECT * FROM config に手を伸ばすでしょう。DynamoDB では、ハードコードされたパーティションキーで同じことを行います。そのキーを常に知っているので、Query や Scan ではなく GetItem で読み取ります。
DynamoDB のシングルトンアイテムとは何か?
シングルトンアイテムとは、固定でハードコードされたキーの下に格納された単一の DynamoDB の行で、機能フラグや設定のブロブのような、アプリケーション全体のグローバルな状態を保持します。キーを常に知っているので、GetItem で読み取り、更新と条件式で更新します。
- シングルトンは定数キーを持つ 1 つのアイテム。 ユーザー ID やドキュメント ID をテンプレートに埋め込む代わりに、
PK/SK(例:SETTINGS#APP/FLAGS#V1)をコードにハードコードします。 ScanではなくGetItemで読む。 完全なキーを常に知っているので、ポイント読み取りのコストは平坦で予測可能です(4 KB までのアイテムなら最大 1 読み取りユニット)。- 定義上、ホットキー。 すべてのリクエストが同じパーティションに触れうるので、キャッシュしてアイテムを小さく保ちましょう。書き込みのボトルネックにしてはいけません。
- 更新式と条件式で安全に変更する。 アプリ内での読み取り-変更-書き込みは使いません。失われた更新の競合はそこに潜んでいます。
パターンを見分ける
データがどの 1 つのエンティティにもスコープされていないとき、あなたはグローバルな状態を抱えています。いくつかの兆候があります。
- 全員に対して同じフラグ(
signup_enabled = false)。 - アプリが起動時に読み込む調整項目のブロブ(レート制限、デフォルトのクォータ)。
- 行ごとではなく、システム全体のバージョン番号。
ユーザー、テナント、ドキュメントにスコープされたものは、シングルトンではありません。それはそのエンティティの ID でキー付けされた通常のアイテムです。シングルトンは、他にどこにも置き場所のない、残りのグローバルな部分です。
定数キーを与える
パターン全体は 1 つの決定にかかっています。キーはテンプレートではなくリテラルであることです。オーバーロードされた単一テーブル内のグローバルな機能フラグアイテムには、固定のプレフィックスと固定の値を選びます。
| PK | SK | attributes |
|---|---|---|
| SETTINGS#APP | FLAGS#V1 | signup_enabled, maintenance_mode, ai_search_enabled |
PK = "SETTINGS#APP" と SK = "FLAGS#V1" はコードに焼き付けられていて、ユーザー ID もテナント ID もありません。アプリケーションは毎回まさにこのアイテムを要求し、既知のキーは GetItem です。DynamoDB が提供する最も安価で最も予測可能な読み取りです。
V1 サフィックスは意図的です。後でフラグのスキーマの形が変わったら、稼働中のアイテムをその場で変更する代わりに、FLAGS#V2 アイテムを書き込んで読み手を切り替えます。シングルトンキーにバージョンを付けることで、きれいなマイグレーションの継ぎ目が手に入ります。
GetItem で読む
キーが完全にわかっているので、シングルトンに対して Query も Scan もしません。Scan はテーブル全体を読み取って(課金して)から、フィルターに一致しないものを捨てます。直接アドレス指定できる 1 行のための Scan の落とし穴です。
SETTINGS#APP / FLAGS#V1 に対する GetItem は、単一の強い整合性または結果整合性のある読み取りでフラグを返します。4 KB までのアイテムは、結果整合性で 0.5 読み取りユニット、強い整合性で 1 読み取りユニットかかります(DynamoDB の読み取りおよび書き込みオペレーション)。
これらはオンデマンドでは読み取りリクエストユニット、プロビジョンドキャパシティでは RCU です。シングルトンを小さく保てば、そのコストは横ばいのままです。設定のブロブが 2 つ目の 4 KB ブロックに膨らむと、課金される読み取りは 2 倍になります。
読み取りの経路では、アプリが起動するかリクエストが到着したときに固定キーを GetItem し、結果をキャッシュします。流れは次のとおりです。
固定キーは、グローバルな参照を、組み込みのデフォルト経路を持つ 1 回のポイント読み取りに変えます。
いいえ の分岐に注意してください。シングルトンが見つからなくても、決してクラッシュすべきではありません。初回デプロイの隙間や不正なキーが開いた状態ではなく閉じた状態で失敗するよう、安全な値(機能はオフ、メンテナンスはオン)にデフォルトします。
競合なしに更新する
罠は、アプリ内での読み取り-変更-書き込みでシングルトンを更新することです。フラグを GetItem し、メモリ内で 1 つを反転させ、それから全体を PutItem で書き戻す。2 つの同時書き込み手が両方とも古いアイテムを読み、2 つ目の Put が 1 つ目の変更を上書きします。失われた更新です。
2 つの DynamoDB の機能が、アプリ側のロックなしにこの競合を防ぎます。
- 更新式 は 1 つの属性をサーバー側で変更し、残りには触れません。アイテム全体を
Putし直す必要はありません。 - 条件式 は、アイテムがまだ期待どおりに見える場合にのみ書き込みを成功させるので、古い書き込みは
ConditionalCheckFailedExceptionで拒否されます(AWS の条件式のドキュメント)。
1 つのフラグを反転させるには、SET でその属性だけを対象にし、同時書き込み手が互いを踏みつけられないようにリビジョンの繰り上げでガードします。
# UpdateItem
Key PK=SETTINGS#APP SK=FLAGS#V1
UpdateExpression SET signup_enabled = :on, revision = :next
ConditionExpression revision = :current
2 つの書き込み手が競合すると、2 つ目の revision = :current チェックが ConditionalCheckFailedException で失敗します。
自動では再試行されません。コードがアイテムを読み直して再試行します。ReturnValuesOnConditionCheckFailure: ALL_OLD を渡せば、エラーが現在のアイテムを運ぶので、読み直しを省けます。
名前、値、そしてこの式の形は、コードに組み込む前に DynamoDB Expression Builder でひな型化できます。演算子をより深く見るには、更新式のイディオムガイドを参照してください。
ホットキーに気を配る
シングルトンは、構造上、ホットキーです。アプリのあらゆる部分が同じパーティションを読みうるからです。キャッシュすれば読み取りには問題ありませんが、それがこのパターンの主なリスクです。
1 つのアイテムの上限は、パーティションの毎秒 3,000 読み取りユニットと 1,000 書き込みユニットです。4 KB までのアイテムなら、結果整合性の GetItem で毎秒約 6,000 回です。上限については物理パーティションで解説しています。
- 積極的にキャッシュする。 フラグはリクエストごとではなく、プロセスごと(または N 秒ごと)に一度読みます。シングルトンの値はメモ化するのに最も安価なものです。
- 書き込みはまれに。 管理者が 1 日に数回切り替えるフラグは何でもありません。リクエストごとにインクリメントするシングルトンは、毎秒 1,000 書き込みの上限に当たります。
- 小さく保つ。 読み取りコストはアイテムサイズに応じて 4 KB ブロック単位でスケールします。肥大した設定ブロブは、必要以上にすべての起動を高コストにします。
書き込みの多いグローバルなカウンターには、代わりにシャーディングされたカウンターを使います。N はピーク時の毎秒書き込み数 ÷ 1,000 から決めます。
各インクリメントを、ランダムなパーティションキー COUNTER#GLOBAL#0..N-1 への UpdateItem ADD #n :1 として書き込み、N 個のキーすべてを 1 回の BatchGetItem で読んで合計します。ADD によるインクリメントはアトミックカウンターで、書き込みのシャーディングはホットパーティションで解説しています。
シングルトン対エンティティごとのアイテム
線引きは データが何にスコープされているか です。
| シングルトンアイテム | エンティティごとのアイテム | |
|---|---|---|
| キー | ハードコードされた定数(SETTINGS#APP) | ID でテンプレート化(USER#42) |
| 数 | ちょうど 1 つ | ユーザー / ドキュメント / テナントごとに 1 つ |
| 典型的な読み取り | 既知のキーへの GetItem | エンティティによる GetItem か Query |
| スコープ | アプリケーション全体 | 単一のエンティティ |
| 用途 | グローバルなフラグ、設定、システムバージョン | プロフィール、ドキュメント、ID ごとのあらゆるもの |
同じ種類の 2 つ のシングルトンが欲しくなっているなら、あなたが持っているのはシングルトンではありません。それはエンティティごとのアイテムであり、キー付けし忘れたのがそのエンティティ(たとえばテナントごとの設定)です。
落とし穴と次のステップ
キーで直接アドレス指定し、更新式と条件式で書き込み、見つからないときは安全な値にデフォルトし、高頻度の書き込みを載せないことです。
シングルトンはシングルテーブル設計の中に心地よく収まります。エンティティの行の隣にある、固定キーを持つもう 1 つのアイテムコレクションです。
DynoTable を試してテーブルを閲覧し、固定キーでシングルトンの行を見つけ、有料プランなら書き込み経路を構築しながらフラグを手で編集してみましょう。