From 40e361cfed5dbdfd2ef4980006ababb5f599d507 Mon Sep 17 00:00:00 2001 From: suryaiyer95 Date: Mon, 29 Jan 2024 11:48:59 -0800 Subject: [PATCH] fix: update readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 5f7fc81c..9ec0f6b5 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,24 @@ 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) +The manifest.json file contains essential metadata about your dbt models, tests, and more. To create it: + +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) + +The catalog.json file provides schema details related to your dbt models. To create it: + +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 |