Class SequelizeCollection

Hierarchy

BaseCollection
- SequelizeCollection

Index

Constructors

Properties

dataSource model name nativeDriver schema

Methods

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

Constructors

constructor

new SequelizeCollection(name: string, datasource: DataSource<Collection>, model: ModelDefined<any, any>, logger?: Logger): SequelizeCollection
Parameters
- name: string
- datasource: DataSource<Collection>
- model: ModelDefined<any, any>
- Optional logger: Logger
Returns SequelizeCollection
Overrides BaseCollection.constructor
- Defined in packages/datasource-sequelize/src/collection.ts:42

Properties

`Readonly` dataSource

dataSource: DataSource<Collection>

`Protected` model

model: ModelDefined<any, any>

`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
Inherited from BaseCollection.addAction
- Defined in packages/datasource-toolkit/dist/src/base-collection.d.ts:17

`Protected` addChart

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

`Protected` addField

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

`Protected` addFields

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

`Protected` addSegments

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

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[]>
Overrides BaseCollection.aggregate
- Defined in packages/datasource-sequelize/src/collection.ts:174

create

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

delete

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

`Protected` enableCount

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

`Protected` enableSearch

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

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>
Inherited from BaseCollection.execute
- Defined in packages/datasource-toolkit/dist/src/base-collection.d.ts:31

getForm

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

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 packages/datasource-sequelize/src/collection.ts:116

renderChart

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

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 packages/datasource-sequelize/src/collection.ts:153