/ 
DBIx-Class-Async-0.40
/ DBIx::Class::Async::ResultSet::Pager

NAME

DBIx::Class::Async::ResultSet::Pager - Asynchronous pagination handling for Async ResultSets

VERSION

Version 0.40

SYNOPSIS

my $rs = $schema->resultset('User')->page(1);
my $pager = $rs->pager;

# total_entries returns a Future
$pager->total_entries->then(sub {
    my $total = shift;
    print "Total users: $total\n";
    print "Last page: " . $pager->last_page . "\n";
    return Future->done;
})->get;

DESCRIPTION

This module provides a pagination object for DBIx::Class::Async::ResultSet. It is designed to work similarly to Data::Page, but with the critical difference that the total entry count is fetched asynchronously from the database worker.

CONSTRUCTOR

new

my $pager = DBIx::Class::Async::ResultSet::Pager->new(
    resultset => $rs
);

Instantiates a new pager. Usually called via $rs->pager.

METHODS

total_entries

Returns a Future that resolves to the total number of entries matching the ResultSet condition, ignoring pagination limits. The result is cached after the first call.

entries_per_page

Returns the number of entries per page (rows attribute).

current_page

Returns the current page number.

last_page

Returns the total number of pages. Note: This assumes total_entries has been resolved. If not, it defaults to 1.

entries_on_this_page

Returns the number of entries on the current page.

previous_page

Returns the previous page number or undef if on the first page.

next_page

Returns the next page number or undef if on the last page.

next_page_rs

Returns a new DBIx::Class::Async::ResultSet for the next page, or undef.

previous_page_rs

Returns a new DBIx::Class::Async::ResultSet for the previous page, or undef.

AUTHOR

Mohammad Sajid Anwar, <mohammad.anwar at yahoo.com>

REPOSITORY

https://github.com/manwar/DBIx-Class-Async

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/manwar/DBIx-Class-Async/issues. I will be notified and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc DBIx::Class::Async::ResultSet::Pager

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright (C) 2026 Mohammad Sajid Anwar.

This program is free software; you can redistribute it and / or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License.By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you,you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement,then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.