@rivyn/db

---

@rivyn/db / Collection

Class: Collection<T>

Type Parameters

T

T extends object = Record<string, unknown>

Constructors

Constructor

new Collection<T>(connection, name): Collection<T>

Parameters

connection

Connection

name

string

Returns

Collection<T>

Properties

name

readonly name: 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>

---

createIndex()

createIndex(field, options?): Promise<IndexDef>

Parameters

field

string

options?

unique?

boolean

Returns

Promise<IndexDef>

---

deleteMany()

deleteMany(filter): Promise<DeleteResult>

Parameters

filter

Filter

Returns

Promise<DeleteResult>

---

deleteOne()

deleteOne(filter): Promise<DeleteResult>

Parameters

filter

Filter

Returns

Promise<DeleteResult>

---

dropIndex()

dropIndex(field): Promise<boolean>

Parameters

field

string

Returns

Promise<boolean>

---

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>

---

getSchema()

getSchema(): Promise<ServerSchemaSpec | null>

Returns

Promise<ServerSchemaSpec | null>

---

indexes()

indexes(): Promise<IndexDef[]>

Returns

Promise<IndexDef[]>

---

insert()

insert(doc): Promise<InsertOneResult>

Parameters

doc

T

Returns

Promise<InsertOneResult>

---

insertMany()

insertMany(docs): Promise<InsertManyResult>

Parameters

docs

T[]

Returns

Promise<InsertManyResult>

---

setSchema()

setSchema(schema): Promise<boolean>

Parameters

schema

ServerSchemaSpec | null

Returns

Promise<boolean>

---

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>