mysql-trigger-mohamed-hamdeen

Real-time MySQL Trigger community node for n8n using ZongJi Change Data Capture.

Package Information

Released: 3 mo ago
Downloads: 0 weekly / 0 monthly
Latest Version: 1.0.3

Documentation

MySQL Trigger node for n8n

A real-time, event-driven MySQL Trigger node for n8n. This node leverages MySQL's binary logs (CDC / Change Data Capture) via the replication protocol, providing instant execution triggers without the latency or database overhead of polling.

Features

  • True Real-time Triggers (CDC): Powered by MySQL Binlog replication protocol. Triggers instantly upon table changes.
  • Flexible Event Monitoring: Listen specifically for INSERT, UPDATE, and DELETE actions (or any combination of them).
  • Granular Filters: Filter events by specific databases and comma-separated tables.
  • Data States: Provides the full event payload, including both the "before" and "after" row states for UPDATE events.
  • Auto-Reconnect & Fault Tolerance: Robust handling of protocol disconnects and connection losses with auto-retries.

Installation

From the n8n UI (Community Nodes)

  1. Go to Settings > Community Nodes.
  2. Click Install a community node.
  3. Enter the package name:
    n8n-nodes-mysql-trigger
    
  4. Check the agreement box and click Install.

MySQL Server Configuration (CDC Prerequisites)

Because this node acts as a replication replica to stream binlog events, your MySQL server must have binary logging enabled and configured for Row-Based Logging (RBL).

1. Enable Row-Based Binlogs

Add the following configuration to your MySQL configuration file (e.g., my.cnf or mysqld.cnf) under the [mysqld] section:

[mysqld]
server-id         = 1
log-bin           = mysql-bin
binlog-format     = ROW
binlog_row_image  = FULL

Restart your MySQL server to apply the changes:

sudo systemctl restart mysql

2. Create database user with Replication privileges

The user credentials used by the trigger node must have replication slave and replication client privileges. Run the following SQL queries as root:

CREATE USER 'n8n_cdc_user'@'%' IDENTIFIED BY 'your_secure_password';

-- Grant required replication permissions
GRANT REPLICATION SLAVE, REPLICATION CLIENT, SELECT ON *.* TO 'n8n_cdc_user'@'%';

FLUSH PRIVILEGES;

Parameter Configuration

  • Host: The hostname or IP address of your MySQL database.
  • Port: The port number of your MySQL database (Default: 3306).
  • User: The MySQL username (Must have REPLICATION SLAVE privilege).
  • Password: The password for the MySQL user.
  • Database: The database name you want to monitor.
  • Tables: (Optional) Comma-separated list of tables to watch (e.g., users, orders). Leave blank to watch all tables in the database.
  • Events: Multi-select option to trigger on Insert, Update, and/or Delete events.

Output Schema Example

The node outputs a structured JSON array representing the event payload:

INSERT event:

[
  {
    "action": "insert",
    "database": "my_store",
    "table": "users",
    "timestamp": 1718873099,
    "data": {
      "id": 42,
      "email": "user@example.com",
      "created_at": "2026-07-06T12:00:00Z"
    }
  }
]

UPDATE event (Includes Before/After):

[
  {
    "action": "update",
    "database": "my_store",
    "table": "users",
    "timestamp": 1718873105,
    "data": {
      "id": 42,
      "email": "updated_user@example.com",
      "created_at": "2026-07-06T12:00:00Z"
    },
    "oldData": {
      "id": 42,
      "email": "user@example.com",
      "created_at": "2026-07-06T12:00:00Z"
    }
  }
]

License

MIT

Discussion