PmaControl
PmaControl documentation
Technical guides, API reference, internal architecture, and operational procedures — everything you need to deploy, operate, and extend PmaControl.
Quick start
Installation & deployment
Installation on Debian 10/11/12, Ubuntu 18.04/20.04. SSH key deployment, initial configuration, and installation wizard.
Read documentation →Adding servers
Add a MariaDB / MySQL server via the web interface. PmaControl automatically detects the version, type (standalone, replica, Galera, ProxySQL) and starts collection.
Read documentation →Network scan & autodiscovery
Automatic server discovery via nmap. Detection of open MariaDB / MySQL ports and bulk import.
Read documentation →Monitoring & observability
Real-time monitoring
Tracking 120+ MariaDB / MySQL metrics: hit ratio, locks, threads, open files, connections, InnoDB buffer pool, disk space.
Read documentation →Dot3 topology
Interactive map generated via Graphviz: servers, master/slave replication, Galera clusters, ProxySQL, MaxScale, VIP. Failover history and semantic colouring.
Read documentation →Alerts & notifications
Contextual alerts on events: restart, broken replication, disk space, latency. Telegram, Slack, PagerDuty notifications.
Read documentation →Query analysis (Digest)
Performance Schema integration: SQL digest collection, normalisation, visual EXPLAIN, regression and full-scan detection.
Read documentation →Replication & high availability
Master/Slave replication
Assisted configuration, real-time status tracking (lag, IO/SQL errors, GTID), start/stop slave, version comparison between master and slave.
Read documentation →Galera Cluster
Full supervision: quorum calculation (Nodes available = Primary + Synced/Donor), wsrep segments, IST/SST flow, garb arbitrator, split-brain detection.
Read documentation →InnoDB Cluster & Group Replication
Automatic detection of members and Primary/Replica roles via group_replication_*. Displayed in Dot3 with dedicated subgraphs.
Read documentation →VIP servers
Virtual IP/DNS management: resolution to real server, failover history (previous destination + date), displayed in Dot3.
Read documentation →Backups & data
Backup & restore
Backup orchestration (mysqldump, mariabackup, xtrabackup), scheduling, compression, encryption, SFTP storage areas, automatic restore testing.
Read documentation →Versioned schema export
Structured export per database: tables, views, procedures, functions, triggers, events. Git repository per database, selective import, multi-environment comparison.
Read documentation →Cleaner (data purge)
Scheduling and execution of obsolete data purges per table, with statistics and daemon mode.
Read documentation →Binary logs
Backup, viewing, and purging of MariaDB / MySQL binary logs. Search within binlog events.
Read documentation →API & integrations
REST API
Full CRUD on inventory: tags, clients, environments, aliases, storage-areas, servers, ssh-keys. GET, POST, PUT, PATCH, DELETE verbs. OpenAPI export.
Read documentation →Native integrations
MariaDB, MySQL, Percona Server, ProxySQL, MaxScale, Galera, InnoDB Cluster, AWS RDS, Azure Database, GCP CloudSQL. Alerting via Telegram, Slack, PagerDuty.
Read documentation →Percona Toolkit
Execution of pt-online-schema-change from the interface, OSC temporary table management.
Read documentation →Security & administration
MariaDB / MySQL user management
Security audit, privilege comparison between hosts, detection of never-connected users, grants export and backup.
Read documentation →PmaControl access control
Built-in authentication with roles and permissions. Optional LDAP support. Every action is audited.
Read documentation →CSRF protection (Origin + scoped token)
Shared Glial helper: per-scope CSRF token, same-site Origin/Referer validation, explicit 403/405/400 rejections before any SQL mutation.
Read documentation →AI Agents & LLM
13 specialised agents running on an on-premise LLM (Ollama). Metrics analysis, configuration recommendations, anomaly detection — your data never leaves your infrastructure.
Read documentation →Internal architecture
Glial engine & Aspirateur
The Glial engine orchestrates collection via the Aspirateur (MariaDB / MySQL + SSH connections), integration into timed files (ts_file), and distribution to workers.
Read documentation →Listener (post-processing)
Update detection via ts_max_date, dispatch to business methods: database refresh, variables, DNS aliases, performance metrics.
Read documentation →Plugins & extensions
Modular architecture: plugins installable/removable via the interface, JSON manifest, automatic SQL execution.
Read documentation →Internal schema (162 tables)
Complete documentation of PmaControl's 162 internal tables: role, columns, foreign keys, and code correlations.
Read documentation →Need help on a specific topic?
Our team produces dedicated guides for your use case. Contact us.