> For the complete documentation index, see [llms.txt](https://docs.netmap.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.netmap.dev/operations/database-migrations.md).

# Database Migrations

NetMap uses SQLite with startup initialization and migration code in `backend/app/db/session.py` and `backend/app/db/firewall_session.py`.

Do not manually edit SQLite files unless restoring from backup or following maintainer instructions.

Documentation gap: this page needs a maintained list of every migration identifier and schema change.

## Databases

| Database      | Purpose                     |
| ------------- | --------------------------- |
| `netmap.db`   | Main application state      |
| `firewall.db` | Firewall/syslog event state |

Both databases use WAL mode and a `busy_timeout`.

## Operator Guidance

Before upgrading:

1. Back up `data/`.
2. Back up secrets.
3. Pull the new image.
4. Start NetMap.
5. Watch logs during startup.
6. Verify `/api/health`.

```bash
docker compose logs --tail=200 netmap
curl --fail http://127.0.0.1:8080/api/health
```

## Developer Guidance

When adding persistent fields or tables:

* add/update SQLAlchemy models;
* add startup migration logic consistent with existing code;
* add tests for existing database upgrade behavior;
* update API schemas and documentation;
* update backup/restore docs if persistent files change.

## Troubleshooting

If startup fails after an upgrade, stop and preserve the current `data/` directory before attempting fixes. Do not delete database files unless the maintainer explicitly confirms that is the intended recovery path.

Related pages:

* [Storage](/configuration/storage.md)
* [Backups](/operations/backups.md)
* [Database Problems](/troubleshooting/database-problems.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.netmap.dev/operations/database-migrations.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.