Class CollectionDecorator

Hierarchy

CollectionDecorator

Implements

Collection

Index

Constructors

Properties

childCollection dataSource

Accessors

name nativeDriver schema

Methods

aggregate create delete execute getForm list markSchemaAsDirty refineFilter refineSchema renderChart update

Constructors

constructor

new CollectionDecorator(childCollection: Collection, dataSource: DataSource<Collection>): CollectionDecorator
Parameters
- childCollection: Collection
- dataSource: DataSource<Collection>
Returns CollectionDecorator
- Defined in packages/datasource-toolkit/src/decorators/collection-decorator.ts:36

Properties

`Protected` childCollection

childCollection: Collection

`Readonly` dataSource

dataSource: DataSource<Collection>

Accessors

name

get name(): string
Returns string
Implementation of Collection.name
- Defined in packages/datasource-toolkit/src/decorators/collection-decorator.ts:32

nativeDriver

get nativeDriver(): unknown
Returns unknown
Implementation of Collection.nativeDriver
- Defined in packages/datasource-toolkit/src/decorators/collection-decorator.ts:18

schema

get schema(): CollectionSchema
Returns CollectionSchema
Implementation of Collection.schema
- Defined in packages/datasource-toolkit/src/decorators/collection-decorator.ts:22

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[]>
Implementation of Collection.aggregate
- Defined in packages/datasource-toolkit/src/decorators/collection-decorator.ts:105

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/decorators/collection-decorator.ts:79

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/decorators/collection-decorator.ts:99

execute

execute(caller: Caller, name: string, data: RecordData, filter?: Filter): Promise<ActionResult>
Parameters
- caller: Caller
- name: string
- data: RecordData
- Optional filter: Filter
Returns Promise<ActionResult>
Implementation of Collection.execute
- Defined in packages/datasource-toolkit/src/decorators/collection-decorator.ts:56

getForm

getForm(caller: Caller, name: string, data?: RecordData, filter?: Filter, metas?: GetFormMetas): Promise<ActionField[]>
Parameters
- caller: Caller
- name: string
- Optional data: RecordData
- Optional filter: Filter
- Optional metas: GetFormMetas
Returns Promise<ActionField[]>
Implementation of Collection.getForm
- Defined in packages/datasource-toolkit/src/decorators/collection-decorator.ts:67

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/decorators/collection-decorator.ts:83

`Protected` markSchemaAsDirty

markSchemaAsDirty(): void
Returns void
- Defined in packages/datasource-toolkit/src/decorators/collection-decorator.ts:120

`Protected` refineFilter

refineFilter(caller: Caller, filter?: PaginatedFilter): Promise<PaginatedFilter>
Parameters
- caller: Caller
- Optional filter: PaginatedFilter
Returns Promise<PaginatedFilter>
- Defined in packages/datasource-toolkit/src/decorators/collection-decorator.ts:124

`Protected` refineSchema

refineSchema(subSchema: CollectionSchema): CollectionSchema
Parameters
- subSchema: CollectionSchema
Returns CollectionSchema
- Defined in packages/datasource-toolkit/src/decorators/collection-decorator.ts:128

renderChart

renderChart(caller: Caller, name: string, recordId: CompositeId): Promise<unknown>
Parameters
- caller: Caller
- name: string
- recordId: CompositeId
Returns Promise<unknown>
Implementation of Collection.renderChart
- Defined in packages/datasource-toolkit/src/decorators/collection-decorator.ts:116

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/decorators/collection-decorator.ts:93