> 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/development/database-changes.md).

# Database Changes

Add SQLAlchemy models under `backend/app/models/` and keep startup/migration behavior aligned with existing DB initialization code.

Update backup and restore documentation if new persistent files are introduced.

## Main And Firewall Databases

NetMap intentionally separates persistent state:

* `netmap.db` for normal application data;
* `firewall.db` for firewall/syslog events.

Choose the database based on write pattern and ownership. High-volume syslog data belongs in the firewall database. Normal application state belongs in the main database.

## Change Checklist

1. Add or update the SQLAlchemy model.
2. Ensure model imports are included where startup initialization expects them.
3. Add migration/startup upgrade logic consistent with the existing project.
4. Add or update Pydantic schemas.
5. Update API route handling.
6. Add tests for fresh databases and upgraded databases.
7. Update backup/restore documentation if persistent state changes.
8. Update API reference documentation if fields are exposed.

## Testing Guidance

Run:

```bash
cd <repo-root>/backend
env UV_CACHE_DIR=/tmp/uv-cache uv run --extra dev pytest tests
```

For targeted schema changes, add focused tests near the affected feature area.

## Related Pages

* [Database Migrations](/operations/database-migrations.md)
* [Storage](/configuration/storage.md)
* [Backend Development](/development/backend-development.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/development/database-changes.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.