@mikro-orm/core/utils/AbstractSchemaGenerator.d.ts

TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.

import type { ClearDatabaseOptions, DropSchemaOptions, EntityMetadata, ISchemaGenerator, UpdateSchemaOptions, CreateSchemaOptions, RefreshDatabaseOptions, EnsureDatabaseOptions } from '../typings.js';
import { type EntityManagerType, type IDatabaseDriver } from '../drivers/IDatabaseDriver.js';
import type { MetadataStorage } from '../metadata/MetadataStorage.js';
import type { Configuration } from './Configuration.js';
export declare abstract class AbstractSchemaGenerator<D extends IDatabaseDriver> implements ISchemaGenerator {
    protected readonly em?: D[typeof EntityManagerType];
    protected readonly driver: D;
    protected readonly config: Configuration;
    protected readonly metadata: MetadataStorage;
    protected readonly platform: ReturnType<D['getPlatform']>;
    protected readonly connection: ReturnType<D['getConnection']>;
    constructor(em: D | D[typeof EntityManagerType]);
    create(options?: CreateSchemaOptions): Promise<void>;
    /**
     * Returns true if the database was created.
     */
    ensureDatabase(options?: EnsureDatabaseOptions): Promise<boolean>;
    refresh(options?: RefreshDatabaseOptions): Promise<void>;
    clear(options?: ClearDatabaseOptions): Promise<void>;
    protected clearIdentityMap(): void;
    getCreateSchemaSQL(options?: CreateSchemaOptions): Promise<string>;
    drop(options?: DropSchemaOptions): Promise<void>;
    getDropSchemaSQL(options?: Omit<DropSchemaOptions, 'dropDb'>): Promise<string>;
    update(options?: UpdateSchemaOptions): Promise<void>;
    getUpdateSchemaSQL(options?: UpdateSchemaOptions): Promise<string>;
    getUpdateSchemaMigrationSQL(options?: UpdateSchemaOptions): Promise<{
        up: string;
        down: string;
    }>;
    /**
     * creates new database and connects to it
     */
    createDatabase(name?: string): Promise<void>;
    dropDatabase(name?: string): Promise<void>;
    execute(query: string): Promise<void>;
    ensureIndexes(): Promise<void>;
    protected getOrderedMetadata(schema?: string, includeWildcardSchema?: boolean): EntityMetadata[];
    protected notImplemented(): never;
}