Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ingest/snowflake): Add feature flag for view defintions #10914

Conversation

ethan-cartwright
Copy link
Contributor

@ethan-cartwright ethan-cartwright commented Jul 15, 2024

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

    • Added an option to include or exclude view definitions when fetching views for databases and schemas in Snowflake.
  • Improvements

    • Enhanced configurability for handling view definitions in datasets, providing more control over the data retrieval process.

Copy link
Contributor

coderabbitai bot commented Jul 15, 2024

Walkthrough

The updates to the Snowflake ingestion codebase primarily focus on adding control over whether view definitions are included in the result sets. This is achieved through the introduction of the include_view_definitions parameter in methods across snowflake_schema.py and snowflake_schema_gen.py. Additionally, some syntax improvements and clarifications in the initialization of attributes and function calls were made.

Changes

File Change Summary
metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema.py Added include_view_definitions parameter to get_views_for_database and refined attribute initialization.
metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema_gen.py Modified gen_dataset_workunits and get_views_for_schema to handle view definitions based on the new parameter. Updated attribute initialization syntax.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SnowflakeSchemaGen
    participant SnowflakeSchema

    User->>SnowflakeSchemaGen: Request to retrieve views
    SnowflakeSchemaGen->>SnowflakeSchema: Call get_views_for_database(include_view_definitions)
    SnowflakeSchema-->>SnowflakeSchemaGen: Return views (with or without definitions)
    SnowflakeSchemaGen->>User: Return processed views
Loading

Poem

In the snowy fields of data's flight,
Views with or without a sight,
Definitions clear or left behind,
Now you control what you find.
🎵 Snowflake dances in the night,
CodeRabbit's update, pure delight. 🌙


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

@github-actions github-actions bot added the ingestion PR or Issue related to the ingestion of metadata label Jul 15, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ea7d6a9 and df2e04c.

Files selected for processing (3)
  • metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_config.py (1 hunks)
  • metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema.py (2 hunks)
  • metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema_gen.py (1 hunks)
Additional comments not posted (4)
metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_config.py (1)

184-187: LGTM! The new field include_view_definitions is correctly added.

The addition of the include_view_definitions field with a default value of True and a description is consistent with the existing configuration fields.

metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema.py (2)

323-325: LGTM! The method get_views_for_database is correctly updated.

The addition of the include_view_definitions parameter to the get_views_for_database method is consistent with the intended functionality.


358-360: LGTM! The logic to include view definitions is correctly implemented.

The conditional inclusion of view definitions based on the include_view_definitions parameter is correctly implemented.

metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema_gen.py (1)

1020-1022: LGTM! The method get_views_for_schema is correctly updated.

The addition of the include_view_definitions parameter to the get_views_for_database method call is consistent with the intended functionality.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 df2e04c and 70b1b11.

Files selected for processing (2)
  • metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema.py (1 hunks)
  • metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema_gen.py (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema_gen.py
Additional comments not posted (1)
metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema.py (1)

135-137: Refactor: Simplified initialization of _table_tags.

The change to initialize _table_tags using a more concise lambda expression is a good practice as it improves readability and maintainability of the code. However, ensure that this refactoring does not alter the behavior, especially in edge cases where the nested dictionary structure is significant.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 70b1b11 and cf95fe4.

Files selected for processing (2)
  • metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema_gen.py (1 hunks)
  • metadata-models/src/main/pegasus/com/linkedin/dataset/ViewProperties.pdl (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema_gen.py
Additional comments not posted (1)
metadata-models/src/main/pegasus/com/linkedin/dataset/ViewProperties.pdl (1)

26-26: Addition of the viewLogic field is well-integrated.

The addition of the viewLogic field as an optional string is consistent with the feature flag implementation for view definitions. This allows flexibility in whether or not view logic is included in the dataset metadata, aligning with the PR's objectives.

Ensure that the field is properly documented in the code to maintain clarity and consistency with other fields in the record.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 cf95fe4 and d17ccb1.

Files selected for processing (1)
  • metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema_gen.py (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • metadata-ingestion/src/datahub/ingestion/source/snowflake/snowflake_schema_gen.py

Copy link
Collaborator

@hsheth2 hsheth2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hsheth2 hsheth2 merged commit 12ee485 into datahub-project:master Jul 16, 2024
58 checks passed
@hsheth2 hsheth2 changed the title Add feature flag for view defintions feat(ingest/snowflake): Add feature flag for view defintions Jul 16, 2024
aviv-julienjehannet pushed a commit to aviv-julienjehannet/datahub that referenced this pull request Jul 25, 2024
Co-authored-by: Ethan Cartwright <ethan.cartwright@acryl.io>
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ingestion PR or Issue related to the ingestion of metadata
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants