feat(dbt): support prefer_sql_parser_lineage with sources enabled

[hsheth2]

Checklist

• The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
• Links to related issues (if applicable)
• Tests for the changes have been added/updated (if applicable)
• Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
• For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

• New Features

  • Introduced a new configuration option to prefer SQL parser lineage for generating table lineage.
  • Enhanced validation logic for lineage configuration settings to ensure compatibility.

• Bug Fixes

  • Improved error handling for conflicting configuration settings related to entity emissions and lineage.

• Tests

  • Expanded test coverage for DBT configuration validation and parsing, ensuring robustness against edge cases.

[coderabbitai]

Walkthrough

The changes in this pull request primarily enhance the DBTCommonConfig class by introducing a new boolean field, prefer_sql_parser_lineage, which influences how lineage is generated based on SQL parser results. The validation logic for skip_sources_in_lineage is updated to ensure compatibility with this new field. Additionally, modifications are made to various test files to accommodate these changes, including updates to test configurations and validation checks for entity emissions in the DBT ingestion process.

Changes

File Path	Change Summary
metadata-ingestion/src/datahub/ingestion/source/dbt/dbt_common.py	Added prefer_sql_parser_lineage boolean field to DBTCommonConfig, updated skip_sources_in_lineage validator, and modified variable names for clarity.
metadata-ingestion/tests/integration/dbt/test_dbt.py	Updated DbtTestConfig class and test cases to reflect new configurations and enhanced testing scenarios.
metadata-ingestion/tests/unit/test_dbt_source.py	Added validation tests for entity emissions and updated existing tests to ensure correct configuration parsing.

Possibly related PRs

• fix(ingestion/tableau): restructure the tableau graphql datasource query #11230: The changes in test_dbt.py include updates to test configurations that may relate to the new prefer_sql_parser_lineage field and its validation logic, indicating a direct connection to the modifications made in the main PR.

Suggested reviewers

• hsheth2

Poem

🐇 In the land of DBT, changes abound,
A new field appears, where lineage is found.
With tests that now dance, in configurations bright,
We hop through the code, with joy and delight!
So let’s raise a cheer, for the paths that we pave,
In the world of ingestion, we’re clever and brave! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[maggiehays]

@coderabbitai summary