DynamoDB-Toolbox

DynamoDB-Toolbox

クイックスタート   •   ドキュメント   •   スポンサー   •   DynamoDB-Toolshack

---

💖 このリポジトリのメンテナンスを支援してくださるスポンサーの皆さまに、心より感謝します：

特長

DynamoDB-Toolboxは、DocumentClientの軽量な抽象化レイヤーで、DynamoDBを使った作業を✨快適✨にします

🤗 よりシンプルなクエリ：DynamoDB-Toolboxが、複雑なDynamoDBリクエストの作成に伴う面倒な作業をすべて引き受けます。コードがより明確で簡潔になり、保守しやすくなります。

📐 データ検証：書き込み時と取得時の両方で、アイテムをスキーマに照らして検証します。これにより、データの一貫性とコードの信頼性が保証されます。

✨ 豊富なスキーマ構文により、デフォルト値、合成、変換、ポリモーフィズムなど、幅広いエッジケースに対応します。

🔄 ポータビリティ：スキーマをZodやJSON Schemaからインポートしたり、エクスポートしたりできます。型推論も維持されます。

🌈 型安全性を極限まで追求：即時のフィードバックとスムーズな自動補完により、開発速度を高めます。

🌴 ツリーシェイク可能：必要なものだけをインポートできます。

☝️ シングルテーブル設計：DynamoDB-Toolboxを使えば、同じテーブル内の複数のエンティティに対するクエリが非常に簡単になります。もちろん、複数のテーブルを使う場合にも同様に便利です。

🪶 LLRT互換：DynamoDB-Toolboxには依存関係がなく、LLRT関数内で使用できます。

開始するには、👉 公式ドキュメント 👈をご覧ください！

ヒント

コードをさらに活用したいですか？DynamoDB-Toolshackをお試しください 🙌

DynamoDB-Toolshackは、DynamoDB-Toolboxと連携するSaaSです。スキーマを認識するUI、テーブルの整合性チェック、マイグレーションシステムを提供し、DynamoDBのエクスペリエンスを向上させます。

ベータ版に参加して、数回クリックするだけで始めましょう！

DynamoDB-Toolboxを使う理由は？

ここにたどり着いた方は、DynamoDBをご存じだと思います。

ご存じない場合は、AWS公式ドキュメントをご覧ください。

要約：DynamoDBは、あらゆる規模で高パフォーマンスなアプリケーションを実行するために設計されたキーバリューデータベースです。現在のトラフィックに応じて自動的にスケールアップおよびスケールダウンし、接続を維持する必要がないため、多くのプロジェクトで選ばれるデータベースとなっています。これにはサーバーレスアプリケーションなどが含まれますが、それだけに限りません。

公式のDocument Clientを使ったことがある方なら、使いにくいと感じたことがあるでしょう。

AWSドキュメントに掲載されているUpdateCommandの例をご覧ください。

await documentClient.send(
  new UpdateCommand({
    TableName: 'Music',
    Key: {
      // 👇 No type-safety on the Primary Key
      artist: 'Acme Band',
      songTitle: 'Happy Day'
    },
    // 👇 Complex string expressions (+ still no type-safety)
    UpdateExpression: 'SET #Y = :y, #AT = :t',
    // 👇 Attribute names provided separately
    ExpressionAttributeNames: {
      '#AT': 'albumTitle',
      '#Y': 'year'
    },
    // 👇 Attribute values as well
    ExpressionAttributeValues: {
      // 👇 No validation or type-safety to enforce DB schema
      ':t': 'Louder Than Ever',
      ':y': '2015'
    },
    ReturnValues: 'ALL_NEW'
  })
)

これはとてもシンプルな例（Musicアイテムの2つのフィールドを更新するだけ）ですが、それでもすでに複雑です 😰

データが複雑になるほど、状況はさらに厄介になります。アイテムに多くの属性があり、その一部がネストされていたり、省略可能だったりする場合はどうでしょうか？値に基づいてアイテムにインデックスを付けたり、異なる種類のアイテムを扱ったりする必要がある場合は？ポリモーフィズムについてはどうでしょうか？

こうした状況はよくありますが、リクエストを生成するために必要なコードの保守は非常に難しくなります。そんなときにDynamoDB-Toolboxが役立ちます 💪

上記のUpdateCommandをDynamoDB-Toolboxで書いた例を簡単にご紹介します。

// Validated AND type-safe syntax 🙌
await MusicEntity.build(UpdateItemCommand)
  .item({
    artist: 'Acme Band',
    songTitle: 'Happy Day',
    albumTitle: 'Louder Than Ever',
    year: '2015'
  })
  .options({ returnValues: 'ALL_NEW' })
  .send()

このようにして、分かりにくい20行のコードが、読みやすく洗練された10行のコードになりました 🤩

いい感じでしょう？さっそく始めましょう！

スポンサーになる！