DynamoDB DocumentClient備忘録

2023年11月17日 17:54

初めまして、株式会社GAGAのKです。

私が業務中「あれ？そういえばどうなんだっけ」とよくなる事柄について備忘録がてらのまとめです。

よければ活用ください。

DynamoDB DocumentClientってなんぞや

以下公式様からの引用

DynamoDB ドキュメントクライアントは、属性値の概念を抽象化することによって項目の操作を簡素化します。この抽象化は、入力パラメータとして提供されるネイティブの JavaScript 型に注釈を付け、注釈付きのレスポンスデータをネイティブの JavaScript 型に変換します。

つまりはJavascriptで動作しやすいようにしてくれたものなんですね。

では、さっそくよく忘れる内容のご紹介です。

DynamoDB DocumentClient（以下docClient）

■ 取得
ネイティブ：getItem
docClient：get

■ 追加
ネイティブ：putItem
docClient：put
備考：存在するアイテムの更新を行うことが可能

■ 更新
ネイティブ：UpdateItem
docClient：update
備考：存在しないアイテムを追加することが可能

■ 削除
ネイティブ：DeleteItem
docClient：delete

■ 取得(検索)
ネイティブ：Query
docClient：query

■ 取得(全件取得)
ネイティブ：Scan
docClient：scan

【補足】似たクラスの違い

■ putとupdate

put：全項目の差し替え

update：一部項目の差し替え

■ getとqueryとscan

get：プライマリキー及びソートキーを１つ指定する

query：キーを指定することができる(検索条件に使用できるのはキーのみ）

scan：属性(Attribute)で結果を絞り込むオプションがある(※キーではない)

バッチ処理

■ たくさん追加
ネイティブ：BatchWriteItem
docClient：batchWrite

■ たくさん取得
ネイティブ：BatchGetItem
docClient：batchGet

こう改めて比較すると、クラス名ほとんど一緒でしたね。

おまけ

よく使われるVSCode(Visual Studio Code)の便利な「ショートカット」と「拡張機能」をご紹介します！

一般的すぎるかもしませんが、ご容赦ください。

ショートカット

■ 行ごと移動（一行まるまる上下に移動させる）

Alt + 矢印キー

■ 選択した文字をダブルクォートまたはシングルクォートで囲む

囲みたい文字を選択し、ダブルクォートもしくはシングルクォートを押下

■ 規定量スペースを空ける

開けたいを行のいずれかでクリックし、TABキー

■ 規定量スペースを無くす

無くしたい行のいずれかでクリックし、Shift + TABキー

拡張機能

■ 日本語化

Japanese Language Pack for Visual Studio Code

■ 全角スペースを発見

Trailing Spaces

■ スペルミスを発見

Code Spell Checker

■ コードの自動整形(プロジェクトによって規則があるので要注意です)

Prettier - Code formatter

■ 最終編集者の表示

GitLens - Git supercharged

参考資料

■ Qiita JavascriptでDynamoDBを操作する

https://qiita.com/Fujimon_fn/items/66be7b807a8329496899

■ AWS DocumentClient

https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html

■ AWS DynamoDB - API Reference

https://docs.aws.amazon.com/pdfs/amazondynamodb/latest/APIReference/dynamodb-api.pdf#Welcome