Skip to content

docs: add Snowflake connector example guide#47

Open
vishwajayawickrama wants to merge 2 commits intowso2:devfrom
vishwajayawickrama:docs/add-snowflake-connector-example-documentation
Open

docs: add Snowflake connector example guide#47
vishwajayawickrama wants to merge 2 commits intowso2:devfrom
vishwajayawickrama:docs/add-snowflake-connector-example-documentation

Conversation

@vishwajayawickrama
Copy link

Purpose

Adds a step-by-step example guide for the Snowflake connector, covering connection setup and the Query operation with embedded screenshots.

Goals

  • Provide a complete walkthrough for configuring the Snowflake connector in the WSO2 Integrator low-code canvas
  • Include annotated screenshots at each key configuration step

Approach

Content generated by the connector-docs-automations pipeline. Example page preview screenshots are included at the bottom of this description.

Release note

Added Snowflake connector example guide showing how to configure the Query operation using the WSO2 Integrator low-code canvas.

Documentation

  • en/docs/connectors/catalog/database/snowflake/example.md (added)
  • en/static/img/connectors/catalog/database/snowflake/ (screenshots added)
  • en/sidebars.ts (sidebar entry added)

Security checks

  • Followed secure coding standards: N/A (documentation only)
  • Ran FindSecurityBugs plugin: N/A (documentation only)
  • Confirmed no keys, passwords, or secrets committed: yes

Doc page preview (desktop)

Playwright screenshots of the rendered example page taken locally.

Desktop preview 01

Desktop preview 02

Desktop preview 03

Desktop preview 04

Desktop preview 05

Desktop preview 06

Desktop preview 07

Desktop preview 08

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 26, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 42993da7-dc5f-4ba9-aab0-a1bdcde457cc

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.


## What you'll build

This integration connects to a live Snowflake instance using the Snowflake connector on the WSO2 Integrator low-code canvas. It sets up an Automation entry point that executes a SQL query operation and captures the result stream, with connection credentials stored safely as Configurable variables.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is "low code canvas" the correct terminology? @rosensilva @NipunaRanasinghe


![Completed flow on the canvas showing Start → snowflake:query → Error Handler → End](/img/connectors/catalog/database/snowflake/snowflake_screenshot_06_completed_flow.png)

[![Deploy to Devant](https://openindevant.choreoapps.dev/images/DeployDevant-White.svg)](https://console.devant.dev/new?gh=wso2/integration-samples/tree/main/connectors/snowflake_connector_demo)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this is the ideal place to have the Deploy button. It is likely to go unnoticed.

My gut feeling is its better to have it at the top. Between the "What you'll build" and "Architecture" headings, under a new heading - "Try it yourself".

WDYT @daneshk @rosensilva @NipunaRanasinghe ?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about same place but with "Try it yourself" H2 Heading

@gayaldassanayake
Copy link
Contributor

Overall this looks great!!!

Added a few comments for potential minor improvements

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants