README.textile

Delayed Deltas for Thinking Sphinx

Installation

This version works with Thinking Sphinx v1.5.0, v2.1.0 and v3.×.

In your Gemfile, it’ll likely look something like this:

gem 'ts-delayed-delta', '~> 2.1'

Or, if you’re referring directly to the git repository:

gem 'ts-delayed-delta',
  :git    => 'git://github.com/pat/ts-delayed-delta.git',
  :branch => 'master',
  :ref    => 'use-latest-commit-here'

And given this gem’s built for Delayed Job, we’re presuming you’ve got that set up (with the database table), and you know how to run it. This gem no longer provides a custom task for that purpose – there’s no need.

Usage

In your index definitions, make sure you set the :delta setting to ThinkingSphinx::Deltas::DelayedDelta:

ThinkingSphinx::Index.define :book, :with => :active_record, :delta => ThinkingSphinx::Deltas::DelayedDelta do
  # ...
end

For those still on pre-v3 versions of Thinking Sphinx, the delta option goes within the define_index block:

define_index do
  # ...

  set_property :delta => ThinkingSphinx::Deltas::DelayedDelta
end

If you’ve never used delta indices before, you’ll want to add the boolean column named delta to each model that is using the approach. It probably doesn’t hurt to add an index to that column as well.

add_column :books, :delta, :boolean, :default => true, :null => false
add_index  :books, :delta

And that’s pretty much it. Make sure Delayed Job is running, and it’ll take care of the jobs to keep your Sphinx indices up to date.

Please keep in mind that you need to run the Delayed Job workers on the same machine as Sphinx, as direct access to Sphinx files (and the Sphinx command-line tools) is essential.

Contributing

Contributions are very much welcome – but keep in mind the following:

• Keep patches in a separate branch
• Don’t mess with the version number. I’ll take care of that when the patch is merged in.
• Please write tests – currently, there’s only acceptance tests in place, because the underlying code is simple enough. If you get stuck into anything complex, unit tests are a smart move.

Contributors

• Ryan Schlesinger (Allowing installs as a plugin)
• Maximilian Schulz (Ensuring compatibility with Bundler)
• Edgars Beigarts (Adding intelligent description for tasks)
• Alexander Simonov (Explicit table definition)
• David Goodlad (Delayed Job/ActiveRecord load order fix)
• Ben Hutton (Delayed Job compatibility update)
• Reinier de Lange (Fix for table name reference)
• Enrico Brunetta (Adding Railtie for Rails 3)
• Jonathan Viney and James Healy (Rails 3.2 deprecation fixes)
• Georg Ledermann (DJ 2.0.x backwards compatibility)
• Jonathan Lim (Cleaning up version references)
• Manjunath Manohar (Allow setting of job queue, smarter cleaning up of jobs)
• Mikko Koski (Ensure new jobs are created if all existing jobs are failures)
• Jason Barnabe (Fix Rails 5.x compatibility)

Copyright

Copyright © 2009-2018, Thinking Sphinx Delayed Deltas (ts-delayed-delta) is developed and maintained by Pat Allan, and is released under the open MIT Licence. Many thanks to all who have contributed patches.