Class Collection

Hierarchy

Collection

Implements

ICollection

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Collection(collectionName: string, collectionConfig: ICollectionConfig, camaConfig: ICamaConfig): Collection

- Defined in modules/collection/index.ts:30
Parameters
- collectionName: string
- collectionConfig: ICollectionConfig
- camaConfig: ICamaConfig
Returns Collection

Properties

Private aggregator

aggregator: IAggregator

Private Optional config

config?: ICollectionConfig

container

container: Container

Private destroyed

destroyed: boolean = false

Private logger

logger: ILogger

Private Optional name

name?: string

Private persistenceAdapter

persistenceAdapter: IPersistenceAdapter

Private queryService

queryService: IQueryService<any>

queue

queue: IQueueService

Methods

aggregate

aggregate(pipeline: any[]): Promise<any>

Implementation of ICollection.aggregate
- Defined in modules/collection/index.ts:130
Perform MongoDB style aggregations

Parameters
- pipeline: any[]
Returns Promise<any>

Private checkDestroyed

checkDestroyed(): void

- Defined in modules/collection/index.ts:120
Returns void

destroy

destroy(): Promise<void>

Implementation of ICollection.destroy
- Defined in modules/collection/index.ts:115
Destroy the collection

remarks
After calling this, the collection instance becomes unusable

Returns Promise<void>

findMany

findMany<T>(query: any, options?: IQueryOptions): Promise<IFilterResult<T>>

Implementation of ICollection.findMany
- Defined in modules/collection/index.ts:88
Find many rows from the collection

remarks
Lazily loads collection into cache, subsequent calls are significantly faster

Type parameters
- T
Parameters
- query: any
  
  Query Object
- Optional options: IQueryOptions
  
  Query options
Returns Promise<IFilterResult<T>>

insertMany

insertMany(rows: any[]): Promise<void>

Implementation of ICollection.insertMany
- Defined in modules/collection/index.ts:54
Insert many values into collection

Parameters
- rows: any[]
  
  The values to be inserted
Returns Promise<void>

insertOne

insertOne(row: any): Promise<void>

Implementation of ICollection.insertOne
- Defined in modules/collection/index.ts:71
Inserts 1 value into collection

remarks
Essentially syntactic sugar - internally calls the same function as insertMany

Parameters
- row: any
Returns Promise<void>

updateMany

updateMany<T>(query: any, delta: any): Promise<void>

Implementation of ICollection.updateMany
- Defined in modules/collection/index.ts:102
Update all matched rows

Type parameters
- T
Parameters
- query: any
- delta: any
Returns Promise<void>

Generated using TypeDoc