Skip to content

Commit

Permalink
extra back-links for snowflake oauth documentation (#750)
Browse files Browse the repository at this point in the history
  • Loading branch information
alpetric authored Nov 4, 2024
1 parent 843cdee commit 21ac4b6
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ You can directly "Test connection" if needed.

To be able to connect to [Snowflake](https://www.snowflake.com/), you can choose to either setup [OAuth for Snowflake](/docs/misc/setup_oauth#oauth) or by defining a Snowflake Resource.

If a Snowflake OAuth connection is present, you can create a new Resource by heading to <a href="https://app.windmill.dev/resources" rel="nofollow">Resources</a>, clicking on "Add Resource" in the top right corner and selecting `snowflake_oauth`.
If a Snowflake OAuth connection is present, you can create a new Resource by heading to <a href="https://app.windmill.dev/resources" rel="nofollow">Resources</a>, clicking on "Add Resource" in the top right corner and selecting `snowflake_oauth`. Take a look at [this guide](/docs/misc/guides/snowflake#sample-app-setup) to learn more about how to build an App with Snowflake OAuth integration.

If you do not wish to use OAuth, click on "Add Resource" in the top right corner and select the `Snowflake` type instead.

Expand Down
14 changes: 12 additions & 2 deletions docs/integrations/snowflake.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,21 @@ Windmill natively supports Snowflake scripts:
description="Learn how to build your first script in PostgreSQL, MySQL, BigQuery, Snowflake."
href="/docs/getting_started/scripts_quickstart/sql"
/>
<DocCard
title="Build a Sample Snowflake App using OAuth"
description="Learn how to build a sample Windmill App using Snowflake OAuth"
href="/docs/misc/guides/snowflake#sample-app-setup"
/>
<DocCard
title="Configure Snowflake OAuth"
description="How to configure a Snowflake OAuth connection"
href="/docs/misc/setup_oauth#snowflake"
/>
</div>

To integrate [Snowflake](https://www.snowflake.com/en/) with Windmill, you need to gather the following information and save it as a [resource](../core_concepts/3_resources_and_types/index.mdx).
To integrate [Snowflake](https://www.snowflake.com/en/) with Windmill, you can either [create and OAuth connection](/docs/misc/setup_oauth#snowflake) or you need to gather the following information and save it as a [resource](../core_concepts/3_resources_and_types/index.mdx).

![Add BigQuery Resource](../assets/integrations/add-snowflake.png.webp)
![Add Snowflake Resource](../assets/integrations/add-snowflake.png.webp)

| Property | Type | Description | Default | Required | Where to Find |
| ------------------ | ------ | ------------------------------------- | ------- | -------- | --------------------------------------------------------------- |
Expand Down
2 changes: 2 additions & 0 deletions docs/misc/2_setup_oauth/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,8 @@ The same steps apply to enable more APIs (**Gmail**, **Gdrive**, etc.) on your G

- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "snowflake_oauth" and set the **client id**, **client secret** and **account identifier**.

Take a look at [this guide](/docs/misc/guides/snowflake#sample-app-setup) to learn more about how to build an App with the Snowflake OAuth integration.

### Custom OAuth

Under [Enterprise Edition](/pricing), you can add a completely custom OAuth without requiring a dev setup. The item accepts an extra optional field: `connect_config` or `login_config` of type OAuthConfig:
Expand Down
2 changes: 1 addition & 1 deletion docs/misc/9_guides/snowflake/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import DocCard from '@site/src/components/DocCard';

# Build an App Accessing Snowflake with End-User Roles

This guide walks you through building an application that accesses Snowflake data based on the end-user’s role, using OAuth in Windmill. By leveraging dynamic role-based credentials from Snowflake’s OAuth integration, we avoid static credentials and enable secure data access customized for each user.
This guide walks you through building an application that accesses Snowflake data based on the end-user’s role, using OAuth in Windmill. By leveraging dynamic role-based credentials from Snowflake’s OAuth integration, we avoid static credentials and enable secure data access customized for each user. This can be particularly useful for organizations with strict data access policies and multiple user roles where [row access policies](https://docs.snowflake.com/en/user-guide/security-row-intro) are set up.

The tutorial includes steps to set up Snowflake OAuth, configure user roles, and create UI components in Windmill for a seamless, role-specific data experience.

Expand Down

0 comments on commit 21ac4b6

Please sign in to comment.