Class: DynamoDbAdapter

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:40

Amazon DynamoDB adapter for entityTS NoSQL layer.

Supports AWS SDK v3 DynamoDB DocumentClient when available, with a built-in zero-latency in-memory fallback for local development and offline unit tests.

Implements

• INoSqlAdapter

Constructors

Constructor

new DynamoDbAdapter(options?): DynamoDbAdapter

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:46

Parameters

Parameter	Type
options	DynamoDbAdapterOptions

Returns

DynamoDbAdapter

Methods

connect()

connect(): Promise<void>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:50

Returns

Promise<void>

Implementation of

INoSqlAdapter.connect

---

disconnect()

disconnect(): Promise<void>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:55

Returns

Promise<void>

Implementation of

INoSqlAdapter.disconnect

---

ping()

ping(): Promise<boolean>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:60

Returns

Promise<boolean>

Implementation of

INoSqlAdapter.ping

---

insertOne()

insertOne<T>(collection, doc, options?): Promise<InsertOneResult>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:64

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
doc	T
options?	InsertOptions

Returns

Promise<InsertOneResult>

Implementation of

INoSqlAdapter.insertOne

---

insertMany()

insertMany<T>(collection, docs, options?): Promise<InsertManyResult>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:72

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
docs	T[]
options?	InsertOptions

Returns

Promise<InsertManyResult>

Implementation of

INoSqlAdapter.insertMany

---

find()

find<T>(collection, filter?, options?): Promise<T[]>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:80

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	FindOptions

Returns

Promise<T[]>

Implementation of

INoSqlAdapter.find

---

findOne()

findOne<T>(collection, filter?, options?): Promise<T | null>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:88

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	Omit<FindOptions, "limit">

Returns

Promise<T | null>

Implementation of

INoSqlAdapter.findOne

---

updateOne()

updateOne(collection, filter, update, options?): Promise<UpdateResult>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:96

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
update	NoSqlUpdate
options?	UpdateOptions

Returns

Promise<UpdateResult>

Implementation of

INoSqlAdapter.updateOne

---

updateMany()

updateMany(collection, filter, update, options?): Promise<UpdateResult>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:105

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
update	NoSqlUpdate
options?	UpdateOptions

Returns

Promise<UpdateResult>

Implementation of

INoSqlAdapter.updateMany

---

deleteOne()

deleteOne(collection, filter, options?): Promise<DeleteResult>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:114

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
options?	DeleteOptions

Returns

Promise<DeleteResult>

Implementation of

INoSqlAdapter.deleteOne

---

deleteMany()

deleteMany(collection, filter, options?): Promise<DeleteResult>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:122

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
options?	DeleteOptions

Returns

Promise<DeleteResult>

Implementation of

INoSqlAdapter.deleteMany

---

countDocuments()

countDocuments(collection, filter?, options?): Promise<number>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:130

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	CountOptions

Returns

Promise<number>

Implementation of

INoSqlAdapter.countDocuments

---

aggregate()

aggregate<T>(collection, pipeline, options?): Promise<T[]>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:138

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
pipeline	AggregationStage[]
options?	AggregateOptions

Returns

Promise<T[]>

Implementation of

INoSqlAdapter.aggregate

---

beginTransaction()

beginTransaction(): Promise<NoSqlTransaction>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:146

Returns

Promise<NoSqlTransaction>

Implementation of

INoSqlAdapter.beginTransaction

---

createIndex()

createIndex(collection, keys, options?): Promise<string>

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:150

Parameters

Parameter	Type
collection	string
keys	Record<string, 1 | -1 | "text" | "2dsphere" | string>
options?	{ unique?: boolean; name?: string; }
options.unique?	boolean
options.name?	string

Returns

Promise<string>

Implementation of

INoSqlAdapter.createIndex

---

getCollection()

getCollection<T>(name): T

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:158

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
name	string

Returns

T

Implementation of

INoSqlAdapter.getCollection

Properties

provider

readonly provider: NoSqlProvider = 'dynamodb'

Defined in: src/nosql/adapters/DynamoDbAdapter.ts:41

Implementation of

INoSqlAdapter.provider