diff --git a/content/en/user-guide/user-interface/index.md b/content/en/user-guide/user-interface/index.md new file mode 100644 index 0000000..fef6d6a --- /dev/null +++ b/content/en/user-guide/user-interface/index.md @@ -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. 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. + +{{< 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. + +Running SQL queries +

+ +You can click on **Warehouses** and **Databases** on the right 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 issued against the local emulator. You can view the request and response headers, body, and status code. + +View request/response traces + +### 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 >}} + +Forward queries to a real Snowflake instance diff --git a/content/en/user-guide/user-interface/proxy-web-ui.png b/content/en/user-guide/user-interface/proxy-web-ui.png new file mode 100644 index 0000000..0d255b9 Binary files /dev/null and b/content/en/user-guide/user-interface/proxy-web-ui.png differ diff --git a/content/en/user-guide/user-interface/request-logs-web-ui.png b/content/en/user-guide/user-interface/request-logs-web-ui.png new file mode 100644 index 0000000..ca4cc96 Binary files /dev/null and b/content/en/user-guide/user-interface/request-logs-web-ui.png differ diff --git a/content/en/user-guide/user-interface/run-sql-queries-web-ui.png b/content/en/user-guide/user-interface/run-sql-queries-web-ui.png new file mode 100644 index 0000000..884975b Binary files /dev/null and b/content/en/user-guide/user-interface/run-sql-queries-web-ui.png differ diff --git a/content/en/user-guide/web-user-interface/index.md b/content/en/user-guide/web-user-interface/index.md deleted file mode 100644 index 1c7549c..0000000 --- a/content/en/user-guide/web-user-interface/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "Web User Interface" -linkTitle: "Web User Interface" -weight: 9 -description: Get started with LocalStack for Snowflake Web User Interface ---- - -{{< preview-notice >}} - -## Introduction - -The Snowflake emulator provides a simple web user interface (UI) accessible via a web browser. The Web UI 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. - -Access the Web UI at [https://snowflake.localhost.localstack.cloud/](https://snowflake.localhost.localstack.cloud/). The Web UI 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 LocalStack Snowflake Web UI 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 -EXTRA_CORS_ALLOWED_ORIGINS='*' IMAGE_NAME=localstack/snowflake DEBUG=1 localstack start -``` - -The `EXTRA_CORS_ALLOWED_ORIGINS` environment variable is used to allow CORS requests from the Web UI. Navigate to [https://snowflake.localhost.localstack.cloud/](https://snowflake.localhost.localstack.cloud/) to access the Web UI. - -### Run SQL queries - -The Web UI provides a Query Editor that allows you to run SQL queries and view the results. - -Running SQL queries -

- -You can click on **Warehouses** and **Databases** on the left side of the screen to view the available warehouses and databases. - -### View request/response traces - -The Web UI provides a detailed view of request/response traces of API calls. You can view the request and response headers, body, and status code. Click on the **Request Logs** tab in the Web UI to view the request/response traces. - -View request/response traces - -### Forward queries to a real Snowflake instance - -You can forward queries from the Snowflake emulator to a real Snowflake instance using a proxy. - -To forward queries, click on the **Proxy** tab in the Web UI and enter the Snowflake account username & password. 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 >}} -Forward queries to a real Snowflake instance diff --git a/content/en/user-guide/web-user-interface/proxy-web-ui.png b/content/en/user-guide/web-user-interface/proxy-web-ui.png deleted file mode 100644 index 891c467..0000000 Binary files a/content/en/user-guide/web-user-interface/proxy-web-ui.png and /dev/null differ diff --git a/content/en/user-guide/web-user-interface/request-logs-web-ui.png b/content/en/user-guide/web-user-interface/request-logs-web-ui.png deleted file mode 100644 index 8cd4da8..0000000 Binary files a/content/en/user-guide/web-user-interface/request-logs-web-ui.png and /dev/null differ diff --git a/content/en/user-guide/web-user-interface/run-sql-queries-web-ui.png b/content/en/user-guide/web-user-interface/run-sql-queries-web-ui.png deleted file mode 100644 index 994d78b..0000000 Binary files a/content/en/user-guide/web-user-interface/run-sql-queries-web-ui.png and /dev/null differ