Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DbControllerModel

Абстрактный класс служащий прослойкой между логикой ядра и подключением к БД. Необходим для корректной настройки контролера, отвечающего за сохранение пользовательских данных. Все прикладные контролеры должны быть унаследованы от него.

Hierarchy

  • DbControllerModel

Index

Constructors

Protected constructor

Properties

Protected _connectConfig

_connectConfig: undefined | IAppDB

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

Protected _primaryKeyName

_primaryKeyName: null | string | number

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

Protected _rules

_rules: IModelRules[]

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

Protected _tableName

_tableName: string

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

Accessors

primaryKeyName

  • get primaryKeyName(): null | string | number
  • set primaryKeyName(primaryKey: null | string | number): void

tableName

  • get tableName(): string
  • set tableName(tableName: string): void

Methods

destroy

  • destroy(): void

escapeString

  • Декодирование текста(Текст становится приемлемым и безопасным для sql запроса).

    Parameters

    Returns string

getValue

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

    Parameters

    • res: IModelRes

      Результат выполнения запроса

    Returns null | IDbControllerResult

Abstract insert

  • Выполнение запроса на добавление записи в источник данных

    Parameters

    • insertData: QueryData

      Данные для добавления записи

    Returns any

Abstract isConnected

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

    Returns Promise<boolean>

Abstract query

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

    Parameters

    • callback: Function

      Запрос, который необходимо выполнить

    Returns any

Abstract remove

  • Выполнение запроса на удаление записи в источнике данных

    Parameters

    • removeData: QueryData

      Данные для удаления записи

    Returns any

save

  • save(saveData: QueryData, isNew: boolean): Promise<any>
  • Выполнение запроса на сохранения записи. Обновление записи происходит в том случае, если запись присутствует в источнике данных. Иначе будет добавлена новая запись.

    Parameters

    • saveData: QueryData

      Данные для сохранения записи

    • isNew: boolean

      Определяет необходимость добавления новой записи

    Returns Promise<any>

Abstract select

  • Выполнение запроса на поиск записей в источнике данных

    Parameters

    • select: null | IQueryData

      Данные для поиска значения

    • isOne: boolean

      Вывести только 1 запись.

    Returns Promise<IModelRes>

selectOne

  • Выполнение запроса на поиск записи записей в источнике данных

    Parameters

    • query: null | IQueryData

      Данные для поиска значения

    Returns Promise<null | IModelRes>

setRules

Abstract update

  • Выполнение запроса на обновление записи в источнике данных

    Parameters

    • updateData: QueryData

      Данные для обновления записи

    Returns any

Generated using TypeDoc