Class BaseDbAdapter<TDbInfo>`Abstract`

Базовый класс для создания адаптеров баз данных. При наследовании вы ОБЯЗАНЫ реализовать следующие методы:

_select - Получение данных
_insert - Добавление данных
_update - Обновление данных
_remove - Удаление данных
isConnected - Проверяет, установлено ли подключение к базе или нет

Эти методы вызываются внутренней логикой фреймворка и определяют, как именно выполняются операции с вашей БД.

Рекомендуется наследоваться от этого класса при создании собственного адаптера, так как он уже реализует общую логику: интеграцию с контекстом приложения, сбор метрик, управление соединениями.

Если по техническим причинам наследование невозможно — ваш класс должен в точности реализовывать интерфейс IDatabaseAdapter

Важно: в приложении может быть активен только один адаптер БД.

Type Parameters

TDbInfo extends IDatabaseInfo = IDatabaseInfo

Hierarchy (View Summary)

BasePlugin
- BaseDbAdapter
  - FileAdapter
  - MongoAdapter

Implements

IDatabaseAdapter

Index

Constructors

constructor

new BaseDbAdapter<TDbInfo extends IDatabaseInfo = IDatabaseInfo>(
options?: IAppDB,
): BaseDbAdapter<TDbInfo>
Конструктор для адаптера базы данных
Type Parameters
- TDbInfo extends IDatabaseInfo = IDatabaseInfo
Parameters
- Optionaloptions: IAppDB
  Дополнительные опции для настройки БД. Тут можно передать настройки для подключения к базе, либо дополнительную информацию, необходимую для работы.
Returns BaseDbAdapter<TDbInfo>
Overrides BasePlugin.constructor
- Defined in plugins/db/Base/Base.ts:56

Properties

`Protected`_appContext

_appContext: AppContext<TDbInfo> = ...

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

`Protected` `Optional`_dbOptions

_dbOptions?: IAppDB

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

dbFormat

dbFormat: string

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

Methods

`Abstract`_insert

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

Этот метод вызывается внутренней логикой фреймворка для добавления данных. Вы обязаны вернуть:
- true — если запись успешно добавлена,
- false — при любой ошибке (подключение, валидация и т.п.).
⚠️ Не выбрасывайте исключения — обрабатывайте ошибки внутри и возвращайте false. Метод может быть синхронным или асинхронным.
Parameters
- insertData: IQuery
  Дополнительная информация для запроса. Содержит сам запрос, а также название таблицы и прочие данные.
Returns boolean | Promise<boolean>
boolean | Promise — true при успешной вставке, иначе false
- Defined in plugins/db/Base/Base.ts:158

_query

_query(_callback: TQueryCb): unknown
Выполняет произвольный запрос через callback. Если вы планируете использовать query(), обязательно переопределите _query. По умолчанию он возвращает null и не выполняет никаких действий.
Parameters
- _callback: TQueryCb
  функция обработчик
Returns unknown
- Defined in plugins/db/Base/Base.ts:198

`Abstract`_remove

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

Этот метод вызывается внутренней логикой фреймворка для удаления данных. Вы обязаны вернуть:
- true — если операция выполнена без ошибок (включая случай, когда под условие не попало записей),
- false — при любой ошибке (подключение, валидация и т.п.).
⚠️ Не выбрасывайте исключения — обрабатывайте ошибки внутри и возвращайте false. Метод может быть синхронным или асинхронным.
Parameters
- removeData: IQuery
  Дополнительная информация для запроса. Содержит сам запрос, а также название таблицы и прочие данные.
Returns boolean | Promise<boolean>
boolean | Promise — true при успешном удалении, иначе false
- Defined in plugins/db/Base/Base.ts:190

`Abstract`_select

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

Этот метод вызывается внутренней логикой фреймворка для получения данных. Вы обязаны вернуть объект, совместимый с IModelRes<IDbResult>, где:
- status: true и data — при успешной выборке (даже если найдено 0 записей);
- status: false и опционально error — при ошибке подключения, синтаксиса и т.п.
⚠️ Не выбрасывайте исключения — обрабатывайте ошибки внутри и возвращайте status: false. Метод может быть синхронным или асинхронным.

Пример возвращаемого значения при успехе:
```
{ status: true, data: [{ id: 1, name: 'Alice' }] }
```
Пример при ошибке:
```
{ status: false, error: 'Connection timeout' }
```
Parameters
- selectData: IQuery
  Дополнительная информация для запроса. Содержит информацию о таблице и структуре.
- where: IQueryData | null
  Сам запрос
- isOne: boolean
  Определяет нужно ли вернуть только 1 найденную запись, либо отдать все доступные данные.
Returns IModelRes<IDataValue> | Promise<IModelRes<IDataValue>>
IModelRes | Promise — результат SELECT-запроса
- Defined in plugins/db/Base/Base.ts:138

`Abstract`_update

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

Этот метод вызывается внутренней логикой фреймворка для обновления данных. Вы обязаны вернуть:
- true — если операция выполнена без ошибок (включая случай, когда под условие не попало записей),
- false — при любой ошибке (подключение, валидация и т.п.).
⚠️ Не выбрасывайте исключения — обрабатывайте ошибки внутри и возвращайте false. Метод может быть синхронным или асинхронным.
Parameters
- updateData: IQuery
  Дополнительная информация для запроса. Содержит сам запрос, а также название таблицы и прочие данные.
Returns boolean | Promise<boolean>
boolean | Promise — true при успешном обновлении, иначе false
- Defined in plugins/db/Base/Base.ts:174

close

close(_tableName: string): void | Promise<void>
Вызывается из destroy() при завершении работы приложения или замене адаптера (FileAdapter закрывает им каждую таблицу). Может использоваться для освобождения ресурсов, связанных с таблицей.
Parameters
- _tableName: string
  Название таблицы, подключение к которой закрывается
Returns void | Promise<void>
Implementation of IDatabaseAdapter.close
- Defined in plugins/db/Base/Base.ts:382

connect

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

Returns boolean | Promise<boolean>
Implementation of IDatabaseAdapter.connect
- Defined in plugins/db/Base/Base.ts:93

destroy

destroy(): void | Promise<void>
Вызывается при завершении работы приложения или замене адаптера. Используйте для закрытия соединений, сохранения данных и т.п.

Returns void | Promise<void>
Implementation of IDatabaseAdapter.destroy
Overrides BasePlugin.destroy
- Defined in plugins/db/Base/Base.ts:372

escapeString

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

⚠️ По умолчанию просто приводит значение к строке. Если ваша БД требует экранирования (например, SQL), обязательно переопределите этот метод.
Parameters
- str: string | number
  Экранируемая строка
Returns string
Экранированная строка
Implementation of IDatabaseAdapter.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
Implementation of IDatabaseAdapter.getValue
- Defined in plugins/db/Base/Base.ts:105

init

init(appContext: AppContext<unknown>): void
Метод инициализации адаптера. Вызывается один раз при подключении через bot.use(). В данном методе можно произвести дополнительную настройку для подключения к базе
Parameters
- appContext: AppContext<unknown>
  Контекст приложения
Returns void
Implementation of IDatabaseAdapter.init
Overrides BasePlugin.init
- Defined in plugins/db/Base/Base.ts:71

insert

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

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

`Abstract`isConnected

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

Returns boolean | Promise<boolean>
Implementation of IDatabaseAdapter.isConnected
- Defined in plugins/db/Base/Base.ts:366

query

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

Внутри себя вызывает this._query. Метрики времени выполнения не записываются (в отличие от select/insert/update/remove).
Parameters
- callback: TQueryCb
  функция обработчик
Returns unknown
Implementation of IDatabaseAdapter.query
- Defined in plugins/db/Base/Base.ts:304

remove

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

Внутри себя вызывает this._remove, основное отличие в том, что в данном методе пишутся метрики.
Parameters
- removeData: IQuery
  Дополнительная информация для запроса. Содержит сам запрос, а также название таблицы и прочие данные.
Returns Promise<boolean>
true при успешном удалении, иначе false
Implementation of IDatabaseAdapter.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
Implementation of IDatabaseAdapter.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)
Implementation of IDatabaseAdapter.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 }.
Implementation of IDatabaseAdapter.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
Implementation of IDatabaseAdapter.update
- Defined in plugins/db/Base/Base.ts:260

Class BaseDbAdapter<TDbInfo>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BaseDbAdapter<TDbInfo>

Properties

Protected_appContext

Protected Optional_dbOptions

dbFormat

Methods

Abstract_insert

Parameters

Returns boolean | Promise<boolean>

_query

Parameters

Returns unknown

Abstract_remove

Parameters

Returns boolean | Promise<boolean>

Abstract_select

Parameters

Returns IModelRes<IDataValue> | Promise<IModelRes<IDataValue>>

Abstract_update

Parameters

Returns boolean | Promise<boolean>

close

Parameters

Returns void | Promise<void>

connect

Returns boolean | Promise<boolean>

destroy

Returns void | Promise<void>

escapeString

Parameters

Returns string

getValue

Parameters

Returns IDbResult<unknown> | null

init

Parameters

Returns void

insert

Parameters

Returns Promise<boolean>

AbstractisConnected

Returns boolean | Promise<boolean>

query

Parameters

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

Settings

On This Page

Class BaseDbAdapter<TDbInfo>`Abstract`

`Protected`_appContext

`Protected` `Optional`_dbOptions

`Abstract`_insert

`Abstract`_remove

`Abstract`_select

`Abstract`_update

`Abstract`isConnected