Skip to content

Commit 52f3116

Browse files
committed
fix everything in getting started docs
1 parent 6ebbd8e commit 52f3116

File tree

3 files changed

+49
-48
lines changed

3 files changed

+49
-48
lines changed

src/content/docs/snowflake/getting-started/faq.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@ description: Frequently asked questions about LocalStack for Snowflake
44
template: doc
55
---
66

7-
8-
9-
107
## FAQs
118

129
### Are Snowflake v2 APIs supported?
@@ -35,4 +32,4 @@ A CI key allows you to use LocalStack in your CI environment. Every activation o
3532

3633
### How can I get help with the Snowflake emulator?
3734

38-
The Snowflake emulator is currently in **preview**. To get help, you can join the [Slack community](https://localstack.cloud/slack) and share your feedback, questions, and suggestions with the LocalStack team on the `#help` channel. If your team is using LocalStack for Snowflake, you can also request support by [contacting us](https://localstack.cloud/contact). We would be happy to setup a private Slack channel for your team to provide dedicated support.
35+
The Snowflake emulator is currently in **preview**. To get help, you can join the [Slack community](https://localstack.cloud/slack) and share your feedback, questions, and suggestions with the LocalStack team on the `#help` channel. If your team is using LocalStack for Snowflake, you can also request support by [contacting us](https://localstack.cloud/contact). We would be happy to setup a private Slack channel for your team to provide dedicated support.

src/content/docs/snowflake/getting-started/index.md

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,50 +4,48 @@ description: Basic installation guide to get started with LocalStack for Snowfla
44
template: doc
55
---
66

7-
8-
97
## Introduction
108

119
You can use the Snowflake Docker image to run the Snowflake emulator.
1210
The Snowflake Docker image is available on the [LocalStack Docker Hub](https://hub.docker.com/r/localstack/snowflake).
1311
To pull the Snowflake Docker image, execute the following command:
1412

15-
{{< command >}}
16-
$ docker pull localstack/snowflake
17-
{{< / command >}}
13+
```bash
14+
docker pull localstack/snowflake
15+
```
1816

1917
You can start the Snowflake Docker container using the following methods:
2018

2119
1. [`localstack` CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli)
2220
2. [`docker` CLI](https://docs.docker.com/get-docker/)
2321
2. [Docker Compose](https://docs.docker.com/compose/install/)
2422

25-
{{<alert type="info">}}
23+
:::note
2624
Before starting, ensure you have a valid `LOCALSTACK_AUTH_TOKEN` to access the Snowflake emulator. Refer to the [Auth Token guide](https://docs.localstack.cloud/getting-started/auth-token/) to obtain your Auth Token and specify it in the `LOCALSTACK_AUTH_TOKEN` environment variable.
27-
{{</alert>}}
25+
:::
2826

2927
### `localstack` CLI
3028

3129
To start the Snowflake Docker container using the `localstack` CLI, execute the following command:
3230

33-
{{< command >}}
34-
$ export LOCALSTACK_AUTH_TOKEN=<your_auth_token>
35-
$ IMAGE_NAME=localstack/snowflake localstack start
36-
{{< / command >}}
31+
```bash
32+
export LOCALSTACK_AUTH_TOKEN=<your_auth_token>
33+
IMAGE_NAME=localstack/snowflake localstack start
34+
```
3735

3836
### `docker` CLI
3937

4038
To start the Snowflake Docker container using the `docker` CLI, execute the following command:
4139

42-
{{< command >}}
43-
$ docker run \
40+
```bash
41+
docker run \
4442
--rm -it \
4543
-p 127.0.0.1:4566:4566 \
4644
-p 127.0.0.1:4510-4559:4510-4559 \
4745
-p 127.0.0.1:443:443 \
4846
-e LOCALSTACK_AUTH_TOKEN=${LOCALSTACK_AUTH_TOKEN:?} \
4947
localstack/snowflake
50-
{{< / command >}}
48+
```
5149

5250
### Docker Compose
5351

@@ -72,9 +70,9 @@ services:
7270
7371
Start the Snowflake Docker container with the following command:
7472
75-
{{< command >}}
76-
$ docker-compose up
77-
{{< / command >}}
73+
```bash
74+
docker-compose up
75+
```
7876

7977
## Updating
8078

@@ -86,10 +84,15 @@ To update the Snowflake Docker container, pull the latest image and restart the
8684

8785
You can check if the Snowflake emulator is running by executing the following command:
8886

89-
{{< command >}}
90-
$ curl -d '{}' snowflake.localhost.localstack.cloud:4566/session
87+
```bash
88+
curl -d '{}' snowflake.localhost.localstack.cloud:4566/session
89+
```
90+
91+
The response should be:
92+
93+
```bash
9194
{"success": true}
92-
{{< / command >}}
95+
```
9396

9497
### How to enable detailed debug logs?
9598

@@ -98,19 +101,19 @@ You can set the `SF_LOG=trace` environment variable in the Snowflake container t
98101
When using `docker-compose` then simply add this variable to the `environment` section of the YAML configuration file.
99102
If you're starting up via the `localstack start` CLI, then make sure to start up via the following configuration:
100103

101-
{{< command >}}
102-
$ DOCKER_FLAGS='-e SF_LOG=trace' DEBUG=1 IMAGE_NAME=localstack/snowflake localstack start
103-
{{< / command >}}
104+
```bash
105+
DOCKER_FLAGS='-e SF_LOG=trace' DEBUG=1 IMAGE_NAME=localstack/snowflake localstack start
106+
```
104107

105108
### The `snowflake.localhost.localstack.cloud` hostname doesn't resolve on my machine, what can I do?
106109

107110
On some systems, including some newer versions of MacOS, the domain name `snowflake.localhost.localstack.cloud` may not resolve properly.
108111
If you are encountering network issues and your Snowflake client drivers are unable to connect to the emulator, you may need to manually add the following entry to your `/etc/hosts` file:
109112

110-
{{< command >}}
113+
```bash
111114
127.0.0.1 snowflake.localhost.localstack.cloud
112-
{{< / command >}}
115+
```
113116

114117
## Next steps
115118

116-
Now that the Snowflake emulator is installed, you can use it for developing and testing your Snowflake data pipelines. Refer to our [Quickstart](/aws/getting-started/quickstart) guide to get started.
119+
Now that the Snowflake emulator is installed, you can use it for developing and testing your Snowflake data pipelines. Refer to our [Quickstart](/aws/getting-started/quickstart) guide to get started.

src/content/docs/snowflake/getting-started/quickstart.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ description: Get started with LocalStack for Snowflake in a few simple steps
44
template: doc
55
---
66

7-
8-
97
## Introduction
108

119
This guide explains how to set up the Snowflake emulator and develop a Python program using the Snowflake Connector for Python (`snowflake-connector-python`) to interact with emulated Snowflake running on your local machine.
@@ -21,19 +19,22 @@ This guide explains how to set up the Snowflake emulator and develop a Python pr
2119

2220
Before you begin, pull the Snowflake emulator image (`localstack/snowflake`) and start the container:
2321

24-
{{< command >}}
25-
$ export LOCALSTACK_AUTH_TOKEN=<your_auth_token>
26-
$ IMAGE_NAME=localstack/snowflake:latest localstack start
27-
{{< / command >}}
22+
```bash
23+
export LOCALSTACK_AUTH_TOKEN=<your_auth_token>
24+
IMAGE_NAME=localstack/snowflake:latest localstack start
25+
```
2826

2927
Check the emulator's availability by running:
3028

31-
{{< command >}}
32-
$ curl -d '{}' snowflake.localhost.localstack.cloud:4566/session
33-
<disable-copy>
29+
```bash
30+
curl -d '{}' snowflake.localhost.localstack.cloud:4566/session
31+
```
32+
33+
The response should be:
34+
35+
```bash
3436
{"success": true}
35-
</disable-copy>
36-
{{< / command >}}
37+
```
3738

3839
### Connect to the Snowflake emulator
3940

@@ -90,9 +91,9 @@ This program creates a table named `ability`, inserts rows, and fetches the resu
9091

9192
Execute the Python program with:
9293

93-
{{< command >}}
94-
$ python main.py
95-
{{< / command >}}
94+
```bash
95+
python main.py
96+
```
9697

9798
The output should be:
9899

@@ -122,9 +123,9 @@ Verify the results by navigating to the LocalStack logs:
122123

123124
To stop LocalStack and remove locally created resources, use:
124125

125-
{{< command >}}
126-
$ localstack stop
127-
{{< / command >}}
126+
```bash
127+
localstack stop
128+
```
128129

129130
LocalStack is ephemeral and doesn't persist data across restarts. It runs inside a Docker container, and once it’s stopped, all locally created resources are automatically removed. In a future release of the Snowflake emulator, we will provide proper persistence and integration with our [Cloud Pods](https://docs.localstack.cloud/user-guide/state-management/cloud-pods/) feature as well.
130131

@@ -134,4 +135,4 @@ You can now explore the following resources to learn more about the Snowflake em
134135

135136
- [User Guide]({{< ref "user-guide" >}}): Learn about the Snowflake emulator's features and how to use them.
136137
- [Tutorials](/aws/tutorials): Explore tutorials to use the Snowflake emulator for local development and testing.
137-
- [References]({{< ref "references" >}}): Find information about the Snowflake emulator's configuration, changelog, and function coverage.
138+
- [References]({{< ref "references" >}}): Find information about the Snowflake emulator's configuration, changelog, and function coverage.

0 commit comments

Comments
 (0)