Class MongooseCollection

Hierarchy (View Summary)

BaseCollection
- MongooseCollection

Index

Constructors

Properties

dataSource model name nativeDriver schema stack

Methods

addAction addChart addField addFields addSegments aggregate create delete enableCount enableSearch execute getForm list renderChart setAggregationCapabilities update

Constructors

constructor

new MongooseCollection(
    dataSource: DataSource,
    model: Model<unknown>,
    stack: Stack,
): MongooseCollection
Parameters
- dataSource: DataSource
- model: Model<unknown>
- stack: Stack
Returns MongooseCollection
Overrides BaseCollection.constructor
- Defined in datasource-mongoose/src/collection.ts:41

Properties

`Readonly`dataSource

dataSource: DataSource

model

model: Model<unknown>

`Readonly`name

name: string

`Readonly`nativeDriver

nativeDriver: unknown

`Readonly`schema

schema: CollectionSchema

stack

stack: Stack

Methods

`Protected`addAction

addAction(name: string, schema: ActionSchema): void
Parameters
- name: string
- schema: ActionSchema
Returns void
Inherited from BaseCollection.addAction
- Defined in datasource-toolkit/dist/src/base-collection.d.ts:18

`Protected`addChart

addChart(name: string): void
Parameters
- name: string
Returns void
Inherited from BaseCollection.addChart
- Defined in datasource-toolkit/dist/src/base-collection.d.ts:19

`Protected`addField

addField(name: string, schema: FieldSchema): void
Parameters
- name: string
- schema: FieldSchema
Returns void
Inherited from BaseCollection.addField
- Defined in datasource-toolkit/dist/src/base-collection.d.ts:20

`Protected`addFields

addFields(fields: { [fieldName: string]: FieldSchema }): void
Parameters
- fields: { [fieldName: string]: FieldSchema }
Returns void
Inherited from BaseCollection.addFields
- Defined in datasource-toolkit/dist/src/base-collection.d.ts:21

`Protected`addSegments

addSegments(segments: string[]): void
Parameters
- segments: string[]
Returns void
Inherited from BaseCollection.addSegments
- Defined in datasource-toolkit/dist/src/base-collection.d.ts:24

aggregate

aggregate(
    caller: Caller,
    filter: Filter,
    aggregation: Aggregation,
    limit?: number,
): Promise<AggregateResult[]>
Parameters
- caller: Caller
- filter: Filter
- aggregation: Aggregation
- Optionallimit: number
Returns Promise<AggregateResult[]>
Overrides BaseCollection.aggregate
- Defined in datasource-mongoose/src/collection.ts:76

create

create(caller: Caller, data: RecordData[]): Promise<RecordData[]>
Parameters
- caller: Caller
- data: RecordData[]
Returns Promise<RecordData[]>
Overrides BaseCollection.create
- Defined in datasource-mongoose/src/collection.ts:93

delete

delete(caller: Caller, filter: Filter): Promise<void>
Parameters
- caller: Caller
- filter: Filter
Returns Promise<void>
Overrides BaseCollection.delete
- Defined in datasource-mongoose/src/collection.ts:101

`Protected`enableCount

enableCount(): void
Returns void
Inherited from BaseCollection.enableCount
- Defined in datasource-toolkit/dist/src/base-collection.d.ts:25

`Protected`enableSearch

enableSearch(): void
Returns void
Inherited from BaseCollection.enableSearch
- Defined in datasource-toolkit/dist/src/base-collection.d.ts:26

execute

execute(
    caller: Caller,
    name: string,
    formValues: RecordData,
    filter?: Filter,
): Promise<ActionResult>
Parameters
- caller: Caller
- name: string
- formValues: RecordData
- Optionalfilter: Filter
Returns Promise<ActionResult>
Inherited from BaseCollection.execute
- Defined in datasource-toolkit/dist/src/base-collection.d.ts:33

getForm

getForm(
    caller: Caller,
    name: string,
    formValues?: RecordData,
    filter?: Filter,
    metas?: GetFormMetas,
): Promise<ActionField[]>
Parameters
- caller: Caller
- name: string
- OptionalformValues: RecordData
- Optionalfilter: Filter
- Optionalmetas: GetFormMetas
Returns Promise<ActionField[]>
Inherited from BaseCollection.getForm
- Defined in datasource-toolkit/dist/src/base-collection.d.ts:34

list

list(
    caller: Caller,
    filter: PaginatedFilter,
    projection: Projection,
): Promise<RecordData[]>
Parameters
- caller: Caller
- filter: PaginatedFilter
- projection: Projection
Returns Promise<RecordData[]>
Overrides BaseCollection.list
- Defined in datasource-mongoose/src/collection.ts:54

renderChart

renderChart(
    caller: Caller,
    name: string,
    recordId: CompositeId,
    parameters?: Record<string, string>,
): Promise<unknown>
Parameters
- caller: Caller
- name: string
- recordId: CompositeId
- Optionalparameters: Record<string, string>
Returns Promise<unknown>
Inherited from BaseCollection.renderChart
- Defined in datasource-toolkit/dist/src/base-collection.d.ts:35

`Protected`setAggregationCapabilities

setAggregationCapabilities(capabilities: AggregationCapabilities): void
Parameters
- capabilities: AggregationCapabilities
Returns void
Inherited from BaseCollection.setAggregationCapabilities
- Defined in datasource-toolkit/dist/src/base-collection.d.ts:27

update

update(caller: Caller, filter: Filter, patch: RecordData): Promise<void>
Parameters
- caller: Caller
- filter: Filter
- patch: RecordData
Returns Promise<void>
Overrides BaseCollection.update
- Defined in datasource-mongoose/src/collection.ts:97