umbot
    Preparing search index...

    Class Model<TState>Abstract

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

    class UserModel extends Model<UserState> {
      public constructor(appContext: AppContext) {
        super(appContext);
      }

      // Определение правил валидации
      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(appContext);
    user.state.username = 'John';
    user.state.age = 25;
    await user.save();

    Type Parameters

    • TState extends IModelState

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

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

    Properties

    _appContext queryData startIndex state

    Constructors

    • Создает новый экземпляр модели. Инициализирует контекст приложения и параметры запроса (queryData)

      Type Parameters

      • TState extends IModelState

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

      Parameters

      • appContext: AppContext

        Контекст приложения (адаптер БД, логгер, метрики)

      Returns Model<TState>

      const user = new UserModel(appContext);

    Methods

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

      Returns Promise<boolean>

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

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

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

      Returns TState

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

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

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

      Returns void | Promise<void>

      model.destroy();

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

      Parameters

      • text: string | number

        Строка или число для экранирования

      Returns string

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

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

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

      Returns TKey

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

    • Возвращает поля, которые вместе с первичным ключом однозначно определяют запись. Переопределите, если значение первичного ключа уникально только в паре с другим полем (как userId у UsersData — в пределах платформы). Эти поля попадают в условие selectOne/update/remove и в IQuery.uniqueKeys.

      Returns string[]

      Имена дополнительных ключевых полей (по умолчанию — пусто)

      protected getUniqueKeys(): string[] {
          return ['platform'];
      }

    • Инициализирует модель данными

      Parameters

      • data: IDbResult<unknown> | IDbResult<unknown>[] | null

        Данные для инициализации

      Returns void

      // Объект: значения сопоставляются по именам полей (меткам attributeLabels)
      model.init({
        id: 1,
        username: 'John',
        age: 25
      });

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

      Returns boolean | Promise<boolean>

      true если подключение активно (синхронно false без адаптера БД, иначе Promise от адаптера)

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

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

      Типы client/db зависят от подключённого адаптера БД — для MongoAdapter это MongoClient и Db из драйвера mongodb. Для FileAdapter _query не реализован — метод вернёт null.

      Parameters

      • callback: TQueryCb

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

      Returns unknown

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

      import type { MongoClient, Db } from 'mongodb';

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

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

      Returns Promise<boolean>

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

      await model.remove();

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

      Returns IModelRules[]

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

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

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

      Parameters

      • isNew: boolean = false

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

      Returns Promise<boolean>

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

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

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

      Returns Promise<ISelectOneModelRes>

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

      const result = await model.selectOne();
      if (result.status) {
        model.init(result.data ?? null); // data опционален, init() допускает null
      }

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

      Returns string

      Имя таблицы

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

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

      Returns Promise<boolean>

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

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

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

      Returns void

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

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

      Parameters

      • where: string | IQueryData = '1'

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

      • isOne: boolean = false

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

      Returns Promise<IModelRes<IDataValue>>

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

      // Объект условий — точные значения полей
      const res = await model.where({ age: 25 });

      // Строка условий формата getQueryData
      const res2 = await model.where('`age`=25 `status`="active"');

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

      Parameters

      • where: string | IQueryData = '1'

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

      Returns Promise<boolean>

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

      const found = await model.whereOne({ id: 1 });
      if (found) {
        console.log('Запись найдена');
      }

    Properties

    Protected_appContext

    _appContext: AppContext

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

    queryData: IQuery

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

    startIndex: number = 0

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

    state: Partial<TState> = {}

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

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

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties