Sidekiq Activerecord::Shard Middleware

A Sidekiq middleware for supports ActiveRecord Shard with ActiveSupport:CurrentAttribute.

Warning This gem can work with sidekiq-cron or other schedulers, because when Schedule perform a job, they can't know the which shard to use.

Installation

Add this line to your application's Gemfile:

gem "sidekiq-activerecord-shard"

And then execute:

$ bundle

Usage

Create app/models/current.rb:

class Current < ActiveSupport::CurrentAttributes
  attribute :tenant_id
end

Set Current.tenant_id on ApplicationController:

class ApplicationController < ActionController::Base
  before_action :set_current_tenant_id

  def set_current_tenant_id
    Current.tenant_id = request.headers["x-tenant-id"]
  end
end

Add sidekiq config config/initializers/sidekiq-activerecord-shard.rb:

# Enable Sidekiq CurrentAttributes middleware for store Current
require "sidekiq/middleware/current_attributes"
Sidekiq::CurrentAttributes.persist(Current)

SidekiqActiveRecordShard.configure do
  self.selected_shard = -> do
    case Current.tenant_id
    when "other"
      :other
    else
      :primary
    end
  end
end

Perform Job by set shared

Some times, you want to perform a job without Request context, or start Job in schedulers.

Now use can use set(shard: "shard_name") to set shared in directly.

# Call job with "other" shard db
MyJob.set(shard: "other").perform_later

# Call job with "primary" shard db
MyJob.set(shard: "primary").perform_later

Contributing

Contribution directions go here.

License