Igor Kromin |   Consultant. Coder. Blogger. Tinkerer. Gamer.

The MySQL SELECT statement syntax includes a LIMIT clause that can be used to restrict how much data is returned from the database. This is fantastic for pagination but in most cases you also want to know how many rows there are in total, which typically requires a second query. With MySQL there is a special option that can be passed to SELECT to do this calculation for you automatically.

First lets see what the documentation says about LIMIT...
The LIMIT clause can be used to constrain the number of rows returned by the SELECT statement. LIMIT takes one or two numeric arguments, which must both be nonnegative integer constants, with these exceptions:
* Within prepared statements, LIMIT parameters can be specified using ? placeholder markers.
* Within stored programs, LIMIT parameters can be specified using integer-valued routine parameters or local variables as of MySQL 5.5.6.

With two arguments, the first argument specifies the offset of the first row to return, and the second specifies the maximum number of rows to return. The offset of the initial row is 0 (not 1)

This means I can write something like this (USERS is just a table from a project I implemented this in)...

That will return the first 10 rows from the USERS table. To get the next 10, I'd change the LIMIT clause to 'LIMIT 10, 10' and the next 10 would be 'LIMIT 20, 10', and so on.

If you specify an offset that is larger than the count of rows in your table, you simply don't get any data back (no error). However if you're building a user interface that paginates through results you want to know when to stop displaying the 'next' link (or link to the page number, etc) without having to rely on the database not returning any data.

Here's where that option I mentioned comes into play. The SQL_CALC_FOUND_ROWS option is required for the FOUND_ROWS() function to work. So you are in fact still having to execute two queries, but you're not having to run a COUNT() query on your data since that's already done by the database for you.

So the SQL changes to this...


Then immediately after running your query to fetch the data, you execute the following query:

That will return the total number of rows your original query would have returned if you didn't have the LIMIT clause.

Lets see an example - assume that the table USERS has 23 rows.
SQL run with LIMIT 0, 10: returns 10 rows.
Running FOUND_ROWS() returns 23;
SQL run with LIMIT 10, 10: returns 10 rows.
Running FOUND_ROWS() returns 23;
SQL run with LIMIT 20, 10: returns 3 rows.
Running FOUND_ROWS() returns 23;

So you can see that the LIMIT and offset do not have an effect on the count returned by FOUND_ROWS() - it will return the total count all the time exactly as if you were to do this:

What this means is if your'e doing pagination, you have to take the offset into account when calculating whether you have more data to paginate to or not. This caught me off guard at first!

If you're using PHP PDO, you can use this to get the result of FOUND_ROWS() ...
// pdo is an instance of PDO
$statement = $pdo->query('SELECT FOUND_ROWS()');

P.S. The FOUND_ROWS() query must be run immediately after the SQL that fetches your data, if you run more SQL after that you will not get the right count back. I found the best way to do this is to use PDO and start a transaction for each of my statements, that way they're completely isolated from one another.


Hope you found this post useful...

...so please read on! I love writing articles that provide beneficial information, tips and examples to my readers. All information on my blog is provided free of charge and I encourage you to share it as you wish. There is a small favour I ask in return however - engage in comments below, provide feedback, and if you see mistakes let me know.

If you want to show additional support and help me pay for web hosting and domain name registration, donations, no matter how small, are always welcome!

Use of any information contained in this blog post/article is subject to this disclaimer.
comments powered by Disqus
Other posts you may like...