📄 tanstack/db/latest/docs/reference/powersync-db-collection/classes/PowerSyncTransactor

Applies mutations to the PowerSync database. This method is called automatically by the collection's insert, update, and delete operations. You typically don't need to call this directly unless you have special transaction requirements.

Example
-------

typescript

// Create a collection
const collection = createCollection(
  powerSyncCollectionOptions<Document>({
    database: db,
    table: APP_SCHEMA.props.documents,
  })
)

const addTx = createTransaction({
  autoCommit: false,
  mutationFn: async ({ transaction }) => {
    await new PowerSyncTransactor({ database: db }).applyTransaction(transaction)
  },
})

addTx.mutate(() => {
  for (let i = 0; i < 5; i++) {
    collection.insert({ id: randomUUID(), name: `tx-${i}` })
  }
})

await addTx.commit()
await addTx.isPersisted.promise


// Create a collection
const collection = createCollection(
  powerSyncCollectionOptions<Document>({
    database: db,
    table: APP_SCHEMA.props.documents,
  })
)

const addTx = createTransaction({
  autoCommit: false,
  mutationFn: async ({ transaction }) => {
    await new PowerSyncTransactor({ database: db }).applyTransaction(transaction)
  },
})

addTx.mutate(() => {
  for (let i = 0; i < 5; i++) {
    collection.insert({ id: randomUUID(), name: `tx-${i}` })
  }
})

await addTx.commit()
await addTx.isPersisted.promise

Param
-----

The transaction containing mutations to apply

Constructors
------------ ### Constructor

new PowerSyncTransactor(options): PowerSyncTransactor;


new PowerSyncTransactor(options): PowerSyncTransactor;

Defined in: PowerSyncTransactor.ts:55

#### Parameters ##### options

TransactorOptions

#### Returns

PowerSyncTransactor

Properties
---------- ### database

database: AbstractPowerSyncDatabase;


database: AbstractPowerSyncDatabase;

Defined in: PowerSyncTransactor.ts:52

### pendingOperationStore

pendingOperationStore: PendingOperationStore;


pendingOperationStore: PendingOperationStore;

Defined in: PowerSyncTransactor.ts:53

Methods
------- ### applyTransaction()

applyTransaction(transaction): Promise<void>;


applyTransaction(transaction): Promise<void>;

Defined in: PowerSyncTransactor.ts:63

Persists a Transaction to the PowerSync SQLite database.

#### Parameters ##### transaction

Transaction<any>

#### Returns

Promise<void>

### handleDelete()

protected handleDelete(
   mutation, 
   context, 
waitForCompletion): Promise<PendingOperation | null>;


protected handleDelete(
   mutation, 
   context, 
waitForCompletion): Promise<PendingOperation | null>;

Defined in: PowerSyncTransactor.ts:204

#### Parameters ##### mutation

PendingMutation<any>

##### context

LockContext

##### waitForCompletion

boolean = false

#### Returns

Promise<PendingOperation | null>

### handleInsert()

protected handleInsert(
   mutation, 
   context, 
waitForCompletion): Promise<PendingOperation | null>;


protected handleInsert(
   mutation, 
   context, 
waitForCompletion): Promise<PendingOperation | null>;

Defined in: PowerSyncTransactor.ts:149

#### Parameters ##### mutation

PendingMutation<any>

##### context

LockContext

##### waitForCompletion

boolean = false

#### Returns

Promise<PendingOperation | null>

### handleOperationWithCompletion()

protected handleOperationWithCompletion(
   mutation, 
   context, 
   waitForCompletion, 
handler): Promise<PendingOperation | null>;


protected handleOperationWithCompletion(
   mutation, 
   context, 
   waitForCompletion, 
handler): Promise<PendingOperation | null>;

Defined in: PowerSyncTransactor.ts:232

Helper function which wraps a persistence operation by:

Fetching the mutation's collection's SQLite table details
Executing the mutation
Returning the last pending diff operation if required

#### Parameters ##### mutation

PendingMutation<any>

##### context

LockContext

##### waitForCompletion

boolean

##### handler

(tableName, mutation, serializeValue) => Promise<void>

#### Returns

Promise<PendingOperation | null>

### handleUpdate()

protected handleUpdate(
   mutation, 
   context, 
waitForCompletion): Promise<PendingOperation | null>;


protected handleUpdate(
   mutation, 
   context, 
waitForCompletion): Promise<PendingOperation | null>;

Defined in: PowerSyncTransactor.ts:177

#### Parameters ##### mutation

PendingMutation<any>

##### context

LockContext

##### waitForCompletion

boolean = false

#### Returns

Promise<PendingOperation | null>

Edit on GitHub

Home

Partners Become a Partner