Skip to content

Commit 402a4ef

Browse files
andrew-3Slashek
andauthored
High performance SQL filtering instance flag documentation (#1759)
* High performance SQL filtering instance flag documentation * Update app/views/pages/developer-guide/platformos-workflow/directory-structure/config.liquid --------- Co-authored-by: Maciej Krajowski-Kukiel <[email protected]>
1 parent 1a682cf commit 402a4ef

File tree

1 file changed

+2
-0
lines changed
  • app/views/pages/developer-guide/platformos-workflow/directory-structure

1 file changed

+2
-0
lines changed

app/views/pages/developer-guide/platformos-workflow/directory-structure/config.liquid

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ metadata:
3030
|translation_keys_to_ignore |[]|Allows to list translation keys which will not be updated/delete on sync/deploy. It is most useful if you would like to change translations using UI and will not reflect it in your codebase. Translations will still be created if not defined.
3131
|validations_for_graph_queries |false|When the feature is enabled, platformOS performs additional consistency validations for specific GraphQL queries, with a primary focus on mutations. These validations are designed to verify that the developer's queries express a valid and well-defined intent. By enforcing these consistency checks, platformOS helps maintain data integrity and prevents unintended or ambiguous mutations from being executed. This feature serves as an additional layer of protection, ensuring that the queries submitted by developers are semantically correct and align with the intended behavior of the application.
3232
|websockets_require_csrf_token |true|If disabled, the websocket connection will not check the CSRF token. By keeping this flag as `true`, connections to websocket will require CSRF token to be included in the parameters, increasing the security of your application.
33+
|high_performance_sql_filtering |false|If enabled, filtering on properties will use more efficient SQL queries behind the scenes. Default is false to maintain backward compatibility, but enabling it can lead to significant performance improvements for applications that heavily utilize property filtering. The optimization and backwards incompatibility is caused by removing extra casting to text, which in many scenarios is not necessary and prevents a default index on the column from being used.
3334

3435

3536
Example `app/config.yml` file with recommended values:
@@ -48,6 +49,7 @@ slug_exact_match: true
4849
sync_assets: true
4950
sync_translations: true
5051
websockets_require_csrf_token: true
52+
high_performance_sql_filtering: true
5153
---
5254
```
5355

0 commit comments

Comments
 (0)