Class AcDbTransaction

Represents a single database transaction.

A transaction records the original state of opened objects so that changes can be committed or rolled back.

This class is normally not instantiated directly by users.

Hierarchy (View Summary)

AcDbTransaction
- AcDbDatabaseTransaction

Index

Constructors

Properties

Methods

abort commit getObject lookupObject

Constructors

constructor

new AcDbTransaction(): AcDbTransaction
Returns AcDbTransaction

Properties

`Readonly`recorder

recorder: AcDbChangeRecorder = ...

Structured changes recorded during this transaction for commit/undo integration

Methods

abort

abort(): void
Aborts this transaction and restores all modified objects.

Returns void
- Defined in packages/data-model/src/database/transaction/AcDbTransaction.ts:74

commit

commit(): void
Commits this transaction. After commit, rollback data is discarded.

Returns void
- Defined in packages/data-model/src/database/transaction/AcDbTransaction.ts:66

getObject

getObject<T extends AcDbObject<AcDbObjectAttrs>>(
    objectId: string,
    mode: AcDbOpenMode,
    openErased?: boolean,
): undefined | T
Records an object opening.

When the object is opened for write, a pre-modification snapshot is stored for abort rollback and a modify entry is added to recorder.
Type Parameters
- T extends AcDbObject<AcDbObjectAttrs>
Parameters
- objectId: string
  Object identifier
- mode: AcDbOpenMode
  Open mode
- openErased: boolean = false
  Whether erased objects are allowed
Returns undefined | T
The opened object, or the cached instance if already opened in this transaction
- Defined in packages/data-model/src/database/transaction/AcDbTransaction.ts:33

`Protected`lookupObject

lookupObject<T extends AcDbObject<AcDbObjectAttrs>>(
objectId: string,
_openErased: boolean,
): T
Internal object lookup hook.

You should connect this to your database or object table.
Type Parameters
- T extends AcDbObject<AcDbObjectAttrs>
Parameters
- objectId: string
- _openErased: boolean
Returns T
- Defined in packages/data-model/src/database/transaction/AcDbTransaction.ts:92