Skip to content
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.

Sign up for GitHub

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

fix: update readme #3

Merged
merged 2 commits into from
Jan 29, 2024
Merged

fix: update readme #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40e361c
fix: update readme
suryaiyer95 Jan 29, 2024
807a69d
fix: generate docs
suryaiyer95 Jan 29, 2024
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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,16 @@ Replace [path_to_manifest] and [path_to_catalog] with the actual paths to your d

The [--catalog-path] is an optional argument. If you don't specify a catalog path, the tool will skip some insights that require the catalog file.

#### Generating Manifest and Catalog Files for dbt Projects

1. Generate Manifest File (manifest.json). Open your dbt project's root directory in a terminal or command prompt. Run `dbt compile`. This command generates manifest.json in the target folder.

2. Generate Catalog File (catalog.json). Ensure you're in your dbt project's root directory. Run `dbt docs generate`. This connects to your database and creates catalog.json in the target folder.

Note: The catalog.json is optional for some operations but required for comprehensive project health checks. dbt docs generate requires an active database connection and may take longer for projects with many models.

### Checks

The following checks are available:

| Name | Type | Description | Files Required | Overrides |
Expand Down
Loading