DOC Changelog CMS search with elemental

silverstripe · Jun 28, 2023 · c4e3add · c4e3add
1 parent f7d15f8
commit c4e3add
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/en/04_Changelogs/5.1.0.md b/en/04_Changelogs/5.1.0.md
@@ -8,6 +8,7 @@ title: 5.1.0 (unreleased)
 
 - [Features and enhancements](#features-and-enhancements)
   - [Eager loading](#eager-loading)
+  - [CMS page search performance](#cms-search-performance)
   - [Other new features](#other-features)
 - [API changes](#api-changes)
 - [Dependency changes](#dependency-changes)
@@ -39,6 +40,16 @@ foreach ($teams as $team) {
 
 Read more about [eager loading](/developer_guides/model/relations/#eager-loading) in the developer docs.
 
+### CMS page search performance
+
+- The CMS search has been optimised to reduce the number of database queries made when searching for pages when the site uses elemental content blocks. This has resulted in a small performance improvement.
+- A new opt-in behaviour is available that makes a very large different to the performance when using elemental content blocks. In testing this more than doubled performance. The opt-in disables the default behaviour of rendering all content blocks for CMS search, and instead simply extracts the database contents of the elements. Note this does not use the `$searchable_fields` config. To opt-in to this behaviour, use the following config:
+
+```yml
+DNADesign\Elemental\Controllers\ElementSiteTreeFilterSearch:
+  render_elements_for_cms_search: false
+```
+
 ### Other new features
 
 - You can now exclude specific `DataObject` models from the check and repair step of `dev/build` - see [ORM Performance](/developer_guides/performance/orm/#skip-check-and-repair) for more information.