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..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 @@ -9,6 +9,10 @@ aliases: ## Introduction +{{% alert color="info" %}} +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). ## Use Cases @@ -139,6 +143,10 @@ 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. +{{% /alert %}} + ### Using Query Response {#use-query-response} After querying the database, you can view the response in the **Response** screen. @@ -261,16 +269,28 @@ 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.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. + * `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 5e631f501ad..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,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/). +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} @@ -25,6 +26,12 @@ 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 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 If you select **Use connection details**, enter: @@ -101,5 +108,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. 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..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,7 +22,10 @@ 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*. +{{% 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.