Limit, Offset, and Pagination

limit

Name

Type

Required

Default

Description

value

numeric

true

The limit value for the query.

Sets the limit value for the query.

QueryBuilder
query.from( "users" )
.limit( 5 );
MySQL
SELECT *
FROM `users`
LIMIT 5

take

Name

Type

Required

Default

Description

value

numeric

true

The limit value for the query.

Sets the limit value for the query. Alias for limit.

QueryBuilder
query.from( "users" )
.take( 5 );
MySQL
SELECT *
FROM `users`
LIMIT 5

offset

Name

Type

Required

Default

Description

value

numeric

true

The offset value for the query.

Sets the offset value for the query.

QueryBuilder
query.from( "users" )
.offset( 25 );
MySQL
SELECT *
FROM `users`
OFFSET 25

forPage

Name

Type

Required

Default

Description

page

numeric

true

The page number to retrieve.

maxRows

numeric

true

The number of records per page. If a number less than 0 is passed, 0 is used instead.

Helper method to calculate the limit and offset given a page number and count per page.

QueryBuilder
query.from( "users" )
.forPage( 3, 15 );
MySQL
SELECT *
FROM `users`
LIMIT 15
OFFSET 30

paginate

This method combines forPage, count, and get to create a pagination struct alongside the results. Information on the paginate method, including custom pagination collectors, can be found in the Retreiving Results section of the documentation.