Class MongoRepository<T>

Repository class for MongoDB Make db operations easier across the services

Type Parameters

Constructors

constructor

Properties

collectionName db logger

Methods

aggregate count countBy create createMany delete deleteBy find findOne findOneBy findWithPagination restore softDelete softDeleteBy update updateBy

Constructors

constructor

Properties

Private collectionName

collectionName: string

collection name

Private db

db: Db

mongodb database instance

Private logger

logger: undefined | Logger = undefined

logger instance

Methods

aggregate

  • aggregate(pipeline): Promise<Document[]>

  • Aggregate records

    Parameters

    • pipeline: Document[]

      aggregation pipeline

    Returns Promise<Document[]>

    aggregated result

count

  • count(): Promise<number>

  • Count the non softDeleted records in the collection

    Returns Promise<number>

    number of records in the collection with delFlg = 0

countBy

  • countBy(query, search?): Promise<number>

  • Count the records in the collection by condition

    Parameters

    • query: Filter<T>

      filter

    • Optional search: SearchAggregatorType

      search condition (only for atlas hosted mongodb full text search)

    Returns Promise<number>

    number of records

create

  • create(entity): Promise<{
        id: string;
    }>

  • Create a new record of entity

    Parameters

    • entity: T

      object to create

    Returns Promise<{
        id: string;
    }>

    id of the created object

createMany

  • createMany(entities): Promise<{
        id: string;
    }[]>

  • Create list of record

    Parameters

    • entities: T[]

      objects to create

    Returns Promise<{
        id: string;
    }[]>

    id list

delete

  • delete(id): Promise<boolean>

  • Delete one record from database

    Parameters

    • id: string

      id of object to delete

    Returns Promise<boolean>

    true if deleted successfully or false if not

deleteBy

  • deleteBy(query): Promise<number>

  • Delete by condition

    Parameters

    • query: Filter<T>

      condition to delete

    Returns Promise<number>

    number of records deleted

find

  • find(query): Promise<WithId<T>[]>

  • Find records by query

    Parameters

    • query: Filter<T>

    Returns Promise<WithId<T>[]>

    list of queries objects

findOne

  • findOne(id): Promise<null | WithId<T>>

  • Find one record by id If no record is found, return null

    Parameters

    • id: string

      id of object to find

    Returns Promise<null | WithId<T>>

    Object or null

findOneBy

  • findOneBy(query): Promise<null | WithId<T>>

  • Find one record by query, If multiple records are found, return the first one If no record is found, return null

    Parameters

    • query: Filter<T>

    Returns Promise<null | WithId<T>>

    Object or null

findWithPagination

restore

  • restore(id): Promise<boolean>

  • Restore a softDeleted record

    Parameters

    • id: string

      id of object to restore

    Returns Promise<boolean>

    true if restored successfully or false if not

softDelete

  • softDelete(id): Promise<boolean>

  • softDelete a record from database mark the delFlg to be 1

    Parameters

    • id: string

      id of object to softDelete

    Returns Promise<boolean>

    true if deleted successfully or false if not

softDeleteBy

  • softDeleteBy(query): Promise<number>

  • softDelete by condition

    Parameters

    • query: Filter<T>

      condition to delete

    Returns Promise<number>

    number of records deleted

update

  • update(id, partialObject): Promise<{
        id: string;
    }>

  • Update a record by id

    Parameters

    • id: string

      id of object to update

    • partialObject: DeepPartial<T>

      data to update

    Returns Promise<{
        id: string;
    }>

    id of the updated object

updateBy

  • updateBy(query, updateQuery): Promise<number>

  • Update records by query

    Parameters

    • query: Filter<T>

      condition

    • updateQuery: UpdateFilter<T>

      update query

    Returns Promise<number>

    number of records been updated

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc