umbot - v2.0.8
    Preparing search index...

    Class Model<TState>Abstract

    Абстрактный класс для создания моделей данных Предоставляет базовую функциональность для работы с данными в базе данных

    class UserModel extends Model<UserState> {
      // Определение правил валидации
      rules(): IModelRules[] {
        return [
          { name: ['username'], type: 'string', max: 50 },
          { name: ['age'], type: 'integer' }
        ];
      }

      // Определение меток атрибутов
      attributeLabels(): UserState {
        return {
          id: 'ID',
          username: 'Имя пользователя',
          age: 'Возраст'
        };
      }

      // Определение имени таблицы
      tableName(): string {
        return 'users';
      }
    }

    // Использование модели
    const user = new UserModel();
    user.state.username = 'John';
    user.state.age = 25;
    await user.save();

    Type Parameters

    • TState extends TStateData

      Тип состояния модели Model

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    dbController queryData startIndex state

    Methods

    rules attributeLabels tableName isConnected escapeString validate getId init selectOne save update add remove where whereOne query destroy

    Constructors

    Properties

    dbController: IDbControllerModel | DbController

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

    // Получение данных через контроллер
    const result = await this.dbController.select(
      { where: { id: 1 } },
      true
    );
    queryData: QueryData

    Объект для хранения параметров запроса Содержит условия поиска и данные для обновления

    // Установка параметров запроса
    this.queryData.setQuery({ id: 1 });
    this.queryData.setData({ name: 'John' });
    startIndex: number = 0

    Начальный индекс для итерации по данным Используется при инициализации модели из массива

    state: Partial<TState> = {}

    Состояние модели Содержит текущие значения всех атрибутов

    // Установка значений
    this.state.username = 'John';
    this.state.age = 25;

    // Получение значений
    console.log(this.state.username);

    Methods

    • Определяет правила валидации для полей модели Должен быть реализован в дочерних классах

      Returns IModelRules[]

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

      rules(): IModelRules[] {
        return [
          { name: ['username'], type: 'string', max: 50 },
          { name: ['age'], type: 'integer' }
        ];
      }

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

      Returns TState

      Объект с метками атрибутов

      attributeLabels(): UserState {
        return {
          id: 'ID',
          username: 'Имя пользователя',
          age: 'Возраст'
        };
      }

    • Определяет имя таблицы в базе данных Должен быть реализован в дочерних классах

      Returns string

      Имя таблицы

      tableName(): string {
        return 'users';
      }

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

      Returns Promise<boolean>

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

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

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

      Parameters

      • text: string | number

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

      Returns string

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

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

    • Выполняет валидацию данных модели Может быть переопределен в дочерних классах

      Returns void

      validate(): void {
        if (!this.state.username) {
          throw new Error('Username is required');
        }
      }

    • Определяет имя первичного ключа таблицы Ищет поле с меткой 'id' или 'ID'

      Returns null | string | number

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

    • Выполняет поиск записи по первичному ключу

      Returns Promise<IModelRes>

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

      const result = await model.selectOne();
      if (result.status) {
        model.init(result.data);
      }

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

      Parameters

      • isNew: boolean = false

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

      Returns Promise<any>

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

      model.state.name = 'John';
      await model.save(); // Обновление существующей записи
      await model.save(true); // Создание новой записи

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

      Returns Promise<any>

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

      model.state.name = 'John';
      await model.update();

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

      Returns Promise<any>

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

      model.state.name = 'John';
      await model.add();

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

      Returns Promise<boolean>

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

      await model.remove();

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

      Parameters

      • where: any = '1'

        Условия запроса

      • isOne: boolean = false

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

      Returns Promise<IModelRes>

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

      const result = await model.where(
        { age: { $gt: 18 } },
        false
      );

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

      Parameters

      • where: any = '1'

        Условия запроса

      Returns Promise<boolean>

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

      const found = await model.whereOne({ id: 1 });
      if (found) {
        console.log('Record found');
      }

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

      Parameters

      • callback: TQueryCb

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

      Returns any

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

      const result = await model.query(async (client, db) => {
        const collection = db.collection('users');
        return await collection.aggregate([
          { $match: { age: { $gt: 18 } } },
          { $group: { _id: '$city', count: { $sum: 1 } } }
        ]).toArray();
      });

    • Закрывает соединение с базой данных

      Returns void

      model.destroy();

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods