Make all format options available when using `--dbt`

[dbeatty10]

Is your feature request related to a problem? Please describe.
Currently, the --dbt flag uses a different output format than non- --dbt executions of data-diff.

Describe the solution you'd like
Ideally, regular data-diff and data-diff --dbt would have the same output format. Additionally, --json and --stats should be possible when using --dbt.

Describe alternatives you've considered
It's an option for --dbt to have completely different formatting and for the --json and --stats flags to not have any effect. But that alternative makes dolphins cry 🐬 😢

Additional context
I'll submit a PR!

[dlawin]

Ideally, regular data-diff and data-diff --dbt would have the same output format

I'm not sure I agree as we are targeting two very diff erent uses cases in these two features, so I do think it makes sense for the output to not align by default

Migrations (primary data-diff use case) vs. dbt model development. But 100% we need parity across features around the output options (not to mention the other diff options flags)

It's an option for --dbt to have completely different formatting and for the --json and --stats flags to not have any effect. But that alternative makes dolphins cry 🐬 😢

lol true

@williebsweet curious on your thoughts here

[dlawin]

and @leoebfolsom @kylemcnair

[dbeatty10]

we are targeting two very diff erent uses cases in these two features

😂

The output format of regular data-diff felt familiar and comfortable due to its similarity with the git diff (and just diff) that I do regularly in the terminal. But when I used data-diff --dbt, I didn't really know what to do with the output.

At minimum, I'd like to be able to configure the output format via the --json and --stats flags (along with a flag for the default format) when using --dbt.

But interested to hear everyone's thoughts on output formats that would be most useful during dbt model development!

In particular, how are the needs of Mary the Migrator and Dylan the dbt Developer similar and how are their needs different? Is there particular diff output one persona needs that the other doesn't? Is there any overlap?

[github-actions]

This issue has been marked as stale because it has been open for 60 days with no activity. If you would like the issue to remain open, please comment on the issue or else it will be closed in 7 days.

[dbeatty10]

@dlawin could we mark this as un-stale?

My feature proposal is to achieve parity across the output options (when using the --dbt option). I'll provide examples of all three below.

data-diff --dbt --dbt-profiles-dir .

data-diff --dbt --dbt-profiles-dir . --json

data-diff --dbt --dbt-profiles-dir . --stats

[kylemcnair]

@dlawin could we mark this as un-stale?

My feature proposal is to achieve parity across the output options (when using the --dbt option). I'll provide examples of all three below.

data-diff --dbt --dbt-profiles-dir .

```shell data-diff --dbt --dbt-profiles-dir . --json ``` ```shell data-diff --dbt --dbt-profiles-dir . --stats ```

Hey @dbeatty10!
I removed the stale label - this seems like a great feature that we'd want to keep on the roadmap. We just added the stale workflow in an attempt to better wrangle older issues, please pardon the noise as we get it dialed.

[dbeatty10]

No worries @kylemcnair -- stalebot is definitely handy to keep the backlog more manageable.

At the moment, the following is more of a link to interesting information rather than a feature request...

Another diff format to take a peek at is the one used by daff:

• http://paulfitz.github.io/daff-doc/spec.html

I believe it originally came from the coopy toolbox, and you can see it in action here:

• https://paulfitz.github.io/daff/

A relevant git repo is here:

• https://github.com/paulfitz/daff

[leoebfolsom]

@dbeatty10 I do really like the daff format, and believe it's a very good way to display row-level data diff info in CLI output, much better imo than the current "regular" (non-dbt) data-diff output. However, I echo what Kyle said above! We'll get there!

[github-actions]

This issue has been marked as stale because it has been open for 60 days with no activity. If you would like the issue to remain open, please comment on the issue and it will be added to the triage queue. Otherwise, it will be closed in 7 days.