DynamoDB で ToDo を 10 分 TTL 付きで扱う
このメモでは、今回の ToDo アプリで使っている DynamoDB の部分だけを整理する。
何をしたいか
- ToDo を DynamoDB に保存したい
- 各 ToDo は作成から 10 分だけ有効にしたい
- 期限が過ぎたデータは DynamoDB から自動削除したい
テーブル設計
今回のテーブルは複合主キーにしている。
主キー = partition key + sort key
定義はこう。
partitionKey: { name: 'pk', type: AttributeType.STRING },
sortKey: { name: 'id', type: AttributeType.STRING },
timeToLiveAttribute: 'expiresAt',
それぞれの役割
-
pk- どのグループに入れるかを決める
- 今回は全 ToDo を
TODOにしている
-
id- そのグループの中で 1 件を識別する
- 今回は
crypto.randomUUID()で作っている
-
expiresAt- TTL 用の属性
- Unix 時刻秒で入れる
今回のデータの持ち方
保存されるイメージはこう。
pk id title completed expiresAt
TODO 550e8400-e29b-41d4-a716-446655440000 buy milk false 1710000000
TODO 7f2e2c61-6d4b-4f2a-8f51-1f8dbf2d89a0 read book true 1710000060
全部 pk = TODO なので、今回は 1 つのグループにまとまる。
なぜ sort key が必要か
pk だけだと 1 つの値に対して 1 件しか持てない。
pk + sort key にすると、同じ pk の中に複数件を入れられる。
pk = TODO
id = 1
pk = TODO
id = 2
pk = TODO
id = 3
これで「ToDo をまとめて扱う」ことができる。
TTL の考え方
TTL は expiresAt を見て DynamoDB がバックグラウンドで削除する。
今回のルールはこう。
expiresAt = 作成時刻 + 10分
例:
const now = Date.now();
expiresAt: Math.floor(now / 1000) + 10 * 60
注意
- TTL は「ちょうど 10 分で消える」保証ではない
- 実際の削除は少し遅れることがある
- なのでアプリ側でも
expiresAtを見て期限切れを除外している
API 側の扱い
アプリからは HTTP API 経由で DynamoDB を触る。
ブラウザ
↓
API Gateway
↓
Lambda
↓
DynamoDB
Lambda 側でやっていることは次の通り。
-
POST /todos- ToDo を作る
-
expiresAtを付ける
-
GET /todos- 期限切れ以外を一覧で返す
-
PATCH /todos/{id}- タイトルや完了状態を更新する
- 期限切れなら更新させない
-
DELETE /todos/{id}- ToDo を削除する
今回の設計の良い点
- 実装が単純
- TTL の仕組みを学びやすい
- ToDo 1 件ごとのライフサイクルが分かりやすい
今回の設計の注意点
-
pk = TODOなので、全件が 1 つのグループに集まる - データ量やアクセスが増えるとホットパーティションになりやすい
- 学習用途や小規模アプリなら問題ないが、実務で伸ばすなら再設計候補
まとめ
-
pkは「どの箱に入れるか」 -
idは「箱の中のどれか」 -
expiresAtは TTL の期限 - ToDo を 10 分だけ残したいなら、
expiresAt = now + 600秒にすればよい - ただし TTL は即時削除ではないので、アプリ側でも期限切れを見て除外する