@yandjin-mikro-orm/knex 6.1.4-rc-sti-changes-1

package/AbstractSqlConnection.d.ts

@@ -0,0 +1,58 @@
+import { type Knex } from "knex";
+import { Connection, type AnyEntity, type Configuration, type ConnectionOptions, type EntityData, type IsolationLevel, type QueryResult, type Transaction, type TransactionEventBroadcaster, type LoggingOptions } from "@yandjin-mikro-orm/core";
+import type { AbstractSqlPlatform } from "./AbstractSqlPlatform";
+export declare abstract class AbstractSqlConnection extends Connection {
+    private static __patched;
+    protected platform: AbstractSqlPlatform;
+    protected client: Knex;
+    constructor(config: Configuration, options?: ConnectionOptions, type?: "read" | "write");
+    abstract createKnex(): void;
+    /** @inheritDoc */
+    connect(): void | Promise<void>;
+    getKnex(): Knex;
+    /**
+     * @inheritDoc
+     */
+    close(force?: boolean): Promise<void>;
+    /**
+     * @inheritDoc
+     */
+    isConnected(): Promise<boolean>;
+    /**
+     * @inheritDoc
+     */
+    checkConnection(): Promise<{
+        ok: boolean;
+        reason?: string;
+        error?: Error;
+    }>;
+    transactional<T>(cb: (trx: Transaction<Knex.Transaction>) => Promise<T>, options?: {
+        isolationLevel?: IsolationLevel;
+        readOnly?: boolean;
+        ctx?: Knex.Transaction;
+        eventBroadcaster?: TransactionEventBroadcaster;
+    }): Promise<T>;
+    begin(options?: {
+        isolationLevel?: IsolationLevel;
+        readOnly?: boolean;
+        ctx?: Knex.Transaction;
+        eventBroadcaster?: TransactionEventBroadcaster;
+    }): Promise<Knex.Transaction>;
+    commit(ctx: Knex.Transaction, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
+    rollback(ctx: Knex.Transaction, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
+    execute<T extends QueryResult | EntityData<AnyEntity> | EntityData<AnyEntity>[] = EntityData<AnyEntity>[]>(queryOrKnex: string | Knex.QueryBuilder | Knex.Raw, params?: unknown[], method?: "all" | "get" | "run", ctx?: Transaction, loggerContext?: LoggingOptions): Promise<T>;
+    /**
+     * Execute raw SQL queries from file
+     */
+    loadFile(path: string): Promise<void>;
+    protected createKnexClient(type: string): Knex;
+    protected getKnexOptions(type: string): Knex.Config;
+    private getSql;
+    /**
+     * do not call `positionBindings` when there are no bindings - it was messing up with
+     * already interpolated strings containing `?`, and escaping that was not enough to
+     * support edge cases like `\\?` strings (as `positionBindings` was removing the `\\`)
+     */
+    private patchKnexClient;
+    protected abstract transformRawResult<T>(res: any, method: "all" | "get" | "run"): T;
+}

package/AbstractSqlConnection.js

@@ -0,0 +1,206 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractSqlConnection = void 0;
+const knex_1 = require("knex");
+const fs_extra_1 = require("fs-extra");
+const core_1 = require("@yandjin-mikro-orm/core");
+const MonkeyPatchable_1 = require("./MonkeyPatchable");
+const parentTransactionSymbol = Symbol("parentTransaction");
+function isRootTransaction(trx) {
+    return !Object.getOwnPropertySymbols(trx).includes(parentTransactionSymbol);
+}
+class AbstractSqlConnection extends core_1.Connection {
+    static __patched = false;
+    client;
+    constructor(config, options, type) {
+        super(config, options, type);
+        this.patchKnexClient();
+    }
+    /** @inheritDoc */
+    connect() {
+        this.createKnex();
+    }
+    getKnex() {
+        if (!this.client) {
+            this.createKnex();
+        }
+        return this.client;
+    }
+    /**
+     * @inheritDoc
+     */
+    async close(force) {
+        await super.close(force);
+        await this.getKnex().destroy();
+    }
+    /**
+     * @inheritDoc
+     */
+    async isConnected() {
+        const check = await this.checkConnection();
+        return check.ok;
+    }
+    /**
+     * @inheritDoc
+     */
+    async checkConnection() {
+        try {
+            await this.getKnex().raw("select 1");
+            return { ok: true };
+        }
+        catch (error) {
+            return { ok: false, reason: error.message, error };
+        }
+    }
+    async transactional(cb, options = {}) {
+        const trx = await this.begin(options);
+        try {
+            const ret = await cb(trx);
+            await this.commit(trx, options.eventBroadcaster);
+            return ret;
+        }
+        catch (error) {
+            await this.rollback(trx, options.eventBroadcaster);
+            throw error;
+        }
+    }
+    async begin(options = {}) {
+        if (!options.ctx) {
+            await options.eventBroadcaster?.dispatchEvent(core_1.EventType.beforeTransactionStart);
+        }
+        const trx = await (options.ctx || this.getKnex()).transaction(null, {
+            isolationLevel: options.isolationLevel,
+            readOnly: options.readOnly,
+        });
+        if (!options.ctx) {
+            await options.eventBroadcaster?.dispatchEvent(core_1.EventType.afterTransactionStart, trx);
+        }
+        else {
+            trx[parentTransactionSymbol] =
+                options.ctx;
+        }
+        return trx;
+    }
+    async commit(ctx, eventBroadcaster) {
+        const runTrxHooks = isRootTransaction(ctx);
+        if (runTrxHooks) {
+            await eventBroadcaster?.dispatchEvent(core_1.EventType.beforeTransactionCommit, ctx);
+        }
+        ctx.commit();
+        await ctx.executionPromise; // https://github.com/knex/knex/issues/3847#issuecomment-626330453
+        if (runTrxHooks) {
+            await eventBroadcaster?.dispatchEvent(core_1.EventType.afterTransactionCommit, ctx);
+        }
+    }
+    async rollback(ctx, eventBroadcaster) {
+        const runTrxHooks = isRootTransaction(ctx);
+        if (runTrxHooks) {
+            await eventBroadcaster?.dispatchEvent(core_1.EventType.beforeTransactionRollback, ctx);
+        }
+        await ctx.rollback();
+        if (runTrxHooks) {
+            await eventBroadcaster?.dispatchEvent(core_1.EventType.afterTransactionRollback, ctx);
+        }
+    }
+    async execute(queryOrKnex, params = [], method = "all", ctx, loggerContext) {
+        await this.ensureConnection();
+        if (core_1.Utils.isObject(queryOrKnex)) {
+            ctx ??= queryOrKnex.client.transacting ? queryOrKnex : null;
+            const q = queryOrKnex.toSQL();
+            queryOrKnex = q.sql;
+            params = q.bindings;
+        }
+        const formatted = this.platform.formatQuery(queryOrKnex, params);
+        const sql = this.getSql(queryOrKnex, formatted, loggerContext);
+        return this.executeQuery(sql, async () => {
+            const query = this.getKnex().raw(formatted);
+            if (ctx) {
+                query.transacting(ctx);
+            }
+            const res = await query;
+            return this.transformRawResult(res, method);
+        }, { query: queryOrKnex, params, ...loggerContext });
+    }
+    /**
+     * Execute raw SQL queries from file
+     */
+    async loadFile(path) {
+        const buf = await (0, fs_extra_1.readFile)(path);
+        await this.getKnex().raw(buf.toString());
+    }
+    createKnexClient(type) {
+        const driverOptions = this.config.get("driverOptions");
+        if (driverOptions.context?.client instanceof knex_1.knex.Client) {
+            this.logger.log("info", "Reusing knex client provided via `driverOptions`");
+            return driverOptions;
+        }
+        return (0, knex_1.knex)(this.getKnexOptions(type)).on("query", (data) => {
+            if (!data.__knexQueryUid) {
+                this.logQuery(data.sql.toLowerCase().replace(/;$/, ""));
+            }
+        });
+    }
+    getKnexOptions(type) {
+        const config = core_1.Utils.mergeConfig({
+            client: type,
+            connection: this.getConnectionOptions(),
+            pool: this.config.get("pool"),
+        }, this.config.get("driverOptions"));
+        const options = config.connection;
+        const password = options.password;
+        if (!(password instanceof Function)) {
+            return config;
+        }
+        config.connection = async () => {
+            const pw = await password();
+            if (typeof pw === "string") {
+                return { ...options, password: pw };
+            }
+            return {
+                ...options,
+                password: pw.password,
+                expirationChecker: pw.expirationChecker,
+            };
+        };
+        return config;
+    }
+    getSql(query, formatted, context) {
+        const logger = this.config.getLogger();
+        if (!logger.isEnabled("query", context)) {
+            return query;
+        }
+        if (logger.isEnabled("query-params", context)) {
+            return formatted;
+        }
+        return this.getKnex().client.positionBindings(query);
+    }
+    /**
+     * do not call `positionBindings` when there are no bindings - it was messing up with
+     * already interpolated strings containing `?`, and escaping that was not enough to
+     * support edge cases like `\\?` strings (as `positionBindings` was removing the `\\`)
+     */
+    patchKnexClient() {
+        const { Client, TableCompiler } = MonkeyPatchable_1.MonkeyPatchable;
+        const query = Client.prototype.query;
+        if (AbstractSqlConnection.__patched) {
+            return;
+        }
+        AbstractSqlConnection.__patched = true;
+        Client.prototype.query = function (connection, obj) {
+            if (typeof obj === "string") {
+                obj = { sql: obj };
+            }
+            if ((obj.bindings ?? []).length > 0) {
+                return query.call(this, connection, obj);
+            }
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            const { __knexUid, __knexTxId } = connection;
+            this.emit("query", Object.assign({ __knexUid, __knexTxId }, obj));
+            return MonkeyPatchable_1.MonkeyPatchable.QueryExecutioner.executeQuery(connection, obj, this);
+        };
+        TableCompiler.prototype.raw = function (query) {
+            this.pushQuery(query);
+        };
+    }
+}
+exports.AbstractSqlConnection = AbstractSqlConnection;

package/AbstractSqlDriver.d.ts

@@ -0,0 +1,73 @@
+import type { Knex } from "knex";
+import { type AnyEntity, type Collection, type Configuration, type ConnectionType, type Constructor, type CountOptions, DatabaseDriver, type DeleteOptions, type Dictionary, type DriverMethodOptions, type EntityData, type EntityDictionary, type EntityField, EntityManagerType, type EntityMetadata, type EntityName, type EntityProperty, type FilterQuery, type FindOneOptions, type FindOptions, type IDatabaseDriver, type LockOptions, type LoggingOptions, type NativeInsertUpdateManyOptions, type NativeInsertUpdateOptions, type ObjectQuery, type Options, type OrderDefinition, type PopulateOptions, type Primary, type QueryOrderMap, type QueryResult, type Transaction, type UpsertManyOptions, type UpsertOptions } from "@yandjin-mikro-orm/core";
+import type { AbstractSqlConnection } from "./AbstractSqlConnection";
+import type { AbstractSqlPlatform } from "./AbstractSqlPlatform";
+import { QueryBuilder, QueryType } from "./query";
+import { SqlEntityManager } from "./SqlEntityManager";
+import type { Field } from "./typings";
+export declare abstract class AbstractSqlDriver<Connection extends AbstractSqlConnection = AbstractSqlConnection, Platform extends AbstractSqlPlatform = AbstractSqlPlatform> extends DatabaseDriver<Connection> {
+    [EntityManagerType]: SqlEntityManager<this>;
+    protected readonly connection: Connection;
+    protected readonly replicas: Connection[];
+    protected readonly platform: Platform;
+    protected constructor(config: Configuration, platform: Platform, connection: Constructor<Connection>, connector: string[]);
+    getPlatform(): Platform;
+    createEntityManager<D extends IDatabaseDriver = IDatabaseDriver>(useContext?: boolean): D[typeof EntityManagerType];
+    find<T extends object, P extends string = never, F extends string = "*", E extends string = never>(entityName: string, where: FilterQuery<T>, options?: FindOptions<T, P, F, E>): Promise<EntityData<T>[]>;
+    findOne<T extends object, P extends string = never, F extends string = "*", E extends string = never>(entityName: string, where: FilterQuery<T>, options?: FindOneOptions<T, P, F, E>): Promise<EntityData<T> | null>;
+    protected hasToManyJoins<T extends object>(hint: PopulateOptions<T>, meta: EntityMetadata<T>): boolean;
+    findVirtual<T extends object>(entityName: string, where: FilterQuery<T>, options: FindOptions<T, any, any, any>): Promise<EntityData<T>[]>;
+    countVirtual<T extends object>(entityName: string, where: FilterQuery<T>, options: CountOptions<T, any>): Promise<number>;
+    protected findFromVirtual<T extends object>(entityName: string, where: FilterQuery<T>, options: FindOptions<T, any> | CountOptions<T, any>, type: QueryType): Promise<EntityData<T>[] | number>;
+    protected wrapVirtualExpressionInSubquery<T extends object>(meta: EntityMetadata<T>, expression: string, where: FilterQuery<T>, options: FindOptions<T, any>, type: QueryType): Promise<T[] | number>;
+    mapResult<T extends object>(result: EntityData<T>, meta: EntityMetadata<T>, populate?: PopulateOptions<T>[], qb?: QueryBuilder<T>, map?: Dictionary): EntityData<T> | null;
+    private mapJoinedProps;
+    count<T extends object>(entityName: string, where: any, options?: CountOptions<T>): Promise<number>;
+    nativeInsert<T extends object>(entityName: string, data: EntityDictionary<T>, options?: NativeInsertUpdateOptions<T>): Promise<QueryResult<T>>;
+    nativeInsertMany<T extends object>(entityName: string, data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T>): Promise<QueryResult<T>>;
+    nativeUpdate<T extends object>(entityName: string, where: FilterQuery<T>, data: EntityDictionary<T>, options?: NativeInsertUpdateOptions<T> & UpsertOptions<T>): Promise<QueryResult<T>>;
+    nativeUpdateMany<T extends object>(entityName: string, where: FilterQuery<T>[], data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T> & UpsertManyOptions<T>): Promise<QueryResult<T>>;
+    nativeDelete<T extends object>(entityName: string, where: FilterQuery<T> | string | any, options?: DeleteOptions<T>): Promise<QueryResult<T>>;
+    syncCollections<T extends object, O extends object>(collections: Iterable<Collection<T, O>>, options?: DriverMethodOptions): Promise<void>;
+    loadFromPivotTable<T extends object, O extends object>(prop: EntityProperty, owners: Primary<O>[][], where?: FilterQuery<any>, orderBy?: OrderDefinition<T>, ctx?: Transaction, options?: FindOptions<T, any, any, any>, pivotJoin?: boolean): Promise<Dictionary<T[]>>;
+    private getPivotOrderBy;
+    execute<T extends QueryResult | EntityData<AnyEntity> | EntityData<AnyEntity>[] = EntityData<AnyEntity>[]>(queryOrKnex: string | Knex.QueryBuilder | Knex.Raw, params?: any[], method?: "all" | "get" | "run", ctx?: Transaction, loggerContext?: LoggingOptions): Promise<T>;
+    /**
+     * 1:1 owner side needs to be marked for population so QB auto-joins the owner id
+     */
+    protected autoJoinOneToOneOwner<T extends object>(meta: EntityMetadata<T>, populate: PopulateOptions<T>[], fields?: readonly EntityField<T, any>[]): PopulateOptions<T>[];
+    /**
+     * @internal
+     */
+    joinedProps<T>(meta: EntityMetadata, populate: PopulateOptions<T>[], options?: {
+        strategy?: Options["loadStrategy"];
+    }): PopulateOptions<T>[];
+    /**
+     * @internal
+     */
+    mergeJoinedResult<T extends object>(rawResults: EntityData<T>[], meta: EntityMetadata<T>, joinedProps: PopulateOptions<T>[]): EntityData<T>[];
+    protected getFieldsForJoinedLoad<T extends object>(qb: QueryBuilder<T>, meta: EntityMetadata<T>, explicitFields?: Field<T>[], exclude?: Field<T>[], populate?: PopulateOptions<T>[], options?: {
+        strategy?: Options["loadStrategy"];
+        populateWhere?: FindOptions<any>["populateWhere"];
+    }, parentTableAlias?: string, parentJoinPath?: string): Field<T>[];
+    /**
+     * @internal
+     */
+    mapPropToFieldNames<T extends object>(qb: QueryBuilder<T>, prop: EntityProperty<T>, tableAlias?: string): Field<T>[];
+    /** @internal */
+    createQueryBuilder<T extends object>(entityName: EntityName<T> | QueryBuilder<T>, ctx?: Transaction<Knex.Transaction>, preferredConnectionType?: ConnectionType, convertCustomTypes?: boolean, loggerContext?: LoggingOptions): QueryBuilder<T>;
+    protected resolveConnectionType(args: {
+        ctx?: Transaction<Knex.Transaction>;
+        connectionType?: ConnectionType;
+    }): ConnectionType;
+    protected extractManyToMany<T>(entityName: string, data: EntityDictionary<T>): EntityData<T>;
+    protected processManyToMany<T extends object>(meta: EntityMetadata<T> | undefined, pks: Primary<T>[], collections: EntityData<T>, clear: boolean, options?: DriverMethodOptions): Promise<void>;
+    lockPessimistic<T extends object>(entity: T, options: LockOptions): Promise<void>;
+    protected buildPopulateWhere<T extends object>(meta: EntityMetadata<T>, joinedProps: PopulateOptions<T>[], options: Pick<FindOptions<any>, "populateWhere">): ObjectQuery<T>;
+    protected buildOrderBy<T extends object>(qb: QueryBuilder<T>, meta: EntityMetadata<T>, populate: PopulateOptions<T>[], options: Pick<FindOptions<any>, "strategy" | "orderBy" | "populateOrderBy">): QueryOrderMap<T>[];
+    protected buildPopulateOrderBy<T extends object>(qb: QueryBuilder<T>, meta: EntityMetadata<T>, populateOrderBy: QueryOrderMap<T>[], parentPath: string, explicit: boolean, parentAlias?: string): QueryOrderMap<T>[];
+    protected buildJoinedPropsOrderBy<T extends object>(qb: QueryBuilder<T>, meta: EntityMetadata<T>, populate: PopulateOptions<T>[], options?: Pick<FindOptions<any>, "strategy" | "orderBy" | "populateOrderBy">, parentPath?: string): QueryOrderMap<T>[];
+    protected normalizeFields<T extends object>(fields: Field<T>[], prefix?: string): string[];
+    protected processField<T extends object>(meta: EntityMetadata<T>, prop: EntityProperty<T> | undefined, field: string, ret: Field<T>[], populate: PopulateOptions<T>[], joinedProps: PopulateOptions<T>[], qb: QueryBuilder<T>): void;
+    protected buildFields<T extends object>(meta: EntityMetadata<T>, populate: PopulateOptions<T>[], joinedProps: PopulateOptions<T>[], qb: QueryBuilder<T>, alias: string, options: Pick<FindOptions<T, any, any, any>, "strategy" | "fields" | "exclude">): Field<T>[];
+}