typeorm 0.2.38-dev.324f1d8

package/connection/Connection.d.ts

@@ -0,0 +1,206 @@
+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 { ConnectionOptions } from "./ConnectionOptions";
+import { QueryRunner } from "../query-runner/QueryRunner";
+import { SelectQueryBuilder } from "../query-builder/SelectQueryBuilder";
+import { QueryResultCache } from "../cache/QueryResultCache";
+import { SqljsEntityManager } from "../entity-manager/SqljsEntityManager";
+import { RelationLoader } from "../query-builder/RelationLoader";
+import { IsolationLevel } from "../driver/types/IsolationLevel";
+import { ReplicationMode } from "../driver/types/ReplicationMode";
+/**
+ * Connection is a single database ORM connection to a specific database.
+ * Its not required to be a database connection, depend on database type it can create connection pool.
+ * You can have multiple connections to multiple databases in your application.
+ */
+export declare class Connection {
+    /**
+     * Connection name.
+     */
+    readonly name: string;
+    /**
+     * Connection options.
+     */
+    readonly options: ConnectionOptions;
+    /**
+     * Indicates if connection is initialized or not.
+     */
+    readonly isConnected: boolean;
+    /**
+     * Database driver used by this connection.
+     */
+    readonly driver: Driver;
+    /**
+     * EntityManager of this connection.
+     */
+    readonly manager: EntityManager;
+    /**
+     * Naming strategy used in the connection.
+     */
+    readonly namingStrategy: NamingStrategyInterface;
+    /**
+     * Logger used to log orm events.
+     */
+    readonly logger: Logger;
+    /**
+     * Migration instances that are registered for this connection.
+     */
+    readonly migrations: MigrationInterface[];
+    /**
+     * Entity subscriber instances that are registered for this connection.
+     */
+    readonly subscribers: EntitySubscriberInterface<any>[];
+    /**
+     * All entity metadatas that are registered for this connection.
+     */
+    readonly entityMetadatas: EntityMetadata[];
+    /**
+     * Used to work with query result cache.
+     */
+    readonly queryResultCache?: QueryResultCache;
+    /**
+     * Used to load relations and work with lazy relations.
+     */
+    readonly relationLoader: RelationLoader;
+    constructor(options: ConnectionOptions);
+    /**
+     * Gets the mongodb entity manager that allows to perform mongodb-specific repository operations
+     * with any entity in this connection.
+     *
+     * Available only in mongodb connections.
+     */
+    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.
+     */
+    get sqljsManager(): SqljsEntityManager;
+    /**
+     * 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.
+     */
+    connect(): Promise<this>;
+    /**
+     * Closes connection with the database.
+     * Once connection is closed, you cannot use repositories or perform any operations except opening connection again.
+     */
+    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>;
+    /**
+     * Drops the database and all its data.
+     * Be careful with this method on production since this method will erase all your database tables and their data.
+     * Can be used only after connection to the database is established.
+     */
+    dropDatabase(): Promise<void>;
+    /**
+     * Runs all pending migrations.
+     * Can be used only after connection to the database is established.
+     */
+    runMigrations(options?: {
+        transaction?: "all" | "none" | "each";
+    }): Promise<Migration[]>;
+    /**
+     * Reverts last executed migration.
+     * Can be used only after connection to the database is established.
+     */
+    undoLastMigration(options?: {
+        transaction?: "all" | "none" | "each";
+    }): Promise<void>;
+    /**
+     * Lists all migrations and whether they have been run.
+     * Returns true if there are pending migrations
+     */
+    showMigrations(): Promise<boolean>;
+    /**
+     * Checks if entity metadata exist for the given entity class, target name or table name.
+     */
+    hasMetadata(target: EntityTarget<any>): boolean;
+    /**
+     * Gets entity metadata for the given entity class or schema name.
+     */
+    getMetadata(target: EntityTarget<any>): EntityMetadata;
+    /**
+     * Gets repository for the given entity.
+     */
+    getRepository<Entity>(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.
+     */
+    getTreeRepository<Entity>(target: EntityTarget<Entity>): TreeRepository<Entity>;
+    /**
+     * Gets mongodb-specific repository for the given entity class or name.
+     * Works only if connection is mongodb-specific.
+     */
+    getMongoRepository<Entity>(target: EntityTarget<Entity>): MongoRepository<Entity>;
+    /**
+     * Gets custom entity repository marked with @EntityRepository decorator.
+     */
+    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.
+     */
+    transaction<T>(runInTransaction: (entityManager: EntityManager) => Promise<T>): Promise<T>;
+    transaction<T>(isolationLevel: IsolationLevel, runInTransaction: (entityManager: EntityManager) => Promise<T>): Promise<T>;
+    /**
+     * Executes raw SQL query and returns raw database results.
+     */
+    query(query: string, parameters?: any[], queryRunner?: QueryRunner): Promise<any>;
+    /**
+     * Creates a new query builder that can be used to build a sql query.
+     */
+    createQueryBuilder<Entity>(entityClass: EntityTarget<Entity>, alias: string, queryRunner?: QueryRunner): SelectQueryBuilder<Entity>;
+    /**
+     * Creates a new query builder that can be used to build a sql query.
+     */
+    createQueryBuilder(queryRunner?: QueryRunner): SelectQueryBuilder<any>;
+    /**
+     * Creates a query runner used for perform queries on a single database connection.
+     * Using query runners you can control your queries to execute using single database connection and
+     * manually control your database transaction.
+     *
+     * Mode is used in replication mode and indicates whatever you want to connect
+     * 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.
+     */
+    createQueryRunner(mode?: ReplicationMode): QueryRunner;
+    /**
+     * Gets entity metadata of the junction table (many-to-many table).
+     */
+    getManyToManyMetadata(entityTarget: EntityTarget<any>, relationPropertyPath: string): EntityMetadata | undefined;
+    /**
+     * Creates an Entity Manager for the current connection with the help of the EntityManagerFactory.
+     */
+    createEntityManager(queryRunner?: QueryRunner): EntityManager;
+    /**
+     * Finds exist entity metadata by the given entity class, target name or table name.
+     */
+    protected findMetadata(target: EntityTarget<any>): EntityMetadata | undefined;
+    /**
+     * Builds metadatas for all registered classes inside this connection.
+     */
+    protected buildMetadatas(): void;
+}