umbot
    Preparing search index...

    Interface IDatabaseAdapter

    Адаптер для работы с базой данных.

    Обеспечивает унифицированный интерфейс для различных СУБД (файловая, MongoDB, PostgreSQL и др.). Все данные подключения и соединения хранятся в AppContext через IDatabaseInfo, чтобы избежать повторного подключения при каждом запросе.

    interface IDatabaseAdapter {
        close: (tableName: string) => void | Promise<void>;
        connect: () => boolean | Promise<boolean>;
        destroy: () => void | Promise<void>;
        ensureSchema?: (
            tables: readonly IDbTableSchema[],
        ) => boolean | Promise<boolean>;
        escapeString: (str: string | number) => string;
        getValue: (data: IModelRes) => IDbResult<unknown> | null;
        init: (appContext: AppContext, bot: Bot) => void;
        insert: (insertData: IQuery) => Promise<boolean>;
        isConnected: () => boolean | Promise<boolean>;
        query: (callback: TQueryCb) => unknown;
        remove: (removeData: IQuery) => Promise<boolean>;
        select: (
            selectData: IQuery,
            where: IQueryData | null,
            isOne: boolean,
        ) => Promise<IModelRes<IDataValue>>;
        selectOne: (
            selectData: IQuery,
            where: IQueryData | null,
        ) => Promise<IModelRes<IDataValue> | null>;
        update: (updateData: IQuery) => Promise<boolean>;
        save(query: IQuery, isNew: boolean): Promise<boolean>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    save

    Properties

    close connect destroy ensureSchema? escapeString getValue init insert isConnected query remove select selectOne update

    Methods

    • Сохраняет данные (INSERT или UPDATE в зависимости от isNew).

      Parameters

      • query: IQuery

        Данные для запроса. Включает как запрос, так и сами данные

      • isNew: boolean

        Флаг, говорящий о том, что добавляется новая запись

      Returns Promise<boolean>

    Properties

    close: (tableName: string) => void | Promise<void>

    Вызывается при удалении модели или завершении сессии. Может использоваться для освобождения ресурсов, связанных с таблицей.

    Type Declaration

      • (tableName: string): void | Promise<void>

      • Parameters

        • tableName: string

          Название таблицы, подключение к которой закрывается

        Returns void | Promise<void>

    connect: () => boolean | Promise<boolean>

    Устанавливает подключение к базе данных. В случае успешного подключения возвращается true

    destroy: () => void | Promise<void>

    Вызывается при завершении работы приложения или замене адаптера. Используйте для закрытия соединений, сохранения данных и т.п.

    ensureSchema?: (tables: readonly IDbTableSchema[]) => boolean | Promise<boolean>

    Подготавливает хранилище под встроенные таблицы umbot: создаёт недостающие таблицы, колонки или индексы. Фреймворк вызывает метод один раз после каждого успешного подключения (connect), до первого запроса к базе. Метод обязан быть идемпотентным: таблицы и индексы, которые уже есть, не пересоздаются.

    Необязательный: адаптер без метода (или базовый адаптер) ничего не готовит — так работают хранилища без схемы (FileAdapter). SQL-адаптер должен создать таблицы, иначе первый же запрос упадёт с «таблица не существует».

    Type Declaration

      • (tables: readonly IDbTableSchema[]): boolean | Promise<boolean>

      • Parameters

        • tables: readonly IDbTableSchema[]

          Описание встроенных таблиц (DB_TABLES_SCHEMA)

        Returns boolean | Promise<boolean>

        false (или Promise), если подготовить схему не удалось — фреймворк запишет ошибку в лог и продолжит работу с базой

    async ensureSchema(tables: readonly IDbTableSchema[]): Promise<boolean> {
        for (const table of tables) {
            const columns = Object.entries(table.fields).map(([name, field]) =>
                `"${name}" ${field.type === 'text' ? 'TEXT' : 'VARCHAR(255)'}`,
            );
            await this.#pool.query(
                `CREATE TABLE IF NOT EXISTS "${table.tableName}" (${columns.join(', ')})`,
            );
        }
        return true;
    }
    escapeString: (str: string | number) => string

    Экранирует строку для безопасного использования в SQL-запросах.

    Type Declaration

      • (str: string | number): string

      • Parameters

        • str: string | number

          — Экранируемая строка

        Returns string

    getValue: (data: IModelRes) => IDbResult<unknown> | null

    Извлекает значения из результата запроса.

    Type Declaration

      • (data: IModelRes): IDbResult<unknown> | null

      • Parameters

        • data: IModelRes

          Результат запроса. В случае успешного запроса вернутся данные, в противном случае null

        Returns IDbResult<unknown> | null

    init: (appContext: AppContext, bot: Bot) => void

    Метод инициализации плагина. Вызывается один раз при подключении через bot.use().

    Type Declaration

      • (appContext: AppContext, bot: Bot): void

      • Parameters

        • appContext: AppContext

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

        • bot: Bot

          Основной класс приложения

        Returns void

    insert: (insertData: IQuery) => Promise<boolean>

    Выполняет INSERT-запрос.

    Type Declaration

      • (insertData: IQuery): Promise<boolean>

      • Parameters

        • insertData: IQuery

          — Дополнительная информация для запроса. Содержит сам запрос, а также название таблицы и прочие данные.

        Returns Promise<boolean>

    isConnected: () => boolean | Promise<boolean>

    Проверяет, установлено ли соединение с БД.

    query: (callback: TQueryCb) => unknown

    Выполняет произвольный запрос через callback.

    Type Declaration

      • (callback: TQueryCb): unknown

      • Parameters

        • callback: TQueryCb

          функция обработчик

        Returns unknown

    remove: (removeData: IQuery) => Promise<boolean>

    Выполняет DELETE-запрос.

    Type Declaration

      • (removeData: IQuery): Promise<boolean>

      • Parameters

        • removeData: IQuery

          — Дополнительная информация для запроса. Содержит сам запрос, а также название таблицы и прочие данные.

        Returns Promise<boolean>

    select: (
        selectData: IQuery,
        where: IQueryData | null,
        isOne: boolean,
    ) => Promise<IModelRes<IDataValue>>

    Выполняет SELECT-запрос.

    Type Declaration

      • (
            selectData: IQuery,
            where: IQueryData | null,
            isOne: boolean,
        ): Promise<IModelRes<IDataValue>>

      • Parameters

        • selectData: IQuery

          Дополнительная информация для запроса. Содержит информацию о таблице и структуре.

        • where: IQueryData | null

          Условия фильтрации (WHERE)

        • isOne: boolean

          Определяет нужно ли вернуть только 1 найденную запись, либо отдать все доступные данные.

        Returns Promise<IModelRes<IDataValue>>

    selectOne: (
        selectData: IQuery,
        where: IQueryData | null,
    ) => Promise<IModelRes<IDataValue> | null>

    Выполняет SELECT с ограничением до одной записи.

    Type Declaration

    update: (updateData: IQuery) => Promise<boolean>

    Выполняет UPDATE-запрос.

    Type Declaration

      • (updateData: IQuery): Promise<boolean>

      • Parameters

        • updateData: IQuery

          — Дополнительная информация для запроса. Содержит сам запрос, а также название таблицы и прочие данные.

        Returns Promise<boolean>

    Settings

    Member Visibility

    On This Page

    Methods
    Properties