Getting started
DBPinball is a database workspace for MySQL and PostgreSQL. This section takes you from a clean machine to a working connection, in the terminal or in the desktop app.
The short version
- Check the requirements.
- Build from source with installation.
- Follow the quick start.
- Create your first connection.
Two front ends, one store
The CLI and the desktop share one connection store at dirs::config_dir()/dbpinball/connections.json and one OS keyring entry per profile. A profile created in the CLI appears in the desktop, and the other way around. You do not need to keep two sets of profiles.
What this documentation covers
| Section | What it answers |
|---|---|
| Guide | How to install and use DBPinball |
| Architecture | How the core, the CLI, the desktop and the store fit together |
| Security | How credentials are stored, and what the limits are |
| Reference | Exact commands, configuration and error behaviour |
| Development | How to build, test and contribute |
| Roadmap | What is implemented, what is planned, what is not available |
Not a marketing page
Every capability described here is taken from the repository and its tests. If a feature is planned or incomplete, it is labelled as such.