Function begin

packages/sql/src/AbstractSqlConnection.ts:171–224

Begins a new transaction or creates a savepoint if a transaction context already exists.

(
    options: {
      isolationLevel?: IsolationLevel;
      readOnly?: boolean;
      ctx?: ControlledTransaction<any, any>;
      eventBroadcaster?: TransactionEventBroadcaster;
      loggerContext?: LogContext;
    } = {},
  )

  /** Begins a new transaction or creates a savepoint if a transaction context already exists. */
  override async begin(
    options: {
      isolationLevel?: IsolationLevel;
      readOnly?: boolean;
      ctx?: ControlledTransaction<any, any>;
      eventBroadcaster?: TransactionEventBroadcaster;
      loggerContext?: LogContext;
    } = {},
  ): Promise<ControlledTransaction<any, any>> {
    if (options.ctx) {
      const ctx = options.ctx as Dictionary;
      await options.eventBroadcaster?.dispatchEvent(EventType.beforeTransactionStart, ctx);
      ctx.index ??= 0;
      const savepointName = `trx${ctx.index + 1}`;
      const trx = await options.ctx.savepoint(savepointName as never).execute();
      Reflect.defineProperty(trx, 'index', { value: ctx.index + 1 });
      Reflect.defineProperty(trx, 'savepointName', { value: savepointName });
      this.logQuery(this.platform.getSavepointSQL(savepointName), options.loggerContext);
      await options.eventBroadcaster?.dispatchEvent(EventType.afterTransactionStart, trx);

      return trx;
    }

    await this.ensureConnection();
    await options.eventBroadcaster?.dispatchEvent(EventType.beforeTransactionStart);
    let trxBuilder = this.getClient().startTransaction();

    if (options.isolationLevel) {
      trxBuilder = trxBuilder.setIsolationLevel(options.isolationLevel);
    }

    if (options.readOnly) {
      trxBuilder = trxBuilder.setAccessMode('read only');
    }

    const trx = await trxBuilder.execute();

    if (options.ctx) {
      const ctx = options.ctx as Dictionary;
      ctx.index ??= 0;
      const savepointName = `trx${ctx.index + 1}`;
      Reflect.defineProperty(trx, 'index', { value: ctx.index + 1 });
      Reflect.defineProperty(trx, 'savepointName', { value: savepointName });
      this.logQuery(this.platform.getSavepointSQL(savepointName), options.loggerContext);
    } else {
      for (const query of this.platform.getBeginTransactionSQL(options)) {
        this.logQuery(query, options.loggerContext);
      }
    }

    await options.eventBroadcaster?.dispatchEvent(EventType.afterTransactionStart, trx);

    return trx;
  }

  /** Commits the transaction or releases the savepoint. */
  override async commit(