Connection Parameters
| Parameter | Description | Required | Example |
|---|---|---|---|
| Host | Database server address | Yes | localhost or mysql.example.com |
| Port | Database port | Yes | 3306 (default) |
| Database | Database name | Yes | production_db |
| Username | Database user | Yes | readonly_user |
| Password | User password | Yes | ******** |
Required Permissions
Grant read access to the target database and system schemas:
mysql_permissions.sql
-- Minimum required permissions GRANT SELECT ON your_database.* TO 'readonly_user'@'%'; -- For metadata extraction (System Catalog) GRANT SELECT ON information_schema.* TO 'readonly_user'@'%'; GRANT SELECT ON mysql.proc TO 'readonly_user'@'%';
Special Features
Fast Metadata Extraction
Optimized queries for quick information_schema access, even on large schemas.
Multiple Database Support
Connect to and document multiple databases from the same server instance.
View Support
Full metadata support for views and materialized views.
Character Set Detection
Automatic detection of character sets and collations.
Common Issues
Authentication plugin error
MySQL 8.0 uses
caching_sha2_password by default. If using older clients, configure the user with mysql_native_password.Connection timeout
Check `wait_timeout` and `interactive_timeout` settings in `my.cnf`. Ensure network stability to the server.
Host not allowed to connect
Grant permissions for the specific client IP/Host or use `'%'` (wildcard) to allow connections from any host (less secure).
Too many connections
The platform manages connection pooling, but check your `max_connections` server setting if you anticipate high load.