Changelog

All notable changes to laravel-query-builder will be documented in this file

6.3.0 - 2024-12-23

What's Changed

Feature: Add "belongs to" filter by @gpibarra in #975
Feature: Additional config options to better match the API spec by @CoolGoose in #983

New Contributors

@CoolGoose made their first contribution in #983

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/6.2.3...6.3.0

6.2.3 - 2024-12-23

What's Changed

Fix selecting fields on belongs to many relations by @rasmuscnielsen in #986

New Contributors

@rasmuscnielsen made their first contribution in #986

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/6.2.2...6.2.3

6.2.2 - 2024-12-11

What's Changed

Update filtering.md to clarify handling of array scope parameter by @g-gullstrand in #976
Remove PHPUnit cache by @tarexme in #982
Fix typo in filtering.md by @yngc0der in #984
Fixed IncludedCount.php by @dash8x in #978

New Contributors

@g-gullstrand made their first contribution in #976
@tarexme made their first contribution in #982
@yngc0der made their first contribution in #984
@dash8x made their first contribution in #978

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/6.2.1...6.2.2

6.2.1 - 2024-10-03

What's Changed

Removed explicit escaping for pgsql driver in FiltersPartial - Fixes #941 by @Talpx1 in #968

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/6.2.0...6.2.1

6.2.0 - 2024-09-27

What's Changed

[FEAT] add filter by operator by @AbdelrahmanBl in #940
Add documentation for the operator filter by @AlexVanderbist in #974

New Contributors

@AbdelrahmanBl made their first contribution in #940

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/6.1.0...6.2.0

6.1.0 - 2024-09-23

What's Changed

Bump ramsey/composer-install from 2 to 3 by @dependabot in #939
Add issue #175 link in selecting-fields.md by @alipadron in #951
Update filtering.md by @justinkekeocha in #954
Bump dependabot/fetch-metadata from 2.1.0 to 2.2.0 by @dependabot in #955
[DOCS] Update Frontend implementation with a new one by @cgarciagarcia in #961
Update Documentation for php markdown by @chengkangzai in #969
AllowedFilter should return static rather than self by @kosarinin in #964

New Contributors

@alipadron made their first contribution in #951
@cgarciagarcia made their first contribution in #961
@chengkangzai made their first contribution in #969
@kosarinin made their first contribution in #964

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/6.0.1...6.1.0

6.0.1 - 2024-05-21

What's Changed

Fix ability to filter models by an array as filter value by @inmula in #943

New Contributors

@inmula made their first contribution in #943

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/6.0.0...6.0.1

6.0.0 - 2024-05-10

What's Changed

Add additional types & Phpstan by @Nielsvanpach in #910

New Contributors

@Nielsvanpach made their first contribution in #910

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.8.1...6.0.0

5.8.1 - 2024-05-10

What's Changed

Fix typo by @justinkekeocha in #926
List query-builder-ts front-end implementation package by @rogervila in #925
Fix incorrect escape character in SQL for LIKE query in partial filter by @Talpx1 in #927

New Contributors

@justinkekeocha made their first contribution in #926
@rogervila made their first contribution in #925
@Talpx1 made their first contribution in #927

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.8.0...5.8.1

5.8.0 - 2024-02-06

What's Changed

[Docs] Update config file content by @shdehnavi in #918
Bump: Deprecating Laravel 9 and PHP 8.1, adding Laravel 11 support by @JustSteveKing in #922

New Contributors

@shdehnavi made their first contribution in #918
@JustSteveKing made their first contribution in #922

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.7.0...5.8.0

5.7.0 - 2024-01-08

What's Changed

Start testing against PHP 8.3 by @sergiy-petrov in #899
Add the possibility to use the literal relation names in the allowedFields. by @carvemerson in #917
Add unsetDefault as a replacement for default(null) which was removed in 5.6.0 by @patrickrobrecht in #902
Allow passing an array to the defaultSort function as documented by @MajidMohammadian in #904
Add disable_invalid_includes_query_exception config option by @dimzeta in #906
Update AllowedFilter.php to include getFilterClass function by @justasSendrauskas in #909

New Contributors

@sergiy-petrov made their first contribution in #899
@carvemerson made their first contribution in #917
@patrickrobrecht made their first contribution in #902
@MajidMohammadian made their first contribution in #904
@dimzeta made their first contribution in #906
@justasSendrauskas made their first contribution in #909

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.6.0...5.7.0

5.6.0 - 2023-10-05

What's Changed

Add support for defining includes by callback by @enricodelazzari in #894
Add nullable filters by @enricodelazzari in #895
Fix escaping control characters in partial filters by @GrahamCampbell in #898

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.5.0...5.6.0

5.5.0 - 2023-09-12

What's Changed

Add support for withExists via IncludedExists by @enricodelazzari in #891
Use default values for all config keys (avoids issues when QueryBuilder is used as a dependency in a package)

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.4.0...5.5.0

5.4.0 - 2023-09-08

What's Changed

Deprecate request_data_source config. The QueryBuilder will always look at both the query string and the request body when available now
Fix having null as the query parameter name for filters (see #889)
Bump actions/checkout from 3 to 4 by @dependabot in #890

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.3.0...5.4.0

5.3.0 - 2023-08-21

What's Changed

Accepts string value for the fields query parameter by @ezra-obiwale in #872
Add FiltersEndsWithStrict filter by @utsavsomaiya in #885
Make sure the allowedSorts are always set (even when none are requested) @luilliarcec in #865

New Contributors

@ezra-obiwale made their first contribution in #872
@utsavsomaiya made their first contribution in #885

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.2.0...5.3.0

5.2.0 - 2023-02-24

What's Changed

Bump dependabot/fetch-metadata from 1.3.5 to 1.3.6 by @dependabot in #843
Update sorting.md by @shukriYusof in #846
Update custom sorts link in documentation by @turpoint in #844
Add config to disable InvalidSortQuery exception by @bohemima in #830

New Contributors

@shukriYusof made their first contribution in #846
@turpoint made their first contribution in #844
@bohemima made their first contribution in #830

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.1.2...5.2.0

5.1.2 - 2023-01-24

What's Changed

Update including-relationships.md by @designvoid in #837
Fix workflow badges in README by @nelson6e65 in #841
Laravel 10.x Compatibility by @laravel-shift in #842

New Contributors

@designvoid made their first contribution in #837
@nelson6e65 made their first contribution in #841
@laravel-shift made their first contribution in #842

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.1.1...5.1.2

5.1.1 - 2022-12-02

What's Changed

Fix array_diff_assoc BC break in v5.1.0 by @stevebauman in #827

New Contributors

@stevebauman made their first contribution in #827

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.1.0...5.1.1

4.0.4 - 2022-11-28

What's Changed

bugfix: appending to plucked values (that are not a Model) is not possible
Add version number to installation command in V4 by @jamesbhatta in #786

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/4.0.3...4.0.4

5.1.0 - 2022-11-28

What's Changed

Feature: Update Generics in IncludeInterface by @sidigi in #810
Feature: Add PHP 8.2 Support by @patinthehat in #825
Feature: Add beginsWithStrict filter by @danilopinotti in #821
Bugfix: ignore allowed filters by @davidjr82 in #818
Bugfix: Change self to static when creating query builder by @olliescase in #819
Docs: Update filtering.md by @Dion213 in #801
Misc: Add Dependabot Automation by @patinthehat in #823
Misc: Bump actions/checkout from 2 to 3 by @dependabot in #824

New Contributors

@Dion213 made their first contribution in #801
@sidigi made their first contribution in #810
@patinthehat made their first contribution in #823
@dependabot made their first contribution in #824
@davidjr82 made their first contribution in #818
@olliescase made their first contribution in #819
@danilopinotti made their first contribution in #821

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.0.3...5.1.0

5.0.3 - 2022-07-29

What's Changed

Fixed: Some links in the documentation for v5 pointing to v2 pages by @hameedraha in #757
static return type when returning $this by @lorenzolosa in #775
[PHP 8.2] Fix ${var} string interpolation deprecation by @Ayesh in #779
Fix grammar by @clouder in #784
Add Inertia.js Tables for Laravel Query Builder by @fabianpnke in #790
Fix Laravel 9 PHPStan generic check for __invoke() method of Filter by @kayw-geek in #781
Fix for Warning by @shaunluedeke in #791

New Contributors

@hameedraha made their first contribution in #757
@lorenzolosa made their first contribution in #775
@Ayesh made their first contribution in #779
@clouder made their first contribution in #784
@fabianpnke made their first contribution in #790
@shaunluedeke made their first contribution in #791

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.0.2...5.0.3

5.0.2 - 2022-04-25

What's Changed

Fix Laravel 9 PHPStan generic check by @kayw-geek in #749

New Contributors

@kayw-geek made their first contribution in #749

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.0.1...5.0.2

4.0.3 - 2022-03-23

What's Changed

V4 - Add support for laravel > 7.30.4 by @luilliarcec in #744

New Contributors

@luilliarcec made their first contribution in #744

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/4.0.2...4.0.3

5.0.1 - 2022-03-18

What's Changed

Update README.md by @wayz9 in #713
Fix release order in CHANGELOG by @medvinator in #717
Fix include casing docs by @canvural in #733
Adapt documentation for publishing package config by @dominikb in #734
Fix warning from passing null to explode for includeParts by @steven-fox in #742

New Contributors

@wayz9 made their first contribution in #713
@medvinator made their first contribution in #717
@canvural made their first contribution in #733
@steven-fox made their first contribution in #742

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/5.0.0...5.0.1

5.0.0 - 2022-01-13

add support for Laravel 9
drop support for older versions

4.0.2 - 2021-12-26

What's Changed

DOC: New sample with multiple default sorts by @williamxsp in #694
PHP 8.1 Support by @Medalink in #702

New Contributors

@williamxsp made their first contribution in #694
@Medalink made their first contribution in #702

Full Changelog: https://github.com/spatie/laravel-query-builder/compare/4.0.1...4.0.2

4.0.1 - 2021-10-27

revert deferred service provider (#677)

4.0.0 - 2021-10-20

nested filters will no longer be automatically camel-cased to match a relationship name
includes will no longer be automatically camel-cased to match a relationship name
fields will no longer be automatically snake-cased to match table or column names
switch to deferred service provider

Take a look at the upgrade guide for a more detailed explanation.

3.6.0 - 2021-09-06

add callback sorts (#654)

3.5.0 - 2021-07-05

add support for cursor pagination

3.4.3 - 2021-07-05

fix unexpected lowercase appends (#637)

3.4.2 - 2021-07-05

no changes

3.4.1 - 2021-05-24

fix simple paginator append not working (#633)

3.4.0 - 2021-05-20

add support for custom includes (#623)
add support for getting request data from the request body (#589)
fix issues when cloning QueryBuilder (#621)

3.3.4 - 2020-11-26

prepend table name to WHERE clause for ambiguous partial filters (#567)
add PHP 8 support

3.3.3 - 2020-10-27

prepend table name to WHERE clause for ambiguous exact filters (#467)

3.3.2 - 2020-10-27

fix config key to disable InvalidFilterQuery exception

3.3.1 - 2020-10-11

make nested scope compatible with older Laravel (#542)

3.3.0 - 2020-10-05

add ability to filter by nested relationship scopes (#519)
add config key to disable InvalidFilterQuery exception (#525)

3.2.4 - 2020-10-01

update what defines an ignored filter value (#533)

3.2.3 - 2020-09-30

add LengthAwarePaginator to QueryBuilder (#532)

3.2.2 - 2020-09-09

Revert changes from v3.2.1 to AllowedFilter::filter()

3.2.1 - 2020-09-09

Fix filtering associative arrays (#488)
AllowedFilter::filter() takes a Illuminate\Database\Eloquent\Builder instead of a QueryBuilder instance

3.2.0 - 2020-09-08

add support for Laravel 8

3.1.0 - 2020-08-18

add individual array delimiters for includes, filters, appends and sorts
ensure relations queried using the exact filter are actual relations on the model

3.0.0 - 2020-08-18

New major version. Please read the UPGRADING guide before upgrading.

Spatie\QueryBuilder\QueryBuilder class no longer extends Laravel's Illuminate\Database\Eloquent\Builder

2.8.2 - 2020-05-25

fix scope filters that are added via macros (e.g. onlyTrashed) (#469)

2.8.1 - 2020-03-20

make service provider deferrable (#381)

2.8.0 - 2020-03-02

add support for Laravel 7

2.7.2 - 2020-02-26

small fix for lumen (#436)

2.7.1 - 2020-02-26

small fix for lumen in service provider

2.7.0 - 2020-02-12

add support for model binding in scope filter parameters (#415)

2.6.1 - 2020-02-11

fix alias for multiple allowed includes (#414)

2.6.0 - 2020-02-10

add FiltersTrashed for filtering soft-deleted models
add FiltersCallback for filtering using a callback

2.5.1 - 2020-01-22

fix dealing with empty or null includes (#395)
fix passing an associative array of scope filter values (#387)

2.5.0 - 2020-01-09

add defaultDirection

2.4.0 - 2020-01-04

add support for a custom filter delimiter (#369)

2.3.0 - 2019-10-08

resolve QueryBuilderRequest from service container

2.2.1 - 2019-10-03

fix issue when passing camel-cased includes (#336)

2.2.0 - 2019-09-24

add option to disable parsing relationship constraints when filtering related model properties in the exact and partial filters (#262)
fix selecting fields from included relationships that are multiple levels deep (#317)

2.1.0 - 2019-09-03

add support for Laravel 6

2.0.1 - 2019-08-12

update doc block for QueryBuilder::for()
add missing typehint in SortsField

2.0.0 - 2019-08-12

removed request macros
sorts and field selects are not allowed by default and need to be explicitly allowed
requesting an include suffixed with Count will add the related models' count using $query->withCount()
custom sorts and filters now need to be passed as instances
renamed Spatie\QueryBuilder\Sort to Spatie\QueryBuilder\AllowedSort
renamed Spatie\QueryBuilder\Included to Spatie\QueryBuilder\AllowedInclude
renamed Spatie\QueryBuilder\Filter to Spatie\QueryBuilder\AllowedFilter
Filter, Include and Sort interfaces no longer need to return the Builder instance
allowedFields should be called before allowedIncludes
filters can now have default values
includes will be converted to camelcase before being parsed

1.17.5 - 2019-07-08

bugfix: correctly parse sorts in chunked query (#299)
bugfix: don't parse empty values in arrays for partial filters (#285)

1.17.4 - 2019-06-03

bugfix: orderByRaw is no longer being rejected as a sorting option (#258)
bugfix: addSelect is no longer being replaced by the ?fields parameter (#260)
bugfix: take leading dash into account when remembering generated sort columns (#272)
bugfix: allowedIncludes no longer adds duplicate includes for nested includes (#251)

1.17.3 - 2019-04-16

bugfix: remove duplicate parsing of (default) sort clauses

1.17.2 - 2019-04-12

bugfix: replace missing sort() method on QueryBuilderRequest
bugfix: don't escape allowedSorts and their aliases
bugfix: don't escape allowedFields

1.17.1 - 2019-04-09

security fixes