Merge pull request #10123 from passalaqua/dat/docs/misc-fixes-queryplan-settings

Misc fixes to datastorage settings and log nodes

Author: MarkvanMents

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

@@ -173,7 +173,11 @@ The database follows the below process:
 
 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.
 
-If you set the `DataStorage_QueryPlan` log node to Trace, you see the query plan for your queries in the Mendix Runtime log.
+If you set the `DataStorage_QueryPlan` log node to Debug, you see the query plan for all your queries in the Mendix Runtime log.
+
+{{% alert color="warning" %}}
+The `DataStorage_QueryPlan` log node has a very large performance impact and should never be enabled in production.
+{{% /alert %}}
 
 ## Read More
 

content/en/docs/refguide/runtime/custom-settings/_index.md

@@ -125,7 +125,7 @@ The settings below influence the behavior of the log files. These settings can o
 | <a id="DatabaseUserName" href="#DatabaseUserName">DatabaseUserName</a> | Name required for authentication to the database. | |
 | <a id="DatabasePassword" href="#DatabasePassword">DatabasePassword</a> | Password for the `DatabaseUserName` supplied above. | |
 | <a id="DatabaseHost" href="#DatabaseHost">DatabaseHost</a> | The host name and optionally the TCP port number of the database. Use a colon (`:`) as separator between the host name and port number. Possible values are: `db.url.org`, `db.url.org:1521`, `10.0.0.5`, and`10.0.0.5:1433`\. It is possible to use a plain IPv6 address by enclosing it in brackets (for example, `[::1]:5432`).<br/>This will be overridden if you supply [DatabaseJdbcUrl](#DatabaseJdbcUrl). | |
-| <a id="DatabaseName" href="#DatabaseName">DatabaseName</a> | The name of the database or schema used by the Mendix app <br/>This will be overridden if you supply [DatabaseJdbcUrl](#DatabaseJdbcUrl). | |
+| <a id="DatabaseName" href="#DatabaseName">DatabaseName</a> | The name of the database or schema used by the Mendix app <br/>Some database types require this even if a `DatabaseJdbcUrl` is defined. | |
 | <a id="DatabaseJdbcUrl" href="#DatabaseJdbcUrl">DatabaseJdbcUrl</a> | Defines the JDBC URL to use for the database connection (which overrides the other database connection settings). |   |
 | <a id="DatabaseUseSsl" href="#DatabaseUseSsl">DatabaseUseSsl</a> | When `true`, the connection will be made using SSL without certificate validation. If you need certificate validation, use [DatabaseJdbcUrl](#DatabaseJdbcUrl) instead.<br />When `false`, the connection will be made without SSL (this is only relevant for SQL Server, which uses SSL by default). | |
 | <a id="DatabaseUseIntegratedSecurity" href="#DatabaseUseIntegratedSecurity">DatabaseUseIntegratedSecurity</a> | This setting defines whether integrated security will be used to authenticate to SQL Server. If true, user name and password will not be used.<br />Ensure that the proper domain user for accessing the SQL Server is authenticated on the runtime server using the `kinit` command. | false |

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

@@ -68,7 +68,7 @@ This list is currently incomplete and is being updated.
 | 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. |
 | 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. |
 | DataStorage_QueryHandling | Logs messages related to the queries that are being executed. |
-| DataStorage_QueryPlan | Query execution plan information for installations (currently only supported for PostgreSQL databases). |
+| DataStorage_QueryPlan | Query execution plan information for installations (currently only supported for PostgreSQL databases). {{% alert color="warning" %}}The `DataStorage_QueryPlan` log node has a very large performance impact and should never be enabled in production.{{% /alert %}} |
 | DocumentExporter | Logs messages related to the templating engine that generates documents. |
 | 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). |
 | InvalidRequestLimiter | Logs messages related to responses being throttled due to invalid requests. |

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

@@ -124,7 +124,11 @@ The database follows the below process:
 
 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.
 
-If you set the `DataStorage_QueryPlan` log node to Trace, you see the query plan for your queries in the Mendix Runtime log.
+If you set the `DataStorage_QueryPlan` log node to Trace, you see the query plan for all your queries in the Mendix Runtime log.
+
+{{% alert color="warning" %}}
+The `DataStorage_QueryPlan` log node has a very large performance impact and should never be enabled in production.
+{{% /alert %}}
 
 ## Read More
 

content/en/docs/refguide10/runtime/custom-settings/_index.md

@@ -122,7 +122,7 @@ The settings below influence the behavior of the log files. These settings can o
 | <a id="DatabaseUserName" href="#DatabaseUserName">DatabaseUserName</a> | Name required for authentication to the database. | |
 | <a id="DatabasePassword" href="#DatabasePassword">DatabasePassword</a> | Password for the `DatabaseUserName` supplied above. | |
 | <a id="DatabaseHost" href="#DatabaseHost">DatabaseHost</a> | The host name and optionally the TCP port number of the database. Use a colon (`:`) as separator between the host name and port number. Possible values are: `db.url.org`, `db.url.org:1521`, `10.0.0.5`, and`10.0.0.5:1433`\. It is possible to use a plain IPv6 address by enclosing it in brackets (for example, `[::1]:5432`).<br/>This will be overridden if you supply [DatabaseJdbcUrl](#DatabaseJdbcUrl). | |
-| <a id="DatabaseName" href="#DatabaseName">DatabaseName</a> | The name of the database or schema used by the Mendix app <br/>This will be overridden if you supply [DatabaseJdbcUrl](#DatabaseJdbcUrl). | |
+| <a id="DatabaseName" href="#DatabaseName">DatabaseName</a> | The name of the database or schema used by the Mendix app <br/>Some database types require this even if a `DatabaseJdbcUrl` is defined. | |
 | <a id="DatabaseJdbcUrl" href="#DatabaseJdbcUrl">DatabaseJdbcUrl</a> | Defines the JDBC URL to use for the database connection (which overrides the other database connection settings). |   |
 | <a id="DatabaseUseSsl" href="#DatabaseUseSsl">DatabaseUseSsl</a> | When `true`, the connection will be made using SSL without certificate validation. If you need certificate validation, use [DatabaseJdbcUrl](#DatabaseJdbcUrl) instead.<br />When `false`, the connection will be made without SSL (this is only relevant for SQL Server, which uses SSL by default). | |
 | <a id="DatabaseUseIntegratedSecurity" href="#DatabaseUseIntegratedSecurity">DatabaseUseIntegratedSecurity</a> | This setting defines whether integrated security will be used to authenticate to SQL Server. If true, user name and password will not be used.<br />Ensure that the proper domain user for accessing the SQL Server is authenticated on the runtime server using the `kinit` command. | false |

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

@@ -64,7 +64,7 @@ This list is currently incomplete and is being updated.
 | 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. |
 | 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. |
 | DataStorage_QueryHandling | Logs messages related to the queries that are being executed. |
-| DataStorage_QueryPlan | Query execution plan information for installations (currently only supported for PostgreSQL databases). |
+| 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 never be enabled in production.{{% /alert %}} |
 | DocumentExporter | Logs messages related to the templating engine that generates documents. |
 | 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). |
 | InvalidRequestLimiter | Logs messages related to responses being throttled due to invalid requests. |

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

@@ -61,7 +61,7 @@ This list is currently incomplete and is being worked on.
 | Connector | |
 | 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. |
 | DataStorage_QueryHandling | Logs messages related to the queries that are being executed. |
-| DataStorage_QueryPlan | Query execution plan information for installations (currently only supported for PostgreSQL databases). |
+| 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 never be enabled in production.{{% /alert %}} |
 | DocumentExporter | Logs messages related to the templating engine that generates documents. |
 | 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). |
 | I18NProcessor | Logs messages related to translation of the app. |

content/en/docs/refguide9/runtime/custom-settings/_index.md

@@ -97,8 +97,8 @@ The settings below influence the behavior of the log files. These settings can o
 | <a id="DatabaseType" href="#DatabaseType">DatabaseType</a> | Defines the database engine which is used as the Mendix database. Valid values are `DB2`, `HSQLDB`, `MYSQL`, `ORACLE`, `POSTGRESQL`, `SAPHANA`, and `SQLSERVER`. | |
 | <a id="DatabaseUserName" href="#DatabaseUserName">DatabaseUserName</a> | Name required for authentication to the database. | |
 | <a id="DatabasePassword" href="#DatabasePassword">DatabasePassword</a> | Password for the `DatabaseUserName` supplied above. | |
-| <a id="DatabaseHost" href="#DatabaseHost">DatabaseHost</a> | The host name and optionally the TCP port number of the database. Use a colon (`:`) as separator between the host name and port number. Possible values are: `db.url.org`, `db.url.org:1521`, `10.0.0.5`, and`10.0.0.5:1433`\. It is possible to use a plain IPv6 address by enclosing it in brackets (for example, `[::1]:5432`).<br/>This will be overridden if you supply `DatabaseJdbcUrl`. | |
-| <a id="DatabaseName" href="#DatabaseName">DatabaseName</a> | The name of the database or schema used by the Mendix app <br/>This will be overridden if you supply **DatabaseJdbcUrl**. | |
+| <a id="DatabaseHost" href="#DatabaseHost">DatabaseHost</a> | The host name and optionally the TCP port number of the database. Use a colon (`:`) as separator between the host name and port number. Possible values are: `db.url.org`, `db.url.org:1521`, `10.0.0.5`, and`10.0.0.5:1433`\. It is possible to use a plain IPv6 address by enclosing it in brackets (for example, `[::1]:5432`).<br/>This will be overridden if you supply [DatabaseJdbcUrl](#DatabaseJdbcUrl). | |
+| <a id="DatabaseName" href="#DatabaseName">DatabaseName</a> | The name of the database or schema used by the Mendix app <br/>Some database types require this even if a `DatabaseJdbcUrl` is defined. | |
 | <a id="DatabaseJdbcUrl" href="#DatabaseJdbcUrl">DatabaseJdbcUrl</a> | Defines the JDBC URL to use for the database connection (which overrides the other database connection settings). |   |
 | <a id="DatabaseUseSsl" href="#DatabaseUseSsl">DatabaseUseSsl</a> | For PostgreSQL databases, defines whether the connection will be made using SSL without certificate validation. If you need certificate validation, use **DatabaseJdbcUrl** instead. | false |
 | <a id="DatabaseUseIntegratedSecurity" href="#DatabaseUseIntegratedSecurity">DatabaseUseIntegratedSecurity</a> | This setting defines whether integrated security will be used to authenticate to SQL Server. If true, user name and password will not be used.<br />If the runtime is not running on Windows, it must be instructed to use JavaKerberos authentication: for versions of Mendix below 9.23.0, add `;integratedSecurity=true;authenticationScheme=JavaKerberos` to **DatabaseJdbcUrl**. In addition, ensure that the proper domain user for accessing the SQL Server is authenticated on the runtime server using the `kinit` command. | false |

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

@@ -64,7 +64,7 @@ This list is currently incomplete and is being updated.
 | Connector | |
 | 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. |
 | DataStorage_QueryHandling | Logs messages related to the queries that are being executed. |
-| DataStorage_QueryPlan | Query execution plan information for installations (currently only supported for PostgreSQL databases). |
+| 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 never be enabled in production.{{% /alert %}} |
 | DocumentExporter | Logs messages related to the templating engine that generates documents. |
 | 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). |
 | IDResolution | Information on retrieval queries and runtime operations that are being executed. |