-
Notifications
You must be signed in to change notification settings - Fork 14
docs: new feature doc for openflow #198
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
b648c15
draft 1:new feature doc for openflow
quetzalliwrites fa5f091
fix header
quetzalliwrites de16fe7
code block fix
quetzalliwrites 83a7e93
Apply suggestions from code review
quetzalliwrites 6dcdf5c
remove mention of internal tests
quetzalliwrites 3e6326d
added image of NiFi UI simulator
quetzalliwrites 1c2871d
add more images
quetzalliwrites 0396d3e
Apply suggestions from code review
quetzalliwrites File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
--- | ||
title: "Openflow" | ||
description: Get started with Openflow in LocalStack for Snowflake | ||
tags: ["Base"] | ||
--- | ||
|
||
## Introduction | ||
Openflow is Snowflake’s data movement service that provides a unified platform for building, scaling, and managing data pipelines. It is powered by Apache NiFi and enables flexible data ingestion, transformation, and integration across diverse sources and destinations. | ||
|
||
The Snowflake emulator in LocalStack supports **basic Openflow functionality** by using Apache NiFi. This allows you to experiment locally with Openflow concepts, such as creating processors and running SQL queries against the Snowflake emulator. | ||
|
||
You can access the Openflow UI when the emulator is running at: | ||
|
||
``` | ||
https://snowflake.localhost.localstack.cloud:4566/openflow/ | ||
``` | ||
|
||
:::note | ||
Openflow in LocalStack for Snowflake is intended for local experimentation. It does not provide the full set of managed Openflow capabilities available in Snowflake’s cloud platform. | ||
::: | ||
|
||
## Getting started | ||
To begin using Openflow in LocalStack: | ||
|
||
1. Start your Snowflake emulator. | ||
2. Open the following URL in your browser: `https://snowflake.localhost.localstack.cloud:4566/openflow/` | ||
|
||
 | ||
|
||
The first load may take some time, as Apache NiFi dependencies are downloaded and initialized. | ||
|
||
Once the UI is available, you can create and configure NiFi processors directly in your browser. | ||
|
||
### Running a query with ExecuteSQL | ||
The following example demonstrates how to run a simple query against the Snowflake emulator using the `ExecuteSQL` processor. | ||
|
||
1. Add an ExecuteSQL processor: Drag the `ExecuteSQL` processor onto the canvas in the Openflow UI. | ||
|
||
2. Configure the processor: | ||
- Set the **Database Connection Pooling Service** to use the default `Snowflake Connection Pool`. | ||
quetzalliwrites marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
 | ||
|
||
- Enter a query, for example: | ||
|
||
```sql | ||
SELECT 123; | ||
``` | ||
|
||
- In the **Relationships** tab, configure the processor to terminate or retry on `failure` and `success`. | ||
quetzalliwrites marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
 | ||
|
||
|
||
3. Start the processor: Right-click the processor and choose **Start**. The processor will run the SQL query against the Snowflake emulator. | ||
quetzalliwrites marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
 | ||
quetzalliwrites marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
4. Verify execution: In the emulator logs, you should see the executed query: | ||
quetzalliwrites marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```sql | ||
Running query (account/DB/schema TEST/TEST/public): SELECT 123 | ||
``` | ||
|
||
|
||
|
||
:::note | ||
## Limitations | ||
- The initial download of Apache NiFi is large (~750 MB) and may take several minutes. | ||
- Only basic UI and processor creation are supported. Advanced Openflow functionality, including governance, AI capabilities, and managed connectors, is not included in the local emulator. | ||
::: |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.