Class DbControllerMongoDb

Контроллер, позволяющий работать с данными, хранящимися в базе данных. А именно поддерживает работу с MongoDb

Hierarchy

DbControllerModel
- DbControllerMongoDb

Index

Constructors

constructor

new DbControllerMongoDb(): DbControllerMongoDb
Returns DbControllerMongoDb
Overrides DbControllerModel.constructor
- Defined in src/models/db/DbControllerMongoDb.ts:17

Properties

`Protected` _connectConfig

_connectConfig: undefined | IAppDB

Конфигурация для настройки подключения к БД.

`Protected` _primaryKeyName

_primaryKeyName: TKey

Название поля, которое является уникальным ключом. По умолчанию id

Default Value

`Protected` _rules

_rules: IModelRules[]

Правила для полей бд. Указывается тип каждого поля.

`Protected` _tableName

_tableName: string

Название таблицы

Accessors

primaryKeyName

get primaryKeyName(): TKey
Возвращает имя уникального ключа

Returns

Returns TKey
Inherited from DbControllerModel.primaryKeyName
- Defined in src/models/db/DbControllerModel.ts:66
set primaryKeyName(primaryKey: TKey): void
Устанавливает имя уникального ключа
Parameters
- primaryKey: TKey
Returns void
Inherited from DbControllerModel.primaryKeyName
- Defined in src/models/db/DbControllerModel.ts:58

tableName

get tableName(): string
Возвращает имя таблицы

Returns string
Inherited from DbControllerModel.tableName
- Defined in src/models/db/DbControllerModel.ts:50
set tableName(tableName: string): void
Устанавливает имя таблицы
Parameters
- tableName: string
Returns void
Inherited from DbControllerModel.tableName
- Defined in src/models/db/DbControllerModel.ts:43

Methods

destroy

destroy(): void
Удаление подключения к БД

Returns void
Overrides DbControllerModel.destroy
- Defined in src/models/db/DbControllerMongoDb.ts:251

escapeString

escapeString(text: string | number): string
Декодирование текста(Текст становится приемлемым и безопасным для sql запроса).

Returns
string

Api
Parameters
- text: string | number
  
  Исходный текст.
Returns string
Overrides DbControllerModel.escapeString
- Defined in src/models/db/DbControllerMongoDb.ts:265

getValue

getValue(res: IModelRes): null | IDbControllerResult
Приводит полученный результат к требуемому типу. В качестве результата должен вернуться объект вида: { key: value } где key - порядковый номер поля(0, 1... 3), либо название поля. Рекомендуется использовать имя поля. Важно чтобы имя поля было указано в rules, имена не входящие в rules будут проигнорированы. value - значение поля.

Returns
Parameters
- res: IModelRes
  
  Результат выполнения запроса
Returns null | IDbControllerResult
Inherited from DbControllerModel.getValue
- Defined in src/models/db/DbControllerModel.ts:89

insert

insert(insertQuery: QueryData): Promise<any>
Выполнение запроса на добавление записи в источник данных

Returns

Api
Parameters
- insertQuery: QueryData
  
  Данные для добавления записи
Returns Promise<any>
Overrides DbControllerModel.insert
- Defined in src/models/db/DbControllerMongoDb.ts:75

isConnected

isConnected(): Promise<boolean>
Проверка подключения к источнику данных. При использовании БД, проверяется статус подключения. Если удалось подключиться, возвращается true, в противном случае false. При сохранении данных в файл, всегда возвращается true.

Returns

Returns Promise<boolean>
Overrides DbControllerModel.isConnected
- Defined in src/models/db/DbControllerMongoDb.ts:280

query

query(callback: Function): any
Выполнение произвольного запроса к источнику данных

Returns

Api
Parameters
- callback: Function
  
  Запрос, который необходимо выполнить
Returns any
Overrides DbControllerModel.query
- Defined in src/models/db/DbControllerMongoDb.ts:152

remove

remove(removeQuery: QueryData): Promise<boolean>
Выполнение запроса на удаление записи в источнике данных

Returns

Api
Parameters
- removeQuery: QueryData
  
  Данные для удаления записи
Returns Promise<boolean>
Overrides DbControllerModel.remove
- Defined in src/models/db/DbControllerMongoDb.ts:114

save

save(saveData: QueryData, isNew: boolean): Promise<any>
Выполнение запроса на сохранения записи. Обновление записи происходит в том случае, если запись присутствует в источнике данных. Иначе будет добавлена новая запись.
Parameters
- saveData: QueryData
  
  Данные для сохранения записи
- isNew: boolean
  
  Определяет необходимость добавления новой записи
Returns Promise<any>
Inherited from DbControllerModel.save
- Defined in src/models/db/DbControllerModel.ts:130

select

select(where: null | IQueryData, isOne?: boolean): Promise<IModelRes>
Выполнение запроса на поиск записей в источнике данных

Returns
Parameters
- where: null | IQueryData
  
  Данные для поиска значения
- isOne: boolean = false
  
  Вывести только 1 запись.
Returns Promise<IModelRes>
Overrides DbControllerModel.select
- Defined in src/models/db/DbControllerMongoDb.ts:209

selectOne

selectOne(query: null | IQueryData): Promise<null | IModelRes>
Выполнение запроса на поиск записи записей в источнике данных

Returns
Parameters
- query: null | IQueryData
  
  Данные для поиска значения
Returns Promise<null | IModelRes>
Inherited from DbControllerModel.selectOne
- Defined in src/models/db/DbControllerModel.ts:166

setRules

setRules(rules: IModelRules[]): void
Устанавливает правила для полей
Parameters
- rules: IModelRules[]
Returns void
Inherited from DbControllerModel.setRules
- Defined in src/models/db/DbControllerModel.ts:74

update

update(updateQuery: QueryData): Promise<any>
Выполнение запроса на обновление записи в источнике данных

Returns

Api
Parameters
- updateQuery: QueryData
  
  Данные для обновления записи
Returns Promise<any>
Overrides DbControllerModel.update
- Defined in src/models/db/DbControllerMongoDb.ts:33

validate

validate(element: null | IQueryData): IQueryData
Валидация значений полей для таблицы.

Api
Parameters
- element: null | IQueryData
Returns IQueryData
- Defined in src/models/db/DbControllerMongoDb.ts:165

Class DbControllerMongoDb

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns DbControllerMongoDb

Properties

Protected _connectConfig

Protected _primaryKeyName

Default Value

Protected _rules

Protected _tableName

Accessors

primaryKeyName

Returns

Returns TKey

Parameters

primaryKey: TKey

Returns void

tableName

Returns string

Parameters

tableName: string

Returns void

Methods

destroy

Returns void

escapeString

Returns

Api

Parameters

text: string | number

Returns string

getValue

Returns

Parameters

res: IModelRes

Returns null | IDbControllerResult

insert

Returns

Api

Parameters

insertQuery: QueryData

Returns Promise<any>

isConnected

Returns

Returns Promise<boolean>

query

Returns

Api

Parameters

callback: Function

Returns any

remove

Returns

Api

Parameters

removeQuery: QueryData

Returns Promise<boolean>

save

Parameters

saveData: QueryData

isNew: boolean

Returns Promise<any>

select

Returns

Parameters

where: null | IQueryData

isOne: boolean = false

Returns Promise<IModelRes>

selectOne

Returns

Parameters

query: null | IQueryData

Returns Promise<null | IModelRes>

setRules

`Protected` _connectConfig

`Protected` _primaryKeyName

`Protected` _rules

`Protected` _tableName