Class BaseCollection`Abstract`

Hierarchy (View Summary)

BaseCollection
- MongooseCollection
- SequelizeCollection

Implements

Collection

Index

Constructors

Properties

dataSource name nativeDriver schema

Methods

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

Constructors

constructor

new BaseCollection(
    name: string,
    datasource: DataSource,
    nativeDriver?: unknown,
): BaseCollection
Parameters
- name: string
- datasource: DataSource
- nativeDriver: unknown = null
Returns BaseCollection
- Defined in packages/datasource-toolkit/src/base-collection.ts:27

Properties

`Readonly`dataSource

dataSource: DataSource

`Readonly`name

name: string

`Readonly`nativeDriver

nativeDriver: unknown

`Readonly`schema

schema: CollectionSchema

Methods

`Protected`addAction

addAction(name: string, schema: ActionSchema): void
Parameters
- name: string
- schema: ActionSchema
Returns void
- Defined in packages/datasource-toolkit/src/base-collection.ts:45

`Protected`addChart

addChart(name: string): void
Parameters
- name: string
Returns void
- Defined in packages/datasource-toolkit/src/base-collection.ts:53

`Protected`addField

addField(name: string, schema: FieldSchema): void
Parameters
- name: string
- schema: FieldSchema
Returns void
- Defined in packages/datasource-toolkit/src/base-collection.ts:61

`Protected`addFields

addFields(fields: { [fieldName: string]: FieldSchema }): void
Parameters
- fields: { [fieldName: string]: FieldSchema }
Returns void
- Defined in packages/datasource-toolkit/src/base-collection.ts:69

`Protected`addSegments

addSegments(segments: string[]): void
Parameters
- segments: string[]
Returns void
- Defined in packages/datasource-toolkit/src/base-collection.ts:75

`Abstract`aggregate

aggregate(
    caller: Caller,
    filter: Filter,
    aggregation: Aggregation,
    limit?: number,
): Promise<AggregateResult[]>
Parameters
- caller: Caller
- filter: Filter
- aggregation: Aggregation
- Optionallimit: number
Returns Promise<AggregateResult[]>
Implementation of Collection.aggregate
- Defined in packages/datasource-toolkit/src/base-collection.ts:103

`Abstract`create

create(caller: Caller, data: RecordData[]): Promise<RecordData[]>
Parameters
- caller: Caller
- data: RecordData[]
Returns Promise<RecordData[]>
Implementation of Collection.create
- Defined in packages/datasource-toolkit/src/base-collection.ts:91

`Abstract`delete

delete(caller: Caller, filter: Filter): Promise<void>
Parameters
- caller: Caller
- filter: Filter
Returns Promise<void>
Implementation of Collection.delete
- Defined in packages/datasource-toolkit/src/base-collection.ts:101

`Protected`enableCount

enableCount(): void
Returns void
- Defined in packages/datasource-toolkit/src/base-collection.ts:79

`Protected`enableSearch

enableSearch(): void
Returns void
- Defined in packages/datasource-toolkit/src/base-collection.ts:83

execute

execute(
    caller: Caller,
    name: string,
    formValues: RecordData,
    filter?: Filter,
): Promise<ActionResult>
Parameters
- caller: Caller
- name: string
- formValues: RecordData
- Optionalfilter: Filter
Returns Promise<ActionResult>
Implementation of Collection.execute
- Defined in packages/datasource-toolkit/src/base-collection.ts:110

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[]>
Implementation of Collection.getForm
- Defined in packages/datasource-toolkit/src/base-collection.ts:119

`Abstract`list

list(
    caller: Caller,
    filter: PaginatedFilter,
    projection: Projection,
): Promise<RecordData[]>
Parameters
- caller: Caller
- filter: PaginatedFilter
- projection: Projection
Returns Promise<RecordData[]>
Implementation of Collection.list
- Defined in packages/datasource-toolkit/src/base-collection.ts:93

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>
Implementation of Collection.renderChart
- Defined in packages/datasource-toolkit/src/base-collection.ts:129

`Protected`setAggregationCapabilities

setAggregationCapabilities(capabilities: AggregationCapabilities): void
Parameters
- capabilities: AggregationCapabilities
Returns void
- Defined in packages/datasource-toolkit/src/base-collection.ts:87

`Abstract`update

update(caller: Caller, filter: Filter, patch: RecordData): Promise<void>
Parameters
- caller: Caller
- filter: Filter
- patch: RecordData
Returns Promise<void>
Implementation of Collection.update
- Defined in packages/datasource-toolkit/src/base-collection.ts:99