rewrite snowflake quickstart guide #83
Conversation
HarshCasper
requested review from
whummer,
gentris,
hovaesco,
eruditmorina,
mmaureenliu and
sabir-akhadov-localstack
|
🎊 PR Preview has been successfully built and deployed to https://localstack-snowflake-docs-preview-pr-83.surge.sh 🎊 |
| @@ -9,14 +9,15 @@ description: Get started with LocalStack for Snowflake in a few simple steps | |||
|
|
|||
| ## Introduction | |||
|
|
|||
| 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. | |||
| This guide explains how to set up the Snowflake emulator and use Snowflake CLI to interact with Snowflake resources running on your local machine. You'll learn how to create databases, tables, set up automated data ingestion using Snowpipe, and work with S3 storage - all running locally with LocalStack. | |||
There was a problem hiding this comment.
I like this fuller example as it shows how to do something useful. However I'd prefer not to mention s3 here. Not all our snowflake prospects are on the aws ecosystem and this will just confuse them. Plus I don't want awscli as a pre-req to our most basic snowflake quide.
| - [`snowflake-connector-python` library](https://docs.snowflake.com/en/developer-guide/python-connector/python-connector-install) | ||
| - [`awscli-local`](https://github.com/localstack/awscli-local) for interacting with LocalStack's S3 service | ||
|
|
||
| It is also recommended to setup an [integration]({{< ref "user-guide/integrations/" >}}) to run your SQL queries. We recommend using the [Snowflake CLI]({{< ref "user-guide/integrations/snow-cli" >}}), [DBeaver]({{< ref "user-guide/integrations/dbeaver" >}}) or the [LocalStack Web Application]({{< ref "user-guide/user-interface" >}}) for this purpose. |
There was a problem hiding this comment.
Suggested edit:
LocalStack for Snowflake works with popular Snowflake integrations to run your SQL queries. This guide uses the [Snowflake CLI], but you can also use [snowSQL], [DBeaver] or the [LocalStack Web Application] for this purpose.
| - Create databases, schemas, and tables | ||
| - Set up S3 stages for data storage | ||
| - Configure Snowpipe for automated data ingestion | ||
| - Load sample student data from CSV files |
There was a problem hiding this comment.
As suggested above, it's better leave out s3 in the quick start guide, but we can mention it at the end or in next steps, e.g. (the spirit, not exact words)
Why Not Try
- You can load data through our [Storage Integration] (currently supporting aws s3) or using a script (see [Snowflake Drivers])
- You can configure [Snowpipe] for automated data ingestion
- You can continue to work with your favourite tools to develop on LocalStack for Snowflake locally, see [Integrations]
There was a problem hiding this comment.
Obviously, that means you'll change much of the tutorial here. I suggest modelling on snowflake's own getting started guide https://docs.snowflake.com/en/user-guide/tutorials/snowflake-in-20minutes where it uses the more typical database tutorial data loading method of uploading from local machine. It does so through the PUT command (https://docs.snowflake.com/en/user-guide/tutorials/snowflake-in-20minutes#stage-data-files) which according to our docs we do support as well (https://snowflake.localstack.cloud/user-guide/stages/#upload-data-to-the-stage). This will also significantly cut down the length of the getting started guide and make it extremely easy to follow.
| Optionally, you can also query your Snowflake resources & data using the LocalStack Web Application, that provides a **Worksheet** tab to run your SQL queries. | ||
|
|
||
| <img src="snowflake-web-ui.png" alt="Running SQL queries using LocalStack Web Application" width="900"/> | ||
|
|
||
| ### Destroy the local infrastructure | ||
|
|
||
| To stop LocalStack and remove locally created resources, use: |
There was a problem hiding this comment.
This is meant for later lines but it's greyed out and I can't seem to comment there:
We're not going to mention Cloud Pods and have a docs ticket open to move the mentioning of it from snowflake docs. Instead I suggest edit the persistence paragraph to something like this:
... all locally created resources are automatically removed. To persist the state of your LocalStack for Snowflake instance, please check out our guide on [State Management].
No description provided.