fix(ingest/snowflake): add limits on tables/columns/queries in lineage

[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

• Enhancements
  • Improved performance and manageability by limiting the number of upstream tables, columns, and queries processed for each downstream entity.

[coderabbitai]

Walkthrough

In the table_upstreams_with_column_lineage function of snowflake_query.py, three constants were introduced to control the maximum number of upstream tables, columns, and queries returned. The aggregation functions within this function now incorporate slicing to restrict the results in accordance with these constants, enhancing the efficiency and manageability of the data retrieval process.

Changes

File	Change Summary
metadata-ingestion/.../snowflake_query.py	Added constants _MAX_UPSTREAMS_PER_DOWNSTREAM, _MAX_UPSTREAM_COLUMNS_PER_DOWNSTREAM, and _MAX_QUERIES_PER_DOWNSTREAM. Updated aggregation functions to include slicing based on these constants.

Poem

Amidst the code where data streams,
Constants cap our lofty dreams,
Limiting flow of upstream ties,
Columns and queries in disguised,
Efficiency now takes the stage,
A rabbit's hop in digital age. ✨🐇

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f4be88d and 7ca173d.

Files selected for processing (1)

• metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_query.py (3 hunks)

Additional comments not posted (3)

metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_query.py (3)

670-672: Introduce constants for limits on tables, columns, and queries.

The addition of these constants is a good practice as it centralizes control over these limits, making the code more maintainable and easier to configure. However, ensure that these values are derived from either configuration settings or environmental variables to allow for easy adjustments without code changes.

---

793-812: Review the implementation of slicing for upstream tables, columns, and queries.

The use of ARRAY_SLICE to enforce limits on the number of upstream tables, columns, and queries is effective and clear. This approach ensures that the data remains manageable and prevents performance degradation when dealing with large datasets. However, consider adding a comment explaining why these specific limits were chosen (e.g., based on performance tests or user feedback), as this will help maintainers understand the reasoning behind these values.

---

Line range hint 670-812: Ensure comprehensive testing on the modified lineage query logic.

Given the complexity of the table_upstreams_with_column_lineage function and its critical role in lineage tracking, it's essential to ensure that this functionality is thoroughly tested. This includes testing with various sizes of datasets to verify that the slicing does not omit critical data and that performance remains acceptable under load.