# Dynamo

> Ecto-inspired Repo and schema library for Amazon DynamoDB in Elixir. Typed schemas that generate composite keys, native DynamoDB vector search (vector_index + search_vectors), a supervised Repo with credential resolution, retries and telemetry, pure request builders, and one normalised %Dynamo.Error{} for every failure. MIT licensed, by Martin Karrer (https://karrer.solutions).

Install: `{:dynamo, github: "bmalum/dynamo"}` in mix.exs (Elixir 1.16+). Current version 0.2.0. The 0.1 API (Dynamo.Table, table_name, untyped fields, belongs_to) is removed; see the changelog for the migration table.

## Docs

- [README](https://elixir-dynamodb.dev/docs/readme.html): overview, installation, every operation with examples
- [Getting started](https://elixir-dynamodb.dev/docs/getting_started.html): DynamoDB Local, repo, schema, CRUD in six steps
- [Data modelling](https://elixir-dynamodb.dev/docs/data_modelling.html): composite keys, sort-key strategies, GSIs, single-table design, embedded schemas, vector search, custom types
- [Streaming, batches and transactions](https://elixir-dynamodb.dev/docs/streaming.html)
- [Testing](https://elixir-dynamodb.dev/docs/testing.html): pure request builders, Req.Test plugs, in-memory fake, DynamoDB Local
- [Agent guide](https://elixir-dynamodb.dev/docs/agents.html): compact cheat sheet and modelling rules for AI agents and humans
- [Changelog](https://elixir-dynamodb.dev/docs/changelog.html): 0.2 rewrite, bugs fixed, 0.1 to 0.2 migration table
- [API reference](https://elixir-dynamodb.dev/docs/api-reference.html)

## Agent skill

- [dynamo-elixir SKILL.md](https://elixir-dynamodb.dev/skills/dynamo-elixir/SKILL.md): step-by-step skill for coding agents working on projects that use Dynamo
- [Cheat sheet](https://elixir-dynamodb.dev/skills/dynamo-elixir/references/cheatsheet.md)
- [0.1 migration](https://elixir-dynamodb.dev/skills/dynamo-elixir/references/migration-0.1.md)

## Optional

- [Source on GitHub](https://github.com/bmalum/dynamo)
- [Full text of all docs in one file](https://elixir-dynamodb.dev/llms-full.txt)