Skip to content

[5.8] Fix columns parameter on paginate method#28937

Merged
taylorotwell merged 1 commit intolaravel:5.8from
driesvints:fix-columns-param-on-paginate-method
Jun 24, 2019
Merged

[5.8] Fix columns parameter on paginate method#28937
taylorotwell merged 1 commit intolaravel:5.8from
driesvints:fix-columns-param-on-paginate-method

Conversation

@driesvints
Copy link
Member

@driesvints driesvints commented Jun 24, 2019

This is currently broken and will throw a SQL exception:

DB::table('posts')->paginate(5, ['title', 'content']);

At the moment when you attempt to pass specific columns on the paginate method on the base query builder it will fail when you provide more than one column. SQL queries can only handle a count for a specific column and not multiple ones. That's why it's unwanted to pass along the columns parameter from the paginate method to the getCountForPagination method. Since we just want to do a count of the current result set a simple count with the '*' sign is enough. At the moment the Eloquent builder already handles pagination in this way.

It's noted by @staudenmeir that the only difference is when you provide a specific column to the getCountForPagination method is that it'll only count non-NULLs. However, it's not feasible to allow this to be done in combination with the paginate method because the columns param on the paginate method soley exists to filter which columns will be retrieved in the paginated result set (which is currently broken thus). See #28844 (comment)

I've added an extra integration test which reproduces the problem at hand. I've updated the tests in the DatabaseQueryBuilderTest class to reflect the changes made to getCountForPagination call.

This has been a long outstanding issue so hopefully this will prevent more issues from popping up.

Fixes #28890

This is currently broken and will throw a SQL exception:

    DB::table('posts')->paginate(5, ['title', 'content']);

At the moment when you attempt to pass specific columns on the paginate method on the base query builder it will fail when you provide more than one column. SQL queries can only handle a count for a specific column and not multiple ones. That's why it's unwanted to pass along the columns parameter from the paginate method to the getCountForPagination method. Since we just want to do a count of the current result set a simple count with the '*' sign is enough. At the moment the Eloquent builder already handles pagination in this way.

It's noted by Staudenmeier that the only difference is when you provide a specific column to the getCountForPagination method is that it'll only count non-NULLs. However, it's not feasible to allow this to be done in combination with the paginate method because the columns param on the paginate method soley exists to filter which columns will be retrieved in the paginated result set (which is currently broken thus). See #28844 (comment)

I've added an extra integration test which reproduces the problem at hand. I've updated the tests in the DatabaseQueryBuilderTest class to reflect the changes made to getCountForPagination call.

This has been a long outstanding issue so hopefully this will prevent more issues from popping up.

Fixes #28890
@driesvints
Copy link
Member Author

@staudenmeir could you perhaps give this PR a second look when you find some time? Thanks! :)

@taylorotwell taylorotwell merged commit 7ac7818 into laravel:5.8 Jun 24, 2019
@driesvints driesvints deleted the fix-columns-param-on-paginate-method branch June 24, 2019 21:23
@micbenner
Copy link

micbenner commented Apr 23, 2020

Not a SQL genius, but just an FYI for future Googlers:

If your query relies on SELECT DISTINCT, i.e., if you use distinct() need to use the query builder, then the paginate() method will not work for you. I believe (either rightly or wrongly), this is why.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Query Builder Paginate gives SQLSTATE[42000] syntax error if you pass columns into paginate()

4 participants