omx dbt

Connect your dbt warehouse and sync metrics to OnlyMetrix.

omx dbt connect

omx dbt connect [OPTIONS]

Reads profiles.yml (same credentials dbt uses) and registers the datasource with OnlyMetrix.

Options

Flag	Description	Default
--profiles-dir PATH	Directory containing profiles.yml	~/.dbt/
--project-dir PATH	dbt project directory	current directory
--profile TEXT	Profile name	from dbt_project.yml
--target TEXT	Target name	profile's default target
--dry-run	Show what would connect without calling API	off
-y, --yes	Skip confirmation prompt	off
--url TEXT	API URL (overrides OMX_API_URL)
--api-key TEXT	API key (overrides OMX_API_KEY)

Examples

# Connect using default profile
omx dbt connect

# Connect a specific target
omx dbt connect --profile my_project --target prod

# Preview without connecting
omx dbt connect --dry-run

# Skip confirmation (for CI)
omx dbt connect -y

omx dbt sync

omx dbt sync [OPTIONS]

Options

Flag	Description	Default
--manifest PATH	Path to manifest.json	./target/manifest.json
--project-dir PATH	dbt project directory	current directory
--dry-run	Preview without calling API	off
--write-status-table	Write compile status to warehouse	off
--strict	Exit non-zero if any metric is opaque/failed	off
--url TEXT	API URL (overrides OMX_API_URL)
--api-key TEXT	API key (overrides OMX_API_KEY)

Examples

# Basic sync after dbt run
dbt run
omx dbt sync

# Preview changes
omx dbt sync --dry-run

# CI mode: fail on opaque metrics
omx dbt sync --strict

# Custom manifest path
omx dbt sync --manifest /path/to/target/manifest.json

# Write status table for dbt test integration
omx dbt sync --write-status-table

Environment variables

Variable	Description
OMX_API_URL	OnlyMetrix API URL
OMX_API_KEY	API key (omx_sk_...)

Dry-run output

Found 5 metrics in manifest

  total_revenue     -> structured    (tier: core)      [create]
  customer_count    -> structured    (tier: standard)  [unchanged]
  active_users      -> structured    (tier: standard)  [update]
  churn_rate        -> opaque        (tier: standard)  [create, ratio -> splits]
  ltv_estimate      -> opaque        (tier: standard)  [create, derived]

Would sync: 3 metrics (1 structured, 2 opaque), skip 1 unchanged
Would update: 1 tier

Action column meanings

Action	Meaning
[create]	New metric, not in OM yet
[update]	Definition changed since last sync
[unchanged]	Hash matches, skipped
[delete]	Removed from dbt manifest

For full integration guide, see dbt Integration.