Class: CustomEntityRepository

backend.CustomEntityRepository

Hierarchy

• BaseRepository<CustomEntity>

  ↳ CustomEntityRepository

Table of contents

Constructors

• constructor

Properties

• dbType

Methods

• applyBaseFilter
• applyCustomEntityFilter
• applyDeleteMany
• applyGetEntityViews
• createCustomEntity
• createEntity
• deleteCustomEntity
• deleteEntity
• deleteMany
• deleteManyFilteredCustomEntities
• getAll
• getById
• getBySlug
• getCustomEntities
• getCustomEntitiesByIds
• getCustomEntityById
• getCustomEntityBySlug
• getEntityViews
• getFilteredCustomEntities
• getFilteredEntities
• getPaged
• getSqlBoolStr
• getSqlLike
• quote
• updateCustomEntity
• updateEntity

Constructors

constructor

• new CustomEntityRepository()

Overrides

BaseRepository.constructor

Defined in

system/core/backend/src/repositories/custom-entity.repository.ts:16

Properties

dbType

• dbType: "mysql" | "mariadb" | "postgres" | "cockroachdb" | "sqlite" | "mssql" | "sap" | "oracle" | "cordova" | "nativescript" | "react-native" | "sqljs" | "mongodb" | "aurora-data-api" | "aurora-data-api-pg" | "expo" | "better-sqlite3" | "capacitor"

Inherited from

BaseRepository.dbType

Defined in

system/core/backend/src/repositories/base.repository.ts:24

Methods

applyBaseFilter

▸ applyBaseFilter<EntityType>(qb, filter?): SelectQueryBuilder<EntityType>

Type parameters

Name	Type
EntityType	TBasePageEntity

Parameters

Name	Type
qb	SelectQueryBuilder<EntityType>
filter?	BaseFilterInput

Returns

SelectQueryBuilder<EntityType>

Inherited from

BaseRepository.applyBaseFilter

Defined in

system/core/backend/src/repositories/base.repository.ts:155

---

applyCustomEntityFilter

▸ applyCustomEntityFilter(qb, filterParams?): void

Parameters

Name	Type
qb	SelectQueryBuilder<CustomEntity>
filterParams?	CustomEntityFilterInput

Returns

void

Defined in

system/core/backend/src/repositories/custom-entity.repository.ts:82

---

applyDeleteMany

▸ applyDeleteMany(qb, input): Promise<void>

Parameters

Name	Type
qb	SelectQueryBuilder<CustomEntity> | DeleteQueryBuilder<CustomEntity>
input	TDeleteManyInput

Returns

Promise<void>

Inherited from

BaseRepository.applyDeleteMany

Defined in

system/core/backend/src/repositories/base.repository.ts:108

---

applyGetEntityViews

▸ applyGetEntityViews(qb, entityType): SelectQueryBuilder<TBasePageEntity>

Parameters

Name	Type
qb	SelectQueryBuilder<TBasePageEntity>
entityType	EDBEntity

Returns

SelectQueryBuilder<TBasePageEntity>

Inherited from

BaseRepository.applyGetEntityViews

Defined in

system/core/backend/src/repositories/base.repository.ts:133

---

createCustomEntity

▸ createCustomEntity(inputData, id?): Promise<CustomEntity>

Parameters

Name	Type
inputData	TCustomEntityInput
id?	null | number

Returns

Promise<CustomEntity>

Defined in

system/core/backend/src/repositories/custom-entity.repository.ts:51

---

createEntity

▸ createEntity(input, id?): Promise<CustomEntity>

Parameters

Name	Type
input	CustomEntity
id?	null | number

Returns

Promise<CustomEntity>

Inherited from

BaseRepository.createEntity

Defined in

system/core/backend/src/repositories/base.repository.ts:70

---

deleteCustomEntity

▸ deleteCustomEntity(id): Promise<boolean>

Parameters

Name	Type
id	number

Returns

Promise<boolean>

Defined in

system/core/backend/src/repositories/custom-entity.repository.ts:70

---

deleteEntity

▸ deleteEntity(id): Promise<boolean>

Parameters

Name	Type
id	number

Returns

Promise<boolean>

Inherited from

BaseRepository.deleteEntity

Defined in

system/core/backend/src/repositories/base.repository.ts:97

---

deleteMany

▸ deleteMany(input): Promise<boolean>

Parameters

Name	Type
input	TDeleteManyInput

Returns

Promise<boolean>

Inherited from

BaseRepository.deleteMany

Defined in

system/core/backend/src/repositories/base.repository.ts:125

---

deleteManyFilteredCustomEntities

▸ deleteManyFilteredCustomEntities(input, filterParams?): Promise<undefined | boolean>

Parameters

Name	Type
input	TDeleteManyInput
filterParams?	CustomEntityFilterInput

Returns

Promise<undefined | boolean>

Defined in

system/core/backend/src/repositories/custom-entity.repository.ts:109

---

getAll

▸ getAll(): Promise<CustomEntity[]>

Returns

Promise<CustomEntity[]>

Inherited from

BaseRepository.getAll

Defined in

system/core/backend/src/repositories/base.repository.ts:44

---

getById

▸ getById(id, relations?): Promise<CustomEntity>

Parameters

Name	Type
id	number
relations?	string[]

Returns

Promise<CustomEntity>

Inherited from

BaseRepository.getById

Defined in

system/core/backend/src/repositories/base.repository.ts:49

---

getBySlug

▸ getBySlug(slug, relations?): Promise<CustomEntity>

Parameters

Name	Type
slug	string
relations?	string[]

Returns

Promise<CustomEntity>

Inherited from

BaseRepository.getBySlug

Defined in

system/core/backend/src/repositories/base.repository.ts:60

---

getCustomEntities

▸ getCustomEntities(params?): Promise<TPagedList<CustomEntity>>

Parameters

Name	Type
params?	TPagedParams<TCustomEntity>

Returns

Promise<TPagedList<CustomEntity>>

Defined in

system/core/backend/src/repositories/custom-entity.repository.ts:20

---

getCustomEntitiesByIds

▸ getCustomEntitiesByIds(ids): Promise<CustomEntity[]>

Parameters

Name	Type
ids	number[]

Returns

Promise<CustomEntity[]>

Defined in

system/core/backend/src/repositories/custom-entity.repository.ts:30

---

getCustomEntityById

▸ getCustomEntityById(id): Promise<undefined | CustomEntity>

Parameters

Name	Type
id	number

Returns

Promise<undefined | CustomEntity>

Defined in

system/core/backend/src/repositories/custom-entity.repository.ts:25

---

getCustomEntityBySlug

▸ getCustomEntityBySlug(slug): Promise<undefined | CustomEntity>

Parameters

Name	Type
slug	string

Returns

Promise<undefined | CustomEntity>

Defined in

system/core/backend/src/repositories/custom-entity.repository.ts:35

---

getEntityViews

▸ getEntityViews(entityId, entityType): Promise<any>

Parameters

Name	Type
entityId	number
entityType	EDBEntity

Returns

Promise<any>

Inherited from

BaseRepository.getEntityViews

Defined in

system/core/backend/src/repositories/base.repository.ts:144

---

getFilteredCustomEntities

▸ getFilteredCustomEntities(pagedParams?, filterParams?): Promise<TPagedList<TCustomEntity>>

Parameters

Name	Type
pagedParams?	PagedParamsInput<CustomEntity>
filterParams?	CustomEntityFilterInput

Returns

Promise<TPagedList<TCustomEntity>>

Defined in

system/core/backend/src/repositories/custom-entity.repository.ts:100

---

getFilteredEntities

▸ getFilteredEntities(pagedParams?, filterParams?): Promise<TPagedList<CustomEntity>>

Parameters

Name	Type
pagedParams?	PagedParamsInput<CustomEntity>
filterParams?	BaseFilterInput

Returns

Promise<TPagedList<CustomEntity>>

Inherited from

BaseRepository.getFilteredEntities

Defined in

system/core/backend/src/repositories/base.repository.ts:164

---

getPaged

▸ getPaged(params?): Promise<TPagedList<CustomEntity>>

Parameters

Name	Type
params?	TPagedParams<CustomEntity>

Returns

Promise<TPagedList<CustomEntity>>

Inherited from

BaseRepository.getPaged

Defined in

system/core/backend/src/repositories/base.repository.ts:38

---

getSqlBoolStr

▸ getSqlBoolStr(b): "true" | "false" | "1" | "0"

Parameters

Name	Type
b	boolean

Returns

"true" | "false" | "1" | "0"

Inherited from

BaseRepository.getSqlBoolStr

Defined in

system/core/backend/src/repositories/base.repository.ts:34

---

getSqlLike

▸ getSqlLike(): "ILIKE" | "LIKE"

Returns

"ILIKE" | "LIKE"

Inherited from

BaseRepository.getSqlLike

Defined in

system/core/backend/src/repositories/base.repository.ts:35

---

quote

▸ quote(str): string

Parameters

Name	Type
str	string

Returns

string

Inherited from

BaseRepository.quote

Defined in

system/core/backend/src/repositories/base.repository.ts:36

---

updateCustomEntity

▸ updateCustomEntity(id, inputData): Promise<CustomEntity>

Parameters

Name	Type
id	number
inputData	TCustomEntityInput

Returns

Promise<CustomEntity>

Defined in

system/core/backend/src/repositories/custom-entity.repository.ts:61

---

updateEntity

▸ updateEntity(id, input): Promise<CustomEntity>

Parameters

Name	Type
id	number
input	CustomEntity

Returns

Promise<CustomEntity>

Inherited from

BaseRepository.updateEntity

Defined in

system/core/backend/src/repositories/base.repository.ts:82