Skip to main content

Catalog JSON file

Current schema: v1

Produced by: (Applies to dbt v2.0 and later) --write-catalog flag

This file contains information from your data warehouse about the tables and views produced and defined by the resources in your project. (Applies to dbt v2.0 and later) dbt Docs v2 reads the dbt Information Schema rather than this file. catalog.json remains available as a separate artifact for Catalog and external tools.

Top-level keys​

  • metadata
  • nodes: Dictionary containing information about database objects corresponding to dbt models, seeds, and snapshots.
  • sources: Dictionary containing information about database objects corresponding to dbt sources.
  • errors: Errors received while running metadata queries during (Applies to dbt v2.0 and later) catalog generation (via --write-catalog flag).

Resource details​

Within sources and nodes, each dictionary key is a resource unique_id. Each nested resource contains:

  • unique_id: <resource_type>.<package>.<resource_name>, same as dictionary key, maps to nodes and sources in the manifest
  • metadata
    • type: table, view, etc.
    • database
    • schema
    • name
    • comment
    • owner
  • columns (array)
    • name
    • type: data type
    • comment
    • index: ordinal
  • stats: differs by database and relation type

Was this page helpful?

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

0
Loading