MariaDB Source
MariaDB is an open-source relational database compatible with MySQL.
3 minute read
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
MariaDB Source Tools
MariaDB Source maintains full compatibility with MySQL, allowing you to use the following tools with this connection:
| Tool Name | Description |
|---|---|
| mysql-execute-sql | A "mysql-execute-sql" tool executes a SQL statement against a MySQL database. |
| mysql-get-query-plan | A "mysql-get-query-plan" tool gets the execution plan for a SQL statement against a MySQL database. |
| mysql-list-active-queries | A "mysql-list-active-queries" tool lists active queries in a MySQL database. |
| mysql-list-all-locks | A "mysql-list-all-locks" tool list all active locks including lock type, lock mode, locked object, lock status, transaction state, query and process id for all objects or specified objects within a designated database or across all databases as requested. |
| mysql-list-table-fragmentation | A "mysql-list-table-fragmentation" tool lists top N fragemented tables in MySQL. |
| mysql-list-table-stats | A "mysql-list-table-stats" tool report table statistics including table size, total latency, rows read, rows written, read and write latency for entire instance, a specified database, or a specified table. |
| mysql-list-tables | The "mysql-list-tables" tool lists schema information for all or specified tables in a MySQL database. |
| mysql-list-tables-missing-unique-indexes | A "mysql-list-tables-missing-unique-indexes" tool lists tables that do not have primary or unique indices in a MySQL instance. |
| mysql-show-query-stats | A "mysql-show-query-stats" tool report query execution statistics including execution count, total and average latency, max latency, total rows examined, full table scans, and inefficient index usage for all queries on a specified database or all databases as requested. |
| mysql-sql | A "mysql-sql" tool executes a pre-defined SQL statement against a MySQL database. |
Requirements
Database User
This source only uses standard authentication. You will need to create a MariaDB user to log in to the database.
Example
kind: source
name: my_mariadb_db
type: 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
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be mysql. |
| host | string | true | IP address to connect to (e.g. “127.0.0.1”). |
| port | string | true | Port to connect to (e.g. “3307”). |
| database | string | true | Name of the MariaDB database to connect to (e.g. “my_db”). |
| user | string | true | Name of the MariaDB user to connect as (e.g. “my-mysql-user”). |
| password | string | true | Password of the MariaDB user (e.g. “my-password”). |
| queryTimeout | string | false | Maximum time to wait for query execution (e.g. “30s”, “2m”). By default, no timeout is applied. |
| queryParams | map<string,string> | false | Arbitrary DSN parameters passed to the driver (e.g. tls: preferred, charset: utf8mb4). Useful for enabling TLS or other connection options. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.