|
| 1 | +--- |
| 2 | +title: User Interface |
| 3 | +description: Get started with LocalStack for Snowflake Web User Interface |
| 4 | +--- |
| 5 | + |
| 6 | +## Introduction |
| 7 | + |
| 8 | +The Snowflake emulator provides a User Interface (UI) via the [LocalStack Web Application](https://app.localstack.cloud/). The User Interface allows you to: |
| 9 | + |
| 10 | +* Run SQL queries and view results using a Query Editor. |
| 11 | +* View detailed request/response traces of API calls. |
| 12 | +* Forward queries to a real Snowflake instance using a proxy. |
| 13 | + |
| 14 | +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. Please note that it does not connect to the real Snowflake cloud environment (except during a proxy connection) or any other external service on the Internet. |
| 15 | + |
| 16 | +:::note |
| 17 | +Please note that the Snowflake User Interface is still experimental and under active development. |
| 18 | +::: |
| 19 | + |
| 20 | +## Getting started |
| 21 | + |
| 22 | +This guide is designed for users new to the Snowflake emulator Web UI. Start your Snowflake emulator using the following command: |
| 23 | + |
| 24 | +```bash |
| 25 | +IMAGE_NAME=localstack/snowflake localstack start |
| 26 | +``` |
| 27 | + |
| 28 | +Navigate to [**https://app.localstack.cloud/inst/default/snowflake**](https://app.localstack.cloud/inst/default/snowflake) to access the User Interface. |
| 29 | + |
| 30 | +### Run SQL queries |
| 31 | + |
| 32 | +The User Interface provides a **Worksheet** tab that allows you to run SQL queries and view the results. |
| 33 | + |
| 34 | + |
| 35 | + |
| 36 | +You can click on **Warehouses** and **Databases** on the right side of the worksheet to view the available warehouses and databases. |
| 37 | + |
| 38 | +### View Snowflake logs |
| 39 | + |
| 40 | +The User Interface provides a **Logs** tab that provides you a detailed view of request/response traces of API calls issued against the local emulator. You can view the request and response headers, body, and status code. |
| 41 | + |
| 42 | + |
| 43 | + |
| 44 | +### Proxy to a real Snowflake instance |
| 45 | + |
| 46 | +You can forward queries from the Snowflake emulator to a real Snowflake instance using a proxy. |
| 47 | + |
| 48 | +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. |
| 49 | + |
| 50 | +:::danger |
| 51 | +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. |
| 52 | +::: |
| 53 | + |
| 54 | + |
0 commit comments