@mikro-orm/knex 6.0.0-dev.4 → 6.0.0-dev.41

package/{dist/AbstractSqlConnection.js → AbstractSqlConnection.js}

@@ -78,7 +78,7 @@ class AbstractSqlConnection extends core_1.Connection {
     }
     async execute(queryOrKnex, params = [], method = 'all', ctx) {
         if (core_1.Utils.isObject(queryOrKnex)) {
-            ctx ?? (ctx = queryOrKnex.client.transacting ? queryOrKnex : null);
+            ctx ??= (queryOrKnex.client.transacting ? queryOrKnex : null);
             const q = queryOrKnex.toSQL();
             queryOrKnex = q.sql;
             params = q.bindings;
@@ -102,6 +102,11 @@ class AbstractSqlConnection extends core_1.Connection {
         await this.client.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) {

package/AbstractSqlDriver.d.ts

@@ -0,0 +1,66 @@
+import type { Knex } from 'knex';
+import type { AnyEntity, Collection, ConnectionType, Configuration, Constructor, CountOptions, DeleteOptions, Dictionary, DriverMethodOptions, EntityData, EntityDictionary, EntityField, EntityMetadata, EntityName, EntityProperty, FilterQuery, FindOneOptions, FindOptions, IDatabaseDriver, LockOptions, NativeInsertUpdateManyOptions, NativeInsertUpdateOptions, PopulateOptions, Primary, QueryOrderMap, QueryResult, Transaction } from '@mikro-orm/core';
+import { DatabaseDriver, EntityManagerType } from '@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>(entityName: string, where: FilterQuery<T>, options?: FindOptions<T, P>): Promise<EntityData<T>[]>;
+    findOne<T extends object, P extends string = never>(entityName: string, where: FilterQuery<T>, options?: FindOneOptions<T, P>): Promise<EntityData<T> | null>;
+    findVirtual<T extends object>(entityName: string, where: FilterQuery<T>, options: FindOptions<T, any>): Promise<EntityData<T>[]>;
+    countVirtual<T extends object>(entityName: string, where: FilterQuery<T>, options: CountOptions<T>): Promise<number>;
+    protected wrapVirtualExpressionInSubquery<T extends object>(meta: EntityMetadata<T>, expression: string, where: FilterQuery<T>, options: FindOptions<T, any>, type: QueryType.COUNT): Promise<number>;
+    protected wrapVirtualExpressionInSubquery<T extends object>(meta: EntityMetadata<T>, expression: string, where: FilterQuery<T>, options: FindOptions<T, any>, type: QueryType.SELECT): Promise<T[]>;
+    protected wrapVirtualExpressionInSubquery<T extends object>(meta: EntityMetadata<T>, expression: string, where: FilterQuery<T>, options: FindOptions<T, any>): Promise<T[]>;
+    mapResult<T extends object>(result: EntityData<T>, meta: EntityMetadata<T>, populate?: PopulateOptions<T>[], qb?: QueryBuilder<T>, map?: Dictionary): EntityData<T> | null;
+    private mapJoinedProps;
+    private appendToCollection;
+    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>): Promise<QueryResult<T>>;
+    nativeUpdateMany<T extends object>(entityName: string, where: FilterQuery<T>[], data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T>): Promise<QueryResult<T>>;
+    nativeDelete<T extends object>(entityName: string, where: FilterQuery<T> | string | any, options?: DeleteOptions<T>): Promise<QueryResult<T>>;
+    syncCollection<T extends object, O extends object>(coll: Collection<T, O>, options?: DriverMethodOptions): Promise<void>;
+    loadFromPivotTable<T extends object, O extends object>(prop: EntityProperty, owners: Primary<O>[][], where?: FilterQuery<any>, orderBy?: QueryOrderMap<T>[], ctx?: Transaction, options?: FindOptions<T, any>): Promise<Dictionary<T[]>>;
+    execute<T extends QueryResult | EntityData<AnyEntity> | EntityData<AnyEntity>[] = EntityData<AnyEntity>[]>(queryOrKnex: string | Knex.QueryBuilder | Knex.Raw, params?: any[], method?: 'all' | 'get' | 'run', ctx?: Transaction): Promise<T>;
+    /**
+     * 1:1 owner side needs to be marked for population so QB auto-joins the owner id
+     */
+    protected autoJoinOneToOneOwner<T extends object, P extends string = never>(meta: EntityMetadata<T>, populate: PopulateOptions<T>[], fields?: readonly EntityField<T, P>[]): PopulateOptions<T>[];
+    protected joinedProps<T>(meta: EntityMetadata, populate: PopulateOptions<T>[]): PopulateOptions<T>[];
+    /**
+     * @internal
+     */
+    mergeJoinedResult<T extends object>(rawResults: EntityData<T>[], meta: EntityMetadata<T>): EntityData<T>[];
+    protected getFieldsForJoinedLoad<T extends object>(qb: QueryBuilder<T>, meta: EntityMetadata<T>, explicitFields?: Field<T>[], populate?: PopulateOptions<T>[], 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): 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>;
+    protected updateCollectionDiff<T extends object, O extends object>(meta: EntityMetadata<O>, prop: EntityProperty<T>, pks: Primary<O>[], deleteDiff: Primary<T>[][] | boolean, insertDiff: Primary<T>[][], options?: DriverMethodOptions & {
+        ownerSchema?: string;
+    }): Promise<void>;
+    lockPessimistic<T extends object>(entity: T, options: LockOptions): Promise<void>;
+    protected buildJoinedPropsOrderBy<T extends object>(entityName: string, qb: QueryBuilder<T>, meta: EntityMetadata<T>, populate: PopulateOptions<T>[], 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>, fields?: Field<T>[]): Field<T>[];
+}