Skip to content

Commit ea09f0d

Browse files
committed
Add warnings about the performance impact of DataStorage_QueryPlan
1 parent 8a10569 commit ea09f0d

5 files changed

Lines changed: 13 additions & 5 deletions

File tree

content/en/docs/refguide/modeling/domain-model/entities/view-entities/use-view-entities.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,11 @@ The database follows the below process:
173173

174174
Even though the query is using a view that also includes address information, the database ignores this information, as it is not relevant when counting customers by age.
175175

176-
If you set the `DataStorage_QueryPlan` log node to Trace, you see the query plan for your queries in the Mendix Runtime log.
176+
If you set the `DataStorage_QueryPlan` log node to Trace, you see the query plan for your all your queries in the Mendix Runtime log.
177+
178+
{{% alert color="warning" %}}
179+
The `DataStorage_QueryPlan` log node has a very large performance impact and should not be enabled in production.
180+
{{% /alert %}}
177181

178182
## Read More
179183

content/en/docs/refguide10/modeling/domain-model/entities/view-entities/use-view-entities.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,11 @@ The database follows the below process:
124124

125125
Even though the query is using a view that also includes address information, the database ignores this information, as it is not relevant when counting customers by age.
126126

127-
If you set the `DataStorage_QueryPlan` log node to Trace, you see the query plan for your queries in the Mendix Runtime log.
127+
If you set the `DataStorage_QueryPlan` log node to Trace, you see the query plan for all your queries in the Mendix Runtime log.
128+
129+
{{% alert color="warning" %}}
130+
The `DataStorage_QueryPlan` log node has a very large performance impact and should not be enabled in production.
131+
{{% /alert %}}
128132

129133
## Read More
130134

content/en/docs/refguide10/runtime/logging/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ This list is currently incomplete and is being updated.
6464
| Connector | Logs when standard or custom request handlers (added through Core#addRequestHandler) are registered, or when a path is called that does not have a registered request handler. |
6565
| Core | Logs messages from the core runtime. This can be startup of the runtime, version of the runtime, license being used and issues related to interpreting the model. |
6666
| DataStorage_QueryHandling | Logs messages related to the queries that are being executed. |
67-
| DataStorage_QueryPlan | Query execution plan information for installations (currently only supported for PostgreSQL databases). |
67+
| DataStorage_QueryPlan | Logs the query plan used by the database for every query (currently only supported for PostgreSQL databases). {{% alert color="warning" %}}The `DataStorage_QueryPlan` log node has a very large performance impact and should not be enabled in production.{{% /alert %}} |
6868
| DocumentExporter | Logs messages related to the templating engine that generates documents. |
6969
| FileDocumentSizesPopulateJob | Logs messages for a background job that populates the file-size field in the database for documents that do not have that field filled (used during legacy migration). |
7070
| InvalidRequestLimiter | Logs messages related to responses being throttled due to invalid requests. |

content/en/docs/refguide8/runtime/logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ This list is currently incomplete and is being worked on.
6161
| Connector | |
6262
| Core | Logs messages from the core runtime. This can be startup of the runtime, version of the runtime, license being used and issues related to interpreting the model. |
6363
| DataStorage_QueryHandling | Logs messages related to the queries that are being executed. |
64-
| DataStorage_QueryPlan | Query execution plan information for installations (currently only supported for PostgreSQL databases). |
64+
| DataStorage_QueryPlan | Logs the query plan used by the database for every query (currently only supported for PostgreSQL databases). {{% alert color="warning" %}}The `DataStorage_QueryPlan` log node has a very large performance impact and should not be enabled in production.{{% /alert %}}
6565
| DocumentExporter | Logs messages related to the templating engine that generates documents. |
6666
| FileDocumentSizesPopulateJob | Logs messages for a background job that populates the file-size field in the database for documents that do not have that field filled (used during legacy migration). |
6767
| I18NProcessor | Logs messages related to translation of the app. |

content/en/docs/refguide9/runtime/logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ This list is currently incomplete and is being updated.
6464
| Connector | |
6565
| Core | Logs messages from the core runtime. This can be startup of the runtime, version of the runtime, license being used and issues related to interpreting the model. |
6666
| DataStorage_QueryHandling | Logs messages related to the queries that are being executed. |
67-
| DataStorage_QueryPlan | Query execution plan information for installations (currently only supported for PostgreSQL databases). |
67+
| DataStorage_QueryPlan | Logs the query plan used by the database for every query (currently only supported for PostgreSQL databases). {{% alert color="warning" %}}The `DataStorage_QueryPlan` log node has a very large performance impact and should not be enabled in production.{{% /alert %}}
6868
| DocumentExporter | Logs messages related to the templating engine that generates documents. |
6969
| FileDocumentSizesPopulateJob | Logs messages for a background job that populates the file-size field in the database for documents that do not have that field filled (used during legacy migration). |
7070
| IDResolution | Information on retrieval queries and runtime operations that are being executed. |

0 commit comments

Comments
 (0)