dynormo

Dynormo

Typesafe ORM for AWS DynamoDB
Explore the docs »

Get Started · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Installation
   • Configuration
   • Usage
3. Contributing
4. License
5. Contact

About The Project

Dynormo is an open-source GitHub project that offers developers a robust object-relational mapping (ORM) library designed specifically for DynamoDB, the popular NoSQL database service provided by Amazon Web Services (AWS). With Dynormo, you can effortlessly interact with DynamoDB using a typesafe and intuitive approach, enabling you to work with your data in a strongly-typed manner.

One of the key features of Dynormo is its type safety. By leveraging the type system of the programming language you're using, Dynormo ensures that your code is free from runtime type errors when interacting with DynamoDB. This prevents common pitfalls such as mismatched data types, missing attributes, or incorrect queries, providing you with a more reliable and predictable development experience.

Dynormo also offers an intuitive API that closely aligns with the DynamoDB data model. It provides a set of high-level abstractions for common database operations such as querying, inserting, updating, and deleting data. These abstractions make it easier to express your intent in code and reduce the boilerplate typically associated with low-level DynamoDB interactions.

(back to top)

Getting Started

Installation

To start using Dynormo in your project, you need to install it via npm. Open your terminal and run the following command:

npm install dynormo --save-dev

Configuration

Before you can start using Dynormo, you need to configure a few things.

Config file

Create a configuration file called dynormo.config.json at the root of your project. This file will contain some configurations need for you DynormoClient. You can read more about the configuration file in the Configuration section.

{
    "entities": ["entities/User.json"]
}

Entity definition

Create a file called User.json in a folder called entities at the root of your project. This file will contain the definition of your User entity. You can read more about entity definitions in the Entities section. Link this entity and all other entities to the entities array in the dynormo.config.json file.

{
    "name": "User",
    "table": "dynormo-users",
    "attributes": {
        "partitionKey": {
            "type": "string",
            "partitionKey": true,
            "generator": "UUID"
        },
        "stringAttr1": {
            "type": "string"
        }
    }
}

Generate type definitions

The last thing you need to do is generate the type definitions for your entities. This is done by running the following command in your terminal:

npx dynormo generate

This will generate all the type definitions and code needed to interact with your DynamoDB tables inside your node_modules folder. You can read more about the generate command in the CLI section.

DynormoClient

The last thing you need to do is create a DynormoClient instance. This is the main entry point for interacting with Dynormo. It is recommended to create a single DynormoClient instance and reuse it throughout your application. You can read more about the DynormoClient in the DynormoClient section.

import { DynormoClient } from '.dynormo'

const client = new DynormoClient({
    client: new DynamoDBClient({
        region: 'eu-central-1',
    }),
})

Usage

Now that you have everything set up, you can start using Dynormo to interact with your DynamoDB tables. Let's create a new user in the dynormo-users table.

import { DynormoClient } from '.dynormo'

const client = new DynormoClient({
    client: new DynamoDBClient({
        region: 'eu-central-1',
    }),
})

const user = await client.user.create({
    stringAttr1: 'Hello World!',
})

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Maximilian Mittelhammer - LinkedIn - [e-mail]

(back to top)