Skip to main content

Settings reference

These settings map to YamlRefactorSettings and can be set via CLI flags or config keys.

Core behavior

SettingDefaultDescription
skip-merge-metafalseSkip inheriting/merging upstream meta fields.
skip-add-columnsfalseSkip injecting missing model columns from the warehouse.
skip-add-source-columnsfalseSkip injecting missing source columns.
skip-add-tagsfalseSkip inheriting upstream tags.
skip-add-data-typesfalseSkip populating data_type.
force-inherit-descriptionsfalseOverwrite child descriptions with upstream descriptions.
use-unrendered-descriptionsfalsePreserve unrendered {{ doc(...) }} descriptions.
prefer-yaml-valuesfalsePreserve unrendered Jinja values across all fields.
add-progenitor-to-metafalseAdd meta.osmosis_progenitor to inherited columns.
add-inheritance-for-specified-keys[]Additional keys to inherit (repeatable).

Output formatting

SettingDefaultDescription
output-to-lowerfalseForce column names and data types to lowercase.
output-to-upperfalseForce column names and data types to uppercase.
numeric-precision-and-scalefalsePreserve numeric precision and scale in types.
string-lengthfalsePreserve string length in types.
strip-eof-blank-linesfalseRemove trailing blank lines at EOF when writing YAML.
sort-bydatabaseColumn ordering (database or alphabetical).

Catalog and introspection

SettingDefaultDescription
catalog-pathnullUse a specific catalog.json for types instead of live introspection.
create-catalog-if-not-existsfalseBuild a catalog if one is missing.

Execution

SettingDefaultDescription
dry-runfalseDo not write changes to disk.
include-externalfalseInclude nodes from external packages.
scaffold-empty-configsfalseEmit empty/placeholder YAML fields.

Where to set these

  • CLI flags (global defaults)
  • Folder-level +dbt-osmosis-options
  • Node-level dbt_osmosis_options in config(...)
  • Column-level meta overrides