Interface Collection

Hierarchy

Collection

Implemented by

Index

Accessors

dataSource name nativeDriver schema

Methods

aggregate create delete execute getForm list renderChart update

Accessors

dataSource

get dataSource(): DataSource<Collection>
Returns DataSource<Collection>
- Defined in packages/datasource-toolkit/src/interfaces/collection.ts:29

name

get name(): string
Returns string
- Defined in packages/datasource-toolkit/src/interfaces/collection.ts:30

nativeDriver

get nativeDriver(): unknown
Returns unknown
- Defined in packages/datasource-toolkit/src/interfaces/collection.ts:28

schema

get schema(): CollectionSchema
Returns CollectionSchema
- Defined in packages/datasource-toolkit/src/interfaces/collection.ts:31

Methods

aggregate

aggregate(caller: Caller, filter: Filter, aggregation: Aggregation, limit?: number): Promise<AggregateResult[]>
Parameters
- caller: Caller
- filter: Filter
- aggregation: Aggregation
- Optional limit: number
Returns Promise<AggregateResult[]>
- Defined in packages/datasource-toolkit/src/interfaces/collection.ts:56

create

create(caller: Caller, data: RecordData[]): Promise<RecordData[]>
Parameters
- caller: Caller
- data: RecordData[]
Returns Promise<RecordData[]>
- Defined in packages/datasource-toolkit/src/interfaces/collection.ts:48

delete

delete(caller: Caller, filter: Filter): Promise<void>
Parameters
- caller: Caller
- filter: Filter
Returns Promise<void>
- Defined in packages/datasource-toolkit/src/interfaces/collection.ts:54

execute

execute(caller: Caller, name: string, formValues: RecordData, filter?: Filter): Promise<ActionResult>
Parameters
- caller: Caller
- name: string
- formValues: RecordData
- Optional filter: Filter
Returns Promise<ActionResult>
- Defined in packages/datasource-toolkit/src/interfaces/collection.ts:33

getForm

getForm(caller: Caller, name: string, formValues?: RecordData, filter?: Filter, metas?: GetFormMetas): Promise<ActionFormElement[]>
Parameters
- caller: Caller
- name: string
- Optional formValues: RecordData
- Optional filter: Filter
- Optional metas: GetFormMetas
Returns Promise<ActionFormElement[]>
- Defined in packages/datasource-toolkit/src/interfaces/collection.ts:40

list

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

renderChart

renderChart(caller: Caller, name: string, recordId: CompositeId): Promise<unknown>
Parameters
- caller: Caller
- name: string
- recordId: CompositeId
Returns Promise<unknown>
- Defined in packages/datasource-toolkit/src/interfaces/collection.ts:63

update

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