Class DbController

Контроллер для работы с данными Автоматически выбирает подходящий источник данных на основе конфигурации приложения

Example

// Создание контроллера
const controller = new DbController();

// Настройка правил и имени таблицы
controller.setRules([
  { name: ['username'], type: 'string', max: 50 }
]);
controller.tableName = 'users';

// Выполнение запросов
const result = await controller.select({ username: 'John' });

DbController

See

DbControllerFile
DbControllerMongoDb

Hierarchy (View Summary)

DbControllerModel
- DbController

Index

Constructors

constructor

new DbController(): DbController
Создает новый экземпляр контроллера Выбирает подходящий источник данных на основе конфигурации приложения

Returns DbController
Example
```
const controller = new DbController();
```
Overrides DbControllerModel.constructor
- Defined in src/models/db/DbController.ts:60

Properties

`Protected`_tableName

_tableName: string

Имя таблицы в базе данных Используется для выполнения запросов

`Protected`_rules

_rules: IModelRules[]

Правила валидации для полей таблицы Определяют типы и ограничения для каждого поля

`Protected`_connectConfig

_connectConfig: undefined | IAppDB

Конфигурация подключения к базе данных Содержит параметры для установки соединения

`Protected`_primaryKeyName

_primaryKeyName: TKey

Имя первичного ключа таблицы По умолчанию 'id'

Default Value

id

Accessors

primaryKeyName

get primaryKeyName(): TKey
Возвращает имя первичного ключа таблицы

Returns TKey
Имя первичного ключа
Example
```
const keyName = controller.primaryKeyName;
```
Overrides DbControllerModel.primaryKeyName
- Defined in src/models/db/DbController.ts:112
set primaryKeyName(primaryKey: TKey): void
Устанавливает имя первичного ключа таблицы
Parameters
- primaryKey: TKey
  Имя первичного ключа
Returns void
Example
```
controller.primaryKeyName = 'id';
```
Overrides DbControllerModel.primaryKeyName
- Defined in src/models/db/DbController.ts:97

tableName

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

Returns string
Имя таблицы
Example
```
const table = controller.tableName;
```
Overrides DbControllerModel.tableName
- Defined in src/models/db/DbController.ts:141
set tableName(tableName: string): void
Устанавливает имя таблицы
Parameters
- tableName: string
  Имя таблицы
Returns void
Example
```
controller.tableName = 'users';
```
Overrides DbControllerModel.tableName
- Defined in src/models/db/DbController.ts:126

Methods

setRules

setRules(rules: IModelRules[]): void
Устанавливает правила валидации для модели
Parameters
- rules: IModelRules[]
  Массив правил валидации
Returns void
Example
```
controller.setRules([
  { name: ['username'], type: 'string', max: 50 },
  { name: ['age'], type: 'integer' }
]);
```
Overrides DbControllerModel.setRules
- Defined in src/models/db/DbController.ts:82

save

save(queryData: QueryData, isNew?: boolean): Promise<any>
Сохраняет запись в источник данных Если запись существует - обновляет, иначе создает новую
Parameters
- queryData: QueryData
  Данные для сохранения
- isNew: boolean = false
  Флаг создания новой записи
Returns Promise<any>
Promise с результатом операции
Example
```
const queryData = new QueryData();
queryData.setData({ username: 'John', age: 25 });
await controller.save(queryData);
```
Overrides DbControllerModel.save
- Defined in src/models/db/DbController.ts:160

isSelected

isSelected(query: null | IQueryData): Promise<boolean>
Проверяет наличие записи в таблице
Parameters
- query: null | IQueryData
  Условия поиска
Returns Promise<boolean>
Promise - true если запись найдена
Example
```
const exists = await controller.isSelected({ id: 1 });
if (exists) {
  console.log('Record found');
}
```
- Defined in src/models/db/DbController.ts:178

update

update(updateQuery: QueryData): Promise<any>
Обновляет существующую запись в источнике данных
Parameters
- updateQuery: QueryData
  Данные для обновления
Returns Promise<any>
Promise с результатом операции
Example
```
const queryData = new QueryData();
queryData.setQuery({ id: 1 });
queryData.setData({ username: 'John' });
await controller.update(queryData);
```
Overrides DbControllerModel.update
- Defined in src/models/db/DbController.ts:196

insert

insert(insertQuery: QueryData): Promise<any>
Добавляет новую запись в источник данных
Parameters
- insertQuery: QueryData
  Данные для добавления
Returns Promise<any>
Promise с результатом операции
Example
```
const queryData = new QueryData();
queryData.setData({ username: 'John', age: 25 });
await controller.insert(queryData);
```
Overrides DbControllerModel.insert
- Defined in src/models/db/DbController.ts:213

remove

remove(removeQuery: QueryData): Promise<boolean>
Удаляет запись из источника данных
Parameters
- removeQuery: QueryData
  Данные для удаления
Returns Promise<boolean>
Promise - true если удаление успешно
Example
```
const queryData = new QueryData();
queryData.setQuery({ id: 1 });
await controller.remove(queryData);
```
Overrides DbControllerModel.remove
- Defined in src/models/db/DbController.ts:230

query

query(callback: TQueryCb): any
Выполняет произвольный запрос к источнику данных
Parameters
- callback: TQueryCb
  Функция обратного вызова для выполнения запроса
Returns any
Результат выполнения запроса
Example
```
const result = await controller.query(async (client, db) => {
  const collection = db.collection('users');
  return await collection.aggregate([
    { $match: { age: { $gt: 18 } } },
    { $group: { _id: '$city', count: { $sum: 1 } } }
  ]).toArray();
});
```
Overrides DbControllerModel.query
- Defined in src/models/db/DbController.ts:251

validate

validate(element: null | IQueryData): IQueryData
Выполняет валидацию данных
Parameters
- element: null | IQueryData
  Данные для валидации
Returns IQueryData
Валидированные данные
Example
```
const validated = controller.validate({
  username: 'John',
  age: 25
});
```
- Defined in src/models/db/DbController.ts:269

select

select(where: null | IQueryData, isOne?: boolean): Promise<IModelRes>
Выполняет поиск записей в источнике данных
Parameters
- where: null | IQueryData
  Условия поиска
- isOne: boolean = false
  Флаг выборки одной записи
Returns Promise<IModelRes>
Promise с результатом запроса
Example
```
// Поиск одной записи
const one = await controller.select({ id: 1 }, true);

// Поиск нескольких записей
const many = await controller.select({ age: { $gt: 18 } });
```
Overrides DbControllerModel.select
- Defined in src/models/db/DbController.ts:289

getValue

getValue(res: IModelRes): null | IDbControllerResult<unknown>
Преобразует результат запроса в требуемый формат
Parameters
- res: IModelRes
  Результат выполнения запроса
Returns null | IDbControllerResult<unknown>
Объект с данными или null
Example
```
const result = await controller.select({ id: 1 });
const value = controller.getValue(result);
console.log(value.username); // John
```
Overrides DbControllerModel.getValue
- Defined in src/models/db/DbController.ts:306

destroy

destroy(): void
Закрывает соединение с источником данных

Returns void
Example
```
controller.destroy();
```
Overrides DbControllerModel.destroy
- Defined in src/models/db/DbController.ts:318

escapeString

escapeString(text: string | number): string
Экранирует специальные символы в строке
Parameters
- text: string | number
  Текст для экранирования
Returns string
Экранированная строка
Example
```
const safe = controller.escapeString("O'Connor");
```
Overrides DbControllerModel.escapeString
- Defined in src/models/db/DbController.ts:333

isConnected

isConnected(): Promise<boolean>
Проверяет состояние подключения к источнику данных

Returns Promise<boolean>
Promise - true если подключение активно
Example
```
const isConnected = await controller.isConnected();
if (isConnected) {
  // Выполнение операций с данными
}
```
Overrides DbControllerModel.isConnected
- Defined in src/models/db/DbController.ts:350

selectOne

selectOne(query: null | IQueryData): Promise<null | IModelRes>
Выполняет поиск одной записи в источнике данных
Parameters
- query: null | IQueryData
  Условия поиска
Returns Promise<null | IModelRes>
Promise с результатом запроса или null
Example
```
const result = await controller.selectOne({ id: 1 });
if (result?.status) {
  console.log('Record found');
}
```
Inherited from DbControllerModel.selectOne
- Defined in src/models/db/DbControllerModel.ts:327

Class DbController

Example

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns DbController

Example

Properties

Protected_tableName

Protected_rules

Protected_connectConfig

Protected_primaryKeyName

Default Value

Accessors

primaryKeyName

Returns TKey

Example

Parameters

Returns void

Example

tableName

Returns string

Example

Parameters

Returns void

Example

Methods

setRules

Parameters

Returns void

Example

save

Parameters

Returns Promise<any>

Example

isSelected

Parameters

Returns Promise<boolean>

Example

update

Parameters

Returns Promise<any>

Example

insert

Parameters

Returns Promise<any>

Example

remove

Parameters

Returns Promise<boolean>

Example

query

Parameters

Returns any

Example

validate

Parameters

Returns IQueryData

Example

select

Parameters

Returns Promise<IModelRes>

Example

getValue

Parameters

Returns null | IDbControllerResult<unknown>

Example

destroy

Returns void

Example

escapeString

Parameters

Returns string

Example

`Protected`_tableName

`Protected`_rules

`Protected`_connectConfig

`Protected`_primaryKeyName