Docs/Connections

MySQL Server Configuration

Use this page for self-managed MySQL-compatible servers that DBConvert Streams connects to directly.

It covers the base connection setup for:

  • Load workflows
  • Data Explorer access
  • MySQL CDC source preparation

For the current public support boundary, see the product introduction page.

For managed cloud databases, use the provider-specific guide instead:

For CDC replication settings, see MySQL CDC Source Configuration.

Server requirements

Use a reachable MySQL endpoint with:

  • a hostname or IP address reachable from the DBConvert Streams deployment
  • a database user with the minimum privileges required for the workflow
  • remote access enabled on the server and firewall path
  • SSL/TLS configured when the environment requires encrypted transport

Minimum privileges

The required access depends on the workflow:

  • Load: SELECT on the source tables
  • Data Explorer / SQL Console: SELECT on the objects you need to inspect or query
  • CDC source: MySQL binlog access plus the permissions described in MySQL CDC Source Configuration

Example read-only grant for Load mode:

GRANT SELECT ON database_name.* TO 'user'@'%';

Connection settings in DBConvert Streams

SettingDefaultDescription
HostMySQL server hostname or IP
Port3306MySQL listener port
UsernameDatabase user
PasswordDatabase password
DatabaseDefault schema to connect to
SSL/TLSdisabledSee SSL Configuration

Example secure server configuration:

[mysqld]
ssl-ca=/path/to/ca.pem
ssl-cert=/path/to/server-cert.pem
ssl-key=/path/to/server-key.pem
require_secure_transport=ON

Example connection payload:

{
  "name": "mysql-secure-source",
  "type": "mysql",
  "host": "your-mysql-server",
  "port": 3306,
  "username": "your_user",
  "password": "your_password",
  "database": "your_database",
  "ssl": {
    "mode": "verify-ca",
    "ca": "/path/to/ca.pem",
    "cert": "/path/to/client-cert.pem",
    "key": "/path/to/client-key.pem"
  }
}

Common SSL modes:

  • disabled: No SSL
  • preferred: Use SSL if available
  • required: Always use SSL
  • verify-ca: Verify server certificate
  • verify-full: Verify server certificate and hostname

For certificate details, use SSL Configuration.

Network and host access

Allow inbound access from the DBConvert Streams deployment to MySQL port 3306.

Example server setting:

[mysqld]
bind-address = 0.0.0.0

Example firewall rule:

sudo ufw allow from <DBCONVERT_STREAMS_IP> to any port 3306

If you restrict source access by IP, make sure the allowlist matches the host that actually runs the API or reader services.

CDC-specific preparation

CDC is not enabled by the base connection alone.

For MySQL CDC source workflows, also configure:

  • binary logging
  • row-based binlog format
  • appropriate privileges for the CDC user
  • any provider-specific replication settings

Use MySQL CDC Source Configuration for the full checklist.

Validation checklist

Before you create a stream:

  1. Test the connection from the Data Explorer sidebar (right-click → Test connection) or from the connection editor.
  2. Open the connection in Data Explorer to confirm the visible objects.
  3. Run a simple query in the SQL Console if you need to validate filters or permissions.
  4. Only then create the Load or CDC workflow.