Home

dynamodb-toolkit (v3)

Opinionated zero-runtime-dependency micro-library for AWS DynamoDB. Built on the AWS JS SDK v3 (@aws-sdk/client-dynamodb + @aws-sdk/lib-dynamodb). ESM-only, hand-written .d.ts sidecars, no build step.

v2 documentation lives at the v2.3-docs git tag of this wiki repo. v2 source remains available on npm as dynamodb-toolkit@2.3.0.

Start here

• Getting started
• Concepts — vocabulary + the additive-params-mutation model every builder uses
• Migration: v2 to v3
• SDK v2 to v3 cheat sheet

Adapter

• Adapter — overview
• Adapter: Constructor options
• Adapter: CRUD methods
• Adapter: Mass methods
• Adapter: Batch builders
• Adapter: Hooks
• Adapter: Raw marker
• Adapter: Indirect indices
• Adapter: Transaction auto-upgrade

Expression builders (dynamodb-toolkit/expressions)

• Expressions: Update builder — buildUpdate, patch + array ops
• Expressions: Filter builder — buildFilter, buildFilterByExample
• Expressions: Condition builder — buildCondition
• Expressions: Projection builder — addProjection

Batch / transactions / mass / paths

• Batch and transactions — applyBatch, applyTransaction, getBatch, getTransaction
• Mass operations — paginateList, iterateList, read*, write*, delete*, copy*, move*
• Paths — getPath, setPath, applyPatch, subsetObject, normalizeFields

REST surface

• REST core — parsers, builders, policy (framework-agnostic)
• HTTP handler — node:http (req, res) handler with the standard route pack