Pro API

Sidekiq Pro adds a few API extensions:

• Sidekiq::Queue#delete_job - takes a JID and deletes the corresponding job from the given queue, if it exists. Returns the deleted job or nil. Executes as a Lua script directly in the Redis process for maximum performance.

jid = MyWorker.perform_async
queue = Sidekiq::Queue.new
queue.delete_job(jid)

• Sidekiq::Queue#delete_by_class - takes a class and deletes all corresponding jobs from the queue. Returns the number of jobs deleted. The Standard API notes apply to this method.

MyWorker.perform_async
queue = Sidekiq::Queue.new
queue.delete_by_class(MyWorker)

Pausing Queues

Sidekiq Pro allows you to pause processing on any queue via the API:

q = Sidekiq::Queue.new('critical')
q.pause!
q.paused? # => true
q.unpause!

• API
• Active-Job
• Advanced-Options
• Batches
• Best-Practices
• Build-vs-Buy
• Bulk-Queueing
• Comm-Installation
• Commercial-FAQ
• Commercial-Support
• Commercial-collaboration
• Complex-Job-Workflows-with-Batches
• Delayed-extensions
• Deployment
• Devise
• Embedding
• Ent-Encryption
• Ent-Historical-Metrics
• Ent-Leader-Election
• Ent-Multi-Process
• Ent-Periodic-Jobs
• Ent-Rate-Limiting
• Ent-Rolling-Restarts
• Ent-Unique-Jobs
• Ent-Web-UI
• Error-Handling
• FAQ
• Getting-Started
• Heroku
• Home
• Iteration
• Job-Format
• Job-Lifecycle
• Kubernetes
• Logging
• Memory
• Metrics
• Middleware
• Miscellaneous-Features
• Monitoring
• Pro-API
• Pro-Expiring-Jobs
• Pro-Metrics
• Pro-Reliability-Client
• Pro-Reliability-Server
• Pro-Web-UI
• Problems-and-Troubleshooting
• Profiling
• Really-Complex-Workflows-with-Batches
• Related-Projects
• Reliability
• Scaling
• Scheduled-Jobs
• Sharding
• Signals
• Testimonials
• Testing
• The-Basics
• Using-Dragonfly
• Using-Redis