Class DbControllerMongoDb

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

Hierarchy

Constructors

Properties

_connectConfig: undefined | IAppDB

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

_primaryKeyName: TKey

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

Default Value

id

_rules: IModelRules[]

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

_tableName: string

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

Accessors

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

    Returns

    Returns TKey

  • set primaryKeyName(primaryKey: TKey): void
  • Устанавливает имя уникального ключа

    Parameters

    Returns void

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

    Returns string

  • set tableName(tableName: string): void
  • Устанавливает имя таблицы

    Parameters

    • tableName: string

    Returns void

Methods

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

    Returns

    string

    Api

    Parameters

    • text: string | number

      Исходный текст.

    Returns string

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

    Returns

    Parameters

    • res: IModelRes

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

    Returns null | IDbControllerResult

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

    Returns

    Returns Promise<boolean>

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

    Returns

    Api

    Parameters

    • callback: Function

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

    Returns any

  • Выполнение запроса на сохранения записи. Обновление записи происходит в том случае, если запись присутствует в источнике данных. Иначе будет добавлена новая запись.

    Parameters

    • saveData: QueryData

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

    • isNew: boolean

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

    Returns Promise<any>

Generated using TypeDoc