MariaDB

MariaDB is an open-source relational database compatible with MySQL.

About

MariaDB is a relational database management system derived from MySQL. It implements the MySQL protocol and client libraries and supports modern SQL features with a focus on performance and reliability.

Note: MariaDB is supported using the MySQL source.

Available Tools

Requirements

Database User

This source only uses standard authentication. You will need to create a MariaDB user to log in to the database.

Example

sources:
    my_mariadb_db:
        kind: mysql
        host: 127.0.0.1
        port: 3306
        database: my_db
        user: ${MARIADB_USER}
        password: ${MARIADB_PASS}
        # Optional TLS and other driver parameters. For example, enable preferred TLS:
        # queryParams:
        #     tls: preferred
        queryTimeout: 30s # Optional: query timeout duration

Tip

Use environment variables instead of committing credentials to source files.

Reference

fieldtyperequireddescription
kindstringtrueMust be mysql.
hoststringtrueIP address to connect to (e.g. “127.0.0.1”).
portstringtruePort to connect to (e.g. “3307”).
databasestringtrueName of the MariaDB database to connect to (e.g. “my_db”).
userstringtrueName of the MariaDB user to connect as (e.g. “my-mysql-user”).
passwordstringtruePassword of the MariaDB user (e.g. “my-password”).
queryTimeoutstringfalseMaximum time to wait for query execution (e.g. “30s”, “2m”). By default, no timeout is applied.
queryParamsmap<string,string>falseArbitrary DSN parameters passed to the driver (e.g. tls: preferred, charset: utf8mb4). Useful for enabling TLS or other connection options.
Last modified December 11, 2025: chore(main): release 0.23.0 (#2138) (466aef0)