[Skip to content](#main)

[→](/)

[![Avunu](/brand/avunu-logo.svg)![Avunu](/brand/avunu-logo-light.svg)](/)[Services](/services/)[Consulting](/services/consulting/)[ERP](/services/erp/)[Odoo](/services/erp/odoo/)[ERPNext](/services/erp/erpnext/)[Custom software](/services/custom-software/)[Devices & IoT](/services/devices-iot/)[Websites](/services/websites/)[Infrastructure](/services/infrastructure/)[Partners](/partners/)

[Work](/work/)[Open source](/open-source/)[Knowledge base](/kb/)[About](/about/)

[About Avunu](/about/)[Team](/about/team/)[Insights](/insights/)[Contact](/contact/)

[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

- [Services](/services/)[Consulting](/services/consulting/)
- [ERP](/services/erp/)
- [Odoo](/services/erp/odoo/)
- [ERPNext](/services/erp/erpnext/)
- [Custom software](/services/custom-software/)
- [Devices & IoT](/services/devices-iot/)
- [Websites](/services/websites/)
- [Infrastructure](/services/infrastructure/)
- [Partners](/partners/)

[Work](/work/)[Open source](/open-source/)[Knowledge base](/kb/)[About](/about/)

- [About Avunu](/about/)
- [Team](/about/team/)
- [Insights](/insights/)
- [Contact](/contact/)

[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

[Knowledge base](/kb/)[Frappe](/kb/frappe/)Bench Operations

Search the knowledge basePress/

ESC

Jump to

[Browse the knowledge base](/kb/)[Frappe](/kb/frappe/)[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

↵select↑↓navigateescclose

Search the knowledge base

[Skip to the article](#kb-article)[Frappe](/kb/frappe/)20 articles

- [Overview](/kb/frappe/)
- [Bench Operations](/kb/frappe/bench-operations/)
- [Builder Page Scripts](/kb/frappe/builder-page-scripts/)
- [Client-Side Recipes](/kb/frappe/client-side-recipes/)
- [Common Query Patterns](/kb/frappe/common-query-patterns/)
- [Custom Field Controllers](/kb/frappe/custom-field-controllers/)
- [Custom Pages](/kb/frappe/custom-pages/)
- [Custom Views](/kb/frappe/custom-views/)
- [Customizations API](/kb/frappe/customizations-api/)
- [Customizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/)
- [Doctype States & Status Fields](/kb/frappe/doctype-states-status-fields/)
- [Grandchild Table Fields](/kb/frappe/grandchild-table-fields/)
- [Portal Views](/kb/frappe/portal-views/)
- [Project Structure & Hooks](/kb/frappe/project-structure-hooks/)
- [Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/)
- [Quick Entry Forms](/kb/frappe/quick-entry-forms/)
- [Script Reports](/kb/frappe/script-reports/)
- [Testing on Live Databases](/kb/frappe/testing-live-databases/)
- [Type Annotations & Controller Overrides](/kb/frappe/type-annotations-controller-overrides/)
- [Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/)
- [Web Forms](/kb/frappe/web-forms/)

Other sections[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

In Frappe: 20 articles

[Overview](/kb/frappe/)[Bench Operations](/kb/frappe/bench-operations/)[Builder Page Scripts](/kb/frappe/builder-page-scripts/)[Client-Side Recipes](/kb/frappe/client-side-recipes/)[Common Query Patterns](/kb/frappe/common-query-patterns/)[Custom Field Controllers](/kb/frappe/custom-field-controllers/)[Custom Pages](/kb/frappe/custom-pages/)[Custom Views](/kb/frappe/custom-views/)[Customizations API](/kb/frappe/customizations-api/)[Customizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/)[Doctype States & Status Fields](/kb/frappe/doctype-states-status-fields/)[Grandchild Table Fields](/kb/frappe/grandchild-table-fields/)[Portal Views](/kb/frappe/portal-views/)[Project Structure & Hooks](/kb/frappe/project-structure-hooks/)[Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/)[Quick Entry Forms](/kb/frappe/quick-entry-forms/)[Script Reports](/kb/frappe/script-reports/)[Testing on Live Databases](/kb/frappe/testing-live-databases/)[Type Annotations & Controller Overrides](/kb/frappe/type-annotations-controller-overrides/)[Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/)[Web Forms](/kb/frappe/web-forms/)

Other sections[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

FrappeBench Operations

Back up and move sites, switch app branches and major versions, run bulk fixes in the bench console, and repair database schema drift.

UpdatedOct 1, 2026

Applies toFrappe v15Frappe v16Bench 5

Tagsfrappebencherpnextbackupmariadbconsole

Reading time9 min

On this page[Back Up and Restore a Site](#back-up-and-restore-a-site)[Take the Backup](#take-the-backup)[Restore on the Destination](#restore-on-the-destination)[Switch App Remotes and Branches](#switch-app-remotes-and-branches)[Point an App at a Fork](#point-an-app-at-a-fork)[Switch Branches](#switch-branches)[Upgrade to a New Major Version](#upgrade-to-a-new-major-version)[Switch to Develop](#switch-to-develop)[Run Fixes in the Bench Console](#run-fixes-in-the-bench-console)[Update a Field on Many Documents](#update-a-field-on-many-documents)[Delete a Specific Document](#delete-a-specific-document)[Delete Every Document of a Type](#delete-every-document-of-a-type)[Delete Cancelled Stock Transactions](#delete-cancelled-stock-transactions)[Revert Cancelled Bank Transactions to Unreconciled](#revert-cancelled-bank-transactions-to-unreconciled)[Clear a Background Job Queue](#clear-a-background-job-queue)[Repair Database Schema](#repair-database-schema)[Recreate or Resync a DocType Table](#recreate-or-resync-a-doctype-table)[Remove Orphaned Columns](#remove-orphaned-columns)

This is a working reference for the bench tasks that come up again and again on Frappe and ERPNext servers: moving a site between servers, pointing apps at a fork or another branch, upgrading major versions, cleaning up data from the bench console, and fixing tables that have drifted from their DocType. Run every command from the bench directory (for example `/home/frappe/frappe-bench`) as the bench user, not as root.

## Back Up and Restore a Site

Use this to move a site to another server, or to clone production into a test bench.

### Take the Backup

On the source server:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--site</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">SITE_NAM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">E</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">backup</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--with-files</span>
```

This writes three files to `sites/<SITE_NAME>/private/backups/`: the database dump (`*-database.sql.gz`), the public files (`*-files.tar`), and the private files (`*-private-files.tar`). Add `--compress` to gzip the file archives.

If the site has backup encryption enabled, the backups are encrypted with the `encryption_key` from the source site's `site_config.json`. Copy that key along with the files, because the destination can't decrypt them without it.

Copy the backup files to the destination server with `scp`, `rsync`, or similar.

### Restore on the Destination

Make sure the destination bench has every app the source site uses, on the same major version:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">get-app</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--branch</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">version-15</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">erpnext</span>
```

If the site doesn't exist on the destination yet, create it first:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">new-site</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">SITE_NAM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">E</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span>
```

Restore the database and files:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--site</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">SITE_NAM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">E</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">restore</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">  </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--with-public-files</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">PATH_T</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">O</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">/</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">BACKUP_PREFI</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">X</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">-files.tar</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">  </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--with-private-files</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">PATH_T</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">O</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">/</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">BACKUP_PREFI</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">X</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">-private-files.tar</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">  </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">PATH_T</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">O</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">/</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">BACKUP_PREFI</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">X</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">-database.sql.gz</span>
```

Add `--encryption-key <ENCRYPTION_KEY>` if the backup is encrypted and the destination site has a different key.

Run migrations so the schema matches the code on the destination:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--site</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">SITE_NAM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">E</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">migrate</span>
```

Warning

`bench restore` drops and recreates the site's database. Everything currently in `<SITE_NAME>` on the destination is replaced. Take a backup of the destination site first if it holds anything you might need. `--force` additionally skips the downgrade and SQL validation checks, so only use it when you know why the check is failing.

Tip

`bench restore` also looks for the file in `sites/<SITE_NAME>/private/backups/` and in the bench directory, so you can pass just the filename if you copied the backups there.

## Switch App Remotes and Branches

### Point an App at a Fork

`bench remote-set-url` changes the `upstream` remote of an installed app. It takes a single argument, the Git URL, and works out the app from the repository name at the end of the URL:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">remote-set-url</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">https://github.com/</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">GITHUB_OR</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">G</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">/</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">APP_NAM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">E</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">.git</span>
```

The repository name must match the app's directory under `apps/`. If it doesn't (for example the repository is `My-App` but the app is `my_app`), set the remote with Git instead:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">git</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">-C</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">apps/</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">APP_NAM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">E</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">remote</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">set-url</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">upstream</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">https://github.com/</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">GITHUB_OR</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">G</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">/</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">REPO_NAM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">E</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">.git</span>
```

To point an app back at the official Frappe repository:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">remote-reset-url</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">APP_NAM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">E</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span>
```

Run `bench remote-urls` to list the remote of every app in the bench.

### Switch Branches

`bench switch-to-branch` fetches from `upstream` and checks out the branch in each app you list. Without an app list it switches every app in the bench.

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">switch-to-branch</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">BRANC</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">H</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">APP_NAM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">E</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span>
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">update</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--patch</span>
```

Always follow a branch switch with `bench update --patch` (which runs `bench migrate` on every site) so the database schema matches the new code.

Warning

`switch-to-branch` runs `git checkout -f`, which throws away uncommitted changes in the app. Commit or stash local work first.

### Upgrade to a New Major Version

Bench refuses to cross a major version unless you pass `--upgrade`. With it, bench also reinstalls Python requirements, backs up every site, runs patches, and rebuilds assets.

Back up every site:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">backup-all-sites</span>
```

Check the system requirements of the target version and upgrade them first. Frappe v15 needs Python 3.10 or newer and Node 18 or newer. Frappe v16 needs Python 3.14 and Node 24. If the Python version changes, rebuild the virtual environment:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">migrate-env</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">python3.14</span>
```

Switch Frappe and every app that follows Frappe's version branches:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">switch-to-branch</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">version-16</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">frappe</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">erpnext</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">hrms</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">payments</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--upgrade</span>
```

Reinstall requirements, run patches, and rebuild:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">setup</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">requirements</span>
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">update</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--patch</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--no-backup</span>
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">build</span>
```

Pull the latest commits on the new branches, resetting any leftover local differences:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">update</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--reset</span>
```

Check that every app actually has the target branch before you start (`git -C apps/<APP_NAME> ls-remote --heads upstream`). Custom apps often only have `main` or `develop`; switch those separately.

Warning

`bench update --reset` hard-resets every app to its upstream branch, discarding local commits and uncommitted changes. Skip it on benches where you edit app code in place.

Tip

Recent bench releases use `uv` for Python packages by default. If `bench setup requirements` fails on one app, you can reinstall it by hand with `uv pip install --python ./env/bin/python -e ./apps/<APP_NAME>` (or `./env/bin/pip install -e ./apps/<APP_NAME>` when `BENCH_DISABLE_UV=1`).

### Switch to Develop

Use this only on development benches:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">switch-to-branch</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">develop</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">frappe</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">erpnext</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--upgrade</span>
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">setup</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">requirements</span>
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">update</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--reset</span>
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">build</span>
```

## Run Fixes in the Bench Console

The bench console is an IPython shell with the site already connected:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--site</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">SITE_NAM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">E</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">console</span>
```

Changes made with `frappe.db.*` or `doc.save()` are not permanent until you call `frappe.db.commit()`. Exit with `exit` or Ctrl+D; uncommitted changes are rolled back.

Warning

Everything in this section changes or deletes production data, and most of it bypasses the normal checks that ERPNext runs through the UI. Take a backup with `bench --site <SITE_NAME> backup` first, and try the script on a copy of the site before running it on the real one.

### Update a Field on Many Documents

Loop through the documents and save each one when you need validations and hooks to run:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">for</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> name </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">in</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.get_all(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Employee Checkin"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">filters</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">{</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"employee"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"<EMPLOYEE_ID>"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">pluck</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    doc </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.get_doc(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Employee Checkin"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, name)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    doc.employee_name </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"<NEW_EMPLOYEE_NAME>"</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    doc.save()</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.db.commit()</span>
```

When you only need to change column values and don't want hooks or `modified` timestamps to change, the query builder does it in one statement:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">BOMOperation </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.qb.DocType(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"BOM Operation"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    frappe.qb.update(BOMOperation)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    .set(BOMOperation.time_in_mins, </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">0</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    .where(BOMOperation.parenttype </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">==</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"BOM"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">).run()</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.db.commit()</span>
```

See [Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/) for more query builder patterns.

### Delete a Specific Document

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.delete_doc(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Stock Entry"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"<DOCUMENT_NAME>"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.db.commit()</span>
```

Submitted documents can't be deleted. Cancel them first (`frappe.get_doc(doctype, name).cancel()`), then delete.

### Delete Every Document of a Type

For log doctypes such as Error Log, empty the table directly:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.db.truncate(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Error Log"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
```

`TRUNCATE` is DDL, takes effect immediately, and can't be rolled back. Use `frappe.db.delete("Error Log")` instead if you want a `DELETE` that waits for `frappe.db.commit()`. Both remove only the doctype's own table; they skip child tables, comments, versions, and controller hooks, which is fine for logs but not for business documents.

For business documents, delete through the ORM so child rows and linked records are cleaned up:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">for</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> doctype </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">in</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> [</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"<DOCTYPE_1>"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"<DOCTYPE_2>"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">for</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> name </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">in</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.get_all(doctype, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">pluck</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">if</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.db.get_value(doctype, name, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"docstatus"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">==</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Mark submitted documents as cancelled so they can be deleted.</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># This skips the real cancel logic (ledger reversals and so on).</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            frappe.db.set_value(doctype, name, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"docstatus"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">2</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">update_modified</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">False</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        frappe.delete_doc(doctype, name, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">force</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">True</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.db.commit()</span>
```

`force=True` skips the "is this document linked elsewhere" check.

Warning

Forcing `docstatus` to 2 and deleting with `force=True` leaves ledger entries and links behind. Only do this to clear out test or junk data. To wipe all transactions for a company before go-live, use ERPNext's **Transaction Deletion Record** instead.

### Delete Cancelled Stock Transactions

Cancelled stock documents keep their GL and stock ledger rows. To remove them completely, for example to clean up test data before go-live:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">for</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> doctype </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">in</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> [</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Stock Reconciliation"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Stock Entry"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Delivery Note"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">for</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> name </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">in</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.get_all(doctype, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">filters</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">{</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"docstatus"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">2</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">pluck</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">for</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> ledger </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">in</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> [</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"GL Entry"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Stock Ledger Entry"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Repost Item Valuation"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            frappe.db.delete(ledger, {</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"voucher_type"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: doctype, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"voucher_no"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: name})</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        frappe.delete_doc(doctype, name)</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.db.commit()</span>
```

Warning

This deletes ledger history permanently. Never run it on a company with closed accounting periods or audited books.

### Revert Cancelled Bank Transactions to Unreconciled

If bank transactions were cancelled by mistake, you can put them back in the reconciliation queue instead of re-importing the statement. Saving with an empty `payment_entries` table makes the Bank Transaction controller recalculate the allocated and unallocated amounts and set the status back to Unreconciled.

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">for</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> name </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">in</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.get_all(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Bank Transaction"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">filters</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">{</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"docstatus"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">2</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">pluck</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    frappe.db.set_value(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Bank Transaction"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, name, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"docstatus"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">update_modified</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">False</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    doc </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.get_doc(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Bank Transaction"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, name)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    doc.payment_entries </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> []</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    doc.save()</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.db.commit()</span>
```

Warning

This changes `docstatus` directly, which ERPNext never does on its own. Filter it down to the specific transactions you mean to revert (for example by `bank_account` or `date`) rather than running it on every cancelled transaction.

### Clear a Background Job Queue

To drop every pending job in a queue for all sites on the bench:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">purge-jobs</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--queue</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">long</span>
```

Add `--site <SITE_NAME>` to only remove that site's jobs, or `--event daily` to only remove scheduled jobs of that type.

From the console, `get_queue` builds the correct queue name for you (since v15, queue names in Redis are prefixed with the bench ID, so a bare `rq.Queue("long")` points at the wrong queue):

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.utils.background_jobs </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> get_queue</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">queue </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> get_queue(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"long"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">queue.count</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">queue.empty()</span>
```

Emptying a queue doesn't stop jobs that are already running. Stop those from the **RQ Job** list in the desk, or from the console:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> rq.command </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> send_stop_job_command</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.utils.background_jobs </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> get_queue, get_redis_conn, get_workers</span>

<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">for</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> worker </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">in</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> get_workers(get_queue(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"long"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    job </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> worker.get_current_job()</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">if</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> job:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        send_stop_job_command(get_redis_conn(), job.id)</span>
```

## Repair Database Schema

### Recreate or Resync a DocType Table

If a doctype's table is missing, or its columns and indexes no longer match the DocType definition, sync it from the console:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.db.updatedb(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"<DOCTYPE>"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.db.commit()</span>
```

`updatedb` creates the table if it doesn't exist and adds or changes columns and indexes to match the DocType. For a standard doctype whose JSON file has changed on disk, `frappe.reload_doctype("<DOCTYPE>", force=True)` reloads the definition from the file and syncs the table in one step.

Note

`updatedb` doesn't repair a table that MariaDB itself reports as corrupted. If `CHECK TABLE` fails, restore the table from a backup, or drop it and let `updatedb` recreate it empty.

### Remove Orphaned Columns

When fields are deleted from a DocType, Frappe leaves their columns in the table. Preview what would be dropped:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--site</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">SITE_NAM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">E</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">trim-tables</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--dry-run</span>
```

Then run it for real:

```
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">bench</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">--site</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E"><</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">SITE_NAM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">E</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">></span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">trim-tables</span>
```

Warning

`trim-tables` drops columns and the data in them. It takes a full backup first unless you pass `--no-backup`; don't skip it.

Sources

- [docs.frappe.io/framework/user/en/bench/bench-commands](https://docs.frappe.io/framework/user/en/bench/bench-commands)
- [docs.frappe.io/framework/user/en/bench/reference/restore](https://docs.frappe.io/framework/user/en/bench/reference/restore)
- [docs.frappe.io/framework/user/en/bench/reference/trim-tables](https://docs.frappe.io/framework/user/en/bench/reference/trim-tables)
- [github.com/frappe/bench/blob/develop/bench/commands/update.py](https://github.com/frappe/bench/blob/develop/bench/commands/update.py)
- [github.com/frappe/bench/blob/develop/bench/commands/git.py](https://github.com/frappe/bench/blob/develop/bench/commands/git.py)
- [github.com/frappe/frappe/blob/version-15/frappe/commands/site.py](https://github.com/frappe/frappe/blob/version-15/frappe/commands/site.py)
- [github.com/frappe/frappe/blob/version-15/frappe/utils/background_jobs.py](https://github.com/frappe/frappe/blob/version-15/frappe/utils/background_jobs.py)

Need help with Frappe?

Our notes can take you a long way, but sometimes you'd rather have someone who's done it before.

[ERPNext implementation](/services/erp/erpnext/)

[← PreviousOverview](/kb/frappe/)[Next →Builder Page Scripts](/kb/frappe/builder-page-scripts/)

CC0This article is in the public domain ([CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)), code samples included. Use it however helps you.

On this page

- [Back Up and Restore a Site](#back-up-and-restore-a-site)
- [Take the Backup](#take-the-backup)
- [Restore on the Destination](#restore-on-the-destination)
- [Switch App Remotes and Branches](#switch-app-remotes-and-branches)
- [Point an App at a Fork](#point-an-app-at-a-fork)
- [Switch Branches](#switch-branches)
- [Upgrade to a New Major Version](#upgrade-to-a-new-major-version)
- [Switch to Develop](#switch-to-develop)
- [Run Fixes in the Bench Console](#run-fixes-in-the-bench-console)
- [Update a Field on Many Documents](#update-a-field-on-many-documents)
- [Delete a Specific Document](#delete-a-specific-document)
- [Delete Every Document of a Type](#delete-every-document-of-a-type)
- [Delete Cancelled Stock Transactions](#delete-cancelled-stock-transactions)
- [Revert Cancelled Bank Transactions to Unreconciled](#revert-cancelled-bank-transactions-to-unreconciled)
- [Clear a Background Job Queue](#clear-a-background-job-queue)
- [Repair Database Schema](#repair-database-schema)
- [Recreate or Resync a DocType Table](#recreate-or-resync-a-doctype-table)
- [Remove Orphaned Columns](#remove-orphaned-columns)

[Back to top↑](#top)

Services

- [ERP implementation](/services/erp/)
- [Odoo](/services/erp/odoo/)
- [ERPNext](/services/erp/erpnext/)
- [Custom software](/services/custom-software/)
- [Devices & IoT](/services/devices-iot/)
- [Websites](/services/websites/)
- [Infrastructure](/services/infrastructure/)

Resources

- [Our work](/work/)
- [Open source](/open-source/)
- [Knowledge base](/kb/)
- [Insights](/insights/)

Company

- [About](/about/)
- [Team](/about/team/)
- [Partners](/partners/)
- [Contact](/contact/)

Clients

- [Project portal](https://erp.avunu.net/projects)
- [Invoices](https://erp.avunu.net/)
- [Support](https://erp.avunu.net/)

[![Avunu](/brand/avunu-logo-light.svg)](/)[\<av-icon data-jx-static>\<svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor" stroke="none" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false">\<path d="M20.400 20.500h-3.600v-5.600c0-1.300 0-3-1.800-3s-2.100 1.400-2.100 2.900v5.700H9.400V9h3.400v1.600c.5-.9 1.600-1.900 3.400-1.900 3.600 0 4.300 2.400 4.300 5.500v6.300zM5.300 7.400a2.100 2.100 0 1 1 0-4.100 2.100 2.100 0 0 1 0 4.100zm1.800 13.100H3.600V9h3.500v11.500zM22.200 0H1.800C.8 0 0 .8 0 1.700v20.600c0 .9.800 1.700 1.800 1.700h20.400c1 0 1.800-.8 1.800-1.700V1.700C24 .8 23.200 0 22.200 0z">\</path>\</svg>\</av-icon>](https://www.linkedin.com/company/avunu)[\<av-icon data-jx-static>\<svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor" stroke="none" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false">\<path d="M12 .3a12 12 0 0 0-3.8 23.4c.6.1.8-.3.8-.6v-2c-3.3.7-4-1.6-4-1.6-.6-1.4-1.4-1.8-1.4-1.8-1-.7.1-.7.1-.7 1.2.1 1.8 1.2 1.8 1.2 1 1.8 2.8 1.3 3.5 1 .1-.8.4-1.3.7-1.6-2.7-.3-5.5-1.3-5.5-5.9 0-1.3.5-2.4 1.2-3.2-.1-.3-.5-1.5.1-3.2 0 0 1-.3 3.3 1.2a11.500 11.500 0 0 1 6 0c2.300-1.500 3.300-1.200 3.300-1.200.6 1.700.2 2.900.1 3.200.8.8 1.200 1.900 1.200 3.200 0 4.600-2.800 5.600-5.500 5.900.4.400.8 1.100.8 2.200v3.300c0 .3.2.7.8.6A12 12 0 0 0 12 .3">\</path>\</svg>\</av-icon>](https://github.com/Avunu)[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

Avunu LLC · 948 East Philadelphia Street, York, PA 17403 · (717) 814-8540Knowledge base articles are in the public domain[Privacy](/privacy/)[Terms](/terms/)
