Skip to content

Commit 829f999

Browse files
Merge pull request mendix#10832 from mendix/kk-snow-tempmergebranch2
Reconciling changes for the Snowflake AI connector
2 parents 0aa4bb9 + 5d34b15 commit 829f999

34 files changed

Lines changed: 108 additions & 154 deletions

content/en/docs/marketplace/genai/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,5 +110,5 @@ The available showcase applications offer implementation inspiration for many of
110110
In addition to the models listed above, you can also connect to other models by implementing one of the following options:
111111

112112
* To connect to other [foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/models-features.html) and implement them in your app, use the [Amazon Bedrock connector](/appstore/modules/aws/amazon-bedrock/).
113-
* To connect to [Snowflake Cortex LLM](https://docs.snowflake.com/en/sql-reference/functions/complete-snowflake-cortex) functions, [configure the Snowflake REST SQL connector for Snowflake Cortex Analyst](/appstore/connectors/snowflake/snowflake-rest-sql/#cortex-analyst).
113+
* To connect to [Snowflake Cortex LLM](https://docs.snowflake.com/en/sql-reference/functions/complete-snowflake-cortex) functions, [configure the Snowflake AI Data Connector for Snowflake Cortex Analyst](/appstore/connectors/snowflake/snowflake-ai-data-connector/#cortex-analyst).
114114
* To implement your connector compatible with the other components, use the [GenAI Commons](/appstore/modules/genai/commons/) interface and follow the how-to [Build Your Own GenAI Connector](/appstore/modules/genai/how-to/byo-connector/).

content/en/docs/marketplace/genai/reference-guide/external-platforms/snowflake-cortex.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ description: "Describes the Snowflake Cortex service."
1212

1313
## Integrating Your Mendix App with Snowflake Cortex
1414

15-
To allow your Mendix app to use Snowflake Cortex GenAI functionalities, install and configure the [Snowflake REST SQL connector](/appstore/connectors/snowflake/snowflake-rest-sql/).
15+
To allow your Mendix app to use Snowflake Cortex GenAI functionalities, install and configure the [Snowflake AI Data Connector](/appstore/connectors/snowflake/snowflake-ai-data-connector/).
1616

1717
Mendix also offers a [Snowflake showcase app](https://marketplace.mendix.com/link/component/225845), which you can use as an example of how to implement the Cortex functionalities in your own app.
1818

@@ -37,7 +37,7 @@ Under the hood, the functionalities are implemented by calling them from microfl
3737

3838
### Implementing the Analyst Functionality
3939

40-
For more information about configuring the integration between Mendix and Snowflake Cortex Analyst, see [Configuring Snowflake Cortex Analyst](/appstore/connectors/snowflake/snowflake-rest-sql/#cortex-analyst).
40+
For more information about configuring the integration between Mendix and Snowflake Cortex Analyst, see [Configuring Snowflake Cortex Analyst](/appstore/connectors/snowflake/snowflake-ai-data-connector/#cortex-analyst).
4141

4242
### Implementing Other Functionalities {#functionalities}
4343

@@ -58,7 +58,7 @@ The [Snowflake showcase app](https://marketplace.mendix.com/link/component/22584
5858

5959
3. To see how a Snowflake Cortex Analyst action is called, use the **Explorer** search box to find and open the *EXAMPLE_CortexAnalyst_GenerateResponseMessage** microflow.
6060

61-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/CortexAnalystRequestExample.png" >}}
61+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/CortexAnalystRequestExample.png" >}}
6262

6363
This microflow calls the Snowflake Cortex Analyst function.
6464

content/en/docs/marketplace/platform-supported-content/modules/snowflake/_index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ Mendix has several options available for users who want to integrate their app w
1313

1414
## Snowflake Integration Options
1515

16-
The integration between Mendix and Snowflake is available in either direction. That is, you can use data from Snowflake in your Mendix app with the External Database connector or the REST SQL connector, but you can also ingest your Mendix data into Snowflake by using the Mendix Data Loader. For more information, refer to the sections below.
16+
The integration between Mendix and Snowflake is available in either direction. That is, you can use data from Snowflake in your Mendix app with the External Database connector or the Snowflake AI Data connector, but you can also ingest your Mendix data into Snowflake by using the Mendix Data Loader. For more information, refer to the sections below.
1717

1818
The following diagram outlines the available integration options:
1919

20-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/snowflake_architecture_setup.png" >}}
20+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/Snowflake Architecture slide.png" >}}
2121

2222
### Building Mendix Apps on Top of Snowflake
2323

24-
Mendix provides real-time interaction with Snowflake through the [External Database connector](https://marketplace.mendix.com/link/component/219862) and the [REST SQL connector](https://marketplace.mendix.com/link/component/225717). These connectors can enable you to perform the following tasks:
24+
Mendix provides real-time interaction with Snowflake through the [External Database connector](https://marketplace.mendix.com/link/component/219862) and the [Snowflake AI Data Connector](https://marketplace.mendix.com/link/component/225717). These connectors can enable you to perform the following tasks:
2525

2626
* Read, write, and use data from Snowflake in your application.
2727
* Execute Java [stored procedures](https://docs.snowflake.com/en/developer-guide/stored-procedure/stored-procedures-overview).
@@ -37,13 +37,13 @@ The External Database connector only supports system-level authentication. It ca
3737

3838
The External Database connector has GA support for Snowflake from [Studio Pro 10.12](/releasenotes/studio-pro/10.12/) (Beta versions are available from [Studio Pro 10.10](/releasenotes/studio-pro/10.10/)). Some Cortex functionalities are currently limited when using the External Database connector, but they are on the roadmap.
3939

40-
#### REST SQL Connector
40+
#### Snowflake AI Data Connector
4141

42-
The [REST SQL connector](https://marketplace.mendix.com/link/component/225717), available from the Mendix Marketplace, supports the 9.24 LTS version of Mendix. It offers key-pair authentication with a private key file according to PKCS #8 standard and OAuth.
42+
The [Snowflake AI Data Connector](https://marketplace.mendix.com/link/component/225717), available from the Mendix Marketplace, supports the 9.24 LTS version of Mendix. It offers key-pair authentication with a private key file according to PKCS #8 standard and OAuth.
4343

44-
With the REST SQL connector, authentication can be done either on system or on end-user level, and the connector supports role-based access control (RBAC) per end user as well.
44+
With the Snowflake AI Data Connector, authentication can be done either on system or on end-user level, and the connector supports role-based access control (RBAC) per end user as well.
4545

46-
The REST SQL connector requires an additional step to transform data rows received from the REST SQL API into Mendix objects. For more information, see [Snowflake REST SQL Connector](/appstore/connectors/snowflake/snowflake-rest-sql/).
46+
The Snowflake AI Data Connector requires an additional step to transform data rows received from the REST SQL API into Mendix objects. For more information, see [Snowflake AI Data Connector](/appstore/connectors/snowflake/snowflake-ai-data-connector/).
4747

4848
##### Role Base Access Control (RBAC)
4949

content/en/docs/marketplace/platform-supported-content/modules/snowflake/mendix-data-loader.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,12 +182,12 @@ Programmatically triggering an ingestion job can meet data ingestion requirement
182182
### Prerequisites
183183

184184
* A fully configured data source in the Mendix Data Loader
185-
* A Mendix app equipped with the Snowflake REST SQL connector
185+
* A Mendix app equipped with the Snowflake AI Data Connector
186186
* An authenticated user that is allowed to trigger stored procedures
187187

188188
### Triggering the Ingestion
189189

190-
To trigger an ingestion job programmatically, use the `ExecuteStatement` operation available in the [Snowflake REST SQL connector](/appstore/connectors/snowflake/snowflake-rest-sql/).
190+
To trigger an ingestion job programmatically, use the `ExecuteStatement` operation available in the [Snowflake AI Data Connector](/appstore/connectors/snowflake/snowflake-ai-data-connector/).
191191

192192
1. Obtain the Snowflake data source ID by performing the following steps:
193193

@@ -196,7 +196,7 @@ To trigger an ingestion job programmatically, use the `ExecuteStatement` operati
196196
3. Click **View** by the configured data source.
197197
4. Copy the value for the `ID` key.
198198

199-
2. In the Snowflake REST SQL connector, use the `ExecuteStatement` operation to execute the following statement:
199+
2. In the Snowflake AI Data Connector, use the `ExecuteStatement` operation to execute the following statement:
200200

201201
```sql
202202
CALL {NAME_OF_THE_MENDIX_DATA_LOADER}.MX_FUNCTIONS.RUN_INGESTION_JOB('{DATASOURCE_ID}','');

content/en/docs/marketplace/platform-supported-content/modules/snowflake/rbac/key-pair.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -16,38 +16,38 @@ In the context of integration between Snowflake and Mendix, RBAC helps ensure th
1616

1717
### Prerequisites
1818

19-
To enable key-pair RBAC for your Mendix app, you must first install and configure the [Snowflake REST SQL Connector](/appstore/connectors/snowflake/snowflake-rest-sql/).
19+
To enable key-pair RBAC for your Mendix app, you must first install and configure the [Snowflake AI Data Connector](/appstore/connectors/snowflake/snowflake-ai-data-connector/).
2020

2121
## Configuring the Connection Details {#connection-details}
2222

2323
To enable role-based access control for your Snowflake-integrated Mendix app, perform the following steps:
2424

2525
1. Ensure your Mendix app has the necessary domain model and entities, as shown in the following figure:
2626

27-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/domain-model.png" >}}
27+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/domain-model.png" >}}
2828

2929
2. Decide on the authentication method. For Snowflake, key-pair authentication is recommended.
3030
3. Configure the necessary keys and credentials in your Snowflake account and assign the public key to a Snowflake user. For more information, see [Key-pair authentication and key-pair rotation](https://docs.snowflake.com/en/user-guide/key-pair-auth) in the Snowflake documentation.
3131
4. In your Mendix app, create a new **Account Overview** page, were you can add the connection details to the users. A new **Connection Details** record is needed for every user that has access to data in Snowflake. The Connection Details object should be filled in at the end-user level.
3232

33-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/connection-details-account.png" >}}
33+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/connection-details-account.png" >}}
3434

3535
5. Optional: If using the [key-pair authentication method](https://docs.snowflake.com/en/user-guide/key-pair-auth), create a **Private Key** object to store each user's private key.
3636
6. Create a microflow that gets a **Connection Details** object associated with the account if it exists, or otherwise creates one along with a private key, as shown in the following figure:
3737

38-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/connection-details-microflow.png" >}}
38+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/connection-details-microflow.png" >}}
3939

4040
7. Create a microflow to redirect the user to a page where they can create or edit their connection details, as shown in the following figure:
4141

42-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/connection-details-newedit.png" >}}
42+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/connection-details-newedit.png" >}}
4343

4444
## Configuring the SQL Queries {#queries}
4545

4646
To interact with Snowflake, you must configure your Mendix app to execute SQL queries by using the **Execute Statement** microflow action.
4747

4848
1. In your Mendix app, create a microflow that contains the **Statement** object. This object contains the fields required for a statement.
4949

50-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/create-statement-object.png" >}}
50+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/create-statement-object.png" >}}
5151

5252
2. In the **SQL Statement** field, enter your SQL query. For example, to select the item and region data from the `Example_RBAC` table in Snowflake, enter the following query:
5353

@@ -60,28 +60,28 @@ To interact with Snowflake, you must configure your Mendix app to execute SQL qu
6060
3. Fill out the **Timeout**, **Database**, **Schema**, and **Warehouse** fields as required.
6161
4. In the **Role** field, specify the Snowflake user role to be used for executing the query, or leave the field blank if you want the statement to be executed with the user's default role in Snowflake. Keep in mind that the user only has access to the warehouse, schema, database, and data granted to their assigned user role.
6262
5. Add a **Retrieve Objects** action after the **Statement** object.
63-
6. In the **XPath constraint** field, enter the following XPath: `[SnowflakeRESTSQL.ConnectionDetails_Account = $currentUser]`
63+
6. In the **XPath constraint** field, enter the following XPath: `[SnowflakeAIDataConnector.ConnectionDetails_Account = $currentUser]`
6464
65-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/retrieve-details.png" >}}
65+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/retrieve-details.png" >}}
6666
6767
This ensures that the connection details are the ones associated with the current user account, so that the user can only access the data to which they have access in Snowflake.
6868
69-
7. Add an **Execute Statement** action provided by the [Rest SQL Connector](/appstore/connectors/snowflake/snowflake-rest-sql/) after the **Retrieve Objects** action.
69+
7. Add an **Execute Statement** action provided by the [Snowflake AI Data Connector](/appstore/connectors/snowflake/snowflake-ai-data-connector/) after the **Retrieve Objects** action.
7070
8. Configure the **Statement** and **ConnectionDetails** parameters as shown in the following figure:
7171
72-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/execute-statement.png" >}}
72+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/execute-statement.png" >}}
7373
74-
9. If required, map the HTTP Response to an MxObject by using an [import mapping](/refguide/import-mappings/), or by adding a [Transform Responses to MxObjects](/appstore/connectors/snowflake/snowflake-rest-sql/#transform-response-to-mx-object) microflow action, as shown in the following figure:
74+
9. If required, map the HTTP Response to an MxObject by using an [import mapping](/refguide/import-mappings/), or by adding a [Transform Responses to MxObjects](/appstore/connectors/snowflake/snowflake-ai-data-connector/#transform-response-to-mx-object) microflow action, as shown in the following figure:
7575
76-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/execute-statement-microflow.png" >}}
76+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/execute-statement-microflow.png" >}}
7777
7878
The **Transform Responses** action creates a single table with the HTTP Response data. To do that, it requires a domain model entity with the attributes names being exactly as the same the returned response attributes. For example, for the sample query used in step 2, you should configure the following domain model entity:
7979
80-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/mapping-entity.png" >}}
80+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/mapping-entity.png" >}}
8181
8282
10. Create a page in your app to display the results of the query.
8383
84-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/sample-results.png" >}}
84+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/sample-results.png" >}}
8585
8686
## Sample Test Scenario
8787
@@ -218,20 +218,20 @@ This section provides an example of how to set up RBAC in Snowflake for two test
218218
FROM EXAMPLE_RBAC;
219219
```
220220
221-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/test-user1-snowflake.png" >}}
221+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/test-user1-snowflake.png" >}}
222222
223223
13. Log in to Snowflake with the **TestUser2** account and execute the same statement.
224224
225-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/test-user2-snowflake.png" >}}
225+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/test-user2-snowflake.png" >}}
226226
227227
14. In your Mendix app, configure the [connection details for your test users](#connection-details), as well as the [Execute Statement microflow](#queries).
228228
15. Create and assign the public key and the private key to the equivalent users in Snowflake.
229229
16. Log in to your Mendix app as **TestUser1**.
230230
17. Verify that you can view the same data as in Snowflake.
231231
232-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/test-user1-mendix.png" >}}
232+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/test-user1-mendix.png" >}}
233233
234234
18. Log in to your Mendix app as **TestUser2**.
235235
19. Verify that you can view the same data as in Snowflake.
236236
237-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-rest-sql/test-user2-mendix.png" >}}
237+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-ai-data-connector/test-user2-mendix.png" >}}

content/en/docs/marketplace/platform-supported-content/modules/snowflake/rbac/snowflake-sso.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can integrate between Snowflake and Mendix applications by using OAUTH provi
2121
To enable SSO-based RBAC for your Mendix app, you must install and configure the following prerequisites:
2222

2323
* [OIDC SSO module](/appstore/modules/oidc/).
24-
* [Snowflake REST SQL Connector](https://docs.mendix.com/appstore/connectors/snowflake/snowflake-rest-sql/)
24+
* [Snowflake AI Data Connector](https://docs.mendix.com/appstore/connectors/snowflake/snowflake-ai-data-connector/)
2525

2626
## Configuring Azure Entra ID
2727

@@ -164,7 +164,7 @@ To configure your Mendix application, perform the following steps:
164164
* name – FullName
165165
* preferred_username – Name
166166
167-
12. Go to the configuration page of the [Snowflake RestSQL connector](/appstore/connectors/snowflake/snowflake-rest-sql/) and add a new connection.
167+
12. Go to the configuration page of the [Snowflake AI Data Connector](/appstore/connectors/snowflake/snowflake-ai-data-connector/) and add a new connection.
168168
13. Select OAUTH as the "Authentication Type".
169169
170170
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-sso/RestSQLOAuth.png" >}}

0 commit comments

Comments
 (0)