> For the complete documentation index, see [llms.txt](https://shiftcode.gitbook.io/dynamo-easy/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://shiftcode.gitbook.io/dynamo-easy/master.md).

# Introduction

�A DynamoDB client which provides an easy to use fluent api to execute requests. It supports typescript decorators, to define the necessary metadata for your models. You don't need to care about the mapping of javascript types to their dynamo types any more. We got you covered.

{% code title="person.model.ts" %}

```typescript
import { Model, PartitionKey } from '@shiftcoders/dynamo-easy'

@Model()
export class Person {
  @PartitionKey()
  id: string
  name: string
  yearOfBirth: number
}

```

{% endcode %}

{% code title="looks-easy-right.snippet.ts" %}

```typescript
import { DynamoStore } from '@shiftcoders/dynamo-easy'
import { Person } from './models'

const personStore = new DynamoStore(Person)

personStore
  .scan()
  .whereAttribute('yearOfBirth').equals(1958)
  .exec()
  .then(res => console.log('ALL items with yearOfBirth == 1958', res))
```

{% endcode %}

{% hint style="info" %}
The library does not provide any operation to manage a table (API operations like 'createTable', 'describeTable', and more operations described [here](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html))
{% endhint %}

{% hint style="info" %}
Are you missing some information or found some wrong description? Please feel free to open an issue on our [github repo](https://github.com/shiftcode/dynamo-easy/issues).
{% endhint %}

## Developed with :heart: by [shiftcode.ch](https://www.shiftcode.ch)<img src="/files/-LYS8Xy-ofhqP2phs7Ky" alt="" data-size="line">&#x20;


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://shiftcode.gitbook.io/dynamo-easy/master.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.