Background jobs using PostgreSQL's LISTEN/NOTIFY
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
.travis.yml
Gemfile
LICENSE
README.md
Rakefile
pg_queue.gemspec

README.md

PgQueue

Background jobs using PostgreSQL's LISTEN/NOTIFY

Build Status

Installation

Add this line to your application's Gemfile:

gem 'pg_queue'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pg_queue

Now you need to create the table where jobs will be stored:

$ rake environment pg_queue:create_table

Run rake -T pg_queue for more tasks

Usage

Rails

Create an initializer with the configuration

PgQueue.connection = ActiveRecord::Base.connection.raw_connection
PgQueue.logger = Rails.logger
PgQueue.interval = 3 # the number of seconds you want the worker wait after process a job

Add this line in the Rakefile

require "pg_queue/tasks"

And then start the worker running

rake environment pg_queue:work

That's it! You're now able to enqueue your jobs. To do that, just call

PgQueue.enqueue(MyQueueClass, "string", 1, false) # parameters will be JSON encoded

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Maintainer

Rafael Souza (rafaelss.com)

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.