zmanemet 中文文档教程

Question

ZmanEmet - MySQL 和 MySQL 之间的实时通信Socket.io 客户端

A node.js 用于 MySQL 服务器和用户界面之间实时更新的包。 该包监听 MySQL 数据库上的事件并实时更新用户。

这个包基于原始的ZongJi和原始 mysql-events 模块。

作者：Niv Apo

安装

npm install zmanemet

快速入门

const mysql = require('mysql');
const ZmanEmet = require('zmanemet');
const { Server } = require("socket.io");

const program = async () => {

    // Create a connection to your DB
    const connection = mysql.createConnection({
        host: 'localhost',
        user: 'root',
        password: 'root',
    });

    // Create a socket.IO server
    const io = new Server(3000);

    // Create a ZmanEmet instance and pass your db & socket.io connections
    const instance = new ZmanEmet(connection,io);

    // Start your instance
    await instance.start();

    // Create a trigger for an event
    let trigger = {
        name: 'TEST',
        expression: 'MY_SCHEMA.users.name',
        statement: "UPDATE", // see MySQLEvents.STATEMENTS.ALL for full list of options
        onEvent: (event) => {
            // Process the event and return the data to send to the client
            let {before,after} = event.affectedRows[0];

            let user_id = after.id;
            let room_id = `user_${user_id}`; // The socket room to send the update
            let event_name = "user.update"; // The event name in the sockets on the client side

            // The data that will be sent to the socket
            let data = {
                user_id:user_id,
                new_name:after.name
            }

            // Optional - send an update to the client via socket.io server
            return [room_id,event_name,data];
        },
    };
    zman.addTrigger(trigger);

    // Add a listener for connection issues
    instance.on(MySQLEvents.EVENTS.CONNECTION_ERROR, console.error);
};

program()
  .then(() => console.log('Waiting for database events...'))
  .catch(console.error);

使用

### #constructor(dbConnection, socketsConnection)

• 使用预先存在的实例化并创建数据库连接连接

  const 连接 = mysql.createConnection({
    主机：'本地主机'，
    用户：'用户名'，
    密码：'密码'，
  });
  
  const myInstance = new ZmanEmet(连接,io);
  

  #start()

• start 函数确保 MySQL 在解决其承诺之前已连接 JavaScript myInstance.start() .then(() => console.log('我正在运行！')) .catch(err => console.error('发生了一些不好的事情', err)); ### #stop()

• stop 函数在解决其承诺之前终止 MySQL 连接并停止 ZongJi JavaScript myInstance.stop() .then(() => console.log('我停了下来！')) .catch(err => console.error('发生了一些不好的事情', err)); ### #pause()

• pause 函数暂停 MySQL 连接，直到调用 #resume() ，当您接收的数据超出您当时可以处理的数据时，这很有用 JavaScript myInstance.pause(); ### #resume()

• resume 函数恢复暂停的 MySQL 连接，因此它再次开始生成 binlog 事件 JavaScript myInstance.resume(); ### #addTrigger({ name, expression, statements, onEvent })

• 为给定表达式/语句添加触发器，并在事件发生时调用 onEvent 函数

  instance.addTrigger({
    名称：'MY_TRIGGER'，
    表达式：'MY_SCHEMA.MY_TABLE.MY_COLUMN',
    语句：MySQLEvents.STATMENTS.INSERT，
    onEvent: 异步(事件) => {
      // 在这里您将获取给定表达式/语句的事件。
      // 该函数在数据库触发触发器之后、数据发送到套接字之前执行。
      // 您可以处理数据并将您想要的数据发送到 socket.io
  let socket_room = "";
  让事件名称=“”；
  让 event_data = "";
  
  返回 [socket_room,event_name,event_data];
   },
  });
  

• name 参数必须是唯一的每个表达式/语句，如果您想删除触发器，稍后将由用户

  instance.addTrigger({
    名称：'MY_TRIGGER'，
    表达式：'MY_SCHEMA.*'，
    语句：MySQLEvents.STATMENTS.ALL，
    ...
  });
  
  实例.removeTrigger({
    名称：'MY_TRIGGER'，
    表达式：'MY_SCHEMA.*'，
    语句：MySQLEvents.STATMENTS.ALL，
  });
  

• 表达式 参数非常动态，您可以用 * 替换任何步骤，以使其等待任何架构、表或列事件 JavaScript 实例.addTrigger({ name: '从 SCHEMA2 的表 USERS 更新名称', 表达式：'SCHEMA2.USERS.name'， ... }); JavaScript 实例.addTrigger({ name: '所有数据库事件', 表达： '*'， ... }); JavaScript 实例.addTrigger({ name: 'SCHEMA2 中的所有事件', 表达式：'SCHEMA2.*'， ... }); JavaScript 实例.addTrigger({ name: '表 USERS 的所有数据库事件', 表达式：'*.USERS', ... }); JavaScript 实例.addTrigger({ name: '表 USERS 的所有数据库事件', 表达式：'*.USERS', ... });

• statement 参数指示应在哪个数据库操作中触发事件 JavaScript 实例.addTrigger({ ... 语句：MySQLEvents.STATMENTS.ALL， ... }); 允许的语句

• onEvent 参数是应该威胁触发事件的函数 JavaScript 实例.addTrigger({ ... onEvent: (事件) => { 控制台.log(事件); // { 类型、架构、表、affectedRows: []、affectedColumns: []、timestamp, } }, ... }); ### #removeTrigger({ name, expression, statements })

• 从当前实例中删除触发器 JavaScript 实例.removeTrigger({ name: '我之前创建的触发器', 表达： ''， 语句：MySQLEvents.STATMENTS.INSERT， });

Tigger 事件对象

它具有以下结构：

{
  type: 'INSERT | UPDATE | DELETE',
  schema: 'SCHEMA_NAME',
  table: 'TABLE_NAME',
  affectedRows: [{
    before: {
      column1: 'A',
      column2: 'B',
      column3: 'C',
      ...
    },
    after: {
      column1: 'D',
      column2: 'E',
      column3: 'F',
      ...
    },
  }],
  affectedColumns: [
    'column1',
    'column2',
    'column3',
  ],
  timestamp: 1530645380029,
  nextPosition: 1343,
  binlogName: 'bin.001',
}

确保数据库用户有权读取要监视的数据库上的 binlog。

LICENSE

MIT © Niv Apo