Skip to content

Database EN

Jump to bottom
github-actions[bot] edited this page Mar 17, 2026 · 2 revisions

Spendify — Database management

Spendify's database is a single SQLite file (ledger.db). This guide covers everything related to data: where it is located, how to back it up, how to restore it, and how to move it to another computer.

Table of contents

  1. What the database contains
  2. Where the database is located
  3. Backup
  4. Restore
  5. First launch with an existing database
  6. Moving the database to another computer
  7. Direct inspection (sqlite3)
  8. Database corruption

1 — What the database contains

The ledger.db file contains everything — there are no other data files to consider for backup:

Table Contents
transaction All imported transactions
category_rule Deterministic categorisation rules
description_rule Description cleaning rules
document_schema CSV/XLSX file schemas (columns, format, etc.)
user_settings User settings (LLM, locale, date format, contexts…)
taxonomy_category / taxonomy_subcategory Custom taxonomy
reconciliation_link Card–account links (RF-03 reconciliation)
internal_transfer_link Internal transfers (RF-04)
import_batch / import_job Import history

The taxonomy.yaml file contains only the default taxonomy — if it has not been modified from within the app, it does not need to be included in the backup.

2 — Where the database is located

Installation mode Path
One-liner Docker (install.sh / install.ps1) Docker volume spendify_data → /app/data/ledger.db inside the container
Docker Compose from repo Docker volume spendify_data → /app/data/ledger.db inside the container
Native (Mac/Linux, uv) ./ledger.db in the project folder

Why is the Docker volume not a normal folder?

The spendify_data volume is managed by Docker and is not directly accessible from your computer's filesystem like a normal folder. To read from or write to the volume, a temporary container must be used as a "bridge" — the commands in the following sections do exactly this.

3 — Backup

3.1 — Backup (native installation)

# Create the backup folder (once)
mkdir -p ~/spendify-backup

# Copy the DB with a name that includes the date
cp ledger.db ~/spendify-backup/ledger_$(date +%Y%m%d_%H%M%S).db

3.2 — Backup (Docker — container running)

Direct method with docker cp, no additional containers required:

mkdir -p ~/spendify-backup

docker cp spendify_app:/app/data/ledger.db \
  ~/spendify-backup/ledger_$(date +%Y%m%d_%H%M%S).db

spendify_app is the container name (defined in docker-compose.yml). The container must be running to use docker cp.

3.3 — Backup (Docker — container stopped)

If the container is stopped, use a temporary Alpine container (lighter than Python):

mkdir -p ~/spendify-backup

docker run --rm \
  -v spendify_data:/data \
  -v ~/spendify-backup:/backup \
  alpine cp /data/ledger.db /backup/ledger_$(date +%Y%m%d_%H%M%S).db

Windows (PowerShell): replace ~/spendify-backup with $env:USERPROFILE\spendify-backup and $(date +%Y%m%d_%H%M%S) with the date written manually, e.g. 20260317_120000.

3.4 — Automatic backup (crontab, Linux/Mac)

# Backup every day at 03:00
0 3 * * * docker cp spendify_app:/app/data/ledger.db ~/spendify-backup/ledger_$(date +\%Y\%m\%d).db

# Delete backups older than 30 days
0 4 * * * find ~/spendify-backup -name "ledger_*.db" -mtime +30 -delete

For native installation:

0 3 * * * cp /path/to/project/ledger.db ~/spendify-backup/ledger_$(date +\%Y\%m\%d).db
0 4 * * * find ~/spendify-backup -name "ledger_*.db" -mtime +30 -delete

4 — Restore

4.1 — Restore (native installation)

# 1. Stop the app
pkill -f "streamlit run app.py"

# 2. Save the current DB (for safety)
cp ledger.db ledger_before_restore_$(date +%Y%m%d_%H%M%S).db

# 3. Restore the chosen backup
cp ~/spendify-backup/ledger_20260317_030000.db ledger.db

# 4. Restart
uv run streamlit run app.py

4.2 — Restore (Docker)

# 1. Stop the container
docker compose -C ~/spendify down

# 2. Copy the backup into the volume
docker run --rm \
  -v spendify_data:/data \
  -v ~/spendify-backup:/backup:ro \
  alpine cp /backup/ledger_20260317_030000.db /data/ledger.db

# 3. Restart
docker compose -C ~/spendify up -d

If you installed from the repository rather than with the one-liner, replace docker compose -C ~/spendify with docker compose from the project folder.

4.3 — Partial restore (selected tables only)

Useful if you want to recover only the categorisation rules from a backup without overwriting transactions. Requires sqlite3 installed on the host:

sqlite3 ledger.db "
ATTACH DATABASE '/path/to/backup/ledger_20260317.db' AS bkp;
DELETE FROM category_rule;
INSERT INTO category_rule SELECT * FROM bkp.category_rule;
DETACH DATABASE bkp;
"

Same logic for other tables: description_rule, user_settings, taxonomy_category, taxonomy_subcategory.

5 — First launch with an existing database

If you already have a ledger.db (for example created with the native installation) and want to use it in the Docker container, you must copy it into the volume before starting the app.

# 1. Make sure the container is stopped
docker compose -C ~/spendify down

# 2. Copy the DB into the volume
docker run --rm \
  -v spendify_data:/data \
  -v "/absolute/path/to/ledger.db":/source/ledger.db:ro \
  alpine cp /source/ledger.db /data/ledger.db

# 3. Verify the file arrived
docker run --rm \
  -v spendify_data:/data \
  alpine ls -lh /data/

# 4. Start the app
docker compose -C ~/spendify up -d

Mac: the absolute path is /Users/yourname/spendify/ledger.db Linux: /home/yourname/spendify/ledger.db

6 — Moving the database to another computer

  1. Back up the DB on the source computer (section 3)
  2. Copy the .db file to the new computer (USB, cloud, scp, etc.)
  3. Install Spendify on the new computer with the one-liner (install.sh / install.ps1)
  4. Import the DB into the Docker volume (section 5)
  5. Open the app: all transactions, rules and settings are present

The SQLite file is portable: it works identically on Mac, Linux and Windows, regardless of processor architecture (Intel / ARM).

7 — Direct inspection (sqlite3)

You can open the database with any SQLite client. Examples:

From the terminal (sqlite3):

# Native installation — from the project folder
sqlite3 ledger.db

# Docker — extract the DB first with docker cp
docker cp spendify_app:/app/data/ledger.db /tmp/ledger_inspect.db
sqlite3 /tmp/ledger_inspect.db

Useful queries:

-- Number of transactions per year
SELECT strftime('%Y', date) AS year, COUNT(*) FROM "transaction" GROUP BY year;

-- Last 10 transactions
SELECT date, description, amount, category FROM "transaction" ORDER BY date DESC LIMIT 10;

-- Active rules
SELECT pattern, category, subcategory FROM category_rule ORDER BY priority;

-- User settings
SELECT key, value FROM user_settings;

GUI clients: DB Browser for SQLite (free, Mac/Linux/Windows) — open the .db file directly.

8 — Database corruption

SQLite file corruption is rare but can occur in the event of a power cut during a write operation.

Check

sqlite3 ledger.db "PRAGMA integrity_check;"
# Expected output: ok
# If the output contains errors, the file is corrupted

Automatic recovery attempt

sqlite3 ledger.db ".recover" | sqlite3 ledger_recovered.db
mv ledger.db ledger_corrupted_$(date +%Y%m%d).db
mv ledger_recovered.db ledger.db

Check again with PRAGMA integrity_check;. If recovery fails, restore from the last valid backup (section 4).

Prevention

  • The Docker installation has restart: unless-stopped which prevents sudden container shutdowns
  • Taking regular backups (section 3.4) always guarantees a recent restore point

Clone this wiki locally