API Query Runner

Неофициальный Бета-перевод

Эта страница переведена PageTurner AI (бета). Не одобрена официально проектом. Нашли ошибку? Сообщить о проблеме →

Для программного изменения схемы БД используйте QueryRunner:

import {
    MigrationInterface,
    QueryRunner,
    Table,
    TableIndex,
    TableColumn,
    TableForeignKey,
} from "typeorm"

export class QuestionRefactoringTIMESTAMP implements MigrationInterface {
    async up(queryRunner: QueryRunner): Promise<void> {
        await queryRunner.createTable(
            new Table({
                name: "question",
                columns: [
                    {
                        name: "id",
                        type: "int",
                        isPrimary: true,
                    },
                    {
                        name: "name",
                        type: "varchar",
                    },
                ],
            }),
            true,
        )

        await queryRunner.createIndex(
            "question",
            new TableIndex({
                name: "IDX_QUESTION_NAME",
                columnNames: ["name"],
            }),
        )

        await queryRunner.createTable(
            new Table({
                name: "answer",
                columns: [
                    {
                        name: "id",
                        type: "int",
                        isPrimary: true,
                    },
                    {
                        name: "name",
                        type: "varchar",
                    },
                    {
                        name: "created_at",
                        type: "timestamp",
                        default: "now()",
                    },
                ],
            }),
            true,
        )

        await queryRunner.addColumn(
            "answer",
            new TableColumn({
                name: "questionId",
                type: "int",
            }),
        )

        await queryRunner.createForeignKey(
            "answer",
            new TableForeignKey({
                columnNames: ["questionId"],
                referencedColumnNames: ["id"],
                referencedTableName: "question",
                onDelete: "CASCADE",
            }),
        )
    }

    async down(queryRunner: QueryRunner): Promise<void> {
        const table = await queryRunner.getTable("answer")
        const foreignKey = table.foreignKeys.find(
            (fk) => fk.columnNames.indexOf("questionId") !== -1,
        )
        await queryRunner.dropForeignKey("answer", foreignKey)
        await queryRunner.dropColumn("answer", "questionId")
        await queryRunner.dropTable("answer")
        await queryRunner.dropIndex("question", "IDX_QUESTION_NAME")
        await queryRunner.dropTable("question")
    }
}

title: Будущее TypeORM sidebar_label: Будущее TypeORM description: Узнайте о планах на будущее и видении TypeORM id: future-of-typeorm slug: future-of-typeorm sidebar_position: 10 tags:

Roadmap
Community
Sponsorship

getDatabases(): Promise<string[]>

queryRunner.getDatabases()
Возвращает все доступные базы данных (включая системные).

Roadmap
Community
Sponsorship

getSchemas(database?: string): Promise<string[]>

database - Если указан, возвращает схемы для этой базы данных

Возвращает все доступные схемы (включая системные). Актуально для SQLServer и Postgres.

Roadmap
Community
Sponsorship

getTable(tableName: string): Promise<Table|undefined>

tableName - имя загружаемой таблицы

Загружает метаданные таблицы из базы данных.

Roadmap
Community
Sponsorship

getTables(tableNames: string[]): Promise<Table[]>

tableNames - имена загружаемых таблиц

Загружает таблицы по заданным именам из базы данных.

Roadmap
Community
Sponsorship

hasDatabase(database: string): Promise<boolean>

database - имя проверяемой базы данных

Проверяет, существует ли база данных с указанным именем.

Roadmap
Community
Sponsorship

hasSchema(schema: string): Promise<boolean>

schema - имя проверяемой схемы

Проверяет, существует ли схема с указанным именем. Используется только для SqlServer и Postgres.

Roadmap
Community
Sponsorship

hasTable(table: Table|string): Promise<boolean>

table - объект таблицы или её название

Проверяет существование таблицы.

Roadmap
Community
Sponsorship

hasColumn(table: Table|string, columnName: string): Promise<boolean>

table - объект таблицы или её название
columnName - имя проверяемого столбца

Проверяет существование столбца в таблице.

Roadmap
Community
Sponsorship

createDatabase(database: string, ifNotExists?: boolean): Promise<void>

database - имя базы данных
ifNotExists - при true игнорирует существование БД (без ошибки), иначе выбрасывает исключение (по умолчанию)

Создает новую базу данных.

Roadmap
Community
Sponsorship

dropDatabase(database: string, ifExists?: boolean): Promise<void>

database - имя базы данных
ifExists - при true игнорирует отсутствие БД (без ошибки), иначе выбрасывает исключение (по умолчанию)

Удаляет базу данных.

Roadmap
Community
Sponsorship

createSchema(schemaPath: string, ifNotExists?: boolean): Promise<void>

schemaPath - имя схемы. Для SQLServer принимает путь (напр. 'dbName.schemaName'). При указании пути создаёт схему в указанной БД
ifNotExists - при true игнорирует существование схемы (без ошибки), иначе выбрасывает исключение (по умолчанию)

Создает новую схему таблиц.

Roadmap
Community
Sponsorship

dropSchema(schemaPath: string, ifExists?: boolean, isCascade?: boolean): Promise<void>

schemaPath - имя схемы. Для SQLServer принимает путь (напр. 'dbName.schemaName'). При указании пути удаляет схему в указанной БД
ifExists - при true игнорирует отсутствие схемы (без ошибки), иначе выбрасывает исключение (по умолчанию)
isCascade - При true автоматически удаляет объекты схемы (таблицы, функции и т.д.). Только для Postgres.

Удаляет схему таблиц.

Roadmap
Community
Sponsorship

createTable(table: Table, ifNotExists?: boolean, createForeignKeys?: boolean, createIndices?: boolean): Promise<void>

table - Объект таблицы
ifNotExists - при true игнорирует существование таблицы (без ошибки), иначе выбрасывает исключение (по умолчанию)
createForeignKeys - создавать ли внешние ключи. По умолчанию true
createIndices - создавать ли индексы. По умолчанию true

Создает новую таблицу.

Roadmap
Community
Sponsorship

dropTable(table: Table|string, ifExists?: boolean, dropForeignKeys?: boolean, dropIndices?: boolean): Promise<void>

table - Объект или имя удаляемой таблицы
ifExists - при true игнорирует отсутствие таблицы (без ошибки), иначе выбрасывает исключение (по умолчанию)
dropForeignKeys - удалять ли внешние ключи. По умолчанию true
dropIndices - удалять ли индексы. По умолчанию true

Удаляет таблицу.

Roadmap
Community
Sponsorship

createView(view: View, syncWithMetadata?: boolean, oldView?: View): Promise<void>

view - объект View
syncWithMetadata - синхронизировать ли представление с метаданными (опционально)
oldView - заменяемый объект View (опционально)

Создает новое представление.

Roadmap
Community
Sponsorship

dropView(view: View|string, ifExists?: boolean): Promise<void>

view - объект View или имя удаляемого представления
ifExists - при true игнорирует отсутствие представления (без ошибки), иначе выбрасывает исключение (по умолчанию)

Удаляет представление.

Roadmap
Community
Sponsorship

renameTable(oldTableOrName: Table|string, newTableName: string): Promise<void>

oldTableOrName - Объект или имя переименовываемой таблицы
newTableName - новое имя таблицы

Переименовывает таблицу.

Roadmap
Community
Sponsorship

addColumn(table: Table|string, column: TableColumn): Promise<void>

table - объект таблицы или её название
column - новый столбец

Добавляет новые столбцы.

Roadmap
Community
Sponsorship

addColumns(table: Table|string, columns: TableColumn[]): Promise<void>

table - объект таблицы или её название
columns - новые столбцы

Добавляет новые столбцы.

Roadmap
Community
Sponsorship

renameColumn(table: Table|string, oldColumnOrName: TableColumn|string, newColumnOrName: TableColumn|string): Promise<void>

table - объект таблицы или её название
oldColumnOrName - старый столбец (объект TableColumn или имя)
newColumnOrName - новый столбец (объект TableColumn или имя)

Переименовывает столбец.

Roadmap
Community
Sponsorship

changeColumn(table: Table|string, oldColumn: TableColumn|string, newColumn: TableColumn): Promise<void>

table - объект таблицы или её название
oldColumn - старый столбец (объект TableColumn или имя)
newColumn - новый столбец. Принимает объект TableColumn

Изменяет столбец в таблице.

Roadmap
Community
Sponsorship

changeColumns(table: Table|string, changedColumns: { oldColumn: TableColumn, newColumn: TableColumn }[]): Promise<void>

table - объект таблицы или её название
changedColumns - массив измененных столбцов:
- oldColumn - старый объект TableColumn
- newColumn - новый объект TableColumn

Изменяет столбцы в таблице.

Roadmap
Community
Sponsorship

dropColumn(table: Table|string, column: TableColumn|string, ifExists?: boolean): Promise<void>

table - объект таблицы или её название
column - объект TableColumn или имя столбца для удаления
ifExists - при true игнорирует отсутствие столбца (без ошибки), иначе выбрасывает исключение (по умолчанию)

Удаляет столбец в таблице.

Roadmap
Community
Sponsorship

dropColumns(table: Table|string, columns: TableColumn[]|string[], ifExists?: boolean): Promise<void>

table - объект таблицы или её название
columns - массив объектов TableColumn или имён столбцов для удаления
ifExists - при true игнорирует отсутствие столбцов (без ошибки), иначе выбрасывает исключение (по умолчанию)

Удаляет столбцы в таблице.

Roadmap
Community
Sponsorship

createPrimaryKey(table: Table|string, columnNames: string[]): Promise<void>

table - объект таблицы или её название
columnNames - массив имён столбцов, которые станут первичным ключом

Создает новый первичный ключ.

Roadmap
Community
Sponsorship

updatePrimaryKeys(table: Table|string, columns: TableColumn[]): Promise<void>

table - объект таблицы или её название
columns - массив объектов TableColumn для обновления

Обновляет составные первичные ключи.

Roadmap
Community
Sponsorship

dropPrimaryKey(table: Table|string, constraintName?: string, ifExists?: boolean): Promise<void>

table - объект таблицы или её название
constraintName - имя ограничения (опционально)
ifExists - при true игнорирует отсутствие первичного ключа (без ошибки), иначе выбрасывает исключение (по умолчанию)

Удаляет первичный ключ.

Roadmap
Community
Sponsorship

createUniqueConstraint(table: Table|string, uniqueConstraint: TableUnique): Promise<void>

table - объект таблицы или её название
uniqueConstraint - объект TableUnique для создания

Создает новое ограничение уникальности.

Примечание: не работает в MySQL, так как MySQL хранит ограничения уникальности как уникальные индексы. Вместо этого используйте метод createIndex().

Roadmap
Community
Sponsorship

createUniqueConstraints(table: Table|string, uniqueConstraints: TableUnique[]): Promise<void>

table - объект таблицы или её название
uniqueConstraints - массив объектов TableUnique для создания

Создает новые ограничения уникальности.

Примечание: не работает в MySQL, так как MySQL хранит ограничения уникальности как уникальные индексы. Вместо этого используйте метод createIndices().

Roadmap
Community
Sponsorship

dropUniqueConstraint(table: Table|string, uniqueOrName: TableUnique|string, ifExists?: boolean): Promise<void>

table - объект таблицы или её название
uniqueOrName - объект TableUnique или имя ограничения для удаления
ifExists - при true игнорирует отсутствие ограничения (без ошибки), иначе выбрасывает исключение (по умолчанию)

Удаляет уникальное ограничение.

Примечание: не работает в MySQL, так как MySQL хранит ограничения уникальности как уникальные индексы. Вместо этого используйте метод dropIndex().

Roadmap
Community
Sponsorship

dropUniqueConstraints(table: Table|string, uniqueConstraints: TableUnique[], ifExists?: boolean): Promise<void>

table - объект таблицы или её название
uniqueConstraints - массив объектов TableUnique для удаления
ifExists - при true игнорирует отсутствие ограничений (без ошибки), иначе выбрасывает исключение (по умолчанию)

Удаляет уникальные ограничения.

Примечание: не работает для MySQL, так как MySQL хранит ограничения уникальности как уникальные индексы. Вместо этого используйте метод dropIndices().

Roadmap
Community
Sponsorship

createCheckConstraint(table: Table|string, checkConstraint: TableCheck): Promise<void>

table - объект таблицы или её название
checkConstraint - объект TableCheck

Создает новое проверочное ограничение.

Примечание: MySQL не поддерживает check-ограничения.

Roadmap
Community
Sponsorship

createCheckConstraints(table: Table|string, checkConstraints: TableCheck[]): Promise<void>

table - объект таблицы или её название
checkConstraints - массив объектов TableCheck

Создает новое проверочное ограничение.

Примечание: MySQL не поддерживает check-ограничения.

Roadmap
Community
Sponsorship

dropCheckConstraint(table: Table|string, checkOrName: TableCheck|string, ifExists?: boolean): Promise<void>

table - объект таблицы или её название
checkOrName - объект TableCheck или имя ограничения
ifExists - при true игнорирует отсутствие ограничения (без ошибки), иначе выбрасывает исключение (по умолчанию)

Удаляет ограничение CHECK.

Примечание: MySQL не поддерживает check-ограничения.

Roadmap
Community
Sponsorship

dropCheckConstraints(table: Table|string, checkConstraints: TableCheck[], ifExists?: boolean): Promise<void>

table - объект таблицы или её название
checkConstraints - массив объектов TableCheck
ifExists - при true игнорирует отсутствие ограничений (без ошибки), иначе выбрасывает исключение (по умолчанию)

Удаляет check-ограничения.

Примечание: MySQL не поддерживает check-ограничения.

Roadmap
Community
Sponsorship

createExclusionConstraint(table: Table|string, exclusionConstraint: TableExclusion): Promise<void>

table - объект таблицы или её название
exclusionConstraint - объект TableExclusion

Создает новое ограничение-исключение (exclusion constraint).

Примечание: ограничения-исключения поддерживаются только в PostgreSQL.

Roadmap
Community
Sponsorship

createExclusionConstraints(table: Table|string, exclusionConstraints: TableExclusion[]): Promise<void>

table - объект таблицы или её название
exclusionConstraints - массив объектов TableExclusion

Создает новые ограничения-исключения (exclusion constraints).

Примечание: ограничения-исключения поддерживаются только в PostgreSQL.

Roadmap
Community
Sponsorship

dropExclusionConstraint(table: Table|string, exclusionOrName: TableExclusion|string, ifExists?: boolean): Promise<void>

table - объект таблицы или её название
exclusionOrName - объект TableExclusion или имя ограничения
ifExists - при true игнорирует отсутствие ограничения (без ошибки), иначе выбрасывает исключение (по умолчанию)

Удаляет ограничение-исключение (exclusion constraint).

Примечание: ограничения-исключения поддерживаются только в PostgreSQL.

Roadmap
Community
Sponsorship

dropExclusionConstraints(table: Table|string, exclusionConstraints: TableExclusion[], ifExists?: boolean): Promise<void>

table - объект таблицы или её название
exclusionConstraints - массив объектов TableExclusion
ifExists - при true игнорирует отсутствие ограничений (без ошибки), иначе выбрасывает исключение (по умолчанию)

Удаляет ограничения-исключения (exclusion constraints).

Примечание: ограничения-исключения поддерживаются только в PostgreSQL.

Roadmap
Community
Sponsorship

createForeignKey(table: Table|string, foreignKey: TableForeignKey): Promise<void>

table - объект таблицы или её название
foreignKey - объект TableForeignKey

Создает новый внешний ключ.

Roadmap
Community
Sponsorship

createForeignKeys(table: Table|string, foreignKeys: TableForeignKey[]): Promise<void>

table - объект таблицы или её название
foreignKeys - массив объектов TableForeignKey

Создает новые внешние ключи.

Roadmap
Community
Sponsorship

dropForeignKey(table: Table|string, foreignKeyOrName: TableForeignKey|string, ifExists?: boolean): Promise<void>

table - объект таблицы или её название
foreignKeyOrName - объект TableForeignKey или имя внешнего ключа
ifExists - при true игнорирует отсутствие внешнего ключа (без ошибки), иначе выбрасывает исключение (по умолчанию)

Удаляет внешний ключ.

Roadmap
Community
Sponsorship

dropForeignKeys(table: Table|string, foreignKeys: TableForeignKey[], ifExists?: boolean): Promise<void>

table - объект таблицы или её название
foreignKeys - массив объектов TableForeignKey
ifExists - если true, игнорирует отсутствие внешних ключей без ошибки, иначе выдает ошибку (по умолчанию)

Удаляет внешние ключи.

Roadmap
Community
Sponsorship

createIndex(table: Table|string, index: TableIndex): Promise<void>

table - объект таблицы или её название
index - объект TableIndex

Создает новый индекс.

Roadmap
Community
Sponsorship

createIndices(table: Table|string, indices: TableIndex[]): Promise<void>

table - объект таблицы или её название
indices - массив объектов TableIndex

Создает новые индексы.

Roadmap
Community
Sponsorship

dropIndex(table: Table|string, index: TableIndex|string, ifExists?: boolean): Promise<void>

table - объект таблицы или её название
index - объект TableIndex или имя индекса
ifExists - если true, игнорирует отсутствие индекса без ошибки, иначе выдает ошибку (по умолчанию)

Удаляет индекс.

Roadmap
Community
Sponsorship

dropIndices(table: Table|string, indices: TableIndex[], ifExists?: boolean): Promise<void>

table - объект таблицы или её название
indices - массив объектов TableIndex
ifExists - если true, игнорирует отсутствие индексов без ошибки, иначе выдает ошибку (по умолчанию)

Удаляет индексы.

Roadmap
Community
Sponsorship

clearTable(tableName: string, options?: {cascade?: boolean}): Promise<void>

tableName - название таблицы
options - дополнительные опции
- cascade - Определяет, нужно ли очищать строки таблиц с внешними ключами (поддерживается только PostgreSQL/CockroachDB и Oracle; другие БД выбросят ошибку при значении true). По умолчанию false

Очищает всё содержимое таблицы.

Примечание: эта операция использует SQL-запрос TRUNCATE, который нельзя отменить в транзакциях.

Roadmap
Community
Sponsorship

enableSqlMemory(): void

Включает специальный режим работы query runner, при котором SQL-запросы не выполняются, а сохраняются в специальной переменной внутри query runner. Вы можете получить сохранённые SQL-запросы с помощью метода getMemorySql().

Roadmap
Community
Sponsorship

disableSqlMemory(): void

Отключает специальный режим работы query runner, при котором SQL-запросы не выполняются. Ранее сохранённые SQL-запросы будут удалены.

Roadmap
Community
Sponsorship

clearSqlMemory(): void

Очищает все сохранённые SQL-запросы.

Roadmap
Community
Sponsorship

getMemorySql(): SqlInMemory

возвращает объект SqlInMemory с массивами SQL-запросов upQueries и downQueries

Возвращает SQL-запросы, сохранённые в памяти. Параметры в запросах уже заменены.

Roadmap
Community
Sponsorship

executeMemoryUpSql(): Promise<void>

Выполняет сохранённые SQL-запросы для операций обновления (up).

Roadmap
Community
Sponsorship

executeMemoryDownSql(): Promise<void>

Выполняет сохранённые SQL-запросы для операций отката (down).

Roadmap
Community
Sponsorship