From 937b5178d487598a59278cb0656e9d4e0fcdcaff Mon Sep 17 00:00:00 2001 From: Clark Winkelmann Date: Mon, 25 Jul 2022 23:54:08 +0200 Subject: [PATCH] Add note about risky performance improvements --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index dddfe32..94959c5 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,16 @@ php flarum fof:sitemap:build _Best for larger forums, starting at 10.000 items._ +### Risky Performance Improvements + +_This setting is meant for large enterprise customers._ + +The optional "Enable risky performance improvements" option modifies the discussion and user SQL queries to limit the number of columns returned. +By removing those columns, it significantly reduces the size of the database response but might break custom visibility scopes or slug drivers added by extensions. + +This setting only brings noticeable improvements if you have millions of discussions or users. +We recommend not enabling it unless the CRON job takes more than an hour to run or that the SQL connection gets saturated by the amount of data. + ## Scheduling Consider setting up the Flarum scheduler, which removes the requirement to setup a cron job as advised above.