Transactions

Database transactions allow your application to make a series of database changes in an all-or-nothing commit. Consider an HTTP request that creates a new Order and has an afterChange hook to update the stock count of related Items. If an error occurs when updating an Item and an HTTP error is returned to the user, you would not want the new Order to be persisted or any other items to be changed either. This kind of interaction with the database is handled seamlessly with transactions.

By default, Payload will use transactions for all data changing operations, as long as it is supported by the configured database. Database changes are contained within all Payload operations and any errors thrown will result in all changes being rolled back without being committed. When transactions are not supported by the database, Payload will continue to operate as expected without them.

The initial request made to Payload will begin a new transaction and attach it to the req.transactionID. If you have a hook that interacts with the database, you can opt in to using the same transaction by passing the req in the arguments. For example:

1const afterChange: CollectionAfterChangeHook = async ({ req }) => {
// because req.transactionID is assigned from Payload and passed through,
// my-slug will only persist if the entire request is successful
await req.payload.create({
  req,
  collection: 'my-slug',
  data: {
    some: 'data',
  },
})
11}

Async Hooks with Transactions

Since Payload hooks can be async and be written to not await the result, it is possible to have an incorrect success response returned on a request that is rolled back. If you have a hook where you do not await the result, then you should not pass the req.transactionID.

1const afterChange: CollectionAfterChangeHook = async ({ req }) => {
// WARNING: an async call made with the same req, but NOT awaited,
// may fail resulting in an OK response being returned with response data that is not committed
const dangerouslyIgnoreAsync = req.payload.create({
  req,
  collection: 'my-slug',
  data: {
    some: 'other data',
  },
})
11
// Should this call fail, it will not rollback other changes
// because the req (and its transactionID) is not passed through
const safelyIgnoredAsync = req.payload.create({
  collection: 'my-slug',
  data: {
    some: 'other data',
  },
})
20}

Direct Transaction Access

When writing your own scripts or custom endpoints, you may wish to have direct control over transactions. This is useful for interacting with your database outside of Payload's local API.

The following functions can be used for managing transactions:

payload.db.beginTransaction - Starts a new session and returns a transaction ID for use in other Payload Local API calls.
payload.db.commitTransaction - Takes the identifier for the transaction, finalizes any changes.
payload.db.rollbackTransaction - Takes the identifier for the transaction, discards any changes.

Payload uses the req object to pass the transaction ID through to the database adapter. If you are not using the req object, you can make a new object to pass the transaction ID directly to database adapter methods and local API calls. Example:

1import payload from 'payload'
2import config from './payload.config'
3
4const standalonePayloadScript = async () => {
5  // initialize Payload
6  await payload.init({ config })
7
8  const transactionID = await payload.db.beginTransaction()
9
10  try {
11    // Make an update using the local API
12    await payload.update({
13      collection: 'posts',
14      data: {
15        some: 'data',
16      },
17      where: {
18        slug: { equals: 'my-slug' }
19      },
20      req: { transactionID },
21    })
22
23    /*
24      You can make additional db changes or run other functions
25      that need to be committed on an all or nothing basis
26     */
27
28    // Commit the transaction
29    await payload.db.commitTransaction(transactionID)
30  } catch (error) {
31    // Rollback the transaction
32    await payload.db.rollbackTransaction(transactionID)
33  }
34}
35
36standalonePayloadScript()

Disabling Transactions

If you wish to disable transactions entirely, you can do so by passing false as the transactionOptions in your database adapter configuration. All the official Payload database adapters support this option.

In addition to allowing database transactions to be disabled at the adapter level. You can prevent Payload from using a transaction in direct calls to the local API by adding disableTransaction: true to the args. For example:

1await payload.update({
collection: 'posts',
data: {
  some: 'data',
},
where: {
  slug: { equals: 'my-slug' }
},
disableTransaction: true,
10})

See what others are building with Payload.

"Payload has transformed the way our clients manage content. It's an indispensable tool for any modern agency."

Deploy your entire stack in one place with Payload Cloud.

Microsoft chose Payload to tell the world about AI.

Transactions

Async Hooks with Transactions

Direct Transaction Access

Disabling Transactions

MongoDB

Related Help Topics