module Sequel::Dataset::Pagination
Holds methods that only relate to paginated datasets. Paginated dataset have pages starting at 1 (page 1 is offset 0, page 2 is offset 1 * #page_size).
Public Instance Methods
The current page of the dataset, starting at 1 and not 0.
# File lib/sequel/extensions/pagination.rb, line 83 def current_page @opts[:current_page] end
Returns the number of records in the current page
# File lib/sequel/extensions/pagination.rb, line 103 def current_page_record_count return 0 if current_page > page_count a = 1 + (current_page - 1) * page_size b = a + page_size - 1 b = pagination_record_count if b > pagination_record_count b - a + 1 end
Returns the record range for the current page
# File lib/sequel/extensions/pagination.rb, line 93 def current_page_record_range return (0..0) if current_page > page_count a = 1 + (current_page - 1) * page_size b = a + page_size - 1 b = pagination_record_count if b > pagination_record_count a..b end
Returns true if the current page is the first page
# File lib/sequel/extensions/pagination.rb, line 113 def first_page? current_page == 1 end
Returns true if the current page is the last page
# File lib/sequel/extensions/pagination.rb, line 118 def last_page? current_page == page_count end
Returns the next page number or nil if the current page is the last page
# File lib/sequel/extensions/pagination.rb, line 123 def next_page current_page < page_count ? (current_page + 1) : nil end
The number of pages in the dataset before pagination, of which this paginated dataset is one. Empty datasets are considered to have a single page.
# File lib/sequel/extensions/pagination.rb, line 78 def page_count @opts[:page_count] end
Returns the page range
# File lib/sequel/extensions/pagination.rb, line 128 def page_range 1..page_count end
The number of records per page (the final page may have fewer than this number of records).
# File lib/sequel/extensions/pagination.rb, line 71 def page_size @opts[:page_size] end
The total number of records in the dataset before pagination.
# File lib/sequel/extensions/pagination.rb, line 88 def pagination_record_count @opts[:pagination_record_count] end
Returns the previous page number or nil if the current page is the first
# File lib/sequel/extensions/pagination.rb, line 133 def prev_page current_page > 1 ? (current_page - 1) : nil end