Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[5.8] Fix columns parameter on paginate method #28937

Merged

Conversation

Projects
None yet
3 participants
@driesvints
Copy link
Member

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

Fix columns parameter on paginate method
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

This comment has been minimized.

Copy link
Member Author

commented Jun 24, 2019

@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

2 checks passed

continuous-integration/styleci/pr The analysis has passed
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@driesvints driesvints deleted the driesvints:fix-columns-param-on-paginate-method branch Jun 24, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.