electrodb

What is electrodb?

ElectroDB is a DynamoDB library that simplifies the process of defining and interacting with DynamoDB tables. It provides a high-level abstraction for defining entities, managing relationships, and performing CRUD operations, making it easier to work with DynamoDB's complex data modeling and querying capabilities.

What are electrodb's main functionalities?

Entity Definition

This feature allows you to define an entity with its attributes and indexes. The code sample demonstrates how to create a User entity with attributes like userId, name, and email, and a primary index.

const { Entity } = require('electrodb');

const UserEntity = new Entity({
  model: {
    entity: 'User',
    version: '1',
    service: 'UserService'
  },
  attributes: {
    userId: { type: 'string', required: true },
    name: { type: 'string', required: true },
    email: { type: 'string', required: true }
  },
  indexes: {
    primary: {
      pk: { field: 'pk', composite: ['userId'] },
      sk: { field: 'sk', composite: [] }
    }
  }
});

CRUD Operations

This feature provides methods for performing CRUD operations on the defined entities. The code sample shows how to create, read, update, and delete a user entity.

const user = await UserEntity.put({
  userId: '123',
  name: 'John Doe',
  email: '[e-mail]'
}).go();

const fetchedUser = await UserEntity.get({ userId: '123' }).go();

const updatedUser = await UserEntity.update({ userId: '123' })
  .set({ name: 'Jane Doe' })
  .go();

const deletedUser = await UserEntity.delete({ userId: '123' }).go();

Querying

This feature allows you to perform complex queries on your entities. The code sample demonstrates how to query the User entity using the primary index.

const users = await UserEntity.query.primary({ userId: '123' }).go();

Relationships

This feature allows you to define and manage relationships between different entities. The code sample shows how to fetch a user along with their related orders using the Service class.

const { Service } = require('electrodb');

const UserService = new Service({
  User: UserEntity,
  Order: OrderEntity
});

const userWithOrders = await UserService.User.get({ userId: '123' }).include(OrderEntity).go();

Other packages similar to electrodb

dynamodb-toolbox

DynamoDB Toolbox is a set of tools that makes it easier to work with Amazon DynamoDB. It provides a simple and consistent way to define and interact with DynamoDB tables and items. Compared to ElectroDB, DynamoDB Toolbox offers a more lightweight and flexible approach but may require more manual setup for complex data models.

aws-sdk

The AWS SDK for JavaScript provides a comprehensive set of tools for interacting with AWS services, including DynamoDB. While it offers low-level access to DynamoDB's API, it lacks the high-level abstractions and convenience features provided by ElectroDB, making it more suitable for developers who need fine-grained control over their DynamoDB interactions.

dynogels

Dynogels is a DynamoDB data mapper for Node.js that simplifies the process of defining and interacting with DynamoDB tables. It offers a similar high-level abstraction as ElectroDB but is less actively maintained and may not support some of the latest DynamoDB features.

README

The README file is missing

Changelog

[3.4.6]

Fixed

• Issue #343; Fixed issue where ElectroDB would attempt to double set an attribute's value on upsert if an index key used the attribute's name as it's field name. This would cause the upsert to fail because DyanmoDB prevents duplicate set operations to the same field.