Generate and update dbt schema.yml files from a template, manifest, and database
Project description
dbt-schemify
Generate and update dbt schema.yml files automatically from a template, your dbt manifest, and live database columns.
How it works
Three sources are merged in priority order (highest first):
- Existing
schema.yml— values already there are never overwritten manifest.json— fills fields marked with theschemifysentinel.schemify.ymltemplate — defines which fields to include and their static defaults
The sentinel value schemify in the template means "auto-populate this field from the manifest or database".
Installation
pip install dbt-schemify
With your database adapter:
pip install "dbt-schemify[snowflake]"
pip install "dbt-schemify[postgres]"
pip install "dbt-schemify[bigquery]"
pip install "dbt-schemify[duckdb]"
Quick start
1. Compile your dbt project to get a manifest:
dbt compile
2. Run schemify:
schemify
If .schemify.yml doesn't exist yet, schemify creates one with sensible defaults — edit it, then re-run.
Reads .schemify.yml, target/manifest.json, and ~/.dbt/profiles.yml automatically.
Writes schema.yml next to each model's SQL file (grouped by folder).
Usage
schemify [options]
Options:
--schema PATH Write all models into a single schema.yml at PATH.
If omitted, a schema.yml is created next to each model's SQL file.
--manifest PATH Path to manifest.json
Default: <project-dir>/target/manifest.json
--template PATH Path to .schemify.yml template
Default: <project-dir>/.schemify.yml
--project-dir DIR dbt project root. Default: current directory
--profile NAME dbt profile name. Default: read from dbt_project.yml
--target NAME dbt target (e.g. dev, prod). Default: profile default
--profiles-dir DIR Directory containing profiles.yml. Default: ~/.dbt/
-s / --select Filter models by name or tag. Space-separated.
Examples: -s orders -s tag:marketing -s tag:finance orders
--each Write one <model_name>.yml per model instead of one schema.yml per folder
--no-db Skip database connection; no column fetching
--info Show resolved paths and configuration, then exit
dbt-schemifyalso works as an alias for backward compatibility.
Examples
# Auto-discover: write schema.yml next to every model's SQL file
schemify
# Check which paths schemify is using
schemify --info
# Only models with a specific tag (one schema.yml per directory)
schemify -s tag:marketing
# Only specific models by name
schemify -s orders customers
# Single model — automatically gets its own <model_name>.yml
schemify -s orders
# Mix names and tags
schemify -s tag:finance orders
# All matching models into one explicit file
schemify --schema models/marketing/schema.yml -s tag:marketing
# One file per model named after the model (e.g. orders.yml, customers.yml)
schemify --each
# Without DB connection (manifest data only)
schemify --no-db
# Custom paths
schemify \
--manifest target/manifest.json \
--template .schemify.yml
Default template
If .schemify.yml is missing, schemify creates this template automatically:
version: '1.0'
models:
- name: schemify
description: schemify # filled from manifest
meta:
owner: analytics # static default applied to all models
config:
enabled: true # static default
columns:
- name: schemify
data_type: schemify # filled from DB
description: schemify # left empty for humans to fill in
meta:
gdpr_tags: schemify
Merge rules
| Situation | Result |
|---|---|
Field exists in schema.yml |
Kept as-is |
Field is schemify sentinel + value in manifest |
Filled from manifest |
Field is schemify sentinel + column data_type |
Filled from DB |
| Field has a static value in template | Used as default |
| Field not in template | Not included in output |
| Column in DB but not in existing schema | Added using template column structure |
| Column in existing schema but not in DB | Preserved |
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file dbt_schemify-0.3.0.tar.gz.
File metadata
- Download URL: dbt_schemify-0.3.0.tar.gz
- Upload date:
- Size: 27.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a93807bbecc9f129490f1732e892a40f2112cd036bc7ac0b320c6c17880a33a7
|
|
| MD5 |
33d7c8a56900306af027b6e461058f42
|
|
| BLAKE2b-256 |
eb39b1c0fad494140a8767818c6e2df685be05b4380c9402ef369b4e55c75001
|
File details
Details for the file dbt_schemify-0.3.0-py3-none-any.whl.
File metadata
- Download URL: dbt_schemify-0.3.0-py3-none-any.whl
- Upload date:
- Size: 22.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
62a4ccf2ba0ce5cfa6b96de5a2088f22ac91b692c106b19e23f2964c85f28204
|
|
| MD5 |
09ba76569a2a9d2a59af5c5c29c7cf90
|
|
| BLAKE2b-256 |
0461fdd6ec2487c743d9ea0c6eb29172e44f21692933008e4174103637ca2e54
|