MySQL Notification Settings
This page documents settings for configuring a MYSQL service as a target for Bucket Notifications. See Publish Events to MySQL for a tutorial on using these settings.
You can establish or modify settings by defining:
- an environment variable on the host system prior to starting or restarting the AIStor Server. Refer to your operating system’s documentation for how to define an environment variable.
- a configuration setting using
mc admin config set.
If you define both an environment variable and the similar configuration setting, MinIO AIStor uses the environment variable value.
Some settings have only an environment variable or a configuration setting, but not both.
Each configuration setting controls fundamental MinIO AIStor behavior and functionality. Test configuration changes in a lower environment, such as DEV or QA, before applying to production.
You can specify multiple targets by appending a unique identifier _ID for each set of related settings.
export MINIO_NOTIFY_MYSQL_ENABLE_PRIMARY="on"
export MINIO_NOTIFY_MYSQL_DSN_STRING_PRIMARY="username:password@tcp(mysql.example.com:3306)/miniodb"
export MINIO_NOTIFY_MYSQL_TABLE_PRIMARY="minioevents"
export MINIO_NOTIFY_MYSQL_FORMAT_PRIMARY="namespace"
export MINIO_NOTIFY_MYSQL_ENABLE_SECONDARY="on"
export MINIO_NOTIFY_MYSQL_DSN_STRING_SECONDARY="username:password@tcp(mysql.example.com:3306)/miniodb"
export MINIO_NOTIFY_MYSQL_TABLE_SECONDARY="minioevents"
export MINIO_NOTIFY_MYSQL_FORMAT_SECONDARY="namespace"With these settings, MINIO_NOTIFY_MYSQL_ENABLE_PRIMARY indicates the environment variable is associated to a MySQL service endpoint with ID of PRIMARY.
You can specify multiple targets by appending a unique identifier :ID to the configuration key.
mc admin config set ALIAS notify_mysql:primary \
dsn_string="username:password@tcp(mysql.example.com:3306)/miniodb" \
table="minioevents" \
format="namespace" \
[ARGUMENT=VALUE ...]
mc admin config set ALIAS notify_mysql:secondary \
dsn_string="username:password@tcp(mysql.example.com:3306)/miniodb" \
table="minioevents" \
format="namespace" \
[ARGUMENT=VALUE ...]Settings
Enable
Specify on to enable publishing bucket notifications to a MySQL service endpoint.
Defaults to off.
Requires specifying the following additional environment variables if set to on:
The top-level configuration key for defining an MySQL service endpoint for use with MinIO AIStor bucket notifications.
Use mc admin config set to set or update an MySQL service endpoint.
The following arguments are required for each target:
Specify additional optional arguments as a whitespace (" ")-delimited list.
mc admin config set ALIAS notify_mysql \
dsn_string="username:password@tcp(mysql.example.com:3306)/miniodb" \
table="minioevents" \
format="namespace" \
[ARGUMENT="VALUE"] ...DSN string
Specify the data source name (DSN) of the MySQL service endpoint. MinIO AIStor expects the following format:
<user>:<password>@tcp(<host>:<port>)/<database>
For example:
"username:password@tcp(mysql.example.com:3306)/miniodb"
version changed
Changed in version RELEASE.2023-05-27T05-56-19Z: MinIO AIStor checks the health of the specified URL (if it is resolvable and reachable) prior to adding the target. MinIO AIStor adds offline targets without blocking.
Table
Specify the name of the MySQL table to which MinIO AIStor publishes event notifications.
Format
Specify the format of event data written to the MySQL service endpoint. MinIO AIStor supports the following values:
namespace- For each bucket event, MinIO AIStor creates a JSON document with the bucket and object name from the event as the document ID and the actual event as part of the document body. Additional updates to that object modify the existing table entry for that object. Similarly, deleting the object also deletes the corresponding table entry.
access- For each bucket event, MinIO AIStor creates a JSON document with the event details and appends it to the table with a MySQL-generated random ID. Additional updates to an object result in new index entries, and existing entries remain unmodified.
Max open connections
Specify the maximum number of open connections to the MySQL database.
Defaults to 2.
Queue dir
Specify the directory path to enable MinIO’s persistent event store for undelivered messages, such as /opt/minio/events.
MinIO AIStor stores undelivered events in the specified store while the MySQL server/broker is offline and replays the stored events when connectivity resumes.
Queue limit
Specify the maximum limit for undelivered messages. Defaults to 100000.
Comment
Specify a comment to associate with the MySQL configuration.