Skip to content

update the web ui docs #71

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions content/en/user-guide/user-interface/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: "User Interface"
linkTitle: "User Interface"
weight: 9
description: Get started with LocalStack for Snowflake Web User Interface
aliases:
- /user-guide/web-user-interface/
---

{{< preview-notice >}}

## Introduction

The Snowflake emulator provides a User Interface (UI) via the [LocalStack Web Application](https://app.localstack.cloud/). The User Interface allows you to:

* Run SQL queries and view results using a Query Editor.
* View detailed request/response traces of API calls.
* Forward queries to a real Snowflake instance using a proxy.

To access the User Interface, you need to start the Snowflake emulator and access the **Snowflake** tab in your default instance of the LocalStack Web Application. This User Interface is available only when the Snowflake emulator is running. It does not connect to the Snowflake service (except during a proxy connection) or any other external service on the Internet.

{{< alert title="Info" >}}
Please note that the Snowflake User Interface is still experimental and under active development.
{{< /alert >}}

## Getting started

This guide is designed for users new to the Snowflake emulator Web UI. Start your Snowflake emulator using the following command:

```bash
IMAGE_NAME=localstack/snowflake localstack start
```

Navigate to [**https://app.localstack.cloud/inst/default/snowflake**](https://app.localstack.cloud/inst/default/snowflake) to access the User Interface.

### Run SQL queries

The User Interface provides a **Worksheet** tab that allows you to run SQL queries and view the results.

<img src="run-sql-queries-web-ui.png" alt="Running SQL queries" width="900"/>
<br><br>

You can click on **Warehouses** and **Databases** on the left side of the worksheet to view the available warehouses and databases.

### View Snowflake logs

The User Interface provides a **Logs** tab that provides you a detailed view of request/response traces of API calls. You can view the request and response headers, body, and status code.

<img src="request-logs-web-ui.png" alt="View request/response traces" width="900"/>

### Proxy to a real Snowflake instance

You can forward queries from the Snowflake emulator to a real Snowflake instance using a proxy.

The User Interface provides a **Proxy** tab that allows you to enter your Snowflake account credentials. Click on the **Save** button to save the credentials. You can now run queries in the Query Editor, and they will be forwarded to the real Snowflake instance.

{{< alert title="Important" color="danger" >}}
Be careful when operating the proxy, as it can incur costs and access data in your real Snowflake account. For security reasons, please make sure to use scoped credentials with the least set of required permissions (ideally read-only). Only run the proxy against test/staging environments, and never against a production database.
{{< /alert >}}

<img src="proxy-web-ui.png" alt="Forward queries to a real Snowflake instance" width="900"/>
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.
57 changes: 0 additions & 57 deletions content/en/user-guide/web-user-interface/index.md

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.