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

package/browser/data-source/BaseDataSourceOptions.d.ts

@@ -1,11 +1,11 @@
-import { EntitySchema } from "../entity-schema/EntitySchema";
-import { LoggerOptions } from "../logger/LoggerOptions";
-import { NamingStrategyInterface } from "../naming-strategy/NamingStrategyInterface";
-import { DatabaseType } from "../driver/types/DatabaseType";
-import { Logger } from "../logger/Logger";
-import { DataSource } from "../data-source/DataSource";
-import { QueryResultCache } from "../cache/QueryResultCache";
-import { MixedList } from "../common/MixedList";
+import type { EntitySchema } from "../entity-schema/EntitySchema";
+import type { LoggerOptions } from "../logger/LoggerOptions";
+import type { NamingStrategyInterface } from "../naming-strategy/NamingStrategyInterface";
+import type { DatabaseType } from "../driver/types/DatabaseType";
+import type { Logger } from "../logger/Logger";
+import type { DataSource } from "../data-source/DataSource";
+import type { QueryResultCache } from "../cache/QueryResultCache";
+import type { MixedList } from "../common/MixedList";
 /**
  * BaseDataSourceOptions is set of DataSourceOptions shared by all database types.
  */
@@ -14,13 +14,6 @@ export interface BaseDataSourceOptions {
      * Database type. This value is required.
      */
     readonly type: DatabaseType;
-    /**
-     * Connection name. If connection name is not given then it will be called "default".
-     * Different connections must have different names.
-     *
-     * @deprecated
-     */
-    readonly name?: string;
     /**
      * Entities to be loaded for this connection.
      * Accepts both entity classes and directories where from entities need to be loaded.
@@ -137,7 +130,7 @@ export interface BaseDataSourceOptions {
         /**
          * Factory function for custom cache providers that implement QueryResultCache.
          */
-        readonly provider?: (connection: DataSource) => QueryResultCache;
+        readonly provider?: (dataSource: DataSource) => QueryResultCache;
         /**
          * Configurable table name for "database" type cache.
          * Default value is "query-result-cache"
@@ -172,15 +165,15 @@ export interface BaseDataSourceOptions {
     readonly invalidWhereValuesBehavior?: {
         /**
          * How to handle null values in where conditions.
-         * - 'ignore': Skip null properties (default)
+         * - 'ignore': Skip null properties
          * - 'sql-null': Transform null to SQL NULL
-         * - 'throw': Throw an error when null is encountered
+         * - 'throw': Throw an error when null is encountered (default)
          */
         readonly null?: "ignore" | "sql-null" | "throw";
         /**
          * How to handle undefined values in where conditions.
-         * - 'ignore': Skip undefined properties (default)
-         * - 'throw': Throw an error when undefined is encountered
+         * - 'ignore': Skip undefined properties
+         * - 'throw': Throw an error when undefined is encountered (default)
          */
         readonly undefined?: "ignore" | "throw";
     };

package/browser/data-source/BaseDataSourceOptions.js

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

package/browser/data-source/BaseDataSourceOptions.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../browser/src/data-source/BaseDataSourceOptions.ts"],"names":[],"mappings":"","file":"BaseDataSourceOptions.js","sourcesContent":["import { EntitySchema } from \"../entity-schema/EntitySchema\"\nimport { LoggerOptions } from \"../logger/LoggerOptions\"\nimport { NamingStrategyInterface } from \"../naming-strategy/NamingStrategyInterface\"\nimport { DatabaseType } from \"../driver/types/DatabaseType\"\nimport { Logger } from \"../logger/Logger\"\nimport { DataSource } from \"../data-source/DataSource\"\nimport { QueryResultCache } from \"../cache/QueryResultCache\"\nimport { MixedList } from \"../common/MixedList\"\n\n/**\n * BaseDataSourceOptions is set of DataSourceOptions shared by all database types.\n */\nexport interface BaseDataSourceOptions {\n    /**\n     * Database type. This value is required.\n     */\n    readonly type: DatabaseType\n\n    /**\n     * Connection name. If connection name is not given then it will be called \"default\".\n     * Different connections must have different names.\n     *\n     * @deprecated\n     */\n    readonly name?: string\n\n    /**\n     * Entities to be loaded for this connection.\n     * Accepts both entity classes and directories where from entities need to be loaded.\n     * Directories support glob patterns.\n     */\n    readonly entities?: MixedList<Function | string | EntitySchema>\n\n    /**\n     * Subscribers to be loaded for this connection.\n     * Accepts both subscriber classes and directories where from subscribers need to be loaded.\n     * Directories support glob patterns.\n     */\n    readonly subscribers?: MixedList<Function | string>\n\n    /**\n     * Migrations to be loaded for this connection.\n     * Accepts both migration classes and glob patterns representing migration files.\n     */\n    readonly migrations?: MixedList<Function | string>\n\n    /**\n     * Migrations table name, in case of different name from \"migrations\".\n     * Accepts single string name.\n     */\n    readonly migrationsTableName?: string\n\n    /**\n     * Transaction mode for migrations to run in\n     */\n    readonly migrationsTransactionMode?: \"all\" | \"none\" | \"each\"\n\n    /**\n     * Typeorm metadata table name, in case of different name from \"typeorm_metadata\".\n     * Accepts single string name.\n     */\n    readonly metadataTableName?: string\n\n    /**\n     * Naming strategy to be used to name tables and columns in the database.\n     */\n    readonly namingStrategy?: NamingStrategyInterface\n\n    /**\n     * Logging options.\n     */\n    readonly logging?: LoggerOptions\n\n    /**\n     * Logger instance used to log queries and events in the ORM.\n     */\n    readonly logger?:\n        | \"advanced-console\"\n        | \"simple-console\"\n        | \"formatted-console\"\n        | \"file\"\n        | \"debug\"\n        | Logger\n\n    /**\n     * Maximum number of milliseconds query should be executed before logger log a warning.\n     */\n    readonly maxQueryExecutionTime?: number\n\n    /**\n     * Maximum number of clients the pool should contain.\n     */\n    readonly poolSize?: number\n\n    /**\n     * Indicates if database schema should be auto created on every application launch.\n     * Be careful with this option and don't use this in production - otherwise you can lose production data.\n     * This option is useful during debug and development.\n     * Alternative to it, you can use CLI and run schema:sync command.\n     *\n     * Note that for MongoDB database it does not create schema, because MongoDB is schemaless.\n     * Instead, it syncs just by creating indices.\n     */\n    readonly synchronize?: boolean\n\n    /**\n     * Indicates if migrations should be auto run on every application launch.\n     * Alternative to it, you can use CLI and run migrations:run command.\n     */\n    readonly migrationsRun?: boolean\n\n    /**\n     * Drops the schema each time connection is being established.\n     * Be careful with this option and don't use this in production - otherwise you'll lose all production data.\n     * This option is useful during debug and development.\n     */\n    readonly dropSchema?: boolean\n\n    /**\n     * Prefix to use on all tables (collections) of this connection in the database.\n     */\n    readonly entityPrefix?: string\n\n    /**\n     * When creating new Entity instances, skip all constructors when true.\n     */\n    readonly entitySkipConstructor?: boolean\n\n    /**\n     * Extra connection options to be passed to the underlying driver.\n     *\n     * todo: deprecate this and move all database-specific types into hts own connection options object.\n     */\n    readonly extra?: any\n\n    /**\n     * Specifies how relations must be loaded - using \"joins\" or separate queries.\n     * If you are loading too much data with nested joins it's better to load relations\n     * using separate queries.\n     *\n     * Default strategy is \"join\", but this default can be changed here.\n     * Also, strategy can be set per-query in FindOptions and QueryBuilder.\n     */\n    readonly relationLoadStrategy?: \"join\" | \"query\"\n\n    /**\n     * Optionally applied \"typename\" to the model.\n     * If set, then each hydrated model will have this property with the target model / entity name inside.\n     *\n     * (works like a discriminator property).\n     */\n    readonly typename?: string\n\n    /**\n     * Holds reference to the baseDirectory where configuration file are expected.\n     *\n     * @internal\n     */\n    baseDirectory?: string\n\n    /**\n     * Allows to setup cache options.\n     */\n    readonly cache?:\n        | boolean\n        | {\n              /**\n               * Type of caching.\n               *\n               * - \"database\" means cached values will be stored in the separate table in database. This is default value.\n               * - \"redis\" means cached values will be stored inside redis. You must provide redis connection options.\n               */\n              readonly type?:\n                  | \"database\"\n                  | \"redis\"\n                  | \"ioredis\"\n                  | \"ioredis/cluster\" // todo: add mongodb and other cache providers as well in the future\n\n              /**\n               * Factory function for custom cache providers that implement QueryResultCache.\n               */\n              readonly provider?: (connection: DataSource) => QueryResultCache\n\n              /**\n               * Configurable table name for \"database\" type cache.\n               * Default value is \"query-result-cache\"\n               */\n              readonly tableName?: string\n\n              /**\n               * Used to provide redis connection options.\n               */\n              readonly options?: any\n\n              /**\n               * If set to true then queries (using find methods and QueryBuilder's methods) will always be cached.\n               */\n              readonly alwaysEnabled?: boolean\n\n              /**\n               * Time in milliseconds in which cache will expire.\n               * This can be setup per-query.\n               * Default value is 1000 which is equivalent to 1 second.\n               */\n              readonly duration?: number\n\n              /**\n               * Used to specify if cache errors should be ignored, and pass through the call to the Database.\n               */\n              readonly ignoreErrors?: boolean\n          }\n\n    /**\n     * Allows automatic isolation of where clauses\n     */\n    readonly isolateWhereStatements?: boolean\n\n    /**\n     * Controls how null and undefined values are handled in find operations.\n     */\n    readonly invalidWhereValuesBehavior?: {\n        /**\n         * How to handle null values in where conditions.\n         * - 'ignore': Skip null properties (default)\n         * - 'sql-null': Transform null to SQL NULL\n         * - 'throw': Throw an error when null is encountered\n         */\n        readonly null?: \"ignore\" | \"sql-null\" | \"throw\"\n\n        /**\n         * How to handle undefined values in where conditions.\n         * - 'ignore': Skip undefined properties (default)\n         * - 'throw': Throw an error when undefined is encountered\n         */\n        readonly undefined?: \"ignore\" | \"throw\"\n    }\n}\n"],"sourceRoot":".."}
+{"version":3,"file":"BaseDataSourceOptions.js","sourceRoot":"../build/browser/src/","sources":["data-source/BaseDataSourceOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { EntitySchema } from \"../entity-schema/EntitySchema\"\nimport type { LoggerOptions } from \"../logger/LoggerOptions\"\nimport type { NamingStrategyInterface } from \"../naming-strategy/NamingStrategyInterface\"\nimport type { DatabaseType } from \"../driver/types/DatabaseType\"\nimport type { Logger } from \"../logger/Logger\"\nimport type { DataSource } from \"../data-source/DataSource\"\nimport type { QueryResultCache } from \"../cache/QueryResultCache\"\nimport type { MixedList } from \"../common/MixedList\"\n\n/**\n * BaseDataSourceOptions is set of DataSourceOptions shared by all database types.\n */\nexport interface BaseDataSourceOptions {\n    /**\n     * Database type. This value is required.\n     */\n    readonly type: DatabaseType\n\n    /**\n     * Entities to be loaded for this connection.\n     * Accepts both entity classes and directories where from entities need to be loaded.\n     * Directories support glob patterns.\n     */\n    readonly entities?: MixedList<Function | string | EntitySchema>\n\n    /**\n     * Subscribers to be loaded for this connection.\n     * Accepts both subscriber classes and directories where from subscribers need to be loaded.\n     * Directories support glob patterns.\n     */\n    readonly subscribers?: MixedList<Function | string>\n\n    /**\n     * Migrations to be loaded for this connection.\n     * Accepts both migration classes and glob patterns representing migration files.\n     */\n    readonly migrations?: MixedList<Function | string>\n\n    /**\n     * Migrations table name, in case of different name from \"migrations\".\n     * Accepts single string name.\n     */\n    readonly migrationsTableName?: string\n\n    /**\n     * Transaction mode for migrations to run in\n     */\n    readonly migrationsTransactionMode?: \"all\" | \"none\" | \"each\"\n\n    /**\n     * Typeorm metadata table name, in case of different name from \"typeorm_metadata\".\n     * Accepts single string name.\n     */\n    readonly metadataTableName?: string\n\n    /**\n     * Naming strategy to be used to name tables and columns in the database.\n     */\n    readonly namingStrategy?: NamingStrategyInterface\n\n    /**\n     * Logging options.\n     */\n    readonly logging?: LoggerOptions\n\n    /**\n     * Logger instance used to log queries and events in the ORM.\n     */\n    readonly logger?:\n        | \"advanced-console\"\n        | \"simple-console\"\n        | \"formatted-console\"\n        | \"file\"\n        | \"debug\"\n        | Logger\n\n    /**\n     * Maximum number of milliseconds query should be executed before logger log a warning.\n     */\n    readonly maxQueryExecutionTime?: number\n\n    /**\n     * Maximum number of clients the pool should contain.\n     */\n    readonly poolSize?: number\n\n    /**\n     * Indicates if database schema should be auto created on every application launch.\n     * Be careful with this option and don't use this in production - otherwise you can lose production data.\n     * This option is useful during debug and development.\n     * Alternative to it, you can use CLI and run schema:sync command.\n     *\n     * Note that for MongoDB database it does not create schema, because MongoDB is schemaless.\n     * Instead, it syncs just by creating indices.\n     */\n    readonly synchronize?: boolean\n\n    /**\n     * Indicates if migrations should be auto run on every application launch.\n     * Alternative to it, you can use CLI and run migrations:run command.\n     */\n    readonly migrationsRun?: boolean\n\n    /**\n     * Drops the schema each time connection is being established.\n     * Be careful with this option and don't use this in production - otherwise you'll lose all production data.\n     * This option is useful during debug and development.\n     */\n    readonly dropSchema?: boolean\n\n    /**\n     * Prefix to use on all tables (collections) of this connection in the database.\n     */\n    readonly entityPrefix?: string\n\n    /**\n     * When creating new Entity instances, skip all constructors when true.\n     */\n    readonly entitySkipConstructor?: boolean\n\n    /**\n     * Extra connection options to be passed to the underlying driver.\n     *\n     * todo: deprecate this and move all database-specific types into hts own connection options object.\n     */\n    readonly extra?: any\n\n    /**\n     * Specifies how relations must be loaded - using \"joins\" or separate queries.\n     * If you are loading too much data with nested joins it's better to load relations\n     * using separate queries.\n     *\n     * Default strategy is \"join\", but this default can be changed here.\n     * Also, strategy can be set per-query in FindOptions and QueryBuilder.\n     */\n    readonly relationLoadStrategy?: \"join\" | \"query\"\n\n    /**\n     * Optionally applied \"typename\" to the model.\n     * If set, then each hydrated model will have this property with the target model / entity name inside.\n     *\n     * (works like a discriminator property).\n     */\n    readonly typename?: string\n\n    /**\n     * Holds reference to the baseDirectory where configuration file are expected.\n     * @internal\n     */\n    baseDirectory?: string\n\n    /**\n     * Allows to setup cache options.\n     */\n    readonly cache?:\n        | boolean\n        | {\n              /**\n               * Type of caching.\n               *\n               * - \"database\" means cached values will be stored in the separate table in database. This is default value.\n               * - \"redis\" means cached values will be stored inside redis. You must provide redis connection options.\n               */\n              readonly type?:\n                  | \"database\"\n                  | \"redis\"\n                  | \"ioredis\"\n                  | \"ioredis/cluster\" // todo: add mongodb and other cache providers as well in the future\n\n              /**\n               * Factory function for custom cache providers that implement QueryResultCache.\n               */\n              readonly provider?: (dataSource: DataSource) => QueryResultCache\n\n              /**\n               * Configurable table name for \"database\" type cache.\n               * Default value is \"query-result-cache\"\n               */\n              readonly tableName?: string\n\n              /**\n               * Used to provide redis connection options.\n               */\n              readonly options?: any\n\n              /**\n               * If set to true then queries (using find methods and QueryBuilder's methods) will always be cached.\n               */\n              readonly alwaysEnabled?: boolean\n\n              /**\n               * Time in milliseconds in which cache will expire.\n               * This can be setup per-query.\n               * Default value is 1000 which is equivalent to 1 second.\n               */\n              readonly duration?: number\n\n              /**\n               * Used to specify if cache errors should be ignored, and pass through the call to the Database.\n               */\n              readonly ignoreErrors?: boolean\n          }\n\n    /**\n     * Allows automatic isolation of where clauses\n     */\n    readonly isolateWhereStatements?: boolean\n\n    /**\n     * Controls how null and undefined values are handled in find operations.\n     */\n    readonly invalidWhereValuesBehavior?: {\n        /**\n         * How to handle null values in where conditions.\n         * - 'ignore': Skip null properties\n         * - 'sql-null': Transform null to SQL NULL\n         * - 'throw': Throw an error when null is encountered (default)\n         */\n        readonly null?: \"ignore\" | \"sql-null\" | \"throw\"\n\n        /**\n         * How to handle undefined values in where conditions.\n         * - 'ignore': Skip undefined properties\n         * - 'throw': Throw an error when undefined is encountered (default)\n         */\n        readonly undefined?: \"ignore\" | \"throw\"\n    }\n}\n"]}

package/browser/data-source/DataSource.d.ts

@@ -1,27 +1,26 @@
-import { Driver } from "../driver/Driver";
-import { Repository } from "../repository/Repository";
-import { EntitySubscriberInterface } from "../subscriber/EntitySubscriberInterface";
-import { EntityTarget } from "../common/EntityTarget";
-import { ObjectType } from "../common/ObjectType";
-import { EntityManager } from "../entity-manager/EntityManager";
-import { TreeRepository } from "../repository/TreeRepository";
-import { NamingStrategyInterface } from "../naming-strategy/NamingStrategyInterface";
-import { EntityMetadata } from "../metadata/EntityMetadata";
-import { Logger } from "../logger/Logger";
-import { MigrationInterface } from "../migration/MigrationInterface";
-import { Migration } from "../migration/Migration";
-import { MongoRepository } from "../repository/MongoRepository";
-import { MongoEntityManager } from "../entity-manager/MongoEntityManager";
-import { DataSourceOptions } from "./DataSourceOptions";
-import { QueryRunner } from "../query-runner/QueryRunner";
+import type { Driver } from "../driver/Driver";
+import type { Repository } from "../repository/Repository";
+import type { EntitySubscriberInterface } from "../subscriber/EntitySubscriberInterface";
+import type { EntityTarget } from "../common/EntityTarget";
+import type { EntityManager } from "../entity-manager/EntityManager";
+import type { TreeRepository } from "../repository/TreeRepository";
+import type { NamingStrategyInterface } from "../naming-strategy/NamingStrategyInterface";
+import type { EntityMetadata } from "../metadata/EntityMetadata";
+import type { Logger } from "../logger/Logger";
+import type { MigrationInterface } from "../migration/MigrationInterface";
+import type { Migration } from "../migration/Migration";
+import type { MongoRepository } from "../repository/MongoRepository";
+import type { MongoEntityManager } from "../entity-manager/MongoEntityManager";
+import type { DataSourceOptions } from "./DataSourceOptions";
+import type { QueryRunner } from "../query-runner/QueryRunner";
 import { SelectQueryBuilder } from "../query-builder/SelectQueryBuilder";
-import { QueryResultCache } from "../cache/QueryResultCache";
-import { SqljsEntityManager } from "../entity-manager/SqljsEntityManager";
+import type { QueryResultCache } from "../cache/QueryResultCache";
+import type { SqljsEntityManager } from "../entity-manager/SqljsEntityManager";
 import { RelationLoader } from "../query-builder/RelationLoader";
-import { IsolationLevel } from "../driver/types/IsolationLevel";
-import { ReplicationMode } from "../driver/types/ReplicationMode";
+import type { IsolationLevel } from "../driver/types/IsolationLevel";
+import type { ReplicationMode } from "../driver/types/ReplicationMode";
 import { RelationIdLoader } from "../query-builder/RelationIdLoader";
-import { ObjectLiteral } from "../common/ObjectLiteral";
+import type { ObjectLiteral } from "../common/ObjectLiteral";
 /**
  * DataSource is a pre-defined connection configuration to a specific database.
  * You can have multiple data sources connected (with multiple connections in it),
@@ -33,17 +32,11 @@ import { ObjectLiteral } from "../common/ObjectLiteral";
 export declare class DataSource {
     readonly "@instanceof": symbol;
     /**
-     * Connection name.
-     *
-     * @deprecated we don't need names anymore since we are going to drop all related methods relying on this property.
-     */
-    readonly name: string;
-    /**
-     * Connection options.
+     * DataSource options.
      */
     readonly options: DataSourceOptions;
     /**
-     * Indicates if DataSource is initialized or not.
+     * Indicates if the DataSource is initialized or not.
      */
     readonly isInitialized: boolean;
     /**
@@ -93,27 +86,24 @@ export declare class DataSource {
     readonly relationLoader: RelationLoader;
     readonly relationIdLoader: RelationIdLoader;
     constructor(options: DataSourceOptions);
-    /**
-     Indicates if DataSource is initialized or not.
-     *
-     * @deprecated use .isInitialized instead
-     */
-    get isConnected(): boolean;
     /**
      * Gets the mongodb entity manager that allows to perform mongodb-specific repository operations
      * with any entity in this connection.
      *
      * Available only in mongodb connections.
+     * @returns the mongodb entity manager
      */
     get mongoManager(): MongoEntityManager;
     /**
      * Gets a sql.js specific Entity Manager that allows to perform special load and save operations
      *
      * Available only in connection with the sqljs driver.
+     * @returns an sqljs specific Entity Manager
      */
     get sqljsManager(): SqljsEntityManager;
     /**
      * Updates current connection options with provided options.
+     * @param options
      */
     setOptions(options: Partial<DataSourceOptions>): this;
     /**
@@ -123,31 +113,14 @@ export declare class DataSource {
      * but it also can setup a connection pool with database to use.
      */
     initialize(): Promise<this>;
-    /**
-     * Performs connection to the database.
-     * This method should be called once on application bootstrap.
-     * This method not necessarily creates database connection (depend on database type),
-     * but it also can setup a connection pool with database to use.
-     *
-     * @deprecated use .initialize method instead
-     */
-    connect(): Promise<this>;
     /**
      * Closes connection with the database.
      * Once connection is closed, you cannot use repositories or perform any operations except opening connection again.
      */
     destroy(): Promise<void>;
-    /**
-     * Closes connection with the database.
-     * Once connection is closed, you cannot use repositories or perform any operations except opening connection again.
-     *
-     * @deprecated use .destroy method instead
-     */
-    close(): Promise<void>;
     /**
      * Creates database schema for all entities registered in this connection.
      * Can be used only after connection to the database is established.
-     *
      * @param dropBeforeSync If set to true then it drops the database with all its tables and data
      */
     synchronize(dropBeforeSync?: boolean): Promise<void>;
@@ -160,6 +133,9 @@ export declare class DataSource {
     /**
      * Runs all pending migrations.
      * Can be used only after connection to the database is established.
+     * @param options
+     * @param options.transaction
+     * @param options.fake
      */
     runMigrations(options?: {
         transaction?: "all" | "none" | "each";
@@ -168,6 +144,9 @@ export declare class DataSource {
     /**
      * Reverts last executed migration.
      * Can be used only after connection to the database is established.
+     * @param options
+     * @param options.transaction
+     * @param options.fake
      */
     undoLastMigration(options?: {
         transaction?: "all" | "none" | "each";
@@ -180,32 +159,31 @@ export declare class DataSource {
     showMigrations(): Promise<boolean>;
     /**
      * Checks if entity metadata exist for the given entity class, target name or table name.
+     * @param target
      */
     hasMetadata(target: EntityTarget<any>): boolean;
     /**
      * Gets entity metadata for the given entity class or schema name.
+     * @param target
      */
     getMetadata(target: EntityTarget<any>): EntityMetadata;
     /**
      * Gets repository for the given entity.
+     * @param target
      */
     getRepository<Entity extends ObjectLiteral>(target: EntityTarget<Entity>): Repository<Entity>;
     /**
      * Gets tree repository for the given entity class or name.
-     * Only tree-type entities can have a TreeRepository, like ones decorated with @Tree decorator.
+     * Only tree-type entities can have a TreeRepository, like ones decorated with `@Tree` decorator.
+     * @param target
      */
     getTreeRepository<Entity extends ObjectLiteral>(target: EntityTarget<Entity>): TreeRepository<Entity>;
     /**
      * Gets mongodb-specific repository for the given entity class or name.
      * Works only if connection is mongodb-specific.
+     * @param target
      */
     getMongoRepository<Entity extends ObjectLiteral>(target: EntityTarget<Entity>): MongoRepository<Entity>;
-    /**
-     * Gets custom entity repository marked with @EntityRepository decorator.
-     *
-     * @deprecated use Repository.extend function to create a custom repository
-     */
-    getCustomRepository<T>(customRepository: ObjectType<T>): T;
     /**
      * Wraps given function execution (and all operations made there) into a transaction.
      * All database operations must be executed using provided entity manager.
@@ -214,8 +192,11 @@ export declare class DataSource {
     transaction<T>(isolationLevel: IsolationLevel, runInTransaction: (entityManager: EntityManager) => Promise<T>): Promise<T>;
     /**
      * Executes raw SQL query and returns raw database results.
-     *
-     * @see [Official docs](https://typeorm.io/data-source-api) for examples.
+     * @param query
+     * @param parameters
+     * @param queryRunner
+     * @returns a raw response from the database client
+     * @see {@link https://typeorm.io/data-source-api | Official docs} for examples.
      */
     query<T = any>(query: string, parameters?: any[], queryRunner?: QueryRunner): Promise<T>;
     /**
@@ -224,6 +205,9 @@ export declare class DataSource {
      * Raw query execution is supported only by relational databases (MongoDB is not supported).
      * Note: Don't call this as a regular function, it is meant to be used with backticks to tag a template literal.
      * Example: dataSource.sql`SELECT * FROM table_name WHERE id = ${id}`
+     * @param strings
+     * @param values
+     * @returns a raw response from the database client
      */
     sql<T = any>(strings: TemplateStringsArray, ...values: unknown[]): Promise<T>;
     /**
@@ -243,18 +227,23 @@ export declare class DataSource {
      * to master database or any of slave databases.
      * If you perform writes you must use master database,
      * if you perform reads you can use slave databases.
+     * @param mode
      */
     createQueryRunner(mode?: ReplicationMode): QueryRunner;
     /**
      * Gets entity metadata of the junction table (many-to-many table).
+     * @param entityTarget
+     * @param relationPropertyPath
      */
     getManyToManyMetadata(entityTarget: EntityTarget<any>, relationPropertyPath: string): EntityMetadata | undefined;
     /**
      * Creates an Entity Manager for the current connection with the help of the EntityManagerFactory.
+     * @param queryRunner
      */
     createEntityManager(queryRunner?: QueryRunner): EntityManager;
     /**
      * Finds exist entity metadata by the given entity class, target name or table name.
+     * @param target
      */
     protected findMetadata(target: EntityTarget<any>): EntityMetadata | undefined;
     /**