Skip to content
This repository has been archived by the owner on Sep 13, 2023. It is now read-only.

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sfc-gh-dodievich committed Apr 2, 2021
1 parent 3150300 commit 1e011eb
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,12 @@ ERROR(S):
--version Display version information.
```

## -c/--connection
## Retrieving Data
SFGrantReport supports two modes of getting Role and Grant information:
* Direct: connect to Snowflake directly and run commands using snowsql (`-c, --connection` option)
* Offline: use data extracted from Snowflake ACCOUNT_USAGE views (`-i, --input-folder` option)

## -c, --connection
SFGrantReport can connect to Snowflake directly to retrieve Role and Grant information.

Use `-c/--connection` parameter to specify the name of the connection in snowsql configuration file.
Expand Down Expand Up @@ -167,7 +172,7 @@ or
./SFGrantReport --input-folder path/to/account_usage --output-folder ~/Documents/MyAwesomeOfflineReport
```

## -o/--output-folder
## -o, --output-folder
Use `-o/--output-folder` parameter to specify where the report files should go (unless you want them created in the same directory you started the tool.

For example, this command uses named connection `mysnowflakeaccount` and creates report in the folder named `MyAwesomeReport` in the Documents folder:
Expand Down

0 comments on commit 1e011eb

Please sign in to comment.