Class MongoAdapter

Адаптер для работы с базой данных mongodb

Hierarchy (View Summary)

BaseDbAdapter<IMongoDbInfo>
- MongoAdapter

Index

Constructors

constructor

new MongoAdapter(options?: IAppDB): MongoAdapter
Parameters
- Optionaloptions: IAppDB
Returns MongoAdapter
Overrides BaseDbAdapter.constructor
- Defined in plugins/db/Mongo/Adapter.ts:42

Properties

`Protected`_appContext

_appContext: AppContext<IMongoDbInfo> = ...

Контекст приложения

`Protected` `Optional`_dbOptions

_dbOptions?: IAppDB

Дополнительные опции для работы базы данных

dbFormat

dbFormat: string = 'mongodb'

Формат базы данных

Methods

`Protected`_attemptConnect

_attemptConnect(
mongo: __module,
options: MongoClientOptions,
): Promise<{ client: MongoClient; connect: MongoClient }>
Protected
Выполняет до двух попыток подключения с проверкой живучести соединения. Каждая попытка создаёт НОВЫЙ клиент — после неудачного connect() MongoClient переходит в состояние "closed" и его нельзя переиспользовать.
Parameters
- mongo: __module
  Лениво загруженный модуль mongodb
- options: MongoClientOptions
  Опции подключения
Returns Promise<{ client: MongoClient; connect: MongoClient }>
Пара {client, connect} при успехе

Throws
Последняя ошибка, если все попытки провалились
- Defined in plugins/db/Mongo/Adapter.ts:179

`Protected`_buildConnectOptions

_buildConnectOptions(mongo: __module): MongoClientOptions
Protected
Формирует опции подключения к MongoDB из конфига приложения.
Parameters
- mongo: __module
  Лениво загруженный модуль mongodb
Returns MongoClientOptions
Опции клиента MongoDB
- Defined in plugins/db/Mongo/Adapter.ts:122

`Protected`_closePreviousClient

_closePreviousClient(): Promise<void>
Protected
Закрывает предыдущее соединение, если оно было сохранено в databaseInfo. Это предотвращает утечку соединений при повторных вызовах connect().

Returns Promise<void>
- Defined in plugins/db/Mongo/Adapter.ts:157

_insert

_insert(insertData: IQuery): Promise<boolean>
Выполняет INSERT-запрос.
Parameters
- insertData: IQuery
  Дополнительная информация для запроса. Содержит сам запрос, а также название таблицы и прочие данные.
Returns Promise<boolean>
true при успешной вставке, иначе false (нет данных/первичного ключа, запрещённый запрос, ошибка драйвера)
Overrides BaseDbAdapter._insert
- Defined in plugins/db/Mongo/Adapter.ts:427

`Protected`_loadMongo

_loadMongo(): Promise<__module>
Protected
Лениво загружает модуль mongodb (один раз) и кэширует его.

mongodb объявлен как опциональная peer-зависимость: он нужен только тем, кто реально использует MongoAdapter. Статический import в шапке файла заставил бы Node требовать пакет у всех, кто импортирует umbot/plugins, даже при использовании только FileAdapter. Поэтому модуль подгружается динамически в момент первого подключения.

Returns Promise<__module>
Загруженный модуль mongodb

Throws
Если пакет не установлен — понятная ошибка с инструкцией по установке
- Defined in plugins/db/Mongo/Adapter.ts:66

_query

_query(callback: TQueryCb<MongoClient, Db>): Promise<unknown>
Выполняет произвольный запрос через callback.
Parameters
- callback: TQueryCb<MongoClient, Db>
  функция обработчик
Returns Promise<unknown>
Overrides BaseDbAdapter._query
- Defined in plugins/db/Mongo/Adapter.ts:493

_remove

_remove(removeData: IQuery): Promise<boolean>
Выполняет DELETE-запрос.
Parameters
- removeData: IQuery
  Дополнительная информация для запроса. Содержит сам запрос, а также название таблицы и прочие данные.
Returns Promise<boolean>
true при успешном удалении, иначе false (нет данных, запрещённый запрос, ошибка драйвера)
Overrides BaseDbAdapter._remove
- Defined in plugins/db/Mongo/Adapter.ts:461

`Protected`_saveLog

_saveLog(errorMsg: string, error?: Error): void
Protected
Сохранение логов
Parameters
- errorMsg: string
  Текст ошибки
- Optionalerror: Error
  Объект ошибки (опционально)
Returns void
- Defined in plugins/db/Mongo/Adapter.ts:659

_select

_select(
    selectData: IQuery,
    where: IQueryData | null,
    isOne?: boolean,
): Promise<IModelRes<IDataValue>>
Выполняет SELECT-запрос.
Parameters
- selectData: IQuery
  Дополнительная информация для запроса. Содержит информацию о таблице и структуре.
- where: IQueryData | null
  Сам запрос
- isOne: boolean = false
  Определяет нужно ли вернуть только 1 найденную запись, либо отдать все доступные данные.
Returns Promise<IModelRes<IDataValue>>
Promise — результат выборки ({ status: true, data } при успехе, { status: false, error } при ошибке/запрете)
Overrides BaseDbAdapter._select
- Defined in plugins/db/Mongo/Adapter.ts:582

_update

_update(updateData: IQuery): Promise<boolean>
Выполняет UPDATE-запрос.
Parameters
- updateData: IQuery
  Дополнительная информация для запроса. Содержит сам запрос, а также название таблицы и прочие данные.
Returns Promise<boolean>
true при успешном обновлении, иначе false (нет данных/первичного ключа, запрещённый запрос, ошибка драйвера)
Overrides BaseDbAdapter._update
- Defined in plugins/db/Mongo/Adapter.ts:377

close

close(tableName: string): Promise<void>
Закрывает подключение к определенной таблице. В MongoDB нет концепции "закрытия таблицы". Метод close() закрывает всё соединение с базой.
Parameters
- tableName: string
  Имя таблицы
Returns Promise<void>
Overrides BaseDbAdapter.close
- Defined in plugins/db/Mongo/Adapter.ts:678

connect

connect(): Promise<boolean>
Подключается к MongoDB.

Поведение:
- При неудачном connect() или «мёртвом» соединении создаёт новый MongoClient и выполняет до двух попыток подключения.
- Живучесть соединения проверяется ping-командой (isConnectedWith).
- При ошибке пишет причину в error_log и возвращает false.
Returns Promise<boolean>
true — подключение активно, false — ошибка подключения.
Overrides BaseDbAdapter.connect
- Defined in plugins/db/Mongo/Adapter.ts:220

destroy

destroy(): Promise<void>
Закрывает все подключения к БД. Все процессы завершаются; Mongo при закрытии ничего не сохраняет (в отличие от FileAdapter).

Returns Promise<void>
Overrides BaseDbAdapter.destroy
- Defined in plugins/db/Mongo/Adapter.ts:669

escapeString

escapeString(str: string | number): string
Экранирует строку для безопасного использования в запросах.

⚠️ По умолчанию просто приводит значение к строке. Если ваша БД требует экранирования (например, SQL), обязательно переопределите этот метод.
Parameters
- str: string | number
  Экранируемая строка
Returns string
Экранированная строка
Inherited from BaseDbAdapter.escapeString
- Defined in plugins/db/Base/Base.ts:359

getValue

getValue(res: IModelRes<IDbResult<unknown>>): IDbResult<unknown> | null
Удобный метод для извлечения данных из результата запроса. Проверяет res.status и возвращает res.data только при успехе.

Используется в моделях и контроллерах для безопасного доступа к данным.
Parameters
- res: IModelRes<IDbResult<unknown>>
  Результат запроса (IModelRes)
Returns IDbResult<unknown> | null
Данные из res.data при status = true, иначе null
Inherited from BaseDbAdapter.getValue
- Defined in plugins/db/Base/Base.ts:105

init

init(appContext: AppContext): void
Метод инициализации плагина. Вызывается один раз при подключении через bot.use().
Parameters
- appContext: AppContext
  Контекст приложения
Returns void
Overrides BaseDbAdapter.init
- Defined in plugins/db/Mongo/Adapter.ts:88

insert

insert(insertData: IQuery): Promise<boolean>
Выполняет INSERT-запрос.

Внутри себя вызывает this._insert, основное отличие в том, что в данном методе пишутся метрики.
Parameters
- insertData: IQuery
  Дополнительная информация для запроса. Содержит сам запрос, а также название таблицы и прочие данные.
Returns Promise<boolean>
true при успешной вставке, иначе false
Inherited from BaseDbAdapter.insert
- Defined in plugins/db/Base/Base.ts:238

isConnected

isConnected(): Promise<boolean>
Проверяет, установлено ли соединение с БД.

Returns Promise<boolean>
Overrides BaseDbAdapter.isConnected
- Defined in plugins/db/Mongo/Adapter.ts:634

`Protected`isConnectedWith

isConnectedWith(client: MongoClient): Promise<boolean>
Проверяет, установлено ли соединение, для конкретного клиента.
Parameters
- client: MongoClient
  Клиент, у которого проверяем соединение
Returns Promise<boolean>
Promise — true, если команда ping выполнена успешно
- Defined in plugins/db/Mongo/Adapter.ts:254

query

query(callback: TQueryCb<MongoClient, Db>): Promise<unknown>
Выполняет произвольный запрос через callback.

Выполняет this._query напрямую. Метрики времени выполнения не записываются (в отличие от select/insert/update/remove).
Parameters
- callback: TQueryCb<MongoClient, Db>
  функция обработчик
Returns Promise<unknown>
Overrides BaseDbAdapter.query
- Defined in plugins/db/Mongo/Adapter.ts:526

remove

remove(removeData: IQuery): Promise<boolean>
Выполняет DELETE-запрос.

Внутри себя вызывает this._remove, основное отличие в том, что в данном методе пишутся метрики.
Parameters
- removeData: IQuery
  Дополнительная информация для запроса. Содержит сам запрос, а также название таблицы и прочие данные.
Returns Promise<boolean>
true при успешном удалении, иначе false
Inherited from BaseDbAdapter.remove
- Defined in plugins/db/Base/Base.ts:282

save

save(saveData: IQuery, isNew: boolean): Promise<boolean>
Сохраняет запись: вставляет новую или обновляет существующую. Логика:
- Если isNew === true → перед insert ключи условия мержатся в данные (saveData.data = {...data, ...query}) и вызывается insert
- Иначе → сначала делается selectOne по saveData.query, и если запись найдена — вызывается update, иначе — insert (тоже с мерджем ключей условия в данные)
Parameters
- saveData: IQuery
  Данные для запроса. Включает как запрос, так и сами данные
- isNew: boolean
  Флаг, говорящий о том, что точно происходит добавление новой записи
Returns Promise<boolean>
true при успешном сохранении, иначе false
Inherited from BaseDbAdapter.save
- Defined in plugins/db/Base/Base.ts:321

select

select(
    selectData: IQuery,
    where: IQueryData | null,
    isOne: boolean,
): Promise<IModelRes<IDataValue>>
Выполняет SELECT-запрос.

Внутри себя вызывает this._select, основное отличие в том, что в данном методе пишутся метрики.
Parameters
- selectData: IQuery
  Дополнительная информация для запроса. Содержит информацию о таблице и структуре.
- where: IQueryData | null
  Сам запрос
- isOne: boolean
  Определяет нужно ли вернуть только 1 найденную запись, либо отдать все доступные данные.
Returns Promise<IModelRes<IDataValue>>
Результат SELECT-запроса (IModelRes)
Inherited from BaseDbAdapter.select
- Defined in plugins/db/Base/Base.ts:211

selectOne

selectOne(
selectData: IQuery,
where: IQueryData | null,
): Promise<IModelRes<IDataValue> | null>
Выполняет SELECT с ограничением до одной записи.
Parameters
- selectData: IQuery
  Дополнительные данные для запроса
- where: IQueryData | null
  Сам запрос (условие выборки). При null или undefined вернётся null
Returns Promise<IModelRes<IDataValue> | null>
IModelRes с результатом выборки (одна запись — в data), либо null, если условие не передано. При отсутствии записей возвращается { status: false }.
Inherited from BaseDbAdapter.selectOne
- Defined in plugins/db/Base/Base.ts:341

update

update(updateData: IQuery): Promise<boolean>
Выполняет UPDATE-запрос.

Внутри себя вызывает this._update, основное отличие в том, что в данном методе пишутся метрики.
Parameters
- updateData: IQuery
  Дополнительная информация для запроса. Содержит сам запрос, а также название таблицы и прочие данные.
Returns Promise<boolean>
true при успешном обновлении, иначе false
Inherited from BaseDbAdapter.update
- Defined in plugins/db/Base/Base.ts:260

validate

validate(query: IQuery, element: IQueryData | null): IQueryData
Валидация запросов. Правила валидации (query.rules) применяются к element — метод мутирует и возвращает его. При element === null возвращается {}.
Parameters
- query: IQuery
  Запрос: источник правил валидации (query.rules)
- element: IQueryData | null
  Валидируемый элемент данных
Returns IQueryData
Валидированный элемент; при element === null — {}
- Defined in plugins/db/Mongo/Adapter.ts:538

Class MongoAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MongoAdapter

Properties

Protected_appContext

Protected Optional_dbOptions

dbFormat

Methods

Protected_attemptConnect

Parameters

Returns Promise<{ client: MongoClient; connect: MongoClient }>

Throws

Protected_buildConnectOptions

Parameters

Returns MongoClientOptions

Protected_closePreviousClient

Returns Promise<void>

_insert

Parameters

Returns Promise<boolean>

Protected_loadMongo

Returns Promise<__module>

Throws

_query

Parameters

Returns Promise<unknown>

_remove

Parameters

Returns Promise<boolean>

Protected_saveLog

Parameters

Returns void

_select

Parameters

Returns Promise<IModelRes<IDataValue>>

_update

Parameters

Returns Promise<boolean>

close

Parameters

Returns Promise<void>

connect

Returns Promise<boolean>

destroy

Returns Promise<void>

escapeString

Parameters

Returns string

getValue

Parameters

Returns IDbResult<unknown> | null

init

Parameters

Returns void

insert

Parameters

Returns Promise<boolean>

isConnected

Returns Promise<boolean>

ProtectedisConnectedWith

Parameters

Returns Promise<boolean>

query

Parameters

Returns Promise<unknown>

remove

Parameters

Returns Promise<boolean>

save

Parameters

Returns Promise<boolean>

select

Parameters

`Protected`_appContext

`Protected` `Optional`_dbOptions

`Protected`_attemptConnect

`Protected`_buildConnectOptions

`Protected`_closePreviousClient

`Protected`_loadMongo

`Protected`_saveLog

`Protected`isConnectedWith