All notable changes to this project will be documented in this file.
- Updated Fractal to 0.20. (#292)
- Initial Craft 5 support
- Updated Fractal to 0.20. (#292)
- Added version constraint to prevent installation with craftcms/element-api
- Related element types are now configurable (#273)
- Fixed an issues with updating and deleting split elements (#259 & #281)
- Fixed an error in DeindexElementJob
- Fixed missing deletion of orphans of split elements (#259)
- This beta release is a first try at resolving an issue with deindexing of element not working properly. (#281)
- Fixed an error on the Control Panel Utility page (#284)
- Fixed an error when saving elements without a site property (#285)
- Added
AfterIndexImportevent, which fires after the ImportIndex job has finished. (#283)
- Deindexing now also takes the correct siteId into account (#281)
- Added support for creating and configuring replica indexes (#275, thanks @johnnynotsolucky!)
- Fixed an error on the utility page when an index included multiple sites (#276)
- Fixed an issue where saving an element would not update it from the correct site (#266)
- This fixes an issue where we default to the primary site when no site id is supplied through index settings.
- This release adds lazy loading of the index's criteria function, to try and migigate "behaviour not found" errors (#268)
- Indexing jobs now run for every site (#266)
- Use priority & ttr settings for all queue jobs (#271)
- Updated license to be MIT everywhere (#272)
- Fixed tests (#263)
- Fixed missing return types in IndexElement & DeIndexElement jobs
- Futher improvements to prevent scout from being initialized before Craft is ready (#262)
- Scout now requires craft 4.3.5 (see #249)
- Fixed an issue where Element querries would fire before Scout was loaded (#249)
- Fixed a UI issue with button spacing on the utility screen (#245)
- Craft 4 🚀
- Craft CMS 4 compatibility
- Added
renderingContenttoIndexSettings(#230 & #231 - thanks @joshuabaker)
scout/index/importnow optionally takes a--queue=1parameter to run the import(s) through the queue instead running them straigt away.
- Added a config setting to keep using the orginal object in case
splittedObjectsonly contains 1 item. (#193 & #219, thanks @gregkohn)
- MakeSearchable job now uses the index criteria (#177)
- Disable relations on delete if so configured, should improve performance on larger installs (#227)
- Added support for PHP 8.x
- Added support for algolia/algoliasearch-client-php 3.x
- Added
indexRelationsconfig setting (true by default) (#175 & #205) - Exposed options to update and dump index settings from the CP utility (#209)
- CP Utility now works for indexes using the wildcard selector for siteId (#163)
- CP Utility labels are now translatable
- Fixed compatibility with Craft Commerce (#178)
- Don't include indices in Settings::toArray() by default
- Remove pro requirement for Utility
- Allow tightenco/collect ^7.0
- Fix Fractal dependency to stay compatible with element-api
- Fix dependencies, now requires PHP >= 7.1
- Fix an issue where engine could be null - #121
- Fix queued indexing error
- Fix Index settings not being forwarded to replicas
- Don't use element as a prop, as it will get serialized with the whole class int the job queue.
- Defer related element propagation to queue
- Use a custom Serializer for Fractal (thanks @santi6291)
- Fixed a type hinting issue
- Fixed a bug when using
->site('*')in your criteria, thanks @timkelty
{warning} This is a major release, the way you configure Scout has been changed, please read the docs on how to upgrade.
- Rewrite of the full plugin
- Added tests for all functionality
- Added a comprehensive syntax to configure the Indices
- Added a settings page for all settings except Indices
- Resolve fractal conflict
- Fixed a bug when skipping elements when splitElementIndex is also set (#81)
- Now requires Craft 3.2
- Added a fix for Element drafts & revisions in Craft 3.2
- Revert untested change
- Fixed an issue with settings call
- Scout can now skip elements if you return an empty array from the transformer
- Documented the
--forceoption
- Scout now uses v2 of the Algolia API in the background. Nothing has changed in Scout usage.
search_api_keysetting to model- Twig variables for accessing Algolia settings in front end templates
- Normalised the mixture of quotes in the config example documentation
- Fixed a regression by the previous release when deleting elements would not deIndex them.
- Fixed an issue with deindexing elements, thanks @chrislam
- Fixes issue with console commands on Folder capitalization, thanks @philipzaengle
- Added an
indexSettingsoption to mappings that allows for code-based index settings. Thanks to @timkelty - Added
./craft scout/settings/updateand./craft scout/settings/dumpcommands.
- Fixed validator int --> integer
- Added siteId to splitElementIndex
- cast site ids to int as craft/yii returns int as string (#39) @larsboldt
- add connect timeout option (#38) @larsboldt
- Replace call to
deIndexElementswithindexElements(#37)
- Fixed an issue where objects weren't being deleted from the index
- Fixed an issue where splitting indices on site or siteId wouldn't work
- Added a "refresh" command, thanks to @JorgeAnzola
- Object IDs are now unique for multisites
- Added a
syncsetting to enable/disable automatic indexing of elements.
- Records can now be split (see: https://www.algolia.com/doc/guides/indexing/structuring-your-data/?language=php#indexing-long-documents) thanks to @larsboldt
- Changed how the queueing of indexing works to prevent errors and inconsistencies
- Fixed an error when trying to serialize an Entry that cannot be serialized
- Updated the League/Fractal requirement to match that of Element API to avoid conflicts
- Craft Scout now listens to Category events to determine if it needs to reindex elements
- A new icon!
- Console commands to flush & import indexes
- Index filtering is now based on criteria instead of a function
- Move indexing to jobs
- Initial release