A driver for Queues. Uses Fluent to store job metadata in an SQL database.
This package makes use of the SKIP LOCKED
feature supported by some of the major database engines (most notably PostgresSQL and MySQL) when available to make a best-effort guarantee that a task or job won't be picked by multiple workers.
This package should be compatible with:
- PostgreSQL 11.0+
- MySQL 8.0+
- MariaDB 10.5+
Note
Although SQLite can be used with this package, SQLite has no support for advanced locking. It is not likely to function correctly with more than one or two queue workers.
Add QueuesFluentDriver
as dependency to your Package.swift
:
dependencies: [
.package(url: "https://github.com/vapor-community/vapor-queues-fluent-driver.git", from: "3.0.0-beta.2"),
...
]
Add QueuesFluentDriver
to the target you want to use it in:
targets: [
.target(name: "MyFancyTarget", dependencies: [
.product(name: "QueuesFluentDriver", package: "vapor-queues-fluent-driver"),
])
]
This package includes a migration to create the database table which holds job metadata; add it to your Fluent configuration as you would any other migration:
app.migrations.add(JobModelMigration())
Finally, load the QueuesFluentDriver
driver:
app.queues.use(.fluent())
Warning
Always call app.databases.use(...)
before calling app.queues.use(.fluent())
!
You can optionally create a dedicated Database, set to isdefault: false
and with a custom DatabaseID
and use it for your Queues.
In that case you would initialize the Queues configuration like this:
let queuesDb = DatabaseID(string: "my_queues_db")
app.databases.use(.postgres(configuration: dbConfig), as: queuesDb, isDefault: false)
app.queues.use(.fluent(queuesDb))
You can customize the name of the table used by this driver during the migration :
app.migrations.add(JobMetadataMigrate(schema: "my_jobs"))
By default, the Vapor Queues system starts 2 workers per available CPU core, with each worker would polling the database once per second. On a 4-core system, this would results in 8 workers querying the database every second. Most configurations do not need this many workers.
The polling interval can be changed using the refreshInterval
configuration setting:
app.queues.configuration.refreshInterval = .seconds(5)
Likewise, the number of workers to start can be changed via the workerCount
setting:
app.queues.configuration.workerCount = 1