npm 包 pg-queue-io 使用教程

简介

pg-queue-io 是一款 Node.js 的 npm 包，用于在 PostgreSQL 数据库中管理任务队列。相对于其他的任务队列，pg-queue-io 更适合于需要与 PostgreSQL 交互的应用程序。

安装

使用 npm 进行安装：

npm install pg-queue-io --save

使用方法

初始化

当你引用了 pg-queue-io 后，你需要先初始化该包。初始化的代码如下：

-- -------------------- ---- -------
----- ----- - -----------------------

----- ----- - --- -------
    ----- -----------
    ----- ------------
    --------- ---------
    --------- -----------
    ----- -----
---

在初始化时，你需要将 PostgreSQL 数据库的主机、名称、用户名、密码等必要信息输入。在新的队列中，你可以使用 queue 这个实例。

插入任务

使用 queue.insert(data, options) 方法可以向队列中添加一个任务。

queue.insert({test: "test data"})
    .then(function(rows) {
        // do something
    })
    .catch(function(err) {
        console.error(err);
    });

数据必须是一个对象，并且是一个 JSON 可序列化的对象。如果任务成功插入了队列，该方法返回该任务的 ID。你可以在其他方法中使用该 ID。

另外，你可以使用可选的 options 参数自定义任务，options 参数的值会覆盖默认的值。

-- -------------------- ---- -------
------------------- ----- ------- -
    --------- ---
    --------- --
    ------ ----
--
-------------------- -
    -- -- ---------
--
-------------------- -
    -------------------
---

可选参数

• priority：任务的优先级，一个数字，高优先级在队列前面。
• expire：任务的有效期，从插入开始的秒数。
• delay：任务的延迟时间，从插入后的秒数。
• attempts：任务失败后的尝试次数。默认不会重新尝试任务。

获取任务

要获取队列中的任务，请使用 queue.get(options) 方法。

queue.get()
    .then(function(rows) {
        // do something
    })
    .catch(function(err) {
        console.error(err);
    });

如果队列中没有任务或者所有任务都被锁定了，则返回空值。

options 参数也可用于自定义操作。默认的 options 如下：

{
    timeout: 30
}

timeout 参数表示正在处理任务的秒数。如果处理任务的时间超过了 timeout 值，任务将会被认为是失败的。

完成任务

完成任务后，你可以使用 queue.done(id) 方法将任务从队列中删除。

queue.done(1)
    .then(function() {
        // do something
    })
    .catch(function(err) {
        console.error(err);
    });

这个方法也可以接受一个可选的 data 参数，即完成任务后提交的结果。

queue.done(1, {success: true})
    .then(function() {
        // do something
    })
    .catch(function(err) {
        console.error(err);
    });

失败任务

如果一个任务已经失败了，你可以使用 queue.fail(id) 方法将任务重新插入队列。失败任务将会在错误超时后重新提交。

queue.fail(1)
    .then(function() {
        // do something
    })
    .catch(function(err) {
        console.error(err);
    });

你也可以在重新插入任务时指定一个错误原因。

queue.fail(1, {reason: "timeout"})
    .then(function() {
        // do something
    })
    .catch(function(err) {
        console.error(err);
    });

总结

pg-queue-io 是一个方便、易于使用的任务队列，它与 PostgreSQL 数据库协作十分紧密，是那些需要高性能任务处理的应用程序首选。此篇文章提供了 pg-queue-io 的使用方法及示例代码，希望能对你的开发工作提供一些帮助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005756181e8991b448ea55d