frappe-db-reset

Frappe DB Reset Command

Reset and reinitialize Frappe database for development purposes with automatic backup and fresh data setup.

Steps to Execute

1. Verify Environment

• Check if in valid Frappe bench
• Verify site exists
• WARNING: Confirm this is NOT a production site
• Check for existing backups

2. Safety Checks

CRITICAL WARNINGS:

• ⚠️ This operation DESTROYS ALL DATA
• ⚠️ ONLY use on development/test sites
• ⚠️ NEVER run on production sites
• ⚠️ Always create backup first

Ask user to confirm:

1. Is this a development/test site?
2. Do they want to backup first?
3. Do they understand all data will be lost?

Require explicit confirmation: "Type 'RESET' to confirm"

3. Pre-Reset Backup

Create Safety Backup:

bench --site [site-name] backup --with-files

Store backup location for user:

Backup created at:
- Database: sites/[site-name]/private/backups/[timestamp]-database.sql.gz
- Files: sites/[site-name]/private/backups/[timestamp]-files.tar

4. Reset Options

Offer reset approaches:

A. Full Reinstall (Recommended)

• Drops and recreates database
• Reinstalls all apps
• Clean slate

B. Data Reset Only

• Keeps app installations
• Removes user data
• Faster than full reinstall

C. Selective Reset

• Reset specific DocTypes
• Keep master data
• Remove transactions only

5. Execute Full Reinstall

Full Site Reinstall:

# Reinstall site (drops DB and recreates)
bench --site [site-name] reinstall

# Or with options
bench --site [site-name] reinstall \
    --admin-password [password] \
    --mariadb-root-password [root-password] \
    --install-app erpnext \
    --verbose

This will:

1. Drop existing database
2. Create new database
3. Install frappe app
4. Install additional apps (if specified)
5. Create Administrator user
6. Set up default roles and permissions

6. Execute Data-Only Reset

Remove User Data:

# Via console
bench --site [site-name] console

# Get all DocTypes
exclude_core = ['User', 'Role', 'DocType', 'Module Def']

for doctype in frappe.get_all('DocType', pluck='name'):
    if doctype not in exclude_core:
        frappe.db.delete(doctype)

frappe.db.commit()