diff --git a/content/en/docs/marketplace/platform-supported-content/modules/databricks-edc.md b/content/en/docs/marketplace/platform-supported-content/modules/databricks-edc.md index cc71e2b3005..52f1e94c6c9 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/databricks-edc.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/databricks-edc.md @@ -9,6 +9,8 @@ description: "Describes the steps required to use the Mendix External Database c The [External Database connector](/appstore/modules/external-database-connector/) allows you to connect to databases and select data to use in your app. You can use it to directly test connections and queries during configuration in Studio Pro at design time. For Mendix apps that use Databricks as their database, the External Database connector is the recommended integration option for Mendix 10.20.0 and above. +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/). + This how-to describes the steps required to enable your app to use the External Database connector with Databricks. ## Prerequisites @@ -19,10 +21,10 @@ For some general information on how to use bring your own JDBC driver with the e To connect your Mendix application to Databricks with the External Database connector, follow these steps: -1. Install the [External Database connector](https://marketplace.mendix.com/link/component/219862) version 5.1.1 or higher. +1. Optional: If your Studio Pro version is older than 11.13, install the [External Database connector](https://marketplace.mendix.com/link/component/219862) version 5.1.1 or higher. 2. Ensure that you have the required Databricks JDBC Driver by choosing one of the following options: - * To have the dependency downloaded automatically on running your project, add a **Java Dependency** in the **Settings** of you module and provide the following information: + * To have the dependency downloaded automatically on running your project, add a **Java Dependency** in the **Settings** of your module and provide the following information: * **Group ID** - set to **com.databricks** * **Artifact ID** - set to **databricks-jdbc** * **Version** - set to the latest **2.x** version diff --git a/content/en/docs/marketplace/platform-supported-content/modules/edc-aws-athena.md b/content/en/docs/marketplace/platform-supported-content/modules/edc-aws-athena.md new file mode 100644 index 00000000000..0d2618d91c9 --- /dev/null +++ b/content/en/docs/marketplace/platform-supported-content/modules/edc-aws-athena.md @@ -0,0 +1,66 @@ +--- +title: "Configure the External Database Connector for Amazon Athena" +linktitle: "Amazon Athena" +url: /appstore/modules/athena-external-database-connector/ +description: "Describes the steps required to use the Mendix External Database connector with Amazon Athena." +--- + +## Introduction + +The [External Database connector](/appstore/modules/external-database-connector/) allows you to connect to databases and select data to use in your app. You can use it to directly test connections and queries during configuration in Studio Pro at design time. + +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/). + +## Prerequisites + +For some general information on how to use bring your own JDBC driver with the external database connector, read [External Database Connector: Configure for Any Database](/appstore/modules/external-database-connector/#byod). + +## Configuring the Connection Between Your Mendix App and Amazon Athena + +To connect your Mendix application to Amazon Athena with the External Database connector, follow these steps: + +1. Optional: If your Studio Pro version is older than 11.13, install the [External Database connector](https://marketplace.mendix.com/link/component/219862). +2. Ensure that you have the required Amazon Athena JDBC Driver by choosing one of the following options: + + * To have the dependency downloaded automatically on running your project, add a **Java Dependency** in the **Settings** of your module and provide the following information: + + * **Group ID** - set to **com.amazonaws.athena.jdbc** + * **Artifact ID** - set to **AthenaJDBC42** + * **Version** - set to the latest version + + * To install the dependency manually, download the latest version of the [JDBC driver](https://docs.aws.amazon.com/athena/latest/ug/jdbc-v3-driver.html#jdbc-v3-driver-download) that Amazon Athena provides and put the .jar file into the *userlib* of your Mendix project. + + AWS supplies the Athena JDBC driver as one of the following driver packages: + + * The *uber* .jar contains all dependencies packed into a single fat .jar + * The *lean* .jar ontains only the driver .jar, with all dependencies as separate .jars. + +3. Rerun your app to load the driver. +4. Run the [Connect to Database wizard](/appstore/modules/external-database-connector/#configuration), selecting **Other** as the database type, and provide the following configuration parameters: + + * **JDBC Connection String** - Provide the JDBC URL. You can create it using the following template: + + ```text + jdbc:awsathena://athena.eu-central-1.amazonaws.com:443;AwsRegion=;Workgroup=;S3OutputLocation= + ``` + + If you are using a temporary Access Key and Secret, you must also add a Session Token to the URL: `SessionToken=`, + + * **Username** - Enter the Access Key, if you are using it. + * **Password** - Enter the Secret Access Key, if you are using it. + +{{< figure src="/attachments/appstore/platform-supported-content/modules/aws-athena/athena1.png" >}} + +For advanced connection use cases, see [Amazon Athena JDBC 3.x connection parameters - Amazon Athena](https://docs.aws.amazon.com/athena/latest/ug/jdbc-v3-driver-connection-parameters.html). + +## Configuring Metadata Discovery + +After the connection is established, you will see an error log like the following: *Unrecognized table type: "BASE TABLE"*. The tables and views explorer will be empty.This is because the External Database Connector module does not support Amazon Athena out of the box and therefore cannot explore the tables and views. + +To enable metadata discovery, you must add a custom Java class for exploring database objects. For more information, see [External Database Connector](/appstore/modules/external-database-connector/#configure-database-schema-information). + +## Running Queries and Handling Query Responses + +Execute queries in the same way as you would with the supported databases and retrieve responses in the associated entity. For more information about syntax and execution options, refer to the documentation of your specific JDBC library. + +For full usage documentation, including how to use query output as an entity, see [External Database Connector](/appstore/modules/external-database-connector/#configure-database-schema-information). \ No newline at end of file diff --git a/content/en/docs/marketplace/platform-supported-content/modules/snowflake/snowflake-edc.md b/content/en/docs/marketplace/platform-supported-content/modules/snowflake/snowflake-edc.md index a3102806be7..e9e8210d097 100644 --- a/content/en/docs/marketplace/platform-supported-content/modules/snowflake/snowflake-edc.md +++ b/content/en/docs/marketplace/platform-supported-content/modules/snowflake/snowflake-edc.md @@ -10,6 +10,8 @@ weight: 10 The [External Database connector](/appstore/modules/external-database-connector/) allows you to connect to databases and select data to use in your app. You can use it to directly test connections and queries during configuration in Studio Pro (design time). For Mendix apps that work with Snowflake data, the External Database connector is the recommended integration option for Mendix 10 and above. +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/). + This how-to describes the steps required to enable your app to use the External Database connector with Snowflake, and to model several common use cases. ## Configuring the Connection Between Your Mendix App and Snowflake @@ -18,7 +20,7 @@ The External Database connector only supports system-level authentication. It ca To configure connect your Mendix application to Snowflake with the External Database connector, follow these steps: -1. [Install the External Database connector](/appstore/modules/external-database-connector/#installation). If you are using Studio Pro 10.12, please make sure to use the latest version 3.0.0 [External Database Connector](https://marketplace.mendix.com/link/component/219862). +1. Optional: If your Studio Pro version is older than 11.13, install the [External Database connector](https://marketplace.mendix.com/link/component/219862). If you are using Studio Pro 10.12, please make sure to use the latest version 3.0.0 [External Database Connector](https://marketplace.mendix.com/link/component/219862). 2. Run the [Connect to Database wizard](/appstore/modules/external-database-connector/#configuration) and select **Snowflake** as the database type. 3. Provide a name for the database connection document. 4. Provide connection details that can be used to access Snowflake. You can either provide a connection string, or enter connection details. If you enter connection details, a constant with a connection string will be created based on your connection details. diff --git a/static/attachments/appstore/platform-supported-content/modules/aws-athena/athena1.png b/static/attachments/appstore/platform-supported-content/modules/aws-athena/athena1.png new file mode 100644 index 00000000000..08914298fc7 Binary files /dev/null and b/static/attachments/appstore/platform-supported-content/modules/aws-athena/athena1.png differ