MySQL / MariaDB Resource Node

The MySQL / MariaDB Resource makes it easy to pull data out of a MySQL-compatible database and display or process it within Dynaboard.

Configuration Steps

  1. Find the connection parameters or the connection string for your database.
    • Connection strings follow the format mysql://username:password@hostname:port/databaseName
  2. Fill in the required connection information in the resource properties panel.
    • Secret fields (e.g. passwords or certificates) require clicking the ✓ to the right of the field to save the input.
    • If you're not sure about the character set, use the default value.
  3. It's recommended to always enable SSL.
  4. It may be also be required by your provider or DB admin to include additional SSL certificates.
    • If so, download and open the certificates in a text editor. Once open, copy the entire text of the file and paste it into the matching property field.
  5. If your database is behind a firewall (very common), you'll need to allow Dynaboard's outbound IP address.
  6. Click "Test Connection" at the bottom of the panel to verify everything works!

Common Configuration Errors

  • If the connection errors after a while, you may not have configured the firewall rules properly.
  • A secret may be unsaved (e.g. passwords or certificates). Click the ✓ to the right of the field to save it. The text will disappear after a successful save.

Properties

Host

Prophost
Typestring

Hostname or IP address to use for the connection. E.g. this-entire-string.is-the-hostname.com

Port

Propport
Typestring
Default3306

Port to use for the connection.

Database

Propdatabase
Typestring
Defaultmysql

The database name to use for the connection.

Username

Propusername
Typestring
Defaultmysql

The username to use for the connection.

Password

Proppassword
Type({ ref: string } | undefined)

The password to use for the connection.

Character set

Propcharset
Typestring
DefaultUTF8_GENERAL_CI

The character set to use for the connection.

Use SSL

PropuseSSL
Typeboolean
Default{{true}}

Disable to remove SSL encryption. Not recommended to disable.

SSL Certificate Authority

PropsslCA
Type({ ref: string } | undefined)

CA (root certificate) to use for the SSL connection.

SSL Client Private Key

PropsslKey
Type({ ref: string } | undefined)

Client private key to use for the SSL connection.

SSL Client Certificate

PropsslCert
Type({ ref: string } | undefined)

Client certificate to use for the SSL connection.

Actions

Perform SQL Query

Performs a SQL query on the MySQL database.

ParameterTypeDefault
querystringundefined