import { ColumnSchema } from "../schema-builder/schema/ColumnSchema"; import { TableSchema } from "../schema-builder/schema/TableSchema"; import { ForeignKeySchema } from "../schema-builder/schema/ForeignKeySchema"; import { IndexSchema } from "../schema-builder/schema/IndexSchema"; import { Connection } from "../connection/Connection"; import { ReadStream } from "../platform/PlatformTools"; import { InsertResult } from "../driver/InsertResult"; import { EntityManager } from "../entity-manager/EntityManager"; import { ObjectLiteral } from "../common/ObjectLiteral"; /** * Runs queries on a single database connection. * * todo: extract schema build operations out of query runner. */ export interface QueryRunner { /** * Connection used by this query runner. */ readonly connection: Connection; /** * Isolated entity manager working only with current query runner. */ readonly manager: EntityManager; /** * Indicates if connection for this query runner is released. * Once its released, query runner cannot run queries anymore. */ readonly isReleased: boolean; /** * Indicates if transaction is in progress. */ readonly isTransactionActive: boolean; /** * Stores temporarily user data. * Useful for sharing data with subscribers. */ data: ObjectLiteral; /** * Creates/uses database connection from the connection pool to perform further operations. * Returns obtained database connection. */ connect(): Promise; /** * Releases used database connection. * You cannot use this query runner methods after connection is released. */ release(): Promise; /** * Removes all tables from the currently connected database. * Be careful with using this method and avoid using it in production or migrations * (because it can clear all your database). */ clearDatabase(): Promise; /** * Starts transaction. */ startTransaction(): Promise; /** * Commits transaction. * Error will be thrown if transaction was not started. */ commitTransaction(): Promise; /** * Ends transaction. * Error will be thrown if transaction was not started. */ rollbackTransaction(): Promise; /** * Executes a given SQL query and returns raw database results. */ query(query: string, parameters?: any[]): Promise; /** * Returns raw data stream. */ stream(query: string, parameters?: any[], onEnd?: Function, onError?: Function): Promise; /** * Insert a new row with given values into the given table. * Returns value of the generated column if given and generate column exist in the table. */ insert(tableName: string, valuesMap: Object): Promise; /** * Updates rows that match given simple conditions in the given table. */ update(tableName: string, valuesMap: Object, conditions: Object): Promise; /** * Performs a simple DELETE query by a given conditions in a given table. */ delete(tableName: string, condition: string, parameters?: any[]): Promise; /** * Performs a simple DELETE query by a given conditions in a given table. */ delete(tableName: string, conditions: Object): Promise; /** * Inserts new values into closure table. */ insertIntoClosureTable(tableName: string, newEntityId: any, parentId: any, hasLevel: boolean): Promise; /** * Loads all tables (with given names) from the database and creates a TableSchema from them. */ loadTableSchema(tableName: string): Promise; /** * Loads all tables (with given names) from the database and creates a TableSchema from them. */ loadTableSchemas(tableNames: string[]): Promise; /** * Checks if table with the given name exist in the database. */ hasTable(tableName: string): Promise; /** * Creates a schema if it's not created. */ createSchema(): Promise; /** * Creates a new table from the given table metadata and column metadatas. */ createTable(table: TableSchema): Promise; /** * Drops the table. */ dropTable(tableName: string): Promise; /** * Checks if column with the given name exist in the given table. */ hasColumn(tableName: string, columnName: string): Promise; /** * Adds a new column in the table. */ addColumn(tableName: string, column: ColumnSchema): Promise; /** * Adds a new column in the table. */ addColumn(table: TableSchema, column: ColumnSchema): Promise; /** * Adds new columns in the table. */ addColumns(tableSchema: string, columns: ColumnSchema[]): Promise; /** * Adds new columns in the table. */ addColumns(table: TableSchema, columns: ColumnSchema[]): Promise; /** * Renames column in the given table. */ renameColumn(table: TableSchema, oldColumn: ColumnSchema, newColumn: ColumnSchema): Promise; /** * Renames column in the given table. */ renameColumn(tableName: string, oldColumnName: string, newColumnName: string): Promise; /** * Changes a column in the table. */ changeColumn(table: TableSchema, oldColumn: ColumnSchema, newColumn: ColumnSchema): Promise; /** * Changes a column in the table. */ changeColumn(table: string, oldColumn: string, newColumn: ColumnSchema): Promise; /** * Changes a columns in the table. */ changeColumns(table: TableSchema, changedColumns: { oldColumn: ColumnSchema; newColumn: ColumnSchema; }[]): Promise; /** * Drops the column in the table. */ dropColumn(table: TableSchema, column: ColumnSchema): Promise; /** * Drops the columns in the table. */ dropColumns(table: TableSchema, columns: ColumnSchema[]): Promise; /** * Updates primary keys in the table. */ updatePrimaryKeys(table: TableSchema): Promise; /** * Creates a new foreign key. */ createForeignKey(tableName: string, foreignKey: ForeignKeySchema): Promise; /** * Creates a new foreign key. */ createForeignKey(tableSchema: TableSchema, foreignKey: ForeignKeySchema): Promise; /** * Creates a new foreign keys. */ createForeignKeys(table: TableSchema, foreignKeys: ForeignKeySchema[]): Promise; /** * Drops a foreign keys from the table. */ dropForeignKey(table: string, foreignKey: ForeignKeySchema): Promise; /** * Drops a foreign keys from the table. */ dropForeignKey(table: TableSchema, foreignKey: ForeignKeySchema): Promise; /** * Drops a foreign keys from the table. */ dropForeignKeys(table: string, foreignKeys: ForeignKeySchema[]): Promise; /** * Drops a foreign keys from the table. */ dropForeignKeys(table: TableSchema, foreignKeys: ForeignKeySchema[]): Promise; /** * Creates a new index. */ createIndex(tableName: string, index: IndexSchema): Promise; /** * Drops an index from the table. */ dropIndex(table: TableSchema | string, index: IndexSchema | string): Promise; /** * Truncates table. * * todo: probably this should be renamed to drop or clear? */ truncate(tableName: string): Promise; /** * Enables special query runner mode in which sql queries won't be executed, * instead they will be memorized into a special variable inside query runner. * You can get memorized sql using getMemorySql() method. */ enableSqlMemory(): void; /** * Disables special query runner mode in which sql queries won't be executed * started by calling enableSqlMemory() method. * * Previously memorized sql will be flushed. */ disableSqlMemory(): void; /** * Gets sql stored in the memory. Parameters in the sql are already replaced. */ getMemorySql(): (string | { up: string; down: string; })[]; }