umbot - v2.1.3
    Preparing search index...

    Class DbControllerFile

    Контроллер для работы с данными, хранящимися в JSON файлах Реализует базовые операции CRUD для файлового хранилища

    // Создание контроллера
    const controller = new DbControllerFile();
    controller.tableName = 'users';

    // Добавление записи
    const queryData = new QueryData();
    queryData.setData({ id: 1, name: 'John' });
    await controller.insert(queryData);

    // Поиск записей
    const result = await controller.select({ name: 'John' });

    DbControllerFile

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _appContext _connectConfig _primaryKeyName _rules _tableName cachedFileData

    Accessors

    primaryKeyName tableName

    Methods

    destroy escapeString getFileData getValue insert isConnected 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

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

    cachedFileData: IFileData = {}

    Кэш для хранения данных из файлов. Оптимизирует производительность при частом чтении

    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");

    • Получает все данные из файла Использует кэширование для оптимизации производительности

      Returns any

      Объект с данными из файла

      const data = controller.getFileData();
      console.log(data); // { "1": { "id": 1, "name": "John" } }

    • Добавляет новую запись в файл

      Parameters

      • insertQuery: QueryData

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

      Returns Promise<any>

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

      const queryData = new QueryData();
      queryData.setData({ id: 1, name: 'John' });
      await controller.insert(queryData);

    • Проверяет состояние подключения к файлу В текущей реализации всегда возвращает true

      Returns Promise<boolean>

      Promise - всегда true

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

    • Удаляет запись из файла

      Parameters

      • removeQuery: QueryData

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

      Returns Promise<boolean>

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

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

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

      Parameters

      • saveData: QueryData

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

      • isNew: boolean

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

      Returns Promise<any>

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

      const queryData = new QueryData();
      queryData.setData({ username: 'John' });
      queryData.setQuery({ id: 1 });
      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({ name: 'John' });

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

      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

      • updateQuery: QueryData

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

      Returns Promise<any>

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

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

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

      Parameters

      • element: IQueryData | null

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

      Returns IQueryData

      Валидированные данные

      const validated = controller.validate({
        id: 1,
        name: 'John'
      });

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods