Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sfc-gh-cnivera committed Jul 29, 2024
1 parent 4b54a94 commit f204bd0
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ account, [follow these instructions](https://docs.snowflake.com/en/user-guide/or
export SNOWFLAKE_ROLE="<your-snowflake-role>"
export SNOWFLAKE_WAREHOUSE="<your-snowflake-warehouse>"
export SNOWFLAKE_USER="<your-snowflake-user>"
export SNOWFLAKE_PASSWORD="<your-snowflake-password>"
export SNOWFLAKE_ACCOUNT_LOCATOR="<your-snowflake-account-locator>"
export SNOWFLAKE_HOST="<your-snowflake-host>"
```
Expand All @@ -49,7 +48,6 @@ export SNOWFLAKE_HOST="<your-snowflake-host>"
set SNOWFLAKE_ROLE=<your-snowflake-role>
set SNOWFLAKE_WAREHOUSE=<your-snowflake-warehouse>
set SNOWFLAKE_USER=<your-snowflake-user>
set SNOWFLAKE_PASSWORD=<your-snowflake-password>
set SNOWFLAKE_ACCOUNT_LOCATOR=<your-snowflake-account-locator>
set SNOWFLAKE_HOST=<your-snowflake-host>
```
Expand All @@ -63,15 +61,33 @@ import os
os.environ['SNOWFLAKE_ROLE'] = '<your-snowflake-role>'
os.environ['SNOWFLAKE_WAREHOUSE'] = '<your-snowflake-warehouse>'
os.environ['SNOWFLAKE_USER'] = '<your-snowflake-user>'
os.environ['SNOWFLAKE_PASSWORD'] = '<your-snowflake-password>'
os.environ['SNOWFLAKE_ACCOUNT_LOCATOR'] = '<your-snowflake-account-locator>'
os.environ['SNOWFLAKE_HOST'] = '<your-snowflake-host>'
```

4. If you are using single sign-on authetication, you can leave password empty and set additional environ below:
Our semantic model generators currently support three types of authentication. If no `SNOWFLAKE_AUTHENTICATOR`
environment variable
is set, the default is `snowflake`, which uses standard username/password support.

1. Username and Password

```bash
# no SNOWFLAKE_AUTHENTICATOR needed
export SNOWFLAKE_PASSWORD="<your-snowflake-password>"
```

2. Username/Password with MFA

```python
os.environ['SNOWFLAKE_AUTHENTICATOR'] = 'EXTERNALBROWSER'
```bash
export SNOWFLAKE_AUTHENTICATOR="username_password_mfa"
export SNOWFLAKE_PASSWORD="<your-snowflake-password>"
```

3. Single Sign-On (SSO) with Okta

```bash
# no SNOWFLAKE_PASSWORD needed
export SNOWFLAKE_AUTHENTICATOR="externalbrowser"
```

## Usage
Expand Down

0 comments on commit f204bd0

Please sign in to comment.