Module: WillPaginate::ActiveRecord::BaseMethods

Defined in:
lib/will_paginate/active_record.rb

Instance Method Summary collapse

Instance Method Details

#paginate_by_sql(sql, options) ⇒ Object

Wraps find_by_sql by simply adding LIMIT and OFFSET to your SQL string based on the params otherwise used by paginating finds: page and per_page.

Example:

@developers = Developer.paginate_by_sql ['select * from developers where salary > ?', 80000],
                       :page => params[:page], :per_page => 3

A query for counting rows will automatically be generated if you don’t supply :total_entries. If you experience problems with this generated SQL, you might want to perform the count manually in your application.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/will_paginate/active_record.rb', line 169

def paginate_by_sql(sql, options)
  pagenum  = options.fetch(:page) { raise ArgumentError, ":page parameter required" }
  per_page = options[:per_page] || self.per_page
  total    = options[:total_entries]

  WillPaginate::Collection.create(pagenum, per_page, total) do |pager|
    query = sanitize_sql(sql.dup)
    original_query = query.dup
    # add limit, offset
    query << " LIMIT #{pager.per_page} OFFSET #{pager.offset}"
    # perfom the find
    pager.replace find_by_sql(query)

    unless pager.total_entries
      count_query = original_query.sub /\bORDER\s+BY\s+[\w`,\s]+$/mi, ''
      count_query = "SELECT COUNT(*) FROM (#{count_query})"

      unless self.connection.adapter_name =~ /^(oracle|oci$)/i
        count_query << ' AS count_table'
      end
      # perform the count query
      pager.total_entries = count_by_sql(count_query)
    end
  end
end