From 1b209b52ff3b83b1288084a5e5851a90600e58d1 Mon Sep 17 00:00:00 2001 From: SurabhiSaraf <83819512+SurabhiSaraf@users.noreply.github.com> Date: Wed, 22 Jul 2026 15:20:14 +0530 Subject: [PATCH 1/6] Update _index.md --- .../external-database-connector/_index.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/_index.md b/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/_index.md index 5e631f501ad..dd1cda62318 100644 --- a/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/_index.md +++ b/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/_index.md @@ -11,7 +11,8 @@ description: "Overview of how to configure the [External Database Connection doc The [External Database Connector](/appstore/modules/external-database-connector/) integrates with Studio Pro with an **External database connection** service document. Use this document to connect to external databases in Studio Pro. {{% alert color="info" %}} -You must install the [External Database Connector](https://marketplace.mendix.com/link/component/219862) for external database connections to work properly while running your app. For instructions on adding modules or connectors to your app, see [Use Marketplace Content in Studio Pro](/appstore/use-content/). +**Studio Pro 11.12 and earlier:** You must install the [External Database Connector](https://marketplace.mendix.com/link/component/219862) from the Marketplace for external database connections to work. For instructions, see [Use Marketplace Content in Studio Pro](/appstore/use-content/). +**Studio Pro 11.13 and later:** External database connectivity is built into Studio Pro — no Marketplace download is required. {{% /alert %}} ## Connect to the Database Wizard {#wizard} @@ -25,6 +26,11 @@ Enter or select the following: * **Name** — name of your database connection * **Database Type** — Microsoft SQL, MySQL, Oracle, PostgreSQL, or Snowflake +{{% alert color="info" %}} +From Studio Pro 11.13, when you select a database type, the required JDBC library is automatically added to the **Java Dependencies** tab in [Module Settings](/refguide/module-settings/) of the module you are working on. The dependency is downloaded to the **vendorlib** folder when you run the app or trigger Java dependency management. To use a different version, you can edit the dependency in [Module Settings](/refguide/module-settings/). +For BYOD user has to add the required JDBC driver details in module settings +{{% /alert %}} + ### Connection Details If you select **Use connection details**, enter: @@ -101,5 +107,4 @@ The **Response Structure** tab displays a preview of an entity that can be creat * To configure the connector with an external database, follow the steps in [External Database Connector](/appstore/modules/external-database-connector/). * To utilize the connector to integrate data into your Mendix application, see [Querying and Integrating External Data](/refguide/use-the-external-database-connector/). -* To use SQL, see [Execute an SQL Statement on an External Database](/refguide/execute-an-sql-statement-on-an-external-database/). * To learn about how to use the data in a microflow, see the [Query External Database](/refguide/query-external-database/) activity. From 9706281839f950cf3d825d9f7cdb884cd3514cda Mon Sep 17 00:00:00 2001 From: SurabhiSaraf <83819512+SurabhiSaraf@users.noreply.github.com> Date: Wed, 22 Jul 2026 15:23:26 +0530 Subject: [PATCH 2/6] Update query-and-integrate-external-data.md --- .../query-and-integrate-external-data.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/query-and-integrate-external-data.md b/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/query-and-integrate-external-data.md index 3626d8a2d2d..0342bac6ffa 100644 --- a/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/query-and-integrate-external-data.md +++ b/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/query-and-integrate-external-data.md @@ -22,7 +22,8 @@ This document teaches you how to do the following: ## Prerequisites -Ensure you have an active connection using the External Database Connection document. For information on how to configure the connector, see [External Database Connector](/appstore/modules/external-database-connector/) in the *Marketplace Guide*. +***Studio Pro 11.12 and earlier: Ensure you have an active connection using the External Database Connection document. For information on how to configure the connector, see [External Database Connector](/appstore/modules/external-database-connector/) in the *Marketplace Guide*. +***Studio Pro 11.13 and later: External database connectivity is built into Studio Pro — no Marketplace download is required. {{% /alert %}} * If additional connection properties are required to connect, you can alternatively use **JDBC Connection String**. * If certificate-based authentication is required for PostgreSQL connections, ensure that all necessary certificates are added before running the app. From fe76609bfb51e8490a34b8a0f6eceb882a74669f Mon Sep 17 00:00:00 2001 From: SurabhiSaraf <83819512+SurabhiSaraf@users.noreply.github.com> Date: Wed, 22 Jul 2026 15:32:31 +0530 Subject: [PATCH 3/6] Update external-database-connector.md --- .../modules/external-database-connector.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md b/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md index 66449be4f7c..7ffcb795dab 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md @@ -9,6 +9,10 @@ aliases: ## Introduction +{{% alert color="info" %}} +You do not need to download this module from the Marketplace if you are using Studio Pro 11.13 or later, as it is included as part of the Studio Pro offering.For more details see [Connect to an External Database](/refguide/external-database-connection/). +{{% /alert %}} + Connect to Microsoft SQL, MySQL, PostgreSQL, Oracle, and Snowflake databases with the [External Database Connector](https://marketplace.mendix.com/link/component/219862). ## Use Cases From 0c98f74f313f748ec17a378f18ed495dd4d4dd7f Mon Sep 17 00:00:00 2001 From: SurabhiSaraf <83819512+SurabhiSaraf@users.noreply.github.com> Date: Wed, 22 Jul 2026 17:48:35 +0530 Subject: [PATCH 4/6] Update external-database-connector.md --- .../modules/external-database-connector.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md b/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md index 7ffcb795dab..4bb9a2f6fee 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md @@ -265,8 +265,9 @@ To connect to PostgreSQL when the application is running in Mendix Cloud, follow ### Configure Database Schema Information -The Browse Database Schema tab might not display a comprehensive overview of all available schemas for certain databases. You can customize this behavior using the Configure option. To do so, follow these steps: +The Browse Database Schema tab might not display a comprehensive overview of all available schemas for certain databases. You can customize this behavior using the Configure option. +If you are using Studio-pro 11.12 or earlier, Follow below steps 1. Open the **App** menu and select **Deploy for Eclipse**. 2. Extend the class MxQueryBasedSchemaInfoProvider. 3. Override the following methods based on your requirements: @@ -276,6 +277,16 @@ The Browse Database Schema tab might not display a comprehensive overview of all * getFunctionMetaDataQuery 4. Use the provided example, MxDb2SchemaInfoProvider for IBM Db2, for a better understanding of how to customize the schema information. +If you are on Studio-pro 11.13 or later version, Please follow below steps: +1.Use Mendix public API class QueryBasedSchemaInfoProvider to extend your java class. +for example : Create MxDb2SchemaInfoProvider.java inside \MendixApp\javasource\myfirstmodule\myloader +2.Override the following methods based on your requirements: + * getTableMetaDataQuery + * getViewMetaDataQuery + * getProcedureMetaDataQuery + * getFunctionMetaDataQuery + + ### Running Queries and Handling Query Responses Execute queries as you would with supported databases, and retrieve responses in the associated entity. Refer to the documentation of your specific JDBC library for detailed syntax and execution options. From 9f58a7066ee9e488ac8dcd1fb0e440d79530cfa1 Mon Sep 17 00:00:00 2001 From: SurabhiSaraf <83819512+SurabhiSaraf@users.noreply.github.com> Date: Wed, 22 Jul 2026 18:26:45 +0530 Subject: [PATCH 5/6] Update external-database-connector.md --- .../modules/external-database-connector.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md b/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md index 4bb9a2f6fee..cce6f58dbe3 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md @@ -142,6 +142,9 @@ WHERE empno IN ``` Here, the parameter `EmpIdList` is of type String with the value `[1,7946,3,4,7942,7943,7945]`. +{{% alert color="info" %}} +Parameter names cannot start with a number, following the Mendix naming convention. +{{% /alert %}} ### Using Query Response {#use-query-response} From dc6a8d0289e2e2fdb41c324f39999600bec501e1 Mon Sep 17 00:00:00 2001 From: Quinn Tracy <142489060+quinntracy@users.noreply.github.com> Date: Wed, 22 Jul 2026 15:50:35 +0200 Subject: [PATCH 6/6] Review --- .../modules/external-database-connector.md | 38 ++++++++++--------- .../external-database-connector/_index.md | 9 +++-- .../query-and-integrate-external-data.md | 6 ++- 3 files changed, 29 insertions(+), 24 deletions(-) diff --git a/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md b/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md index cce6f58dbe3..ed66c7a6766 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/external-database-connector.md @@ -10,7 +10,7 @@ aliases: ## Introduction {{% alert color="info" %}} -You do not need to download this module from the Marketplace if you are using Studio Pro 11.13 or later, as it is included as part of the Studio Pro offering.For more details see [Connect to an External Database](/refguide/external-database-connection/). +If you are using Studio Pro 11.13 or later, you do not need to download this module from the Marketplace, as the External Database Connector comes included with Studio Pro. For more information, see [Connect to an External Database](/refguide/external-database-connection/). {{% /alert %}} Connect to Microsoft SQL, MySQL, PostgreSQL, Oracle, and Snowflake databases with the [External Database Connector](https://marketplace.mendix.com/link/component/219862). @@ -142,8 +142,9 @@ WHERE empno IN ``` Here, the parameter `EmpIdList` is of type String with the value `[1,7946,3,4,7942,7943,7945]`. + {{% alert color="info" %}} -Parameter names cannot start with a number, following the Mendix naming convention. +Parameter names cannot start with a number. {{% /alert %}} ### Using Query Response {#use-query-response} @@ -270,24 +271,25 @@ To connect to PostgreSQL when the application is running in Mendix Cloud, follow The Browse Database Schema tab might not display a comprehensive overview of all available schemas for certain databases. You can customize this behavior using the Configure option. -If you are using Studio-pro 11.12 or earlier, Follow below steps +If you are using Studio Pro 11.13 or later, follow the steps below: + +1. Use the Mendix public API class QueryBasedSchemaInfoProvider to extend your Java class. For example, create `MxDb2SchemaInfoProvider.java` inside `\MendixApp\javasource\myfirstmodule\myloader`. +2. Override the following methods based on your requirements: + * `getTableMetaDataQuery` + * `getViewMetaDataQuery` + * `getProcedureMetaDataQuery` + * `getFunctionMetaDataQuery` + +If you are using Studio Pro 11.12 or earlier, follow the steps below: + 1. Open the **App** menu and select **Deploy for Eclipse**. -2. Extend the class MxQueryBasedSchemaInfoProvider. +2. Extend the class `MxQueryBasedSchemaInfoProvider`. 3. Override the following methods based on your requirements: - * getTableMetaDataQuery - * getViewMetaDataQuery - * getProcedureMetaDataQuery - * getFunctionMetaDataQuery -4. Use the provided example, MxDb2SchemaInfoProvider for IBM Db2, for a better understanding of how to customize the schema information. - -If you are on Studio-pro 11.13 or later version, Please follow below steps: -1.Use Mendix public API class QueryBasedSchemaInfoProvider to extend your java class. -for example : Create MxDb2SchemaInfoProvider.java inside \MendixApp\javasource\myfirstmodule\myloader -2.Override the following methods based on your requirements: - * getTableMetaDataQuery - * getViewMetaDataQuery - * getProcedureMetaDataQuery - * getFunctionMetaDataQuery + * `getTableMetaDataQuery` + * `getViewMetaDataQuery` + * `getProcedureMetaDataQuery` + * `getFunctionMetaDataQuery` +4. Use the provided example, `MxDb2SchemaInfoProvider` for IBM Db2, for a better understanding of how to customize the schema information. ### Running Queries and Handling Query Responses diff --git a/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/_index.md b/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/_index.md index dd1cda62318..998e500a1ee 100644 --- a/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/_index.md +++ b/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/_index.md @@ -11,8 +11,8 @@ description: "Overview of how to configure the [External Database Connection doc The [External Database Connector](/appstore/modules/external-database-connector/) integrates with Studio Pro with an **External database connection** service document. Use this document to connect to external databases in Studio Pro. {{% alert color="info" %}} -**Studio Pro 11.12 and earlier:** You must install the [External Database Connector](https://marketplace.mendix.com/link/component/219862) from the Marketplace for external database connections to work. For instructions, see [Use Marketplace Content in Studio Pro](/appstore/use-content/). -**Studio Pro 11.13 and later:** External database connectivity is built into Studio Pro — no Marketplace download is required. +For Studio Pro 11.13 and later, external database connectivity is built into Studio Pro. Therefore you do not need to download the Marketplace module for use. +For Studio Pro 11.12 and earlier, you must install the [External Database Connector](https://marketplace.mendix.com/link/component/219862) from the Marketplace for external database connections to work. For instructions, see [Use Marketplace Content in Studio Pro](/appstore/use-content/). {{% /alert %}} ## Connect to the Database Wizard {#wizard} @@ -27,8 +27,9 @@ Enter or select the following: * **Database Type** — Microsoft SQL, MySQL, Oracle, PostgreSQL, or Snowflake {{% alert color="info" %}} -From Studio Pro 11.13, when you select a database type, the required JDBC library is automatically added to the **Java Dependencies** tab in [Module Settings](/refguide/module-settings/) of the module you are working on. The dependency is downloaded to the **vendorlib** folder when you run the app or trigger Java dependency management. To use a different version, you can edit the dependency in [Module Settings](/refguide/module-settings/). -For BYOD user has to add the required JDBC driver details in module settings +From Studio Pro 11.13 and later, when you select a database type, the required JDBC library is automatically added to the **Java Dependencies** tab in [Module Settings](/refguide/module-settings/) of the module you are working on. The dependency is downloaded to the **vendorlib** folder when you run the app or trigger Java dependency management. To use a different version, you can edit the dependency in [Module Settings](/refguide/module-settings/). + +For BYOD, you have to add the required JDBC driver details in Module Settings. {{% /alert %}} ### Connection Details diff --git a/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/query-and-integrate-external-data.md b/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/query-and-integrate-external-data.md index 0342bac6ffa..8d0763aca80 100644 --- a/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/query-and-integrate-external-data.md +++ b/content/en/docs/refguide/modeling/integration/use-platform-supported-content/external-database-connector/query-and-integrate-external-data.md @@ -22,8 +22,10 @@ This document teaches you how to do the following: ## Prerequisites -***Studio Pro 11.12 and earlier: Ensure you have an active connection using the External Database Connection document. For information on how to configure the connector, see [External Database Connector](/appstore/modules/external-database-connector/) in the *Marketplace Guide*. -***Studio Pro 11.13 and later: External database connectivity is built into Studio Pro — no Marketplace download is required. {{% /alert %}} +{{% alert type="info" %}} +For Studio Pro 11.13 and later, external database connectivity is built into Studio Pro. Therefore you do not need to download the Marketplace module for use. + +For Studio Pro 11.12 and earlier, ensure you have an active connection using the External Database Connection document. For information on how to configure the connector, see [External Database Connector](/appstore/modules/external-database-connector/) in the *Marketplace Guide*. {{% /alert %}} * If additional connection properties are required to connect, you can alternatively use **JDBC Connection String**. * If certificate-based authentication is required for PostgreSQL connections, ensure that all necessary certificates are added before running the app.