typeorm 0.3.29-dev.cc07c90 → 1.0.0-beta.1

package/browser/query-runner/QueryRunner.d.ts

@@ -1,28 +1,33 @@
-import { TableColumn } from "../schema-builder/table/TableColumn";
-import { Table } from "../schema-builder/table/Table";
-import { TableForeignKey } from "../schema-builder/table/TableForeignKey";
-import { TableIndex } from "../schema-builder/table/TableIndex";
-import { DataSource } from "../data-source/DataSource";
-import { ReadStream } from "../platform/PlatformTools";
-import { EntityManager } from "../entity-manager/EntityManager";
-import { ObjectLiteral } from "../common/ObjectLiteral";
-import { SqlInMemory } from "../driver/SqlInMemory";
-import { TableUnique } from "../schema-builder/table/TableUnique";
-import { View } from "../schema-builder/view/View";
-import { Broadcaster } from "../subscriber/Broadcaster";
-import { TableCheck } from "../schema-builder/table/TableCheck";
-import { IsolationLevel } from "../driver/types/IsolationLevel";
-import { TableExclusion } from "../schema-builder/table/TableExclusion";
-import { QueryResult } from "./QueryResult";
-import { ReplicationMode } from "../driver/types/ReplicationMode";
+import type { TableColumn } from "../schema-builder/table/TableColumn";
+import type { Table } from "../schema-builder/table/Table";
+import type { TableForeignKey } from "../schema-builder/table/TableForeignKey";
+import type { TableIndex } from "../schema-builder/table/TableIndex";
+import type { DataSource } from "../data-source/DataSource";
+import type { ReadStream } from "../platform/PlatformTools";
+import type { EntityManager } from "../entity-manager/EntityManager";
+import type { ObjectLiteral } from "../common/ObjectLiteral";
+import type { SqlInMemory } from "../driver/SqlInMemory";
+import type { TableUnique } from "../schema-builder/table/TableUnique";
+import type { View } from "../schema-builder/view/View";
+import type { Broadcaster } from "../subscriber/Broadcaster";
+import type { TableCheck } from "../schema-builder/table/TableCheck";
+import type { IsolationLevel } from "../driver/types/IsolationLevel";
+import type { TableExclusion } from "../schema-builder/table/TableExclusion";
+import type { QueryResult } from "./QueryResult";
+import type { ReplicationMode } from "../driver/types/ReplicationMode";
 /**
  * Runs queries on a single database connection.
  */
-export interface QueryRunner {
+export interface QueryRunner extends AsyncDisposable {
     /**
-     * Connection used by this query runner.
+     * DataSource used by this query runner.
      */
-    readonly connection: DataSource;
+    readonly dataSource: DataSource;
+    /**
+     * DataSource used by this query runner.
+     * @deprecated since 1.0.0. Use {@link dataSource} instance instead.
+     */
+    get connection(): DataSource;
     /**
      * Broadcaster used on this query runner to broadcast entity events.
      */
@@ -45,18 +50,6 @@ export interface QueryRunner {
      * Useful for sharing data with subscribers.
      */
     data: ObjectLiteral;
-    /**
-     * All synchronized tables in the database.
-     *
-     * @deprecated Call `getTables()`
-     */
-    loadedTables: Table[];
-    /**
-     * All synchronized views in the database.
-     *
-     * @deprecated Call `getViews()`
-     */
-    loadedViews: View[];
     /**
      * Creates/uses database connection from the connection pool to perform further operations.
      * Returns obtained database connection.
@@ -75,6 +68,7 @@ export interface QueryRunner {
      * You cannot use query runner methods after connection is released.
      */
     release(): Promise<void>;
+    [Symbol.asyncDispose](): Promise<void>;
     /**
      * Removes all tables from the currently connected database.
      * Be careful with using this method and avoid using it in production or migrations
@@ -172,29 +166,29 @@ export interface QueryRunner {
     /**
      * Creates a new database.
      */
-    createDatabase(database: string, ifNotExist?: boolean): Promise<void>;
+    createDatabase(database: string, ifNotExists?: boolean): Promise<void>;
     /**
-     * Drops database.
+     * Drops a database.
      */
-    dropDatabase(database: string, ifExist?: boolean): Promise<void>;
+    dropDatabase(database: string, ifExists?: boolean): Promise<void>;
     /**
      * Creates a new table schema.
      */
-    createSchema(schemaPath: string, ifNotExist?: boolean): Promise<void>;
+    createSchema(schemaPath: string, ifNotExists?: boolean): Promise<void>;
     /**
-     * Drops table schema.
+     * Drops a table schema.
      * For SqlServer can accept schema path (e.g. 'dbName.schemaName') as parameter.
      * If schema path passed, it will drop schema in specified database.
      */
-    dropSchema(schemaPath: string, ifExist?: boolean, isCascade?: boolean): Promise<void>;
+    dropSchema(schemaPath: string, ifExists?: boolean, isCascade?: boolean): Promise<void>;
     /**
      * Creates a new table.
      */
-    createTable(table: Table, ifNotExist?: boolean, createForeignKeys?: boolean, createIndices?: boolean): Promise<void>;
+    createTable(table: Table, ifNotExists?: boolean, createForeignKeys?: boolean, createIndices?: boolean): Promise<void>;
     /**
      * Drops a table.
      */
-    dropTable(table: Table | string, ifExist?: boolean, dropForeignKeys?: boolean, dropIndices?: boolean): Promise<void>;
+    dropTable(table: Table | string, ifExists?: boolean, dropForeignKeys?: boolean, dropIndices?: boolean): Promise<void>;
     /**
      * Creates a new view.
      */
@@ -202,7 +196,7 @@ export interface QueryRunner {
     /**
      * Drops a view.
      */
-    dropView(view: View | string): Promise<void>;
+    dropView(view: View | string, ifExists?: boolean): Promise<void>;
     /**
      * Renames a table.
      */
@@ -237,11 +231,11 @@ export interface QueryRunner {
     /**
      * Drops a column in the table.
      */
-    dropColumn(table: Table | string, column: TableColumn | string): Promise<void>;
+    dropColumn(table: Table | string, column: TableColumn | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops columns in the table.
      */
-    dropColumns(table: Table | string, columns: TableColumn[] | string[]): Promise<void>;
+    dropColumns(table: Table | string, columns: TableColumn[] | string[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new primary key.
      */
@@ -253,7 +247,7 @@ export interface QueryRunner {
     /**
      * Drops a primary key.
      */
-    dropPrimaryKey(table: Table | string, constraintName?: string): Promise<void>;
+    dropPrimaryKey(table: Table | string, constraintName?: string, ifExists?: boolean): Promise<void>;
     /**
      * Creates a new unique constraint.
      */
@@ -265,11 +259,11 @@ export interface QueryRunner {
     /**
      * Drops a unique constraint.
      */
-    dropUniqueConstraint(table: Table | string, uniqueOrName: TableUnique | string): Promise<void>;
+    dropUniqueConstraint(table: Table | string, uniqueOrName: TableUnique | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops unique constraints.
      */
-    dropUniqueConstraints(table: Table | string, uniqueConstraints: TableUnique[]): Promise<void>;
+    dropUniqueConstraints(table: Table | string, uniqueConstraints: TableUnique[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new check constraint.
      */
@@ -281,11 +275,11 @@ export interface QueryRunner {
     /**
      * Drops a check constraint.
      */
-    dropCheckConstraint(table: Table | string, checkOrName: TableCheck | string): Promise<void>;
+    dropCheckConstraint(table: Table | string, checkOrName: TableCheck | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops check constraints.
      */
-    dropCheckConstraints(table: Table | string, checkConstraints: TableCheck[]): Promise<void>;
+    dropCheckConstraints(table: Table | string, checkConstraints: TableCheck[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new exclusion constraint.
      */
@@ -295,13 +289,13 @@ export interface QueryRunner {
      */
     createExclusionConstraints(table: Table | string, exclusionConstraints: TableExclusion[]): Promise<void>;
     /**
-     * Drops a exclusion constraint.
+     * Drops an exclusion constraint.
      */
-    dropExclusionConstraint(table: Table | string, exclusionOrName: TableExclusion | string): Promise<void>;
+    dropExclusionConstraint(table: Table | string, exclusionOrName: TableExclusion | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops exclusion constraints.
      */
-    dropExclusionConstraints(table: Table | string, exclusionConstraints: TableExclusion[]): Promise<void>;
+    dropExclusionConstraints(table: Table | string, exclusionConstraints: TableExclusion[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new foreign key.
      */
@@ -313,11 +307,11 @@ export interface QueryRunner {
     /**
      * Drops a foreign key.
      */
-    dropForeignKey(table: Table | string, foreignKeyOrName: TableForeignKey | string): Promise<void>;
+    dropForeignKey(table: Table | string, foreignKeyOrName: TableForeignKey | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops foreign keys.
      */
-    dropForeignKeys(table: Table | string, foreignKeys: TableForeignKey[]): Promise<void>;
+    dropForeignKeys(table: Table | string, foreignKeys: TableForeignKey[], ifExists?: boolean): Promise<void>;
     /**
      * Creates a new index.
      */
@@ -329,16 +323,18 @@ export interface QueryRunner {
     /**
      * Drops an index.
      */
-    dropIndex(table: Table | string, index: TableIndex | string): Promise<void>;
+    dropIndex(table: Table | string, index: TableIndex | string, ifExists?: boolean): Promise<void>;
     /**
      * Drops indices.
      */
-    dropIndices(table: Table | string, indices: TableIndex[]): Promise<void>;
+    dropIndices(table: Table | string, indices: TableIndex[], ifExists?: boolean): Promise<void>;
     /**
      * Clears all table contents.
      * Note: this operation uses SQL's TRUNCATE query which cannot be reverted in transactions.
      */
-    clearTable(tableName: string): Promise<void>;
+    clearTable(tableName: string, options?: {
+        cascade?: boolean;
+    }): Promise<void>;
     /**
      * 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.

package/browser/query-runner/QueryRunner.js

@@ -1,3 +1,3 @@
-export {};
-
-//# sourceMappingURL=QueryRunner.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=QueryRunner.js.map

package/browser/query-runner/QueryRunner.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../browser/src/query-runner/QueryRunner.ts"],"names":[],"mappings":"","file":"QueryRunner.js","sourcesContent":["import { TableColumn } from \"../schema-builder/table/TableColumn\"\nimport { Table } from \"../schema-builder/table/Table\"\nimport { TableForeignKey } from \"../schema-builder/table/TableForeignKey\"\nimport { TableIndex } from \"../schema-builder/table/TableIndex\"\nimport { DataSource } from \"../data-source/DataSource\"\nimport { ReadStream } from \"../platform/PlatformTools\"\nimport { EntityManager } from \"../entity-manager/EntityManager\"\nimport { ObjectLiteral } from \"../common/ObjectLiteral\"\nimport { SqlInMemory } from \"../driver/SqlInMemory\"\nimport { TableUnique } from \"../schema-builder/table/TableUnique\"\nimport { View } from \"../schema-builder/view/View\"\nimport { Broadcaster } from \"../subscriber/Broadcaster\"\nimport { TableCheck } from \"../schema-builder/table/TableCheck\"\nimport { IsolationLevel } from \"../driver/types/IsolationLevel\"\nimport { TableExclusion } from \"../schema-builder/table/TableExclusion\"\nimport { QueryResult } from \"./QueryResult\"\nimport { ReplicationMode } from \"../driver/types/ReplicationMode\"\n\n/**\n * Runs queries on a single database connection.\n */\nexport interface QueryRunner {\n    /**\n     * Connection used by this query runner.\n     */\n    readonly connection: DataSource\n\n    /**\n     * Broadcaster used on this query runner to broadcast entity events.\n     */\n    readonly broadcaster: Broadcaster\n\n    /**\n     * Entity manager working only with this query runner.\n     */\n    readonly manager: EntityManager\n\n    /**\n     * Indicates if connection for this query runner is released.\n     * Once its released, query runner cannot run queries anymore.\n     */\n    readonly isReleased: boolean\n\n    /**\n     * Indicates if transaction is in progress.\n     */\n    readonly isTransactionActive: boolean\n\n    /**\n     * Stores temporarily user data.\n     * Useful for sharing data with subscribers.\n     */\n    data: ObjectLiteral\n\n    /**\n     * All synchronized tables in the database.\n     *\n     * @deprecated Call `getTables()`\n     */\n    loadedTables: Table[]\n\n    /**\n     * All synchronized views in the database.\n     *\n     * @deprecated Call `getViews()`\n     */\n    loadedViews: View[]\n\n    /**\n     * Creates/uses database connection from the connection pool to perform further operations.\n     * Returns obtained database connection.\n     */\n    connect(): Promise<any>\n\n    /**\n     * Called before migrations are run.\n     */\n    beforeMigration(): Promise<void>\n\n    /**\n     * Called after migrations are run.\n     */\n    afterMigration(): Promise<void>\n\n    /**\n     * Releases used database connection.\n     * You cannot use query runner methods after connection is released.\n     */\n    release(): Promise<void>\n\n    /**\n     * Removes all tables from the currently connected database.\n     * Be careful with using this method and avoid using it in production or migrations\n     * (because it can clear all your database).\n     */\n    clearDatabase(database?: string): Promise<void>\n\n    /**\n     * Starts transaction.\n     */\n    startTransaction(isolationLevel?: IsolationLevel): Promise<void>\n\n    /**\n     * Commits transaction.\n     * Error will be thrown if transaction was not started.\n     */\n    commitTransaction(): Promise<void>\n\n    /**\n     * Rollbacks transaction.\n     * Error will be thrown if transaction was not started.\n     */\n    rollbackTransaction(): Promise<void>\n\n    /**\n     * Executes a given SQL query and returns raw database results.\n     */\n    query(\n        query: string,\n        parameters: any[] | undefined,\n        useStructuredResult: true,\n    ): Promise<QueryResult>\n\n    /**\n     * Executes a given SQL query and returns raw database results.\n     */\n    query(query: string, parameters?: any[]): Promise<any>\n\n    /**\n     * Tagged template function that executes raw SQL query and returns raw database results.\n     * Template expressions are automatically transformed into database parameters.\n     * Raw query execution is supported only by relational databases (MongoDB is not supported).\n     * Note: Don't call this as a regular function, it is meant to be used with backticks to tag a template literal.\n     * Example: queryRunner.sql`SELECT * FROM table_name WHERE id = ${id}`\n     */\n    sql<T = any>(\n        strings: TemplateStringsArray,\n        ...values: unknown[]\n    ): Promise<T>\n\n    /**\n     * Returns raw data stream.\n     */\n    stream(\n        query: string,\n        parameters?: any[],\n        onEnd?: Function,\n        onError?: Function,\n    ): Promise<ReadStream>\n\n    /**\n     * Returns all available database names including system databases.\n     */\n    getDatabases(): Promise<string[]>\n\n    /**\n     * Returns all available schema names including system schemas.\n     * If database parameter specified, returns schemas of that database.\n     * Useful for SQLServer and Postgres only.\n     */\n    getSchemas(database?: string): Promise<string[]>\n\n    /**\n     * Loads a table by a given name from the database.\n     */\n    getTable(tablePath: string): Promise<Table | undefined>\n\n    /**\n     * Loads all tables from the database and returns them.\n     */\n    getTables(tablePaths?: string[]): Promise<Table[]>\n\n    /**\n     * Loads a view by a given name from the database.\n     */\n    getView(viewPath: string): Promise<View | undefined>\n\n    /**\n     * Loads all views from the database and returns them.\n     */\n    getViews(viewPaths?: string[]): Promise<View[]>\n\n    /**\n     * Returns replication mode (ex: `master` or `slave`).\n     */\n    getReplicationMode(): ReplicationMode\n\n    /**\n     * Checks if a database with the given name exist.\n     */\n    hasDatabase(database: string): Promise<boolean>\n\n    /**\n     * Loads currently using database\n     */\n    getCurrentDatabase(): Promise<string | undefined>\n\n    /**\n     * Checks if a schema with the given name exist.\n     */\n    hasSchema(schema: string): Promise<boolean>\n\n    /**\n     * Loads currently using database schema\n     */\n    getCurrentSchema(): Promise<string | undefined>\n\n    /**\n     * Checks if a table with the given name exist.\n     */\n    hasTable(table: Table | string): Promise<boolean>\n\n    /**\n     * Checks if a column exist in the table.\n     */\n    hasColumn(table: Table | string, columnName: string): Promise<boolean>\n\n    /**\n     * Creates a new database.\n     */\n    createDatabase(database: string, ifNotExist?: boolean): Promise<void>\n\n    /**\n     * Drops database.\n     */\n    dropDatabase(database: string, ifExist?: boolean): Promise<void>\n\n    /**\n     * Creates a new table schema.\n     */\n    createSchema(schemaPath: string, ifNotExist?: boolean): Promise<void>\n\n    /**\n     * Drops table schema.\n     * For SqlServer can accept schema path (e.g. 'dbName.schemaName') as parameter.\n     * If schema path passed, it will drop schema in specified database.\n     */\n    dropSchema(\n        schemaPath: string,\n        ifExist?: boolean,\n        isCascade?: boolean,\n    ): Promise<void>\n\n    /**\n     * Creates a new table.\n     */\n    createTable(\n        table: Table,\n        ifNotExist?: boolean,\n        createForeignKeys?: boolean,\n        createIndices?: boolean,\n    ): Promise<void>\n\n    /**\n     * Drops a table.\n     */\n    dropTable(\n        table: Table | string,\n        ifExist?: boolean,\n        dropForeignKeys?: boolean,\n        dropIndices?: boolean,\n    ): Promise<void>\n\n    /**\n     * Creates a new view.\n     */\n    createView(\n        view: View,\n        syncWithMetadata?: boolean,\n        oldView?: View,\n    ): Promise<void>\n\n    /**\n     * Drops a view.\n     */\n    dropView(view: View | string): Promise<void>\n\n    /**\n     * Renames a table.\n     */\n    renameTable(\n        oldTableOrName: Table | string,\n        newTableName: string,\n    ): Promise<void>\n\n    /**\n     * Change table comment. Only supports MySQL and MariaDB\n     */\n    changeTableComment(\n        tableOrName: Table | string,\n        comment?: string,\n    ): Promise<void>\n\n    /**\n     * Adds a new column.\n     */\n    addColumn(table: Table | string, column: TableColumn): Promise<void>\n\n    /**\n     * Adds new columns.\n     */\n    addColumns(table: Table | string, columns: TableColumn[]): Promise<void>\n\n    /**\n     * Renames a column.\n     */\n    renameColumn(\n        table: Table | string,\n        oldColumnOrName: TableColumn | string,\n        newColumnOrName: TableColumn | string,\n    ): Promise<void>\n\n    /**\n     * Changes a column in the table.\n     */\n    changeColumn(\n        table: Table | string,\n        oldColumn: TableColumn | string,\n        newColumn: TableColumn,\n    ): Promise<void>\n\n    /**\n     * Changes columns in the table.\n     */\n    changeColumns(\n        table: Table | string,\n        changedColumns: { oldColumn: TableColumn; newColumn: TableColumn }[],\n    ): Promise<void>\n\n    /**\n     * Drops a column in the table.\n     */\n    dropColumn(\n        table: Table | string,\n        column: TableColumn | string,\n    ): Promise<void>\n\n    /**\n     * Drops columns in the table.\n     */\n    dropColumns(\n        table: Table | string,\n        columns: TableColumn[] | string[],\n    ): Promise<void>\n\n    /**\n     * Creates a new primary key.\n     */\n    createPrimaryKey(\n        table: Table | string,\n        columnNames: string[],\n        constraintName?: string,\n    ): Promise<void>\n\n    /**\n     * Updates composite primary keys.\n     */\n    updatePrimaryKeys(\n        table: Table | string,\n        columns: TableColumn[],\n    ): Promise<void>\n\n    /**\n     * Drops a primary key.\n     */\n    dropPrimaryKey(\n        table: Table | string,\n        constraintName?: string,\n    ): Promise<void>\n\n    /**\n     * Creates a new unique constraint.\n     */\n    createUniqueConstraint(\n        table: Table | string,\n        uniqueConstraint: TableUnique,\n    ): Promise<void>\n\n    /**\n     * Creates new unique constraints.\n     */\n    createUniqueConstraints(\n        table: Table | string,\n        uniqueConstraints: TableUnique[],\n    ): Promise<void>\n\n    /**\n     * Drops a unique constraint.\n     */\n    dropUniqueConstraint(\n        table: Table | string,\n        uniqueOrName: TableUnique | string,\n    ): Promise<void>\n\n    /**\n     * Drops unique constraints.\n     */\n    dropUniqueConstraints(\n        table: Table | string,\n        uniqueConstraints: TableUnique[],\n    ): Promise<void>\n\n    /**\n     * Creates a new check constraint.\n     */\n    createCheckConstraint(\n        table: Table | string,\n        checkConstraint: TableCheck,\n    ): Promise<void>\n\n    /**\n     * Creates new check constraints.\n     */\n    createCheckConstraints(\n        table: Table | string,\n        checkConstraints: TableCheck[],\n    ): Promise<void>\n\n    /**\n     * Drops a check constraint.\n     */\n    dropCheckConstraint(\n        table: Table | string,\n        checkOrName: TableCheck | string,\n    ): Promise<void>\n\n    /**\n     * Drops check constraints.\n     */\n    dropCheckConstraints(\n        table: Table | string,\n        checkConstraints: TableCheck[],\n    ): Promise<void>\n\n    /**\n     * Creates a new exclusion constraint.\n     */\n    createExclusionConstraint(\n        table: Table | string,\n        exclusionConstraint: TableExclusion,\n    ): Promise<void>\n\n    /**\n     * Creates new exclusion constraints.\n     */\n    createExclusionConstraints(\n        table: Table | string,\n        exclusionConstraints: TableExclusion[],\n    ): Promise<void>\n\n    /**\n     * Drops a exclusion constraint.\n     */\n    dropExclusionConstraint(\n        table: Table | string,\n        exclusionOrName: TableExclusion | string,\n    ): Promise<void>\n\n    /**\n     * Drops exclusion constraints.\n     */\n    dropExclusionConstraints(\n        table: Table | string,\n        exclusionConstraints: TableExclusion[],\n    ): Promise<void>\n\n    /**\n     * Creates a new foreign key.\n     */\n    createForeignKey(\n        table: Table | string,\n        foreignKey: TableForeignKey,\n    ): Promise<void>\n\n    /**\n     * Creates new foreign keys.\n     */\n    createForeignKeys(\n        table: Table | string,\n        foreignKeys: TableForeignKey[],\n    ): Promise<void>\n\n    /**\n     * Drops a foreign key.\n     */\n    dropForeignKey(\n        table: Table | string,\n        foreignKeyOrName: TableForeignKey | string,\n    ): Promise<void>\n\n    /**\n     * Drops foreign keys.\n     */\n    dropForeignKeys(\n        table: Table | string,\n        foreignKeys: TableForeignKey[],\n    ): Promise<void>\n\n    /**\n     * Creates a new index.\n     */\n    createIndex(table: Table | string, index: TableIndex): Promise<void>\n\n    /**\n     * Creates new indices.\n     */\n    createIndices(table: Table | string, indices: TableIndex[]): Promise<void>\n\n    /**\n     * Drops an index.\n     */\n    dropIndex(table: Table | string, index: TableIndex | string): Promise<void>\n\n    /**\n     * Drops indices.\n     */\n    dropIndices(table: Table | string, indices: TableIndex[]): Promise<void>\n\n    /**\n     * Clears all table contents.\n     * Note: this operation uses SQL's TRUNCATE query which cannot be reverted in transactions.\n     */\n    clearTable(tableName: string): Promise<void>\n\n    /**\n     * Enables special query runner mode in which sql queries won't be executed,\n     * instead they will be memorized into a special variable inside query runner.\n     * You can get memorized sql using getMemorySql() method.\n     */\n    enableSqlMemory(): void\n\n    /**\n     * Disables special query runner mode in which sql queries won't be executed\n     * started by calling enableSqlMemory() method.\n     *\n     * Previously memorized sql will be flushed.\n     */\n    disableSqlMemory(): void\n\n    /**\n     * Flushes all memorized sqls.\n     */\n    clearSqlMemory(): void\n\n    /**\n     * Gets sql stored in the memory. Parameters in the sql are already replaced.\n     */\n    getMemorySql(): SqlInMemory\n\n    /**\n     * Executes up sql queries.\n     */\n    executeMemoryUpSql(): Promise<void>\n\n    /**\n     * Executes down sql queries.\n     */\n    executeMemoryDownSql(): Promise<void>\n}\n"],"sourceRoot":".."}
+{"version":3,"file":"QueryRunner.js","sourceRoot":"../build/browser/src/","sources":["query-runner/QueryRunner.ts"],"names":[],"mappings":"","sourcesContent":["import type { TableColumn } from \"../schema-builder/table/TableColumn\"\nimport type { Table } from \"../schema-builder/table/Table\"\nimport type { TableForeignKey } from \"../schema-builder/table/TableForeignKey\"\nimport type { TableIndex } from \"../schema-builder/table/TableIndex\"\nimport type { DataSource } from \"../data-source/DataSource\"\nimport type { ReadStream } from \"../platform/PlatformTools\"\nimport type { EntityManager } from \"../entity-manager/EntityManager\"\nimport type { ObjectLiteral } from \"../common/ObjectLiteral\"\nimport type { SqlInMemory } from \"../driver/SqlInMemory\"\nimport type { TableUnique } from \"../schema-builder/table/TableUnique\"\nimport type { View } from \"../schema-builder/view/View\"\nimport type { Broadcaster } from \"../subscriber/Broadcaster\"\nimport type { TableCheck } from \"../schema-builder/table/TableCheck\"\nimport type { IsolationLevel } from \"../driver/types/IsolationLevel\"\nimport type { TableExclusion } from \"../schema-builder/table/TableExclusion\"\nimport type { QueryResult } from \"./QueryResult\"\nimport type { ReplicationMode } from \"../driver/types/ReplicationMode\"\n\n/**\n * Runs queries on a single database connection.\n */\nexport interface QueryRunner extends AsyncDisposable {\n    /**\n     * DataSource used by this query runner.\n     */\n    readonly dataSource: DataSource\n\n    /**\n     * DataSource used by this query runner.\n     * @deprecated since 1.0.0. Use {@link dataSource} instance instead.\n     */\n    get connection(): DataSource\n\n    /**\n     * Broadcaster used on this query runner to broadcast entity events.\n     */\n    readonly broadcaster: Broadcaster\n\n    /**\n     * Entity manager working only with this query runner.\n     */\n    readonly manager: EntityManager\n\n    /**\n     * Indicates if connection for this query runner is released.\n     * Once its released, query runner cannot run queries anymore.\n     */\n    readonly isReleased: boolean\n\n    /**\n     * Indicates if transaction is in progress.\n     */\n    readonly isTransactionActive: boolean\n\n    /**\n     * Stores temporarily user data.\n     * Useful for sharing data with subscribers.\n     */\n    data: ObjectLiteral\n\n    /**\n     * Creates/uses database connection from the connection pool to perform further operations.\n     * Returns obtained database connection.\n     */\n    connect(): Promise<any>\n\n    /**\n     * Called before migrations are run.\n     */\n    beforeMigration(): Promise<void>\n\n    /**\n     * Called after migrations are run.\n     */\n    afterMigration(): Promise<void>\n\n    /**\n     * Releases used database connection.\n     * You cannot use query runner methods after connection is released.\n     */\n    release(): Promise<void>\n\n    [Symbol.asyncDispose](): Promise<void>\n\n    /**\n     * Removes all tables from the currently connected database.\n     * Be careful with using this method and avoid using it in production or migrations\n     * (because it can clear all your database).\n     */\n    clearDatabase(database?: string): Promise<void>\n\n    /**\n     * Starts transaction.\n     */\n    startTransaction(isolationLevel?: IsolationLevel): Promise<void>\n\n    /**\n     * Commits transaction.\n     * Error will be thrown if transaction was not started.\n     */\n    commitTransaction(): Promise<void>\n\n    /**\n     * Rollbacks transaction.\n     * Error will be thrown if transaction was not started.\n     */\n    rollbackTransaction(): Promise<void>\n\n    /**\n     * Executes a given SQL query and returns raw database results.\n     */\n    query(\n        query: string,\n        parameters: any[] | undefined,\n        useStructuredResult: true,\n    ): Promise<QueryResult>\n\n    /**\n     * Executes a given SQL query and returns raw database results.\n     */\n    query(query: string, parameters?: any[]): Promise<any>\n\n    /**\n     * Tagged template function that executes raw SQL query and returns raw database results.\n     * Template expressions are automatically transformed into database parameters.\n     * Raw query execution is supported only by relational databases (MongoDB is not supported).\n     * Note: Don't call this as a regular function, it is meant to be used with backticks to tag a template literal.\n     * Example: queryRunner.sql`SELECT * FROM table_name WHERE id = ${id}`\n     */\n    sql<T = any>(\n        strings: TemplateStringsArray,\n        ...values: unknown[]\n    ): Promise<T>\n\n    /**\n     * Returns raw data stream.\n     */\n    stream(\n        query: string,\n        parameters?: any[],\n        onEnd?: Function,\n        onError?: Function,\n    ): Promise<ReadStream>\n\n    /**\n     * Returns all available database names including system databases.\n     */\n    getDatabases(): Promise<string[]>\n\n    /**\n     * Returns all available schema names including system schemas.\n     * If database parameter specified, returns schemas of that database.\n     * Useful for SQLServer and Postgres only.\n     */\n    getSchemas(database?: string): Promise<string[]>\n\n    /**\n     * Loads a table by a given name from the database.\n     */\n    getTable(tablePath: string): Promise<Table | undefined>\n\n    /**\n     * Loads all tables from the database and returns them.\n     */\n    getTables(tablePaths?: string[]): Promise<Table[]>\n\n    /**\n     * Loads a view by a given name from the database.\n     */\n    getView(viewPath: string): Promise<View | undefined>\n\n    /**\n     * Loads all views from the database and returns them.\n     */\n    getViews(viewPaths?: string[]): Promise<View[]>\n\n    /**\n     * Returns replication mode (ex: `master` or `slave`).\n     */\n    getReplicationMode(): ReplicationMode\n\n    /**\n     * Checks if a database with the given name exist.\n     */\n    hasDatabase(database: string): Promise<boolean>\n\n    /**\n     * Loads currently using database\n     */\n    getCurrentDatabase(): Promise<string | undefined>\n\n    /**\n     * Checks if a schema with the given name exist.\n     */\n    hasSchema(schema: string): Promise<boolean>\n\n    /**\n     * Loads currently using database schema\n     */\n    getCurrentSchema(): Promise<string | undefined>\n\n    /**\n     * Checks if a table with the given name exist.\n     */\n    hasTable(table: Table | string): Promise<boolean>\n\n    /**\n     * Checks if a column exist in the table.\n     */\n    hasColumn(table: Table | string, columnName: string): Promise<boolean>\n\n    /**\n     * Creates a new database.\n     */\n    createDatabase(database: string, ifNotExists?: boolean): Promise<void>\n\n    /**\n     * Drops a database.\n     */\n    dropDatabase(database: string, ifExists?: boolean): Promise<void>\n\n    /**\n     * Creates a new table schema.\n     */\n    createSchema(schemaPath: string, ifNotExists?: boolean): Promise<void>\n\n    /**\n     * Drops a table schema.\n     * For SqlServer can accept schema path (e.g. 'dbName.schemaName') as parameter.\n     * If schema path passed, it will drop schema in specified database.\n     */\n    dropSchema(\n        schemaPath: string,\n        ifExists?: boolean,\n        isCascade?: boolean,\n    ): Promise<void>\n\n    /**\n     * Creates a new table.\n     */\n    createTable(\n        table: Table,\n        ifNotExists?: boolean,\n        createForeignKeys?: boolean,\n        createIndices?: boolean,\n    ): Promise<void>\n\n    /**\n     * Drops a table.\n     */\n    dropTable(\n        table: Table | string,\n        ifExists?: boolean,\n        dropForeignKeys?: boolean,\n        dropIndices?: boolean,\n    ): Promise<void>\n\n    /**\n     * Creates a new view.\n     */\n    createView(\n        view: View,\n        syncWithMetadata?: boolean,\n        oldView?: View,\n    ): Promise<void>\n\n    /**\n     * Drops a view.\n     */\n    dropView(view: View | string, ifExists?: boolean): Promise<void>\n\n    /**\n     * Renames a table.\n     */\n    renameTable(\n        oldTableOrName: Table | string,\n        newTableName: string,\n    ): Promise<void>\n\n    /**\n     * Change table comment. Only supports MySQL and MariaDB\n     */\n    changeTableComment(\n        tableOrName: Table | string,\n        comment?: string,\n    ): Promise<void>\n\n    /**\n     * Adds a new column.\n     */\n    addColumn(table: Table | string, column: TableColumn): Promise<void>\n\n    /**\n     * Adds new columns.\n     */\n    addColumns(table: Table | string, columns: TableColumn[]): Promise<void>\n\n    /**\n     * Renames a column.\n     */\n    renameColumn(\n        table: Table | string,\n        oldColumnOrName: TableColumn | string,\n        newColumnOrName: TableColumn | string,\n    ): Promise<void>\n\n    /**\n     * Changes a column in the table.\n     */\n    changeColumn(\n        table: Table | string,\n        oldColumn: TableColumn | string,\n        newColumn: TableColumn,\n    ): Promise<void>\n\n    /**\n     * Changes columns in the table.\n     */\n    changeColumns(\n        table: Table | string,\n        changedColumns: { oldColumn: TableColumn; newColumn: TableColumn }[],\n    ): Promise<void>\n\n    /**\n     * Drops a column in the table.\n     */\n    dropColumn(\n        table: Table | string,\n        column: TableColumn | string,\n        ifExists?: boolean,\n    ): Promise<void>\n\n    /**\n     * Drops columns in the table.\n     */\n    dropColumns(\n        table: Table | string,\n        columns: TableColumn[] | string[],\n        ifExists?: boolean,\n    ): Promise<void>\n\n    /**\n     * Creates a new primary key.\n     */\n    createPrimaryKey(\n        table: Table | string,\n        columnNames: string[],\n        constraintName?: string,\n    ): Promise<void>\n\n    /**\n     * Updates composite primary keys.\n     */\n    updatePrimaryKeys(\n        table: Table | string,\n        columns: TableColumn[],\n    ): Promise<void>\n\n    /**\n     * Drops a primary key.\n     */\n    dropPrimaryKey(\n        table: Table | string,\n        constraintName?: string,\n        ifExists?: boolean,\n    ): Promise<void>\n\n    /**\n     * Creates a new unique constraint.\n     */\n    createUniqueConstraint(\n        table: Table | string,\n        uniqueConstraint: TableUnique,\n    ): Promise<void>\n\n    /**\n     * Creates new unique constraints.\n     */\n    createUniqueConstraints(\n        table: Table | string,\n        uniqueConstraints: TableUnique[],\n    ): Promise<void>\n\n    /**\n     * Drops a unique constraint.\n     */\n    dropUniqueConstraint(\n        table: Table | string,\n        uniqueOrName: TableUnique | string,\n        ifExists?: boolean,\n    ): Promise<void>\n\n    /**\n     * Drops unique constraints.\n     */\n    dropUniqueConstraints(\n        table: Table | string,\n        uniqueConstraints: TableUnique[],\n        ifExists?: boolean,\n    ): Promise<void>\n\n    /**\n     * Creates a new check constraint.\n     */\n    createCheckConstraint(\n        table: Table | string,\n        checkConstraint: TableCheck,\n    ): Promise<void>\n\n    /**\n     * Creates new check constraints.\n     */\n    createCheckConstraints(\n        table: Table | string,\n        checkConstraints: TableCheck[],\n    ): Promise<void>\n\n    /**\n     * Drops a check constraint.\n     */\n    dropCheckConstraint(\n        table: Table | string,\n        checkOrName: TableCheck | string,\n        ifExists?: boolean,\n    ): Promise<void>\n\n    /**\n     * Drops check constraints.\n     */\n    dropCheckConstraints(\n        table: Table | string,\n        checkConstraints: TableCheck[],\n        ifExists?: boolean,\n    ): Promise<void>\n\n    /**\n     * Creates a new exclusion constraint.\n     */\n    createExclusionConstraint(\n        table: Table | string,\n        exclusionConstraint: TableExclusion,\n    ): Promise<void>\n\n    /**\n     * Creates new exclusion constraints.\n     */\n    createExclusionConstraints(\n        table: Table | string,\n        exclusionConstraints: TableExclusion[],\n    ): Promise<void>\n\n    /**\n     * Drops an exclusion constraint.\n     */\n    dropExclusionConstraint(\n        table: Table | string,\n        exclusionOrName: TableExclusion | string,\n        ifExists?: boolean,\n    ): Promise<void>\n\n    /**\n     * Drops exclusion constraints.\n     */\n    dropExclusionConstraints(\n        table: Table | string,\n        exclusionConstraints: TableExclusion[],\n        ifExists?: boolean,\n    ): Promise<void>\n\n    /**\n     * Creates a new foreign key.\n     */\n    createForeignKey(\n        table: Table | string,\n        foreignKey: TableForeignKey,\n    ): Promise<void>\n\n    /**\n     * Creates new foreign keys.\n     */\n    createForeignKeys(\n        table: Table | string,\n        foreignKeys: TableForeignKey[],\n    ): Promise<void>\n\n    /**\n     * Drops a foreign key.\n     */\n    dropForeignKey(\n        table: Table | string,\n        foreignKeyOrName: TableForeignKey | string,\n        ifExists?: boolean,\n    ): Promise<void>\n\n    /**\n     * Drops foreign keys.\n     */\n    dropForeignKeys(\n        table: Table | string,\n        foreignKeys: TableForeignKey[],\n        ifExists?: boolean,\n    ): Promise<void>\n\n    /**\n     * Creates a new index.\n     */\n    createIndex(table: Table | string, index: TableIndex): Promise<void>\n\n    /**\n     * Creates new indices.\n     */\n    createIndices(table: Table | string, indices: TableIndex[]): Promise<void>\n\n    /**\n     * Drops an index.\n     */\n    dropIndex(\n        table: Table | string,\n        index: TableIndex | string,\n        ifExists?: boolean,\n    ): Promise<void>\n\n    /**\n     * Drops indices.\n     */\n    dropIndices(\n        table: Table | string,\n        indices: TableIndex[],\n        ifExists?: boolean,\n    ): Promise<void>\n\n    /**\n     * Clears all table contents.\n     * Note: this operation uses SQL's TRUNCATE query which cannot be reverted in transactions.\n     */\n    clearTable(\n        tableName: string,\n        options?: { cascade?: boolean },\n    ): Promise<void>\n\n    /**\n     * Enables special query runner mode in which sql queries won't be executed,\n     * instead they will be memorized into a special variable inside query runner.\n     * You can get memorized sql using getMemorySql() method.\n     */\n    enableSqlMemory(): void\n\n    /**\n     * Disables special query runner mode in which sql queries won't be executed\n     * started by calling enableSqlMemory() method.\n     *\n     * Previously memorized sql will be flushed.\n     */\n    disableSqlMemory(): void\n\n    /**\n     * Flushes all memorized sqls.\n     */\n    clearSqlMemory(): void\n\n    /**\n     * Gets sql stored in the memory. Parameters in the sql are already replaced.\n     */\n    getMemorySql(): SqlInMemory\n\n    /**\n     * Executes up sql queries.\n     */\n    executeMemoryUpSql(): Promise<void>\n\n    /**\n     * Executes down sql queries.\n     */\n    executeMemoryDownSql(): Promise<void>\n}\n"]}

package/browser/repository/BaseEntity.d.ts

@@ -1,20 +1,21 @@
-import { Repository } from "./Repository";
-import { FindOptionsWhere } from "../find-options/FindOptionsWhere";
-import { DeepPartial } from "../common/DeepPartial";
-import { SaveOptions } from "./SaveOptions";
-import { FindOneOptions } from "../find-options/FindOneOptions";
-import { RemoveOptions } from "./RemoveOptions";
-import { FindManyOptions } from "../find-options/FindManyOptions";
-import { DataSource } from "../data-source";
-import { SelectQueryBuilder } from "../query-builder/SelectQueryBuilder";
-import { InsertResult } from "../query-builder/result/InsertResult";
-import { UpdateResult } from "../query-builder/result/UpdateResult";
-import { DeleteResult } from "../query-builder/result/DeleteResult";
-import { ObjectId } from "../driver/mongodb/typings";
-import { QueryDeepPartialEntity } from "../query-builder/QueryPartialEntity";
-import { UpsertOptions } from "./UpsertOptions";
-import { EntityTarget } from "../common/EntityTarget";
-import { PickKeysByType } from "../common/PickKeysByType";
+import type { Repository } from "./Repository";
+import type { FindOptionsWhere } from "../find-options/FindOptionsWhere";
+import type { DeepPartial } from "../common/DeepPartial";
+import type { SaveOptions } from "./SaveOptions";
+import type { FindOneOptions } from "../find-options/FindOneOptions";
+import type { RemoveOptions } from "./RemoveOptions";
+import type { FindManyOptions } from "../find-options/FindManyOptions";
+import type { DataSource } from "../data-source";
+import type { SelectQueryBuilder } from "../query-builder/SelectQueryBuilder";
+import type { InsertResult } from "../query-builder/result/InsertResult";
+import type { UpdateResult } from "../query-builder/result/UpdateResult";
+import type { DeleteResult } from "../query-builder/result/DeleteResult";
+import type { ObjectId } from "../driver/mongodb/typings";
+import type { QueryDeepPartialEntity } from "../query-builder/QueryPartialEntity";
+import type { UpsertOptions } from "./UpsertOptions";
+import type { UpdateOptions } from "./UpdateOptions";
+import type { EntityTarget } from "../common/EntityTarget";
+import type { PickKeysByType } from "../common/PickKeysByType";
 /**
  * Base abstract entity for all entities, used in ActiveRecord patterns.
  */
@@ -31,18 +32,22 @@ export declare class BaseEntity {
     /**
      * Saves current entity in the database.
      * If entity does not exist in the database then inserts, otherwise updates.
+     * @param options
      */
     save(options?: SaveOptions): Promise<this>;
     /**
      * Removes current entity from the database.
+     * @param options
      */
     remove(options?: RemoveOptions): Promise<this>;
     /**
      * Records the delete date of current entity.
+     * @param options
      */
     softRemove(options?: SaveOptions): Promise<this>;
     /**
      * Recovers a given entity in the database.
+     * @param options
      */
     recover(options?: SaveOptions): Promise<this>;
     /**
@@ -51,6 +56,7 @@ export declare class BaseEntity {
     reload(): Promise<void>;
     /**
      * Sets DataSource to be used by entity.
+     * @param dataSource
      */
     static useDataSource(dataSource: DataSource | null): void;
     /**
@@ -68,16 +74,19 @@ export declare class BaseEntity {
     /**
      * Checks entity has an id.
      * If entity composite compose ids, it will check them all.
+     * @param entity
      */
     static hasId(entity: BaseEntity): boolean;
     /**
      * Gets entity mixed id.
+     * @param entity
      */
     static getId<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, entity: T): any;
     /**
      * Creates a new query builder that can be used to build a SQL query.
+     * @param alias
      */
     static createQueryBuilder<T extends BaseEntity>(this: {
         new (): T;
@@ -104,6 +113,8 @@ export declare class BaseEntity {
     } & typeof BaseEntity, entityLike: DeepPartial<T>): T;
     /**
      * Merges multiple entities (or entity-like objects) into a given entity.
+     * @param mergeIntoEntity
+     * @param entityLikes
      */
     static merge<T extends BaseEntity>(this: {
         new (): T;
@@ -116,6 +127,7 @@ export declare class BaseEntity {
      *
      * Note that given entity-like object must have an entity id / primary key to find entity by.
      * Returns undefined if entity with given id was not found.
+     * @param entityLike
      */
     static preload<T extends BaseEntity>(this: {
         new (): T;
@@ -163,6 +175,7 @@ export declare class BaseEntity {
      * Unlike save method executes a primitive operation without cascades, relations and other operations included.
      * Executes fast and efficient INSERT query.
      * Does not check if entity exist in the database, so query will fail if duplicate entity is being inserted.
+     * @param entity
      */
     static insert<T extends BaseEntity>(this: {
         new (): T;
@@ -172,14 +185,19 @@ export declare class BaseEntity {
      * Unlike save method executes a primitive operation without cascades, relations and other operations included.
      * Executes fast and efficient UPDATE query.
      * Does not check if entity exist in the database.
+     * @param criteria
+     * @param partialEntity
+     * @param options
      */
     static update<T extends BaseEntity>(this: {
         new (): T;
-    } & typeof BaseEntity, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | FindOptionsWhere<T>, partialEntity: QueryDeepPartialEntity<T>): Promise<UpdateResult>;
+    } & typeof BaseEntity, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | FindOptionsWhere<T>, partialEntity: QueryDeepPartialEntity<T>, options?: UpdateOptions): Promise<UpdateResult>;
     /**
      * Inserts a given entity into the database, unless a unique constraint conflicts then updates the entity
      * Unlike save method executes a primitive operation without cascades, relations and other operations included.
      * Executes fast and efficient INSERT ... ON CONFLICT DO UPDATE/ON DUPLICATE KEY UPDATE query.
+     * @param entityOrEntities
+     * @param conflictPathsOrOptions
      */
     static upsert<T extends BaseEntity>(this: {
         new (): T;
@@ -189,66 +207,81 @@ export declare class BaseEntity {
      * Unlike remove method executes a primitive operation without cascades, relations and other operations included.
      * Executes fast and efficient DELETE query.
      * Does not check if entity exist in the database.
+     * @param criteria
      */
     static delete<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, criteria: string | string[] | number | number[] | Date | Date[] | ObjectId | ObjectId[] | FindOptionsWhere<T>): Promise<DeleteResult>;
     /**
      * Checks whether any entity exists that matches the given options.
+     * @param options
      */
     static exists<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, options?: FindManyOptions<T>): Promise<boolean>;
     /**
      * Checks whether any entity exists that matches the given conditions.
+     * @param where
      */
     static existsBy<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, where: FindOptionsWhere<T>): Promise<boolean>;
     /**
      * Counts entities that match given options.
+     * @param options
      */
     static count<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, options?: FindManyOptions<T>): Promise<number>;
     /**
      * Counts entities that match given WHERE conditions.
+     * @param where
      */
     static countBy<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, where: FindOptionsWhere<T>): Promise<number>;
     /**
      * Return the SUM of a column
+     * @param columnName
+     * @param where
      */
     static sum<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, columnName: PickKeysByType<T, number>, where: FindOptionsWhere<T>): Promise<number | null>;
     /**
      * Return the AVG of a column
+     * @param columnName
+     * @param where
      */
     static average<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, columnName: PickKeysByType<T, number>, where: FindOptionsWhere<T>): Promise<number | null>;
     /**
      * Return the MIN of a column
+     * @param columnName
+     * @param where
      */
     static minimum<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, columnName: PickKeysByType<T, number>, where: FindOptionsWhere<T>): Promise<number | null>;
     /**
      * Return the MAX of a column
+     * @param columnName
+     * @param where
      */
     static maximum<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, columnName: PickKeysByType<T, number>, where: FindOptionsWhere<T>): Promise<number | null>;
     /**
      * Finds entities that match given options.
+     * @param options
      */
     static find<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, options?: FindManyOptions<T>): Promise<T[]>;
     /**
      * Finds entities that match given WHERE conditions.
+     * @param where
      */
     static findBy<T extends BaseEntity>(this: {
         new (): T;
@@ -257,6 +290,7 @@ export declare class BaseEntity {
      * Finds entities that match given find options.
      * Also counts all entities that match given conditions,
      * but ignores pagination settings (from and take options).
+     * @param options
      */
     static findAndCount<T extends BaseEntity>(this: {
         new (): T;
@@ -265,55 +299,35 @@ export declare class BaseEntity {
      * Finds entities that match given WHERE conditions.
      * Also counts all entities that match given conditions,
      * but ignores pagination settings (from and take options).
+     * @param where
      */
     static findAndCountBy<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, where: FindOptionsWhere<T>): Promise<[T[], number]>;
-    /**
-     * Finds entities by ids.
-     * Optionally find options can be applied.
-     *
-     * @deprecated use `findBy` method instead in conjunction with `In` operator, for example:
-     *
-     * .findBy({
-     *     id: In([1, 2, 3])
-     * })
-     */
-    static findByIds<T extends BaseEntity>(this: {
-        new (): T;
-    } & typeof BaseEntity, ids: any[]): Promise<T[]>;
     /**
      * Finds first entity that matches given conditions.
+     * @param options
      */
     static findOne<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, options: FindOneOptions<T>): Promise<T | null>;
     /**
      * Finds first entity that matches given conditions.
+     * @param where
      */
     static findOneBy<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, where: FindOptionsWhere<T>): Promise<T | null>;
-    /**
-     * Finds first entity that matches given options.
-     *
-     * @deprecated use `findOneBy` method instead in conjunction with `In` operator, for example:
-     *
-     * .findOneBy({
-     *     id: 1 // where "id" is your primary column name
-     * })
-     */
-    static findOneById<T extends BaseEntity>(this: {
-        new (): T;
-    } & typeof BaseEntity, id: string | number | Date | ObjectId): Promise<T | null>;
     /**
      * Finds first entity that matches given conditions.
+     * @param options
      */
     static findOneOrFail<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, options: FindOneOptions<T>): Promise<T>;
     /**
      * Finds first entity that matches given conditions.
+     * @param where
      */
     static findOneByOrFail<T extends BaseEntity>(this: {
         new (): T;
@@ -321,14 +335,20 @@ export declare class BaseEntity {
     /**
      * Executes a raw SQL query and returns a raw database results.
      * Raw query execution is supported only by relational databases (MongoDB is not supported).
+     * @param query
+     * @param parameters
      */
     static query<T extends BaseEntity>(this: {
         new (): T;
     } & typeof BaseEntity, query: string, parameters?: any[]): Promise<any>;
     /**
      * Clears all the data from the given table/collection (truncates/drops it).
+     * @param options
+     * @param options.cascade
      */
     static clear<T extends BaseEntity>(this: {
         new (): T;
-    } & typeof BaseEntity): Promise<void>;
+    } & typeof BaseEntity, options?: {
+        cascade?: boolean;
+    }): Promise<void>;
 }