createTransaction | TanStack DB Deutsch

function createTransaction<T>(config): Transaction<T>;

Defined in: packages/db/src/transactions.ts:344

Creates a new transaction for grouping multiple collection operations

Type Parameters

T

T extends object = Record<string, unknown>

Parameters

config

TransactionConfig<T>

Transaction configuration with mutation function

Returns

Transaction<T>

A new Transaction instance

Examples

// Basic transaction usage
const tx = createTransaction({
  mutationFn: async ({ transaction }) => {
    // Send all mutations to API
    await api.saveChanges(transaction.mutations)
  }
})

tx.mutate(() => {
  collection.insert({ id: "1", text: "Buy milk" })
  collection.update("2", draft => { draft.completed = true })
})

await tx.when('settled')

// Handle transaction errors
try {
  const tx = createTransaction({
    mutationFn: async () => { throw new Error("API failed") }
  })

  tx.mutate(() => {
    collection.insert({ id: "1", text: "New item" })
  })

  await tx.when('settled')
} catch (error) {
  console.log('Transaction failed:', error)
}

// Manual commit control
const tx = createTransaction({
  autoCommit: false,
  mutationFn: async () => {
    // API call
  }
})

tx.mutate(() => {
  collection.insert({ id: "1", text: "Item" })
})

// Commit later
await tx.commit()