0.4.3 • Published 5 years ago
dynalee v0.4.3
dynalee
dyanlee is DML only DynamoDB ORM
Strongly typed.
Define model with way to follow DynamoDB philosophy.
usage
Model
define hash model
import {HashModel} from 'dynalee'
interface Cat {
name: string
birth: number
color: string
}
const CatModel = new HashModel<Cat, 'name'>({
table: 'TableName',
hashKey: 'name'
})
const aCat = CatModel.of({
name: 'first cat',
birth: 2018,
color: 'white'
})
const docCat = await aCat.put() // save
console.log(docCat.head())
/*
{
name: 'first cat'
birth: 2018
color: 'white'
}
*/
define multiple model in one table
import {RangeModel} from 'dynalee'
interface Index {
name: string
birth: number
}
interface Cat extends Index {
color: string
age?: number,
doYouWantSet?: string[]|Set<string> // use union for DynamoDB type and javascript type
doYouWantList?: string[]
}
interface Dog extends Index {
longLegs: boolean
}
const model = new RangeModel<Index, 'name', 'birth'>({
table: 'TableName',
hashKey: 'name',
rangeKey: 'birth',
})
const CatModel = model as RangeModel<Cat, 'name', 'birth'>
const DogModel = model as RangeModel<Dog, 'name', 'birth'>
update
CatModel
.update('deptno cat', '1985')
.update(setter => {
setter
.of({
age: 10,
color: 'white'
}) // set multiple props
})
condition(setter => {
setter.attributeNotExists('ID')
})
.returnValue('NONE')
.run()
update 2
CatModel
.update('deptno cat', '1985')
.update(setter => {
setter
.set('color', 'white')
.add('age', 10)
})
condition((and, or, not) => {
and.attributeNotExists('ID')
})
.returnValue('NONE')
.run()
delete
CatModel.delete('deptno cat', '1985')
get item
CatModel.get('deptno cat', '1985')
Document
create
const document = await CatModel
.of({
name: 'son of deptno cat',
birth: '2006',
age: 10
})
.put() // save
get raw data
const document = await CatModel.get('deptno cat', '1985')
const rawdata = document.head()
delete
const document = await CatModel.get('deptno cat', '1985')
document.delete()
put
const document = await CatModel.get('deptno cat', '1985')
await document
.set(setter => {
setter.age = 10
setter.color = 'white'
})
.put()
SecondaryIndex
define secondary index
import {SecondaryIndex} from 'dynalee'
interface Index {
name: string
birth: number
}
interface Cat extends Index {
color: string
}
interface Dog extends Index {
longLegs: boolean
}
const model = new SecondaryIndex<Index, 'name', 'birth'>({
table: 'TableName',
index: 'IndexTable',
hashKey: 'species',
rangeKey: 'birth'
})
const CatModel = model as SecondaryIndex<Cat, 'name', 'birth'>
const DogModel = model as SecondaryIndex<Dog, 'name', 'birth'>
query on secondary index
const documents = await CatModel
.query('Turkish Angora')
.run()
const items = documents.Items.map(item => item.head())
query on secondary index
const documents = await CatModel
.rangeQuery('Turkish Angora')
.eq('2006')
.run()
const items = documents.Items.map(item => item.head())
more query options
const nextToken = null
const documents = await CatModel
.rangeQuery('Turkish Angora')
.eq('2006')
.desc()
.consistent()
.limit(10)
.startAt(nextToken)
.run()
const items = documents.Items.map(item => item.head())
scan on secondary index
const documents = await CatModel
.scan()
.filter(setter => {
setter.attributeNotExists('specis')
})
.run()
const items = documents.Items.map(item => item.head())
advanced usage
Set
const cat = await CatModel
.of({
name: 'my cat',
birth: '2018',
age: 10,
doYouWantSet: new Set(['string set 1', 'string set 2'])
})
.update(setter => { // example code, `of` method can include below props
setter
.plus('age', 1)
.add('doYouWantSet', new Set(['string set 3']))
})
.put()
const document = cat.head()
console.log(document.doYouWantSet instanceof Set) // true
const jsDocument = cat.head(true)
console.log(jsDocument.doYouWantSet instanceof Set) // false
console.log(Array.isArray(jsDocument.doYouWantSet)) // true
List
const cat = await CatModel
.of({
name: 'my cat',
birth: '2018',
age: 10,
doYouWantList: ['string 1', 'string 2']
})
.update(setter => { // example code, `of` method can include below props
setter
.plus('age', 1)
.add('doYouWantSet', ['string 3'])
})
.put()
Trigger
likes CreatedAt, UpdatedAt
import {HashModel, DocumentOptions} from 'dynalee'
const document: DocumentOptions = {
onCreate: [
{
attributeName: 'CreatedAt',
handler(prevVal?) {
return new Date().toISOString()
}
},
],
onUpdate: [
{
attributeName: 'UpdatedAt',
handler(prevVal?) {
return new Date().toISOString()
}
}
],
}
interface Cat {
name: string
}
const CatModel = new HashModel<Cat, 'name'>({
table: 'TableName',
hashKey: 'name',
options: {
document
}
})
use with dynamon
import {HashModel} from 'dynalee'
interface Cat {
name: string
}
const CatModel = new HashModel<Cat, 'name'>({
table: 'TableName',
hashKey: 'name',
options: {
aws: {
region : 'dynamon',
endpoint: 'http://localhost:8000'
},
}
})
link
license
MIT
0.4.3
5 years ago
0.4.2
5 years ago
0.4.1
5 years ago
0.4.0
5 years ago
0.3.3
5 years ago
0.3.0
5 years ago
0.2.3
5 years ago
0.2.1
5 years ago
0.2.0
5 years ago
0.1.17
5 years ago
0.1.16
5 years ago
0.1.15
5 years ago
0.1.14
5 years ago
0.1.13
5 years ago
0.1.12
5 years ago
0.1.11
5 years ago
0.1.10
5 years ago
0.1.9
5 years ago
0.1.8
5 years ago
0.1.7
6 years ago
0.1.6
6 years ago
0.1.5
6 years ago
0.1.4
6 years ago
0.1.3
6 years ago
0.1.2
6 years ago
0.1.1
6 years ago
0.1.0
6 years ago