johnbona/disque

Installation and Setup

1. Start a Disque container using Docker or follow Disque's installation instructions.

docker run -d --rm -p 7711:7711 --name disque efrecon/disque:1.0-rc1

2 Add the dependency to Package.swift.

.package(url: "https://github.com/johnbona/disque", from: "0.1.0")

3. Register the provider and config in configure.swift.

public func configure(_ config: inout Config, _ env: inout Environment, _ services: inout Services ) throws {
	// ...

	try services.register(DisqueProvider())

	var databases = DatabasesConfig()
	let disqueConfig = DisqueDatabase(config: DisqueClientConfig())

	databases.add(database: disqueConfig, as: .disque)
	services.register(databases)
}

4. Fetch a connection from the connection pool and use the Disque client.

return req.withPooledConnection(to: .disque) { disque -> Future<[Job<TestJob>]> in
	return disque.get(count: 1, from: ["test-queue"], as: TestJob.self)
}

Usage

All of Disque's commands (except for HELLO, QPEEK, QSCAN, JSCAN) are implemented in Swift with job bodies conforming to Codable.

Get a job from the queue

return req.withPooledConnection(to: .disque) { disque -> Future<[Job<TestJob>]> in
	return disque.get(count: 1, from: ["test-queue"], as: TestJob.self)
}

Get a job from multiple queues (job priority)

return req.withPooledConnection(to: .disque) { disque -> Future<[Job<TestJob>]> in
	return disque.get(count: 1, from: ["high-priority", "low-priority"], as: TestJob.self)
}

Add a job to a queue

req.withPooledConnection(to: .disque) { disque -> Future<String> in
	return try disque.add(job: TestJob(), to: "test-queue")
}

Completing (acking) a job

req.withPooledConnection(to: .disque) { disque -> Future<Int> in
	return try disque.ack(jobIDs: ["D-00000000-000000000000000000000000-0000"])
}

Resources

• Disque repository and documentation
• Original Disque announcement from @antirez with architecture details: Adventures in Message Queues
• Join Vapor's Discord channel for support
• Feel free to reach out on Twitter (@johnbona) with any comments or questions

License

Disque is released under the MIT License.

Package Metadata

Repository: johnbona/disque

Default branch: master

README: README.md