Skip to content

feat: docs for connecting to user-specific account #68

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

Merged
merged 2 commits into from
Mar 13, 2025
Merged
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
72 changes: 72 additions & 0 deletions content/en/user-guide/accounts/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: "Accounts"
linkTitle: "Accounts"
weight: 17
description: Get started with Accounts in LocalStack for Snowflake
---

## Introduction

An account is a unique identifier for a Snowflake instance within an organization. It acts as a container
for resources and operations related to data storage, processing, and management.

The Snowflake emulator lets you connect to and manage resources in different accounts.

## Getting Started

This guide explains how to start and connect to the Snowflake emulator using specific accounts.

You can specify any account name when connecting to the Snowflake emulator. If you don't, all resources
will be managed by the default `test` account.

Depending on the Snowflake Driver you choose, you can pass `account` accordingly.

### Connect using Snowflake Connection Object

If the Snowflake driver provides a connection object, you can pass the `account` parameter in the connection object.

Example using the Snowflake Connector for Python:

```python
sf_conn_obj = sf.connect(
account="your_account",
# other parameters
)
```

Example using the NodeJS Driver for Snowflake:

```javascript
var connection = snowflake.createConnection({
account: "your_account",
// other parameters
});
```

### Connect using Connection String

You can also specify the account for Snowflake drivers that let you connect with a connection string.

Example establishing a JDBC connection:

```
jdbc:snowflake://snowflake.localhost.localstack.cloud:4566/?account=your_account
```

### Check Current Account

Once successfully connected, you can verify which account you are connected to by executing the following SQL command:

```sql
SELECT CURRENT_ACCOUNT_NAME();
```

The query statement will return the name of the account you are currently connected to. Output should look like:

```sql
+------------------------------------------+
| CURRENT_ACCOUNT_NAME() |
|------------------------------------------|
| YOUR_ACCOUNT |
+------------------------------------------+
```