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 src/plugins/db/Mongo/Adapter.ts:45

Properties

`Protected`_appContext

_appContext: AppContext<IMongoDbInfo>

`Protected` `Optional`_dbOptions

_dbOptions?: IAppDB

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

dbFormat

dbFormat: string = 'mongodb'

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

Methods

_insert

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

_query

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

_remove

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

`Protected`_saveLog

_saveLog(errorMsg: string, error?: Error): void
Protected
Сохранение логов
Parameters
- errorMsg: string
- Optionalerror: Error
Returns void
- Defined in src/plugins/db/Mongo/Adapter.ts:382

_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>>
Overrides BaseDbAdapter._select
- Defined in src/plugins/db/Mongo/Adapter.ts:319

_update

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

close

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

connect

connect(): Promise<boolean>
Устанавливает подключение к базе данных. В случае успешного подключения возвращается true

Returns Promise<boolean>
Overrides BaseDbAdapter.connect
- Defined in src/plugins/db/Mongo/Adapter.ts:68

destroy

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

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

escapeString

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

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

getValue

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

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

init

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

insert

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

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

isConnected

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

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

query

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

Внутри себя вызывает this._query, основное отличие в том, что в данном методе пишутся метрики.
Parameters
- callback: TQueryCb<MongoClient, Db>
  функция обработчик
Returns Promise<unknown>
Overrides BaseDbAdapter.query
- Defined in src/plugins/db/Mongo/Adapter.ts:269

remove

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

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

save

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

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>>
Inherited from BaseDbAdapter.select
- Defined in src/plugins/db/Base/Base.ts:192

selectOne

selectOne(
selectData: IQuery,
where: IQueryData | null,
): Promise<IModelRes<IDataValue> | null>
Выполняет SELECT с ограничением до одной записи.
Parameters
- selectData: IQuery
  Дополнительные данные для запроса
- where: IQueryData | null
  Сам запроса
Returns Promise<IModelRes<IDataValue> | null>
Inherited from BaseDbAdapter.selectOne
- Defined in src/plugins/db/Base/Base.ts:314

update

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

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

validate

validate(query: IQuery, element: IQueryData | null): IQueryData
Валидация запросов. Валидирует запрос, приводя его к корректному виду
Parameters
- query: IQuery
- element: IQueryData | null
Returns IQueryData
- Defined in src/plugins/db/Mongo/Adapter.ts:279

Class MongoAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MongoAdapter

Properties

Protected_appContext

Protected Optional_dbOptions

dbFormat

Methods

_insert

Parameters

Returns Promise<boolean>

_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>

query

Parameters

Returns Promise<unknown>

remove

Parameters

Returns Promise<boolean>

save

Parameters

Returns Promise<boolean>

select

Parameters

Returns Promise<IModelRes<IDataValue>>

selectOne

Parameters

Returns Promise<IModelRes<IDataValue> | null>

update

Parameters

Returns Promise<boolean>

validate

Parameters

Returns IQueryData

Settings

On This Page

`Protected`_appContext

`Protected` `Optional`_dbOptions

`Protected`_saveLog