Class CollectionDecorator

Implements

Collection

Index

Constructors

Properties

childCollection dataSource

Accessors

name nativeDriver schema

Methods

aggregate create delete execute getForm getSearchedFields list markSchemaAsDirty refineFilter refineSchema renderChart update

Constructors

constructor

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

Properties

`Protected`childCollection

childCollection: Collection

`Readonly`dataSource

dataSource: DataSource

Accessors

name

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

nativeDriver

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

schema

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

Methods

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

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:92

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:112

execute

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

getForm

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

getSearchedFields

getSearchedFields(search: string, extended: boolean): SearchedField[]
Which fields a search will actually reach, and where they live — null when the collection cannot say, which a caller must read as "unknown", never as "none".
Parameters
- search: string
- extended: boolean
Returns SearchedField[]
- Defined in packages/datasource-toolkit/src/decorators/collection-decorator.ts:43

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:96

`Protected`markSchemaAsDirty

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

`Protected`refineFilter

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

`Protected`refineSchema

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

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

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:106