@rivyn/db

---

@rivyn/db / Model

Class: Model<T>

Type Parameters

T

T extends object = Record<string, unknown>

Constructors

Constructor

new Model<T>(collection, schema): Model<T>

Parameters

collection

Collection<Record<string, unknown>>

schema

Schema

Returns

Model<T>

Properties

collection

readonly collection: Collection<Record<string, unknown>>

---

schema

readonly schema: Schema

Accessors

name

Get Signature

get name(): string

Returns

string

Methods

aggregate()

aggregate(pipeline): Promise<Record<string, unknown>[]>

Parameters

pipeline

Record<string, unknown>[]

Returns

Promise<Record<string, unknown>[]>

---

count()

count(filter?): Promise<number>

Parameters

filter?

Filter = {}

Returns

Promise<number>

---

create()

create(doc): Promise<WithId<T>>

Parameters

doc

Record<string, unknown>

Returns

Promise<WithId<T>>

---

createMany()

createMany(docs): Promise<WithId<T>[]>

Parameters

docs

Record<string, unknown>[]

Returns

Promise<WithId<T>[]>

---

deleteMany()

deleteMany(filter): Promise<DeleteResult>

Parameters

filter

Filter

Returns

Promise<DeleteResult>

---

deleteOne()

deleteOne(filter): Promise<DeleteResult>

Parameters

filter

Filter

Returns

Promise<DeleteResult>

---

find()

find(filter?, opts?): Promise<WithId<T>[]>

Parameters

filter?

Filter = {}

opts?

FindOptions = {}

Returns

Promise<WithId<T>[]>

---

findOne()

findOne(filter?): Promise<WithId<T> | null>

Parameters

filter?

Filter = {}

Returns

Promise<WithId<T> | null>

---

findOneAndDelete()

findOneAndDelete(filter): Promise<WithId<T> | null>

Parameters

filter

Filter

Returns

Promise<WithId<T> | null>

---

findOneAndUpdate()

findOneAndUpdate(filter, update, options?): Promise<WithId<T> | null>

Parameters

filter

Filter

update

UpdateSpec

options?

UpdateOptions & object = {}

Returns

Promise<WithId<T> | null>

---

stats()

stats(): Promise<CollectionStats>

Returns

Promise<CollectionStats>

---

updateMany()

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

Parameters

filter

Filter

update

UpdateSpec

options?

UpdateOptions = {}

Returns

Promise<UpdateResult>

---

updateOne()

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

Parameters

filter

Filter

update

UpdateSpec

options?

UpdateOptions = {}

Returns

Promise<UpdateResult>