Class AcDbDatabaseTransaction

Database-bound transaction with object lookup through AcDbDatabase.

Created by AcDbDatabaseTransactionManager.startTransaction and returned from AcDbDatabaseTransactionManager.runUndoable.

Hierarchy (View Summary)

AcDbTransaction
- AcDbDatabaseTransaction

Index

Constructors

Properties

Methods

abort commit getObject lookupObject

Constructors

constructor

new AcDbDatabaseTransaction(database: AcDbDatabase): AcDbDatabaseTransaction
Parameters
- database: AcDbDatabase
  Database whose objects are opened and recorded
Returns AcDbDatabaseTransaction
Overrides AcDbTransaction.constructor
- Defined in packages/data-model/src/database/transaction/AcDbDatabaseTransaction.ts:15

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
Inherited from AcDbTransaction.abort
- 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
Inherited from AcDbTransaction.commit
- 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
Inherited from AcDbTransaction.getObject
- Defined in packages/data-model/src/database/transaction/AcDbTransaction.ts:33

`Protected`lookupObject

lookupObject<T extends AcDbObject<AcDbObjectAttrs>>(
objectId: string,
openErased: boolean,
): T
Resolves an object ID through the owning database.
Type Parameters
- T extends AcDbObject<AcDbObjectAttrs>
Parameters
- objectId: string
  Identifier of the object to open
- openErased: boolean
  Reserved for erased-object support
Returns T
The matching live object

Throws
Error when the object cannot be found
Overrides AcDbTransaction.lookupObject
- Defined in packages/data-model/src/database/transaction/AcDbDatabaseTransaction.ts:27