umbot - v2.1.3
    Preparing search index...

    Class DbController

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

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

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

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

    DbController

    • DbControllerFile
    • DbControllerMongoDb

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _appContext _connectConfig _primaryKeyName _rules _tableName

    Accessors

    primaryKeyName tableName

    Methods

    destroy escapeString getValue insert isConnected isSelected query remove save select selectOne setAppContext setRules update validate

    Constructors

    Properties

    Protected_appContext

    _appContext: AppContext | undefined

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

    Protected_connectConfig

    _connectConfig: IAppDB | undefined

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

    Protected_primaryKeyName

    _primaryKeyName: TKey

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

    id

    Protected_rules

    _rules: IModelRules[]

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

    Protected_tableName

    _tableName: string

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

    Accessors

    • get primaryKeyName(): TKey

      Возвращает имя первичного ключа таблицы

      Returns TKey

      Имя первичного ключа

      const keyName = controller.primaryKeyName;
    • set primaryKeyName(primaryKey: TKey): void

      Устанавливает имя первичного ключа таблицы

      Parameters

      • primaryKey: TKey

        Имя первичного ключа

      Returns void

      controller.primaryKeyName = 'id';
    • get tableName(): string

      Возвращает имя таблицы

      Returns string

      Имя таблицы

      const table = controller.tableName;
    • set tableName(tableName: string): void

      Устанавливает имя таблицы

      Parameters

      • tableName: string

        Имя таблицы

      Returns void

      controller.tableName = 'users';

    Methods

    • Экранирует специальные символы в строке

      Parameters

      • text: string | number

        Текст для экранирования

      Returns string

      Экранированная строка

      const safe = controller.escapeString("O'Connor");

    • Добавляет новую запись в источник данных

      Parameters

      • insertQuery: QueryData

        Данные для добавления

      Returns Promise<any>

      Promise с результатом операции

      const queryData = new QueryData();
      queryData.setData({ username: 'John', age: 25 });
      await controller.insert(queryData);

    • Проверяет состояние подключения к источнику данных

      Returns Promise<boolean>

      Promise - true если подключение активно

      const isConnected = await controller.isConnected();
      if (isConnected) {
        // Выполнение операций с данными
      }

    • Проверяет наличие записи в таблице

      Parameters

      • query: IQueryData | null

        Условия поиска

      Returns Promise<boolean>

      Promise - true если запись найдена

      const exists = await controller.isSelected({ id: 1 });
      if (exists) {
        console.log('Record found');
      }

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

      Parameters

      • callback: TQueryCb

        Функция обратного вызова для выполнения запроса

      Returns any

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

      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();
      });

    • Удаляет запись из источника данных

      Parameters

      • removeQuery: QueryData

        Данные для удаления

      Returns Promise<boolean>

      Promise - true если удаление успешно

      const queryData = new QueryData();
      queryData.setQuery({ id: 1 });
      await controller.remove(queryData);

    • Сохраняет запись в источник данных Если запись существует - обновляет, иначе создает новую

      Parameters

      • queryData: QueryData

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

      • isNew: boolean = false

        Флаг создания новой записи

      Returns Promise<any>

      Promise с результатом операции

      const queryData = new QueryData();
      queryData.setData({ username: 'John', age: 25 });
      await controller.save(queryData);

    • Выполняет поиск записей в источнике данных

      Parameters

      • where: IQueryData | null

        Условия поиска

      • isOne: boolean = false

        Флаг выборки одной записи

      Returns Promise<IModelRes>

      Promise с результатом запроса

      // Поиск одной записи
      const one = await controller.select({ id: 1 }, true);

      // Поиск нескольких записей
      const many = await controller.select({ age: { $gt: 18 } });

    • Выполняет поиск одной записи в источнике данных

      Parameters

      • query: IQueryData | null

        Условия поиска

      Returns Promise<IModelRes | null>

      Promise с результатом запроса или null

      const result = await controller.selectOne({ id: 1 });
      if (result?.status) {
        console.log('Record found');
      }

    • Устанавливает правила валидации для модели

      Parameters

      • rules: IModelRules[]

        Массив правил валидации

      Returns void

      controller.setRules([
        { name: ['username'], type: 'string', max: 50 },
        { name: ['age'], type: 'integer' }
      ]);

    • Обновляет существующую запись в источнике данных

      Parameters

      • updateQuery: QueryData

        Данные для обновления

      Returns Promise<any>

      Promise с результатом операции

      const queryData = new QueryData();
      queryData.setQuery({ id: 1 });
      queryData.setData({ username: 'John' });
      await controller.update(queryData);

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods