Strongly typed ORM for DynamoDB - Built with the single-table-design pattern in mind.
MIT License
Object Relational mapper for DynamoDB, inspired by typeorm.
TypeDORM is an ORM built from ground up using typescript and latest javascript features to provide an easy gateway when doing complex highly relational data modeling in dynamoDB. TypeDORM is built with single-table-design first in mind, but should work as smoothly with regular entity table <-> design pattern. TypeDORM would have not existed without TypeORM and dynamodb-toolbox, big shout-out to these projects and their awesome contributors.
TypeDORM borrows decorator based syntax from TypeORM and provides fully type safe ORM to with dynamodb. TypeDORM currently only support Data Mapper.
Package | Latest Stable | Recent Beta | Recent Alpha |
---|---|---|---|
@typedorm/common | |||
@typedorm/core | |||
@typedorm/testing | |||
@typedorm/document-client |
Branches | Stability |
---|---|
main | |
develop | |
alpha |
findOne
, find
, count
, exists
, create
, update
, and delete
operationswrite
and read
operationswrite
and read
operationsfind
, count
, parallelScan
and scan
operationsAnd many more to come.
Install core and common modules from npm.
npm install @typedorm/core @typedorm/common --save
Install AWS SDK for nodejs, TypeDORM uses documentClient to interact with dynamodb.
a. When using AWS SDK Version 2
npm install aws-sdk --save
b. When using AWS SDK Version 3
npm install @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb --save
Install reflect-metadata
shim
npm install reflect-metadata --save
and import it as the first thing in node entry file as
import 'reflect-metadata'
If you are using TypeDORM with typescript, make sure you also have below options enabled in tsconfig.json
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
First thing to do when working with TypeDORM is to setup dynamodb table config. Currently this needs to be manually setup and have also have it configured in deployed table instance(s).
This guide shows how to setup single-table-design
my-table.ts
import {Table, INDEX_TYPE} from '@typedorm/common';
// create table
const myGlobalTable = new Table({
name: 'test-table',
partitionKey: 'PK',
sortKey: 'SK',
indexes: {
GSI1: {
type: INDEX_TYPE.GSI,
partitionKey: 'GSI1PK',
sortKey: 'GSI1SK',
},
GSI2: {
type: INDEX_TYPE.GSI,
partitionKey: 'GSI2PK',
sortKey: 'GSI2SK',
},
LSI1: {
type: INDEX_TYPE.LSI,
sortKey: 'LSI1SK',
},
},
});
Note: These indexes must match exactly to what is created in dynamo table instance hosted.
organisation.entity.ts
import {Attribute, Entity, AutoGenerateAttribute} from '@typedorm/common';
import {AUTO_GENERATE_ATTRIBUTE_STRATEGY} from '@typedorm/common';
@Entity({
name: 'organisation',
primaryKey: {
partitionKey: 'ORG#{{id}}',
sortKey: 'ORG#{{id}}',
},
indexes: {
// specify GSI1 key - "GSI1" named global secondary index needs to exist in above table declaration
GSI1: {
partitionKey: 'ORG#{{id}}#STATUS#{{status}}',
sortKey: 'ORG#{{id}}#ACTIVE#{{active}}',
type: INDEX_TYPE.GSI,
},
// specify LSI1 key
LSI1: {
sortKey: 'TICKETS#UPDATED_AT#{{updatedAt}}',
type: INDEX_TYPE.LSI,
},
},
})
export class Organisation {
@AutoGenerateAttribute({
strategy: AUTO_GENERATE_ATTRIBUTE_STRATEGY.UUID4,
})
id: string;
@Attribute()
name: string;
@Attribute()
status: string;
@Attribute()
active: boolean;
@AutoGenerateAttribute({
strategy: AUTO_GENERATE_ATTRIBUTE_STRATEGY.EPOCH_DATE,
autoUpdate: true, // this will make this attribute and any indexes referencing it auto update for any write operation
})
updatedAt: number;
}
The connection initialization steps slightly differs when using AWS SDK V2 vs V3.
import {createConnection} from '@typedorm/core';
import {DocumentClientV2} from '@typedorm/document-client';
import AWS from 'aws-sdk';
const documentClient = new DocumentClientV2(new AWS.DynamoDB.DocumentClient());
// initialize with specifying list of entities
createConnection({
table: myGlobalTable,
entities: [Organisation],
documentClient, // <-- When documentClient is not provided, TypeDORM defaults to use the DocumentClientV2
});
// or initialize with specifying path match for entities
createConnection({
table: myGlobalTable,
entities: 'path-to-entities/*.entity.ts',
documentClient, // <-- When documentClient is not provided, TypeDORM defaults to use the DocumentClientV2
});
import {createConnection} from '@typedorm/core';
import {DocumentClientV3} from '@typedorm/document-client';
import {DynamoDBClient} from '@aws-sdk/client-dynamodb';
const documentClient = new DocumentClientV3(new DynamoDBClient({}));
// initialize with specifying list of entities
createConnection({
table: myGlobalTable,
entities: [Organisation],
documentClient, // <-- When documentClient is not provided, TypeDORM defaults to use the DocumentClientV2
});
// or initialize with specifying path match for entities
createConnection({
table: myGlobalTable,
entities: 'path-to-entities/*.entity.ts',
documentClient, // <-- When documentClient is not provided, TypeDORM defaults to use the DocumentClientV2
});
import {getEntityManager} from '@typedorm/core';
const org = new Organisation();
org.name = 'My awesome org';
org.status = 'onboarding';
org.active = true;
const entityManger = getEntityManager();
// create item
const response = await entityManger.create(org);
// get item
const org = await entityManger.findOne(Organisation, {
id: response.id,
status: 'onboarding',
active: true,
});
// delete item
await entityManger.delete(Organisation, {
id: response.id,
status: 'onboarding',
active: true,
});
DynamoDB is different, different than most other no-sql databases, and therefore data in dynamodb should be stored the way dynamodb expects to get the most benefits out of it. While doing this development experience suffers and all data can become a huge mess very quickly, this is specially true with single-table-design patten. To resolve this, TypeDORM let's declaratively define schema and later takes control from there to provide best development experience possible.
To find out more about how the data looks like when it is stored in dynamo have a look at this detailed guide.
Please submit an issue for any bugs or ideas here, or you can reach out to me on twitter @whimzy_live.